-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2896 from xiadd/master
Add docs for ChainIDE
- Loading branch information
Showing
4 changed files
with
220 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,83 @@ | ||
| import glob from 'glob'; | ||
| import markdownIt from 'markdown-it' | ||
| import meta from 'markdown-it-meta' | ||
| import fs from 'fs' | ||
| import _ from 'lodash' | ||
| import { searchPlugin } from '@vuepress/plugin-search' | ||
| import glob from "glob"; | ||
| import markdownIt from "markdown-it"; | ||
| import meta from "markdown-it-meta"; | ||
| import fs from "fs"; | ||
| import _ from "lodash"; | ||
| import { searchPlugin } from "@vuepress/plugin-search"; | ||
| const sidebar = (directory, array) => { | ||
| return array.map(i => { | ||
| const children = _.sortBy( | ||
| glob | ||
| .sync(`./${directory}/${i[1]}/*.md`) | ||
| .map(path => { | ||
| const md = new markdownIt(); | ||
| const file = fs.readFileSync(path, "utf8"); | ||
| md.use(meta); | ||
| md.render(file); | ||
| const order = md.meta.order; | ||
| return { path, order }; | ||
| }) | ||
| .filter(f => f.order !== false), | ||
| ["order", "path"] | ||
| ) | ||
| .map(f => f.path.slice(1)) | ||
| .filter(f => !f.match("README")); | ||
| return { | ||
| text: i[0], | ||
| children, | ||
| collapsible:true | ||
| }; | ||
| }); | ||
| return array.map((i) => { | ||
| const children = _.sortBy( | ||
| glob | ||
| .sync(`./${directory}/${i[1]}/*.md`) | ||
| .map((path) => { | ||
| const md = new markdownIt(); | ||
| const file = fs.readFileSync(path, "utf8"); | ||
| md.use(meta); | ||
| md.render(file); | ||
| const order = md.meta.order; | ||
| return { path, order }; | ||
| }) | ||
| .filter((f) => f.order !== false), | ||
| ["order", "path"] | ||
| ) | ||
| .map((f) => f.path.slice(1)) | ||
| .filter((f) => !f.match("README")); | ||
| return { | ||
| text: i[0], | ||
| children, | ||
| collapsible: true, | ||
| }; | ||
| }); | ||
| }; | ||
| import{defineUserConfig } from 'vuepress' | ||
| import { defaultTheme } from 'vuepress' | ||
| export default defineUserConfig( { | ||
| base: "/docs/", | ||
| plugins: [ | ||
| searchPlugin({ | ||
| locales: { | ||
| '/': { | ||
| placeholder: 'Search', | ||
| }, | ||
| } | ||
| }), | ||
| ], | ||
| locales: { | ||
| import { defineUserConfig } from "vuepress"; | ||
| import { defaultTheme } from "vuepress"; | ||
| export default defineUserConfig({ | ||
| base: "/docs/", | ||
| plugins: [ | ||
| searchPlugin({ | ||
| locales: { | ||
| "/": { | ||
| lang: "en-US", | ||
| title: "IRISnet Documents", | ||
| description: "IRISnet Documents", | ||
| } | ||
| }, | ||
| theme: defaultTheme({ | ||
| repo: "irisnet/irishub", | ||
| docsDir: "docs", | ||
| editLinks: true, | ||
| contributors: false, | ||
| docsBranch: "main", | ||
| editLinkText: 'Help us improve this page!', | ||
| locales: { | ||
| "/": { | ||
| editLinkText: 'Help us improve this page!', | ||
| navbar: [ | ||
| { | ||
| text: 'Back to IRISnet', | ||
| link: 'https://www.irisnet.org' | ||
| } | ||
| ], | ||
| sidebar: sidebar("", [ | ||
| ["Getting Started", "get-started"], | ||
| ["Concepts", "concepts"], | ||
| ["Features", "features"], | ||
| ["Daemon", "daemon"], | ||
| ["CLI Client", "cli-client"], | ||
| ["Endpoints", "endpoints"], | ||
| ["Tools", "tools"], | ||
| ["Migration", "migration"], | ||
| ["Resources", "resources"] | ||
| ]), | ||
| } | ||
| placeholder: "Search", | ||
| }, | ||
| }, | ||
| }), | ||
| ], | ||
| locales: { | ||
| "/": { | ||
| lang: "en-US", | ||
| title: "IRISnet Documents", | ||
| description: "IRISnet Documents", | ||
| }, | ||
| }, | ||
| theme: defaultTheme({ | ||
| repo: "irisnet/irishub", | ||
| docsDir: "docs", | ||
| editLinks: true, | ||
| contributors: false, | ||
| docsBranch: "main", | ||
| editLinkText: "Help us improve this page!", | ||
| locales: { | ||
| "/": { | ||
| editLinkText: "Help us improve this page!", | ||
| navbar: [ | ||
| { | ||
| text: "Back to IRISnet", | ||
| link: "https://www.irisnet.org", | ||
| }, | ||
| ], | ||
| sidebar: sidebar("", [ | ||
| ["Getting Started", "get-started"], | ||
| ["Concepts", "concepts"], | ||
| ["Features", "features"], | ||
| ["Daemon", "daemon"], | ||
| ["CLI Client", "cli-client"], | ||
| ["Endpoints", "endpoints"], | ||
| ["ChainIDE for IRISnet", "chainide-for-irisnet"], | ||
| ["Tools", "tools"], | ||
| ["Migration", "migration"], | ||
| ["Resources", "resources"], | ||
| ]), | ||
| }, | ||
| }, | ||
| }), | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| order: 1 | ||
| --- | ||
|
|
||
| # ChainIDE for IRISnet Environment Configuration | ||
|
|
||
| > This section provides a detailed explanation of the environment configuration for IRISnet IDE, which is essential for developing dApps on the IRISnet blockchain. | ||
| ## Create a new IRISnet Project | ||
|
|
||
| Visit [ChainIDE](https://chainide.com/) and click the "Try Now" button on the front page as shown in the figure below. | ||
|
|
||
|  | ||
|
|
||
| Here, you will choose your login method, which includes two options: GitHub and Guest. For this tutorial, select GitHub login, as later on, the use of the Sandbox requires users to log in with GitHub. | ||
|
|
||
|  | ||
|
|
||
| Click the "New Project" button. | ||
|
|
||
|  | ||
|
|
||
| A pop-up window will appear. On the left side of the pop-up, select "IRISnet". Then, select a temple to create a new project. | ||
|
|
||
|  | ||
|
|
||
| ## Configure Wallet | ||
|
|
||
| IRISnet IDE provides support for two smart contract environments: EVM and Native. The EVM environment supports Metamask wallet, while the Native environment supports Kelpr wallet. | ||
|
|
||
| ### Supported EVM Wallet | ||
|
|
||
| **Metamask** | ||
|
|
||
| > https://metamask.io/ | ||
| ### Supported Native Wallet | ||
|
|
||
| **Kelpr** | ||
|
|
||
| > https://www.keplr.app/ | ||
| ## Acquiring test tokens | ||
|
|
||
| Test tokens can be acquired from a tesnet faucet. Use test tokens to cover the cost of deployment, transaction fees, gas fees, etc., on the testnet. | ||
|
|
||
| Tutorials on Acquiring Test Tokens: | ||
|
|
||
| Native: https://irisnet.org/docs/get-started/testnet.html#run-a-full-node | ||
|
|
||
| EVM: https://irisnet.org/docs/get-started/evm-contract.html#prepare-account-for-evm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| order: 3 | ||
| --- | ||
|
|
||
| # How to Use IRISnet Native IDE | ||
|
|
||
| > Issue, Edit, and Query FTs and NFTs on IRISnet | ||
| ## Connect to IRISnet Native | ||
|
|
||
| Once inside the project, click "Connect Wallet" in the upper right corner, select "Injected Web3 Provider," and then select "Kelpr Wallet" to connect to the IRISnet Native blockchain. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| Click on the address in the bottom right corner to obtain your Kelpr wallet address. | ||
|
|
||
|  | ||
|
|
||
| ## Run the FT & NFT Toolbox | ||
|
|
||
| On the right side, select either "IRIS FT Toolkit" or "IRIS NFT Toolkit," to issue, edit, and query IRISnet FTs and NFTs on the IRISnet Native blockchain. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| order: 2 | ||
| --- | ||
|
|
||
| # How to Use IRISnet EVM IDE | ||
|
|
||
| > The process of writing, compiling, deploying, interacting, and querying with IRISnet EVM smart contracts | ||
| ## Write a contract | ||
|
|
||
| Upon entering the project, the README.md file included in the folder will be automatically previewed. | ||
|
|
||
|  | ||
|
|
||
| In the Explorer panel, you can create new files (or folders), refresh the directory, and download files. You can also directly click on the files that come with the template. | ||
|
|
||
|  | ||
|
|
||
| Click on a contract file to edit the code. | ||
|
|
||
|  | ||
|
|
||
| ## Compile a contract | ||
|
|
||
| Once your contract code is written, click on the "Compiler" button in the right-side menu to open the compilation module. Choose the compiler version and decide whether to enable optimization, then click "Compile \*\*\*.sol" to initiate the compilation. | ||
|
|
||
|  | ||
|
|
||
| After successful compilation, the ABI and BYTE CODE will be displayed below, and there will be a confirmation message in the console stating "Compile contract success." | ||
|
|
||
|  | ||
|
|
||
| ## Connect to IRISnet EVM | ||
|
|
||
| Before deploying a contract, you need to click on "Connect Wallet" in the upper right corner and select connect to JavaScript VM (for testing, implemented in JavaScript) or Metamask (for deployment on the IRISnet blockchain). | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Deploy a contract | ||
|
|
||
| Click the "Deploy & Interaction" button on the right-hand side, which will bring up the deployment and interaction pages. Select the compiled contract and click "Deploy" to initiate the deployment (then confirm in Metamask). After successful contract deployment, the console will display the contract deployment result and relevant information. | ||
|
|
||
|  | ||
|
|
||
| In addition, you can click "Import Deployed Contract" to import a contract that has already been deployed for contract interactions. | ||
|
|
||
|  | ||
|
|
||
| ## Contract interaction | ||
|
|
||
| After a successful contract deployment, you can interact with the contract. Click on the deployed contract, choose the corresponding interface, and click "Submit" or "Get" to perform interactions. | ||
|
|
||
|  | ||
|
|
||
| ## Transaction Query | ||
|
|
||
| Click on the transaction hash in the Output section to view the specific details of each transaction. | ||
|
|
||
|  | ||
|
|
||
| ## IRISnet EVM Sandbox | ||
|
|
||
| If you prefer using the command line for development, you can open the IRISnet EVM Sandbox, which comes pre-loaded with [Hardhat](https://hardhat.org/), [Truffle](https://trufflesuite.com/), [Brownie](https://eth-brownie.readthedocs.io/en/stable/) [Ganache](https://trufflesuite.com/ganache/), [Git](https://git-scm.com/) and [Node.js V16](https://nodejs.org/en). | ||
|
|
||
|  | ||
|
|
||
| If you've started a process on a port in the Sandbox and wish to access that port, please refer to [ChainIDE - Port Forwarding](https://chainide.gitbook.io/chainide-english-1/port-forwarding). |