From 55e5f34b327a822d769f55d3edd856cfb5c6f038 Mon Sep 17 00:00:00 2001 From: Halabitimoty <57334680+Halabitimoty@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:49:31 +0100 Subject: [PATCH 1/4] Task: Readme Added --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fa905b..4efb255 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# ramm-sdk +# RAMM EVM SDK for Solana Network +#### Welcome to the RAMM EVM SDK for Solana Network! This software development kit (SDK) enables developers to integrate Ethereum Virtual Machine (EVM) capabilities into the Solana blockchain, allowing for the deployment and execution of Ethereum-compatible smart contracts on the Solana network. + +### Table of Contents + +`1. Introduction` +`2. Features` +`3. Installation` +`4. Getting Started` +`5. Usage` +`6. Examples` +`7. Troubleshooting` +`8. Contributing` +`9. License` + +### Introduction + +The RAMM EVM SDK is a comprehensive toolkit that brings EVM compatibility to the Solana blockchain. It leverages Solana's high-performance infrastructure while providing developers with familiar Ethereum development tools and libraries. + +### Features + +`* EVM Compatibility: Execute Ethereum smart contracts on the Solana blockchain.` +`* Solidity Support: Write smart contracts in Solidity, the popular Ethereum programming language.` +`* Web3.js Integration: Connect to the Solana network using Web3.js, enabling seamless interaction with smart contracts.` +`* Scalability: Utilize Solana's high throughput and low transaction fees for decentralized applications (DApps).` + +### Installation + +To install the RAMM EVM SDK, follow these steps: + +`npm install @ramm/evm-sdk` + +### Getting Started + +`1. Initialize Solana Wallet:` + +`const wallet = await solanaWeb3.createWallet();` + +`2. Deploy EVM Contract:` + +`const evmContract = await rammEvm.deployContract(wallet, "YourSolidityContract.sol");` + +`3. Interact with Smart Contract:` + +`const result = await evmContract.methods.yourSmartContractMethod().send();` + +### Usage + +The RAMM EVM SDK provides a set of APIs for interacting with Solana and deploying/executing Ethereum-compatible smart contracts. Refer to the `[documentation](#)` for detailed information on available methods and their usage. + +### Examples + +Explore the`[examples](#)` directory for sample applications and use cases demonstrating the integration of the RAMM EVM SDK with Solana. + +### Troubleshooting + +If you encounter any issues or have questions, please check the `[troubleshooting guide](#)` or open an `[issue](#)` on GitHub. + +### Contributing + +We welcome contributions from the community. To contribute, please follow the guidelines outlined in `[CONTRIBUTOR.md](#)`. + +### License + +This SDK is licensed under the `[MIT License](#)`. Feel free to use, modify, and distribute it in your projects. From 69013c8388939037df48fd48edb6f1cdb1571982 Mon Sep 17 00:00:00 2001 From: Halabitimoty <57334680+Halabitimoty@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:59:17 +0100 Subject: [PATCH 2/4] Task: Readme Added --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4efb255..0bf9db4 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ ### Table of Contents -`1. Introduction` -`2. Features` -`3. Installation` -`4. Getting Started` -`5. Usage` -`6. Examples` -`7. Troubleshooting` -`8. Contributing` -`9. License` +1. Introduction +2. Features +3. Installation +4. Getting Started +5. Usage +6. Examples +7. Troubleshooting +8. Contributing +9. License ### Introduction @@ -20,10 +20,10 @@ The RAMM EVM SDK is a comprehensive toolkit that brings EVM compatibility to the ### Features -`* EVM Compatibility: Execute Ethereum smart contracts on the Solana blockchain.` -`* Solidity Support: Write smart contracts in Solidity, the popular Ethereum programming language.` -`* Web3.js Integration: Connect to the Solana network using Web3.js, enabling seamless interaction with smart contracts.` -`* Scalability: Utilize Solana's high throughput and low transaction fees for decentralized applications (DApps).` +- EVM Compatibility: Execute Ethereum smart contracts on the Solana blockchain. +- Solidity Support: Write smart contracts in Solidity, the popular Ethereum programming language. +- Web3.js Integration: Connect to the Solana network using Web3.js, enabling seamless interaction with smart contracts. +- Scalability: Utilize Solana's high throughput and low transaction fees for decentralized applications (DApps).` ### Installation @@ -33,15 +33,15 @@ To install the RAMM EVM SDK, follow these steps: ### Getting Started -`1. Initialize Solana Wallet:` +1. Initialize Solana Wallet: `const wallet = await solanaWeb3.createWallet();` -`2. Deploy EVM Contract:` +2. Deploy EVM Contract:` `const evmContract = await rammEvm.deployContract(wallet, "YourSolidityContract.sol");` -`3. Interact with Smart Contract:` +3. Interact with Smart Contract:` `const result = await evmContract.methods.yourSmartContractMethod().send();` From 579e667468a83b01d3b3a46c7b00ba130c985c69 Mon Sep 17 00:00:00 2001 From: Halabitimoty <57334680+Halabitimoty@users.noreply.github.com> Date: Wed, 31 Jan 2024 12:02:56 +0100 Subject: [PATCH 3/4] Task: Readme Added --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0bf9db4..f7728ec 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,33 @@ The RAMM EVM SDK is a comprehensive toolkit that brings EVM compatibility to the To install the RAMM EVM SDK, follow these steps: -`npm install @ramm/evm-sdk` +``` +npm install @ramm/evm-sdk +``` ### Getting Started 1. Initialize Solana Wallet: -`const wallet = await solanaWeb3.createWallet();` +``` +const wallet = await solanaWeb3.createWallet(); +``` 2. Deploy EVM Contract:` -`const evmContract = await rammEvm.deployContract(wallet, "YourSolidityContract.sol");` +``` +const evmContract = await rammEvm.deployContract(wallet, "YourSolidityContract.sol"); +``` 3. Interact with Smart Contract:` -`const result = await evmContract.methods.yourSmartContractMethod().send();` +``` +const result = await evmContract.methods.yourSmartContractMethod().send(); +``` ### Usage -The RAMM EVM SDK provides a set of APIs for interacting with Solana and deploying/executing Ethereum-compatible smart contracts. Refer to the `[documentation](#)` for detailed information on available methods and their usage. +The RAMM EVM SDK provides a set of APIs for interacting with Solana and deploying/executing Ethereum-compatible smart contracts. Refer to the `[documentation](docs/ramm)` for detailed information on available methods and their usage. ### Examples @@ -55,7 +63,7 @@ Explore the`[examples](#)` directory for sample applications and use cases demon ### Troubleshooting -If you encounter any issues or have questions, please check the `[troubleshooting guide](#)` or open an `[issue](#)` on GitHub. +If you encounter any issues or have questions, please check the `[troubleshooting guide](/guide)` or open an `[issue](#)` on GitHub. ### Contributing From cbef4773a0a4019972efc6c23f24d9e7912586a0 Mon Sep 17 00:00:00 2001 From: Halabitimoty <57334680+Halabitimoty@users.noreply.github.com> Date: Wed, 31 Jan 2024 12:05:04 +0100 Subject: [PATCH 4/4] Task: Readme Added --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f7728ec..03518b8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The RAMM EVM SDK is a comprehensive toolkit that brings EVM compatibility to the - EVM Compatibility: Execute Ethereum smart contracts on the Solana blockchain. - Solidity Support: Write smart contracts in Solidity, the popular Ethereum programming language. - Web3.js Integration: Connect to the Solana network using Web3.js, enabling seamless interaction with smart contracts. -- Scalability: Utilize Solana's high throughput and low transaction fees for decentralized applications (DApps).` +- Scalability: Utilize Solana's high throughput and low transaction fees for decentralized applications (DApps). ### Installation @@ -41,7 +41,7 @@ npm install @ramm/evm-sdk const wallet = await solanaWeb3.createWallet(); ``` -2. Deploy EVM Contract:` +2. Deploy EVM Contract: ``` const evmContract = await rammEvm.deployContract(wallet, "YourSolidityContract.sol");