Using the Smart Contract CLI

Options	Description
-V, --version	output the version number
-h, --help	display help for command

Commands	Description
login [options]	login to ledgerswarm smartcontract wallet
getContractList [options]	list smart contract instances
getAvailableContracts [options]	list smart contracts available for deployment
getContractDetails [options]	list the details of the specified smart contract
callFunction [options]	call a function of the specified smart contract
newContract [options]	deploy a new instance of specified smart contract
getContractState [options]	show current state for a smart contract instance
watchContract [options]	show current state for a smart contract instance specified in a file
logout	logout of ledgerswarm smart contract wallet
help [command]	display help for command

Users interact with smart contracts via the Smart Contract Wallet. The wallet contains the certificates and keys needed to interact with a Smart Contract Host which runs and maintins the smart contract state. The wallet can also interact with LedgerSwarm to execute transactions on behalf of a smart contract.

lscontract help login

lscontract login -u username -p password -s wallet.server.io

logout

lscontract help logout

lscontract logout

Available Contracts

Available contracts are the templates that are loaded onto the smart contract hosts you are conntected to. These are the contracts you can deploy.

getAvailableContracts

lscontract help getAvailableContracts

lscontract getAvailableContracts -d table

getContractDetails

Each contract comprises a collection of json schemas and javascript functions. The json schemas describe the contract roles, the contraints of each roles, the input values required to initialise a new instance and the parameters required to call the contract functions. The contract functions are javascript functions that alter the contract state in some way.

lscontract help getContractDetails

lscontract getContractDetails -n 'Payment Mandate v5' -c BEEBANK

Deploy a New Contract Instance

newContract

Create a new instance of an available contract. This will prompt you for the starting (genesis) values for the contract and will ask you which participants are assigned to each of the contract roles.