diff --git a/docs/03-sygma-sdk/02-Quick-Start/04-gmp.md b/docs/03-sygma-sdk/02-Quick-Start/04-gmp.md index 5b846b1..469123a 100644 --- a/docs/03-sygma-sdk/02-Quick-Start/04-gmp.md +++ b/docs/03-sygma-sdk/02-Quick-Start/04-gmp.md @@ -24,9 +24,9 @@ There are a few requirements for the Destination chain contract function that ge To initialize the generic message transfer object, the following parameters need to be supplied: -- An EIP1193 compatible EVM provider +- An `EIP-1193` compatible EVM provider - Environment variable `SYGMA_ENV` needs to be set as `mainnet` or `testnet` -- Address, ABI of the contract and the function that will be invoked on the destination chain. +- Address, `ABI` of the contract and the function that will be invoked on the destination chain. ```typescript const gmpTransfer = await createCrossChainContractCall< diff --git a/docs/03-sygma-sdk/03-Advanced/01-local-setup.md b/docs/03-sygma-sdk/03-Advanced/01-local-setup.md index 0987539..7c33d9f 100644 --- a/docs/03-sygma-sdk/03-Advanced/01-local-setup.md +++ b/docs/03-sygma-sdk/03-Advanced/01-local-setup.md @@ -80,7 +80,7 @@ yarn build #### 4) Run the EVM-to-Substrate token transfer example 1. `cd` into the `evm-to-substrate-fungible-transfer` example inside the `/sygma-sdk/examples` folder -2. Update RPC Urls and transfer parameters in the example with local configuration +2. Update RPC URLs and transfer parameters in the example with local configuration 3. run: diff --git a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/01-EVM-EVM-example.md b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/01-EVM-EVM-example.md index 70f14fa..1c862bb 100644 --- a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/01-EVM-EVM-example.md +++ b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/01-EVM-EVM-example.md @@ -111,7 +111,7 @@ const privateKey = process.env.PRIVATE_KEY; if (!privateKey) throw new Error("Missing environment variable: PRIVATE_KEY"); ``` -- Define transfer contants like destination chain ID, source chain ID, recipient address, resource ID and RPC Urls +- Define transfer constants like destination chain ID, source chain ID, recipient address, resource ID and RPC URLs ```ts const SEPOLIA_CHAIN_ID = 11155111; diff --git a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/02-EVM-Substrate-example.md b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/02-EVM-Substrate-example.md index 090168e..15c2cc9 100644 --- a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/02-EVM-Substrate-example.md +++ b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/02-EVM-Substrate-example.md @@ -91,7 +91,7 @@ cd examples/evm-to-substrate-fungible-transfer yarn run transfer ``` -The example will use `ethers` in conjunction with the Sygma SKD to create a transfer from Sepolia to Rococo-Phala with a `sygUSD` token. It will be received on Rococo-Phala as the `sygUSD` token. +The example will use `ethers` in conjunction with the Sygma SDK to create a transfer from Sepolia to Rococo-Phala with a `sygUSD` token. It will be received on Rococo-Phala as the `sygUSD` token. ### Script functionality @@ -118,7 +118,7 @@ const privateKey = process.env.PRIVATE_KEY; if (!privateKey) throw new Error("Missing environment variable: PRIVATE_KEY"); ``` -- Define transfer contants like destination chain ID, source chain ID, recipient address, resource ID and RPC Urls +- Define transfer constants like destination chain ID, source chain ID, recipient address, resource ID and RPC URLs ```ts const SEPOLIA_CHAIN_ID = 11155111; diff --git a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/03-Substrate-EVM-example.md b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/03-Substrate-EVM-example.md index bdcad1f..688f050 100644 --- a/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/03-Substrate-EVM-example.md +++ b/docs/03-sygma-sdk/04-Examples/01-Basic-ERC-20-Token-Transfers/03-Substrate-EVM-example.md @@ -121,7 +121,7 @@ const TANGLE_RPC_URL = process.env.SOURCE_SUBSTRATE_RPC_URL ?? "wss://rpc.tangle.tools"; ``` -Note: In the case of a substrate transfer, mnmeonic is required. +Note: In the case of a substrate transfer, mnemonic is required. - Constant and function to retrieve Sygma scanner URL (Optional) diff --git a/docs/03-sygma-sdk/04-Examples/02-GMP-Examples/01-GMP-Example-With-A-Simple-Storage-Contract.md b/docs/03-sygma-sdk/04-Examples/02-GMP-Examples/01-GMP-Example-With-A-Simple-Storage-Contract.md index 96f60c8..ea00754 100644 --- a/docs/03-sygma-sdk/04-Examples/02-GMP-Examples/01-GMP-Example-With-A-Simple-Storage-Contract.md +++ b/docs/03-sygma-sdk/04-Examples/02-GMP-Examples/01-GMP-Example-With-A-Simple-Storage-Contract.md @@ -60,7 +60,7 @@ This example uses the `dotenv` module to manage private keys. To run the example **DO NOT COMMIT PRIVATE KEYS WITH REAL FUNDS TO GITHUB. DOING SO COULD RESULT IN COMPLETE LOSS OF YOUR FUNDS.** -Create a `.env` file in the `evm-to-evm-generic-message-transfer` folder withiin examples: +Create a `.env` file in the `evm-to-evm-generic-message-transfer` folder within examples: ```bash cd examples/evm-to-evm-generic-message-transfer