def command_desc(self):
p1 = ParameterDesc('address', 'address to create an alias for')
p2 = ParameterDesc('alias',
'custom name to associate with the address')
return CommandDesc('alias',
'create an alias for an address',
params=[p1, p2])
def command_desc(self):
p1 = ParameterDesc('tx_count', 'number of transactions to send')
p2 = ParameterDesc('--change-addr',
'address to send remaining funds to',
optional=True)
p3 = ParameterDesc(
'--from-addr',
'source address to take funds from (if not specified, take first address in wallet)',
optional=True)
p4 = ParameterDesc(
'--fee',
'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01',
optional=True)
p5 = ParameterDesc(
'--owners',
'list of NEO addresses indicating the transaction owners e.g. --owners=[address1,address2]',
optional=True)
p6 = ParameterDesc(
'--tx-attr',
f"a list of transaction attributes to attach to the transaction\n\n"
f"{' ':>17} See: http://docs.neo.org/en-us/network/network-protocol.html section 4 for a description of possible attributes\n\n"
f"{' ':>17} Example:\n"
f"{' ':>20} --tx-attr=[{{\"usage\": <value>,\"data\":\"<remark>\"}}, ...]\n"
f"{' ':>20} --tx-attr=[{{\"usage\": 0x90,\"data\":\"my brief description\"}}]\n",
optional=True)
params = [p1, p2, p3, p4, p5, p6]
return CommandDesc('sendmany',
'send multiple NEO/GAS transactions',
params=params)
def command_desc(self):
p1 = ParameterDesc('path', 'path to the desired Python (.py) file')
p2 = ParameterDesc(
'storage',
'boolean input to determine if smart contract requires storage')
p3 = ParameterDesc(
'dynamic_invoke',
'boolean input to determine if smart contract requires dynamic invoke'
)
p4 = ParameterDesc(
'payable',
'boolean input to determine if smart contract is payable')
p5 = ParameterDesc('params',
'input parameter types of the smart contract')
p6 = ParameterDesc(
'returntype', f"the return type of the smart contract output\n\n"
f"{' ':>17} For more information about parameter types see\n"
f"{' ':>17} https://neo-python.readthedocs.io/en/latest/data-types.html#contractparametertypes\n",
optional=True)
p7 = ParameterDesc(
'--fee',
'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01',
optional=True)
params = [p1, p2, p3, p4, p5, p6, p7]
return CommandDesc(
'deploy',
'Deploy a smart contract (.avm) file to the blockchain',
params=params)
def command_desc(self):
p1 = ParameterDesc('attribute',
'asset name, assetId, or "all"\n\n'
f"{' ':>17} Example:\n"
f"{' ':>20} 'neo' or 'c56f33fc6ecfcd0c225c4ab356fee59390af8560be0e930faebe74a6daff7c9b'\n"
f"{' ':>20} 'gas' or '602c79718b16e442de58778e148d0b1084e3b2dffd5de6b7b16cee7969282de7'\n")
return CommandDesc('asset', 'show a specified asset', [p1])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
p4 = ParameterDesc('amount', 'number of tokens to send')
return CommandDesc('approve', 'approve an allowance', [p1, p2, p3, p4])
def command_desc(self):
p1 = ParameterDesc('token', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
p4 = ParameterDesc('amount', 'number of tokens to send')
return CommandDesc('sendfrom', 'send a token on behalf of another account (requires approval)', [p1, p2, p3, p4])
def command_desc(self):
p1 = ParameterDesc('address', 'address to split from')
p2 = ParameterDesc('asset', 'type of asset to split (NEO/GAS)')
p3 = ParameterDesc('unspent_index', 'index of the vin to split')
p4 = ParameterDesc('divisions', 'number of vouts to divide into ')
p5 = ParameterDesc('fee', 'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01', optional=True)
return CommandDesc('split', 'split an asset unspent output into N outputs', params=[p1, p2, p3, p4, p5])
def command_desc(self):
p1 = ParameterDesc(
'attribute',
'block index, an address, or contract script hash to show notifications for'
)
return CommandDesc('notifications',
'show specified contract execution notifications',
[p1])
def command_desc(self):
p1 = ParameterDesc('token', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
p4 = ParameterDesc('amount', 'number of tokens to send')
p5 = ParameterDesc('--fee', 'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01', optional=True)
return CommandDesc('sendfrom', 'send a token on behalf of another account (requires approval)', [p1, p2, p3, p4, p5])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
p4 = ParameterDesc('amount', 'number of tokens to send')
p5 = ParameterDesc('--fee', 'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01', optional=True)
return CommandDesc('approve', 'approve an allowance', [p1, p2, p3, p4, p5])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
return CommandDesc(
'allowance',
'get the amount an account can transfer from another acount',
[p1, p2, p3])
def command_desc(self):
p1 = ParameterDesc(
'block-size',
'preset of "slow"/"normal"/"fast", or a specific block request size (max. 500) e.g. 250 '
)
p2 = ParameterDesc('queue-size',
'maximum number of outstanding block requests')
return CommandDesc('node-requests', 'configure block request settings',
[p1, p2])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
p2 = ParameterDesc('addresses',
'space separated list of NEO addresses')
p3 = ParameterDesc(
'--fee',
'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01',
optional=True)
return CommandDesc('register', 'register for a crowd sale',
[p1, p2, p3])
def command_desc(self):
p1 = ParameterDesc(
'--from-addr',
'source address to claim gas from (if not specified, take first address in wallet)',
optional=True)
p2 = ParameterDesc(
'--to-addr',
'destination address for claimed gas (if not specified, take first address in wallet; or, use the from address, if specified)',
optional=True)
return CommandDesc('claim', 'claim gas', params=[p1, p2])
def command_desc(self):
p1 = ParameterDesc('token', 'token symbol or script hash')
p2 = ParameterDesc('from_addr', 'address to send token from')
p3 = ParameterDesc('to_addr', 'address to send token to')
p4 = ParameterDesc('amount', 'number of tokens to send')
p5 = ParameterDesc('--tx-attr', f"a list of transaction attributes to attach to the transaction\n\n"
f"{' ':>17} See: http://docs.neo.org/en-us/network/network-protocol.html section 4 for a description of possible attributes\n\n" # noqa: E128 ignore indentation
f"{' ':>17} Example:\n"
f"{' ':>20} --tx-attr=[{{\"usage\": <value>,\"data\":\"<remark>\"}}, ...]\n"
f"{' ':>20} --tx-attr=[{{\"usage\": 0x90,\"data\":\"my brief description\"}}]\n", optional=True)
return CommandDesc('send', 'send a token from the wallet', [p1, p2, p3, p4, p5])
def command_desc(self):
p1 = ParameterDesc(
'own pub key',
'public key in your own wallet (use `wallet` to find the information)'
)
p2 = ParameterDesc(
'sign_cnt',
'minimum number of signatures required for using the address (min is: 1)'
)
p3 = ParameterDesc('signing key n',
'all remaining signing public keys')
return CommandDesc('multisig_addr', 'import a multi-signature address',
[p1, p2, p3])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
p2 = ParameterDesc('to_addr', 'address to mint tokens to')
p3 = ParameterDesc('--attach-neo', 'amount of neo to attach to the transaction', optional=True)
p4 = ParameterDesc('--attach-gas', 'amount of gas to attach to the transaction', optional=True)
p5 = ParameterDesc('--fee', 'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01', optional=True)
p6 = ParameterDesc('--tx-attr', f"a list of transaction attributes to attach to the transaction\n\n"
f"{' ':>17} See: http://docs.neo.org/en-us/network/network-protocol.html section 4 for a description of possible attributes\n\n" # noqa: E128 ignore indentation
f"{' ':>17} Example:\n"
f"{' ':>20} --tx-attr=[{{\"usage\": <value>,\"data\":\"<remark>\"}}, ...]\n"
f"{' ':>20} --tx-attr=[{{\"usage\": 0x90,\"data\":\"my brief description\"}}]\n", optional=True)
return CommandDesc('mint', 'mint tokens from a contract', [p1, p2, p3, p4, p5, p6])
def command_desc(self):
p1 = ParameterDesc('contract', 'token contract hash (script hash)')
p2 = ParameterDesc(
'inputs',
'test parameters fed to the smart contract, or use "--i" for prompted parameter input',
optional=True)
p3 = ParameterDesc(
'--attach-neo',
'amount of neo to attach to the transaction. Required if --attach-gas is not specified',
optional=True)
p4 = ParameterDesc(
'--attach-gas',
'amount of gas to attach to the transaction. Required if --attach-neo is not specified',
optional=True)
p5 = ParameterDesc(
'--no-parse-addr',
'flag to turn off address parsing when input into the smart contract',
optional=True)
p6 = ParameterDesc(
'--from-addr',
'source address to take fee funds from (if not specified, take first address in wallet)',
optional=True)
p7 = ParameterDesc(
'--fee',
'Attach GAS amount to give your transaction priority (> 0.001) e.g. --fee=0.01',
optional=True)
p8 = ParameterDesc(
'--owners',
'list of NEO addresses indicating the transaction owners e.g. --owners=[address1,address2]',
optional=True)
p9 = ParameterDesc(
'--return-type',
'override the return parameter type e.g. --return-type=02',
optional=True)
p10 = ParameterDesc(
'--tx-attr',
'a list of transaction attributes to attach to the transaction\n\n'
f"{' ':>17} See: http://docs.neo.org/en-us/network/network-protocol.html section 4 for a description of possible attributes\n\n"
f"{' ':>17} Example\n"
f"{' ':>20} --tx-attr=[{{\"usage\": <value>,\"data\":\"<remark>\"}}, ...]\n"
f"{' ':>20} --tx-attr=[{{\"usage\": 0x90,\"data\":\"my brief description\"}}]\n\n"
f"{' ':>17} For more information about parameter types see\n"
f"{' ':>17} https://neo-python.readthedocs.io/en/latest/data-types.html#contractparametertypes\n",
optional=True)
params = [p1, p2, p3, p4, p5, p6, p7, p8, p9, p10]
return CommandDesc(
'invoke',
'Call functions on the smart contract. Will prompt before sending to the network',
params=params)
def command_desc(self):
p1 = ParameterDesc('path', 'path to the desired Python (.py) file')
p2 = ParameterDesc(
'storage',
'boolean input to determine if smart contract requires storage')
p3 = ParameterDesc(
'dynamic_invoke',
'boolean input to determine if smart contract requires dynamic invoke'
)
p4 = ParameterDesc(
'payable',
'boolean input to determine if smart contract is payable')
p5 = ParameterDesc('params',
'input parameter types of the smart contract')
p6 = ParameterDesc('returntype',
'return type of the smart contract output')
p7 = ParameterDesc(
'inputs',
'test parameters fed to the smart contract, or use "--i" for prompted parameter input',
optional=True)
p8 = ParameterDesc(
'--no-parse-addr',
'flag to turn off address parsing when input into the smart contract',
optional=True)
p9 = ParameterDesc(
'--from-addr',
'source address to take fee funds from (if not specified, take first address in wallet)',
optional=True)
p10 = ParameterDesc(
'--owners',
'list of NEO addresses indicating the transaction owners e.g. --owners=[address1,address2]',
optional=True)
p11 = ParameterDesc(
'--tx-attr',
'a list of transaction attributes to attach to the transaction\n\n'
f"{' ':>17} See: http://docs.neo.org/en-us/network/network-protocol.html section 4 for a description of possible attributes\n\n"
f"{' ':>17} Example\n"
f"{' ':>20} --tx-attr=[{{\"usage\": <value>,\"data\":\"<remark>\"}}, ...]\n"
f"{' ':>20} --tx-attr=[{{\"usage\": 0x90,\"data\":\"my brief description\"}}]\n\n"
f"{' ':>17} Usage Examples:\n"
f"{' ':>20} build_run path.py True False False 0710 05 input1 input2\n"
f"{' ':>20} build_run path.py True False False 0710 05 --i\n\n"
f"{' ':>17} For more information about parameter types see\n"
f"{' ':>17} https://neo-python.readthedocs.io/en/latest/data-types.html#contractparametertypes\n",
optional=True)
params = [p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11]
return CommandDesc(
'build_run',
'compile a specified Python (.py) script into a smart contract (.avm) file and test it',
params=params)
def command_desc(self):
p1 = ParameterDesc(
'verbose',
'also show the number of queued, known, and bad addresses',
optional=True)
p2 = ParameterDesc('queued',
'also list the queued addresses',
optional=True)
p3 = ParameterDesc('known',
'also list the known addresses',
optional=True)
p4 = ParameterDesc('bad', 'also list the bad addresses', optional=True)
params = [p1, p2, p3, p4]
return CommandDesc('nodes',
'show connected peers and their blockheight',
params=params)
def command_desc(self):
p1 = ParameterDesc('asset',
'type of asset to query (NEO/GAS)',
optional=True)
p2 = ParameterDesc(
'--from-addr',
'address to check the unspent assets from (if not specified, checks for all addresses)',
optional=True)
p3 = ParameterDesc('--watch',
'show assets that are in watch only addresses',
optional=True)
p4 = ParameterDesc('--count',
'only count the unspent assets',
optional=True)
return CommandDesc('unspent',
'show unspent assets',
params=[p1, p2, p3, p4])
def command_desc(self):
p1 = ParameterDesc('path', 'path to the desired smart contract (.avm) file')
p2 = ParameterDesc('storage', 'boolean input to determine if smart contract requires storage')
p3 = ParameterDesc('dynamic_invoke', 'boolean input to determine if smart contract requires dynamic invoke')
p4 = ParameterDesc('payable', 'boolean input to determine if smart contract is payable')
p5 = ParameterDesc('params', 'input parameter types of the smart contract')
p6 = ParameterDesc('returntype', 'the return type of the smart contract output')
p7 = ParameterDesc('inputs', 'test parameters fed to the smart contract, or use "--i" for prompted parameter input', optional=True)
p8 = ParameterDesc('--no-parse-addr', 'flag to turn off address parsing when input into the smart contract', optional=True)
p9 = ParameterDesc('--from-addr',
'source address to take fee funds from (if not specified, take first address in wallet)\n\n'
f"{' ':>17} Usage Examples:\n"
f"{' ':>20} load_run path.py True False False 0710 05 input1 input2\n"
f"{' ':>20} load_run path.py True False False 0710 05 --i\n\n"
f"{' ':>17} For more information about parameter types see\n"
f"{' ':>17} https://neo-python.readthedocs.io/en/latest/data-types.html#contractparametertypes\n", optional=True)
params = [p1, p2, p3, p4, p5, p6, p7, p8, p9]
return CommandDesc('load_run', 'load a specified smart contract (.avm) file and test it', params=params)
def command_desc(self):
return CommandDesc('token', 'various token operations')
def command_desc(self):
p1 = ParameterDesc('jsn', 'transaction in JSON format')
params = [p1]
return CommandDesc('sign',
'sign a multi-signature transaction',
params=params)
def command_desc(self):
p1 = ParameterDesc('path', 'path to the desired Python (.py) file')
return CommandDesc(
'build',
'compile a specified Python (.py) script into a smart contract (.avm) file',
[p1])
def command_desc(self):
p1 = ParameterDesc('attribute', 'either "on"|"off" or 1|0, or "reset"')
return CommandDesc(
'debugstorage',
'use a separate database for smart contract storage item debugging',
params=[p1])
def command_desc(self):
return CommandDesc('sc', 'develop smart contracts')
def command_desc(self):
p1 = ParameterDesc('contract', 'token contract hash (script hash)')
return CommandDesc('delete', 'remove a token from the wallet', [p1])
def command_desc(self):
p1 = ParameterDesc('address', 'address to delete')
return CommandDesc('delete', 'delete an address from the wallet', params=[p1])
def command_desc(self):
p1 = ParameterDesc('symbol', 'token symbol or script hash')
return CommandDesc('history', 'show transaction history', [p1])
