Micropayment hub client for counterparty assets.
Project description
Micropayment hub CLI interface for counterparty assets.
Setup
$ pip install picopayments-cli
Usage
$ picopayments-cli [config argumants] <command> [command arguments]
Usage examples
# show help text
$ picopayments-cli --help
# show help text for command
$ picopayments-cli <command> --help
# connect to hub
$ picopayments-cli --testnet connect ASSET QUANTITY
# Show status of current connections
$ picopayments-cli --testnet status
# queue payment
$ picopayments-cli --testnet queuepayment SOURCEHANDLE DESTINATIONHANDLE QUANTITY
# sync payments
$ picopayments-cli --testnet sync
# close payment channel
$ picopayments-cli --testnet close HANDLE
API Calls/Commands
version
Returns current version of number.
hubstatus
Get current hub status.
Arguments
asset (str): Optionally limit output to given asset.
Returns
List of open connections, current terms, funding addresses
and current liquidity for new connections.
{
"connections": {
"a0b1156206dedb1aa24084752b5693a9022349dc547fb9952aa510003e93": {
"asset": "XCP",
"balance": 31338,
"status": "open",
"ttl": 401
}
},
"current_terms": {
"XCP": {
"deposit_max": 0,
"deposit_min": 0,
"deposit_ratio": 1.0,
"expire_max": 0,
"expire_min": 0,
"sync_fee": 1
}
},
"funding_addresses": {
"BTC": "mhzPMMC3hkQUL9HUYY13s2NehEJXCA923Z",
"XCP": "n1f73Cvxi7KFWK5p7W8F6JYbyQxV5djqUo"
},
"liquidity": {
"addresses": {
"XCP": [
{
"address": "mzEPqJet1LvZK5wjeDqmYx4udC3zx9oFwm",
"balances": {
"BTC": 333600,
"XCP": 399876544
}
}
]
},
"total": {
"BTC": 807814,
"XCP": 599845207
}
}
}
balances
Get balances for address or current wallet.
Arguments
asset (str, default=None): Optionally filter for given asset.
address (str, default=None): Optionally provide address to check, uses wallet by default
Returns
Dict mapping asset to available quantity in satoshis,
Unconfirmed assets are ignored.
{
"BTC": 926109330,
"XCP": 140982404156
}
blocksend
Send funds using via blockchain transaction.
Arguments
asset (str): Asset to send.
destination (address): Address to receive the funds.
quantity (int): Quantity of the given asset to transfer.
extra_btc (int, default=0): Optional bitcoin to also be sent.
Returns
txid of published transaction.
connect
Create micropayment connection with hub.
Arguments
asset (str): Asset to exchange in connection.
quantity (str): Quantity to be bound in the deposit, this determins the maximum amount that can bet transferred.
expire_time (int, default=1024): Time in blocks after which the deposit expires and can be recovered.
delay_time (int, default=2): Blocks hub must wait before payout, protects against publish revoked commits.
Returns
{
"send_deposit_txid": "published bitcoin transaction id",
"handle": "handle for created connection"
}
queuepayment
Queue micropayment channel send (sent on sync).
Arguments
source (str): Handle of connection to send funds from.
destination (str): Handle of connection to receive funds.
quantity (int): Quantity of channel asset to transfer.
token (str, default=None): Optional token payee will receive with the payment.
Returns
Provided token or generated token if None given.
status
Get status of connections and wallet.
Arguments
handle (str, default=None): Optionally limit to given handle.
verbose (bool, default=False): Optionally show additional information.
Returns
{
"connections": {
"a0b206d1f68edb1aa24084752b5693a9022349dc547fb9952aa510003e93": {
"asset": "XCP",
"balance": 31337,
"status": "open",
"ttl": 404
}
},
"wallet": {
"address": "n2WQGAvnDS1vf7uXToLou6kLxJXRGFHo2b",
"balances": {
"BTC": 926109330,
"XCP": 140982404156
}
}
}
sync
Sync open and recover funds from closed connections.
This WILL cost a fee per channnel synced as defined in the hub terms.
Synchronize open connections to send/receive payments.
Recover funds of closed connections.
Arguments
handle (str, default=None): Optionally limit to given handle.
Returns
{
"connection handle": {
"txids": ["of transactions publish while recovering funds"],
"received_payments": [
{
"payer_handle": "sender handle",
"amount": 1337,
"token": "provided by sender"
}
]
}
}
close
Close open connection and settle to blockchain.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for picopayments_cli-0.0.19-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5296d7a5a4ec9203fda3398902aaa565ecc4d4bbf2c14d394de3baa77a7906e1 |
|
MD5 | 4eb30e9b9fc76667535228954677d4aa |
|
BLAKE2b-256 | 18f9a5b8ce8e3e2b8fe8ee4f94e9796554cb5e44a0a56253bb189c9eca41ba0d |