Skip to content

Commit

Permalink
feat(isc-wiki): implement suggestions from reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ginowine
Ginowine committed Jun 13, 2024
1 parent 20dbd3a commit 5101599
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 80 deletions.
90 changes: 50 additions & 40 deletions docs/build/isc/v1.1/docs/how-tos/core-contracts/token/send-token-across-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ import CreateNativeToken from '../../../_admonitions/_create-native-token.md';

# Send Native Token Across Chains

In this guide, you'll learn how to send L1 native Tokens from L1 to an L2 EVM account on a destination chain by using the `sendCrossChain` function of the `NativeTokenController.sol` contract.
## Introduction

Cross-chain token transfers are crucial in the evolving decentralized finance (DeFi) landscape. In this guide, you'll learn how to send L1 native Tokens from L1 to an L2 EVM account on a destination chain using the `sendCrossChain` function of the [`NativeTokenController.sol`](https://github.com/iotaledger/isc-cross-chain/blob/master/contracts/NativeTokenController.sol) contract.

<CreateNativeToken/>

Expand All @@ -23,25 +25,25 @@ First, let’s take a look at the `sendCrossChain` function in the `NativeTokenC

```solidity
function sendCrossChain(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Function implementation
}
```

This function facilitates the transfer of a specified `amount` of tokens from the current chain to a `destinationChain`, with the `destinationAddress` as the recipient on the destination chain. The `sendCrossChain` function invokes the `ISC.sandbox.send` function, which manages the actual cross-chain message transmission.
This function facilitates the transfer of native tokens from a Layer 1 (L1) address to a specified Layer 2 (L2) EVM account. It requires the L1 address of the destination chain (`chainAddress`), the recipient address on the destination chain (`_destination`), the destination chain's ID (`_chainID`), the amount of native tokens to be sent (`_amount`), and the amount of base tokens to cover the storage deposit (`_storageDeposit`).
The `sendCrossChain` wrapper function invokes the `ISC.sandbox.send` function, which manages the actual cross-chain message transmission.

## Setting Up the Development Environment

<DemoTokenSetup/>

## Using the `sendCrossChain` Function

To send native tokens across chains, you need to provide the following transaction details to the `sendCrossChain` function.
To send native tokens across chains, you need to provide the following transaction details to the `sendCrossChain` function:

* `ChainAddress` - The L1 address of the destination chain.
* `Destination` - The address on the destination chain that will receive the tokens.
Expand All @@ -57,52 +59,60 @@ To send native tokens across chains, you need to provide the following transacti
Let's define a function named `sendCrossChainMessage` in our contract, which will interact with the `sendCrossChain` function in the `NativeTokenController` contract.

```solidity
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
```

# Full Example Code
## Full Example Code

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./NativeTokenController.sol"; // Adjust the path as necessary
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
contract CrossChainMessenger {
NativeTokenController public nativeTokenController;
constructor(address _nativeTokenControllerAddress) {
nativeTokenController = NativeTokenController(_nativeTokenControllerAddress);
}
nativeTokenController = NativeTokenController(_nativeTokenControllerAddress);
}
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit,
tokenAddress
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
}
```
```
## Conclution

By following this guide, you have learned how to set up your development environment and use the `sendCrossChain` function in the [`NativeTokenController.sol`](https://github.com/iotaledger/isc-cross-chain/blob/master/contracts/NativeTokenController.sol) contract to send native tokens across chains. You can now interact with the sendCrossChain function within your own smart contracts to facilitate cross-chain token transfers.

By leveraging cross-chain capabilities, you can create more interoperable and versatile decentralized applications, paving the way for a more connected blockchain ecosystem.
90 changes: 50 additions & 40 deletions ...d/isc/v1.3-alpha/docs/how-tos/core-contracts/token/send-token-across-chains.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ import CreateNativeToken from '../../../_admonitions/_create-native-token.md';

# Send Native Token Across Chains

In this guide, you'll learn how to send L1 native Tokens from L1 to an L2 EVM account on a destination chain by using the `sendCrossChain` function of the `NativeTokenController.sol` contract.
## Introduction

Cross-chain token transfers are crucial in the evolving decentralized finance (DeFi) landscape. In this guide, you'll learn how to send L1 native Tokens from L1 to an L2 EVM account on a destination chain using the `sendCrossChain` function of the [`NativeTokenController.sol`](https://github.com/iotaledger/isc-cross-chain/blob/master/contracts/NativeTokenController.sol) contract.

<CreateNativeToken/>

Expand All @@ -23,25 +25,25 @@ First, let’s take a look at the `sendCrossChain` function in the `NativeTokenC

```solidity
function sendCrossChain(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Function implementation
}
```

This function facilitates the transfer of a specified `amount` of tokens from the current chain to a `destinationChain`, with the `destinationAddress` as the recipient on the destination chain. The `sendCrossChain` function invokes the `ISC.sandbox.send` function, which manages the actual cross-chain message transmission.
This function facilitates the transfer of native tokens from a Layer 1 (L1) address to a specified Layer 2 (L2) EVM account. It requires the L1 address of the destination chain (`chainAddress`), the recipient address on the destination chain (`_destination`), the destination chain's ID (`_chainID`), the amount of native tokens to be sent (`_amount`), and the amount of base tokens to cover the storage deposit (`_storageDeposit`).
The `sendCrossChain` wrapper function invokes the `ISC.sandbox.send` function, which manages the actual cross-chain message transmission.

## Setting Up the Development Environment

<DemoTokenSetup/>

## Using the `sendCrossChain` Function

To send native tokens across chains, you need to provide the following transaction details to the `sendCrossChain` function.
To send native tokens across chains, you need to provide the following transaction details to the `sendCrossChain` function:

* `ChainAddress` - The L1 address of the destination chain.
* `Destination` - The address on the destination chain that will receive the tokens.
Expand All @@ -57,52 +59,60 @@ To send native tokens across chains, you need to provide the following transacti
Let's define a function named `sendCrossChainMessage` in our contract, which will interact with the `sendCrossChain` function in the `NativeTokenController` contract.

```solidity
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
```

# Full Example Code
## Full Example Code

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./NativeTokenController.sol"; // Adjust the path as necessary
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
contract CrossChainMessenger {
NativeTokenController public nativeTokenController;
constructor(address _nativeTokenControllerAddress) {
nativeTokenController = NativeTokenController(_nativeTokenControllerAddress);
}
nativeTokenController = NativeTokenController(_nativeTokenControllerAddress);
}
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit,
tokenAddress
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
function sendCrossChainMessage(
address destinationChain,
bytes memory destinationAddress,
uint256 amount,
ISCChainID chainID,
uint64 storageDeposit
) external {
// Ensure the sender has enough tokens (assuming a balanceOf function exists)
uint256 senderBalance = IERC20(tokenAddress).balanceOf(msg.sender);
require(senderBalance >= amount, "Insufficient token balance");
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
// Call the sendCrossChain function from NativeTokenController
nativeTokenController.sendCrossChain(destinationChain, destinationAddress, amount, chainID, storageDeposit);
}
}
```
```
## Conclution

By following this guide, you have learned how to set up your development environment and use the `sendCrossChain` function in the [`NativeTokenController.sol`](https://github.com/iotaledger/isc-cross-chain/blob/master/contracts/NativeTokenController.sol) contract to send native tokens across chains. You can now interact with the sendCrossChain function within your own smart contracts to facilitate cross-chain token transfers.

By leveraging cross-chain capabilities, you can create more interoperable and versatile decentralized applications, paving the way for a more connected blockchain ecosystem.

0 comments on commit 5101599

Please sign in to comment.