cpchain-cli

CPChain CLI Tools

This tool aim to help developer develop smart contract on CPChain mainnet.

Usage

npm install -g cpchain-cli

cpchain-cli help

cpchain-cli create my-contract

cd my-contract

# Test contract
truffle test

Base Contracts

The CPChain foundation has provided this repo which has many tested base contracts. Developers can use it to develop and test smart contracts.

Deploy on Testnet

Before deploying contract on the mainnet, we suggest developers the smart contracts on Testnet first to secure test. You can get Test CPC coins by the faucet. This faucet drips 100 CPC every 10 seconds. You can register your account in our queue.

Create account

# install tools
pip3 install cpc-fusion

# create a new account
cpc-fusion account create

Deploy

Now, copy your address and access faucet to get test coins. Then build your contract and deploy it on Testnet:

# build contracts
npm run build

# deploy on testnet (Specify your keystore)
cpc-fusion deploy --keystore <The path of your keystore>  --abi build/contracts/MyContract.json --endpoint https://civilian.testnet.cpchain.io --chainID 41

Manage Contract by Command-Line

After deploying your contract, you will need to manage it. The cpc-fusion can also support managing deployed contract. Please run as below to get all commands:

cpc-fusion -h

If you want to check all configurations, you can use cpc-fusion get-configs -h, for example:

cpc-fusion get-configs --abi build/contracts/HelloWorld.json --address <contract address>

If you want to call your contract, you can use cpc-fusion call-func -h, for example:

cpc-fusion call-func --keystore <keystore/key> --address <contract address> --abi build/contracts/HelloWorld.json --function <function name> --parameters <parameters>

Add you can add --value to specify the amount of CPC.

If you want to call view function to check something, you can use cpc-fusion view-func -h, for example:

cpc-fusion view-func --abi build/contracts/HelloWorld.json --address <contract address> --function <function name> --parameters <parameters>

Deploy on Mainnet

# deploy on the Mainnet (Specify your keystore)
cpc-fusion deploy --keystore <The path of your keystore>  --abi build/contracts/MyContract.json

Develop

npm i

npm link

scripts/run src/index.ts -h

npm run lint

npm run lint:fix

npm run build

# publish
# npm publish

FAQ

为什么不用 swc 打包

因为当前版本仅支持 commonjs 打包，不支持 ES Modules（官方文档），考虑当需跟上最新的发展，以及很多库已转向 ES Modules，故先弃用 swc 打包方式。

References

• SWC
• ESLint Rules
• CommanderJs
• Boxen: Create boxes in the terminal