Command Line Interface (CLI)¶
Autogenerated documentation.
Raiden python client CLI
usage: raiden-cli [-h] [--endpoint ENDPOINT] [--version VERSION]
{address,channel-close,deposit-increase,channel-open,channel,channels,withdraw-increase,disconnect,connect,connections,mint-token,non-settled,payment-events,payment,pending-transfers,token-register,tokens}
...
Named Arguments¶
- --endpoint
REST API endpoint
Default: “http://127.0.0.1:5001/”
- --version
API version
Default: “v1”
Sub-commands:¶
channel-close¶
Close a channell
raiden-cli channel-close [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
Named Arguments¶
- -t, --token-address
The token we want to be used
- -p, --partner-address
Channel partner address
deposit-increase¶
Increase channel deposit
raiden-cli deposit-increase [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
--total-deposit TOTAL_DEPOSIT
Named Arguments¶
- -t, --token-address
For the given token address
- -p, --partner-address
Channel partner address
- --total-deposit
The increased total deposit
channel-open¶
Opens / creates a channel
raiden-cli channel-open [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
--total-deposit TOTAL_DEPOSIT --settle-timeout
SETTLE_TIMEOUT
Named Arguments¶
- -t, --token-address
For the given token address
- -p, --partner-address
Channel partner address
- --total-deposit
Amount of tokens to be deposited
- --settle-timeout
Amount of blocks that the settle timeout should have
channel¶
Request a channel detail
raiden-cli channel [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
Named Arguments¶
- -t, --token-address
For the given token address
- -p, --partner-address
For the given partner address
channels¶
Request a list of all unsettled channels
raiden-cli channels [-h] [-t TOKEN_ADDRESS]
Named Arguments¶
- -t, --token-address
For the given token address
withdraw-increase¶
Increase channel deposit
raiden-cli withdraw-increase [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
--total-withdraw TOTAL_WITHDRAW
Named Arguments¶
- -t, --token-address
For the given token address
- -p, --partner-address
Channel partner address
- --total-withdraw
The increased total withdraw
disconnect¶
Leave a token network
raiden-cli disconnect [-h] -t TOKEN_ADDRESS
Named Arguments¶
- -t, --token-address
Token address
connect¶
Automatically join a token network
raiden-cli connect [-h] -t TOKEN_ADDRESS --funds FUNDS
[--initial-channel-target INITIAL_CHANNEL_TARGET]
[--joinable-funds-target JOINABLE_FUNDS_TARGET]
Named Arguments¶
- -t, --token-address
Token address
- --funds
Token address
- --initial-channel-target
Token address
- --joinable-funds-target
Token address
mint-token¶
API endpoints for testing
raiden-cli mint-token [-h] -t TOKEN_ADDRESS --to TO --value VALUE
[--contract-method CONTRACT_METHOD]
Named Arguments¶
- -t, --token-address
Target address
- --to
The address to assign the minted tokens to
- --value
he amount of tokens to be minted
- --contract-method
The name of the contract’s minting method
non-settled¶
Partners with non-settled channels
raiden-cli non-settled [-h] -t TOKEN_ADDRESS
Named Arguments¶
- -t, --token-address
For the given token address
payment-events¶
Querying payment events
raiden-cli payment-events [-h] -t TOKEN_ADDRESS --target-address
TARGET_ADDRESS
Named Arguments¶
- -t, --token-address
Target address
- --target-address
Token address
payment¶
Initiate a payment
raiden-cli payment [-h] -t TOKEN_ADDRESS --target-address TARGET_ADDRESS
--amount AMOUNT [--identifier IDENTIFIER]
Named Arguments¶
- -t, --token-address
Token address
- --target-address
Target address
- --amount
Token address
- --identifier
Token address
pending-transfers¶
List of uncompleted transfers
raiden-cli pending-transfers [-h] -t TOKEN_ADDRESS -p PARTNER_ADDRESS
Named Arguments¶
- -t, --token-address
For the given token address
- -p, --partner-address
For the given partner address