From c6e302cf2a4299a28f2a528ac6721ba8470068a4 Mon Sep 17 00:00:00 2001 From: Phuc Thai Date: Sun, 8 Dec 2024 20:46:54 +0700 Subject: [PATCH] feat: add developer guides --- .../guides/smart-contract-requirements.md | 36 +++++++++++++++++++ docs/apps/ccip-bridge/overview.md | 25 +++++++++++-- sidebars.js | 2 ++ 3 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 docs/apps/ccip-bridge/guides/smart-contract-requirements.md diff --git a/docs/apps/ccip-bridge/guides/smart-contract-requirements.md b/docs/apps/ccip-bridge/guides/smart-contract-requirements.md new file mode 100644 index 0000000..61ca468 --- /dev/null +++ b/docs/apps/ccip-bridge/guides/smart-contract-requirements.md @@ -0,0 +1,36 @@ +--- +description: Learn the token requirements to integrate with CCIP +slug: /apps/ccip-bridge/smart-contract-requirements +title: ERC-20 Smart Contract Requirements +toc_max_heading_level: 2 +--- + +## Overview + +Before enabling an ERC20-compatible token in CCIP, it's important to understand the requirements it must fulfill to integrate with CCIP. + +## Token Administrator address requirement + +The token contract must provide an easy way to obtain the token administrator address. This can be achieved if the token contract includes **one of the following functions**: + +* **owner()**: This function returns the token contract owner's address. **We recommend using this function.** +* **getCCIPAdmin()**: This function returns the token administrator's address if it differs from the contract owner's. + +## Requirements for CCIP token transfers + +The token's smart contract must meet minimum requirements to integrate with CCIP. + +### Burn & Mint Requirements +* The token smart contract must have the following functions: + * **mint(address account, uint256 amount)**: This function is used to mint the amount of tokens to a given **account** on the destination blockchain. + * **burn(uint256 amount)** / **burn(address account, uint256 amount)**: This function is used to burn the amount of tokens on the source blockchain. + * **decimals()**: Returns the token's number of decimals. +* On the source and destination blockchains, the token contract must support granting **mint and burn** permissions. The token issuers or another role (such as the token administrator) will grant these permissions to the token pool. +### Lock & Mint Requirements +* The token smart contract must have the following function: + * **decimals()**: Returns the token's number of decimals. +* On the destination blockchain, The token contract must support granting mint and burn permissions described above. The token issuers or another role (such as the token administrator) will grant these permissions to the token pool. + +:::info +**If you don't have an existing token**: For all blockchains where tokens need to be burned and minted (for example, the source or destination chain in the case of Burn and Mint, or the destination blockchain in the case of Lock and Mint), Chainlink provides a [BurnMintERC677](https://github.com/smartcontractkit/ccip/blob/ccip-develop/contracts/src/v0.8/shared/token/ERC677/BurnMintERC677.sol) contract that you can use to deploy your token in minutes. This token follows the [ERC677](https://github.com/ethereum/EIPs/issues/677) or [ERC777](https://ethereum.org/en/developers/docs/standards/tokens/erc-777/), allowing you to use it as-is or extend it to meet your specific requirements. You can also use a standard **ERC-20** as long as it meets the above specifications. +::: \ No newline at end of file diff --git a/docs/apps/ccip-bridge/overview.md b/docs/apps/ccip-bridge/overview.md index 1d76cc5..e24992a 100644 --- a/docs/apps/ccip-bridge/overview.md +++ b/docs/apps/ccip-bridge/overview.md @@ -1,13 +1,34 @@ --- -description: A dApp for bridging ERC-20 tokens and NFTs (non-fungible tokens) (coming soon) between the Ronin chain and others chain. +description: A secure interoperability protocol for enabling token transfers across blockchains slug: /apps/ccip-bridge title: CCIP Bridge --- ## Overview -CCIP Bridge ([app.roninchain.com/ccip-bridge](https://app.roninchain.com/ccip-bridge)) is an app for bridging ERC-20 tokens and NFTs (non-fungible tokens) (coming soon) between the Ronin chain and others chain. +The [Cross-Chain Interoperability Protocol (CCIP)](https://app.roninchain.com/ccip-bridge) is a protocol developed by Chainlink to enable secure and reliable communication and token transfers between different blockchain networks. It provides the technical infrastructure for cross-chain interactions, enabling developers to build decentralized applications (dApps) that operate across multiple blockchains. + + +## Features + +1. **Cross-Chain Connectivity** + Enables communication and token transfers between blockchain networks, including both public and private chains. + +2. **Decentralized Infrastructure** + Utilizes Chainlink's Decentralized Oracle Network to process and validate cross-chain messages, ensuring system reliability. + +3. **Token Transfers** + Supports secure movement of tokens between chains, allowing for interoperability between blockchain ecosystems. + +4. **Built-in Safeguards** + Includes security features such as rate limiting to mitigate risks associated with cross-chain interactions. + ## User guides * [Transfer an ERC-20 token](./guides/transfer-token.md) + +## Developer guides + +* [Learn the token requirements to integrate with CCIP](./guides/smart-contract-requirements.md) +* Developers can access CCIP through [Chainlink's documentation and SDKs](https://docs.chain.link/ccip). The protocol provides tools and resources for integrating cross-chain functionality into dApps, with an emphasis on security and straightforward implementation. diff --git a/sidebars.js b/sidebars.js index 32d3eb8..8e9b227 100644 --- a/sidebars.js +++ b/sidebars.js @@ -151,6 +151,8 @@ const sidebars = { items: [ // Transfer ERC-20 tokens 'apps/ccip-bridge/guides/transfer-token', + // Learn the token requirements to integrate with CCIP + 'apps/ccip-bridge/guides/smart-contract-requirements', ], }, // Katana