diff options
author | Hsuan Lee <boczeratul@gmail.com> | 2019-04-25 00:24:56 +0800 |
---|---|---|
committer | Hsuan Lee <boczeratul@gmail.com> | 2019-04-25 00:25:21 +0800 |
commit | ffb6711c71d42543dfce359a18c7e4c34bf5fe9c (patch) | |
tree | fcfb16fb8990a8683c4ccd2676fc92742701c6d6 | |
parent | 14acb091800526e7dd85a9a1b44a25e7d6ecf054 (diff) | |
download | dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar.gz dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar.bz2 dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar.lz dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar.xz dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.tar.zst dexon-wiki-ffb6711c71d42543dfce359a18c7e4c34bf5fe9c.zip |
Add documentation for tools and libraries
-rw-r--r-- | Interact-from-Mobile-App.md | 2 | ||||
-rw-r--r-- | Interact-from-Web.md | 2 | ||||
-rw-r--r-- | Interact-with-Contracts.md | 2 | ||||
-rw-r--r-- | dexon-ganache.md | 18 | ||||
-rw-r--r-- | dexon-remix.md | 34 | ||||
-rw-r--r-- | dexon-truffle.md | 16 | ||||
-rw-r--r-- | dexonscan.md | 31 | ||||
-rw-r--r-- | dsolc-js.md | 16 | ||||
-rw-r--r-- | dsolidity.md | 10 | ||||
-rw-r--r-- | sol-tools.md | 22 | ||||
-rw-r--r-- | web3-js.md | 15 |
11 files changed, 168 insertions, 0 deletions
diff --git a/Interact-from-Mobile-App.md b/Interact-from-Mobile-App.md index d73b9a0..6620ba5 100644 --- a/Interact-from-Mobile-App.md +++ b/Interact-from-Mobile-App.md @@ -1 +1,3 @@ # from Mobile App + +WIP diff --git a/Interact-from-Web.md b/Interact-from-Web.md index ff14eec..66b6ee0 100644 --- a/Interact-from-Web.md +++ b/Interact-from-Web.md @@ -1 +1,3 @@ # from Web + +WIP diff --git a/Interact-with-Contracts.md b/Interact-with-Contracts.md index b7b3260..352e1c9 100644 --- a/Interact-with-Contracts.md +++ b/Interact-with-Contracts.md @@ -1 +1,3 @@ # Interact with Contracts + +WIP diff --git a/dexon-ganache.md b/dexon-ganache.md index 2f55eaa..9cdf92b 100644 --- a/dexon-ganache.md +++ b/dexon-ganache.md @@ -1 +1,19 @@ # dexon-ganache + +JavaScript mock of DEXON blockchain, for developing and testing smart contracts without actually connecting to a blockchain. + +## Usage + +```bash +# Install from npm +> npm install @dexon-foundation/ganache-cli -g + +# run local Ganache +> dexon-ganache-cli +``` + +## Github + +[https://github.com/dexon-foundation/ganache-cli](https://github.com/dexon-foundation/ganache-cli) + +[https://github.com/dexon-foundation/ganache-core](https://github.com/dexon-foundation/ganache-core) diff --git a/dexon-remix.md b/dexon-remix.md index 17b21e3..bc15e21 100644 --- a/dexon-remix.md +++ b/dexon-remix.md @@ -1 +1,35 @@ # DEXON Remix + +Web-based IDE for developing, compiling, deploying and testing smart contracts. + +## Usage + +You can either use our [hosted version](https://remix.dexon.org) or download from npm + +```bash +# Install from npm +> npm install @dexon-foundation/remix-ide -g + +# run local DEXON-remix IDE +> dremix-ide +``` + +Check out our step-by-step guide for DEXON Remix IDE [here](./Remix-IDE.md) + +## Github + +[https://github.com/dexon-foundation/remix-ide](https://github.com/dexon-foundation/remix-ide) + +## Features + +- **Smart Contract Editor** +Remix IDE provides a fully functioned solidity code editor. + +- **Smart Contract Compiler** +You can compile your smart contract directly from the UI. + +- **Contract Deployer** +Deploy compiled bytecode onto DEXON networks or JavaScript mock network. + +- **Debugger** +Test run and add breakpoints to your smart contract source code. diff --git a/dexon-truffle.md b/dexon-truffle.md index b465676..bdaa5c5 100644 --- a/dexon-truffle.md +++ b/dexon-truffle.md @@ -1 +1,17 @@ # dexon-truffle + +Toolkit for developing Solidity smart contracts on DEXON, including compiler, contract deployer, test suite and a lot more. + +## Usage + +```bash +# Install from npm +> npm install @dexon-foundation/truffle -g + +# run command-line tools +> dexon-truffle init|compile|migrate|test +``` + +## Github + +[https://github.com/dexon-foundation/truffle](https://github.com/dexon-foundation/truffle) diff --git a/dexonscan.md b/dexonscan.md index a39e572..c9ab07f 100644 --- a/dexonscan.md +++ b/dexonscan.md @@ -1 +1,32 @@ # DEXONSCAN + +Official blockchain explorer and web wallet for DEXON. You can also check network status and interact with smart contracts in DEXONSCAN. + +## Usage + +Go directly to DEXONSCAN websites and start exploring DEXON networks. +- [Mainnet DEXONSCAN](https://dexonscan.app) +- [Testnet DEXONSCAN](https://testnet.dexonscan.app) + +## Features + +#### View Network Status + +![](https://storage.googleapis.com/dexon-assets/wiki/dexonscan-network.png) +DEXONSCAN provides a comprehensive chart and a series of stats for you to get a grasp of the current network status easily. + +#### View Governance Status + +You can check the network governance status on DEXONSCAN, including network configurations like block time, minimum staking amount, round length and currently active block producing nodes. + +#### View Blocks, Addresses and Transactions + +Just like every other blockchain explorers, you can check the details of blocks, addresses and transactions on DEXONSCAN. + +#### Wallet + +DEXONSCAN provides wallet UI, with connectability to Chrome/Firefox wallet extension, Ledger and TREZOR. You can manage your assets on DEXON easily and securely with DEXONSCAN. + +#### Smart Contract Interactions + +Smart contract developers can verify their contract source code on DEXONSCAN. Once it's verified, users can see the contract source code and interact with it on DEXONSCAN UI. diff --git a/dsolc-js.md b/dsolc-js.md index b862cea..5180405 100644 --- a/dsolc-js.md +++ b/dsolc-js.md @@ -1 +1,17 @@ # dsolc-js + +JavaScript bindings for DEXON's dsolidity compiler. + +## Usage + +```bash +# Install from npm +> npm install @dexon-foundation/dsolc -g + +# run command-line tools +> dsolcjs --help +``` + +## Github + +[https://github.com/dexon-foundation/dsolc-js](https://github.com/dexon-foundation/dsolc-js) diff --git a/dsolidity.md b/dsolidity.md index b70d8a0..e0de51e 100644 --- a/dsolidity.md +++ b/dsolidity.md @@ -1 +1,11 @@ # dsolidity + +Solidity compiler written in C++, supporting additional DEXON-specific opcodes like on-chain random oracle. + +## Usage + +Instructions about how to build and install the Solidity compiler can be found in the [Solidity documentation](https://solidity.readthedocs.io/en/latest/installing-solidity.html#building-from-source) + +## Github + +[https://github.com/dexon-foundation/dsolidity](https://github.com/dexon-foundation/dsolidity) diff --git a/sol-tools.md b/sol-tools.md index ea6381b..2505242 100644 --- a/sol-tools.md +++ b/sol-tools.md @@ -1 +1,23 @@ # sol-tools + +Toolkit for compiling, testing and profiling smart contracts. Originally developed by 0x team. + +## Usage + +```bash +# Install from npm +> npm install @dexon-foundation/sol-compiler -g +> npm install @dexon-foundation/sol-coverage -g +> npm install @dexon-foundation/sol-profiler -g +> npm install @dexon-foundation/sol-trace -g + +# run command-line tools +> dsol-compiler +> dsol-coverage +> dsol-profiler +> dsol-trace +``` + +## Github + +[https://github.com/dexon-foundation/sol-tools](https://github.com/dexon-foundation/sol-tools) @@ -1 +1,16 @@ # web3.js + +JavaScript library for accessing DEXON network from browser and Node.js. + +## Usage + +```bash +# Install from npm +> npm install web3 --save +``` + +Get more information for web3.js [here](https://web3js.readthedocs.io/) + +## Github + +[https://github.com/ethereum/web3.js/](https://github.com/ethereum/web3.js/) |