@koinos/sdk-as-cli

Installation

# with npm
npm install -g @koinos/sdk-as-cli

# with yarn
yarn global add @koinos/sdk-as-cli

Create a contract boilerplate

# will create "mycontract" in the current working folder
koinos-sdk-as-cli create mycontract

Important note

• It important that your smart contract file lives in the assembly folder of your project. (i.e.: assembly/Calculator.ts)
• And, it is also important that your proto files live in the assembly/proto/ folder of your project. (i.e.: assembly/proto/calculator.proto)

Help

koinos-sdk-as-cli help

Build a contract

# example for building a calculator contract
# build the debug version
koinos-sdk-as-cli build-all debug calculator.proto 

# build the release version
koinos-sdk-as-cli build-all release calculator.proto 

This will result in the generation of:

• a calculator.abi file in the folder abi/
• a calculator-abi.json file in the folder abi/
• a contract.wasm file in the folder build/release and build/debug
• an index.ts file in the folder assembly/
• a Calculator.boilerplate.ts file in the folder assembly/

Generate ABI file

# example for a calculator contract
koinos-sdk-as-cli generate-abi calculator.proto

This will generate a calculator.abi file in the folder abi/

Generate contract.boilerplate.ts and index.ts files

# example for a calculator contract
koinos-sdk-as-cli generate-contract-as calculator.proto

This will generate a Calculator.boilerplate.tsfile and index.ts file in the folder assembly/

Generate AssemblyScript files for all the proto files of a contract

koinos-sdk-as-cli generate-contract-proto

Generate AS files for the given proto files

# example for a calculator contract
koinos-sdk-as-cli generate-as-proto calculator/assembly/proto/calculator.proto

Run tests

koinos-sdk-as-cli run-tests