Skip to content

Instantly share code, notes, and snippets.

@dexX7

dexX7/rpc_help

Created July 6, 2015 23:22
Show Gist options
  • Save dexX7/d2aa23987aad2d351639 to your computer and use it in GitHub Desktop.
Save dexX7/d2aa23987aad2d351639 to your computer and use it in GitHub Desktop.
Download ZIP
Omni Core 0.0.10 RPC help descriptions preview
Raw
rpc_help
$ ./src/omnicore-cli help getactivecrowdsales_MP
getactivecrowdsales_MP
Lists currently active crowdsales.
Result:
[ (array of JSON objects)
{
"propertyid" : n, (number) the identifier of the crowdsale
"name" : "name", (string) the name of the tokens issued via the crowdsale
"issuer" : "address", (string) the Bitcoin address of the issuer on record
"propertyiddesired" : n, (number) the identifier of the tokens eligible to participate in the crowdsale
"tokensperunit" : "n.nnnnnnnn", (string) the amount of tokens granted per unit invested in the crowdsale
"earlybonus" : n, (number) an early bird bonus for participants in percent per week
"percenttoissuer" : n, (number) a percentage of tokens that will be granted to the issuer
"starttime" : nnnnnnnnnn, (number) the start time of the of the crowdsale as Unix timestamp
"deadline" : nnnnnnnnnn (number) the deadline of the crowdsale as Unix timestamp
},
...
]
Examples:
> omnicore-cli getactivecrowdsales_MP
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getactivecrowdsales_MP", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getactivedexsells_MP
getactivedexsells_MP ( address )
Returns currently active offers on the distributed exchange.
Arguments:
1. address (string, optional) address filter (default: include any)
Result:
[ (array of JSON objects)
{
"txid" : "hash", (string) the hash of the transaction of this offer
"propertyid" : n, (number) the identifier of the tokens for sale
"seller" : "address", (string) the Bitcoin address of the seller
"amountavailable" : "n.nnnnnnnn", (string) the number of tokens still listed for sale and currently available
"bitcoindesired" : "n.nnnnnnnn", (string) the number of bitcoins desired in exchange
"unitprice" : "n.nnnnnnnn" , (string) the unit price (BTC/token)
"timelimit" : nn, (number) the time limit in blocks a buyer has to pay following a successful accept
"minimumfee" : "n.nnnnnnnn", (string) the minimum mining fee a buyer has to pay to accept this offer
"amountaccepted" : "n.nnnnnnnn", (string) the number of tokens currently reserved for pending "accept" orders
"accepts": [ (array of JSON objects) a list of pending "accept" orders
{
"buyer" : "address", (string) the Bitcoin address of the buyer
"block" : nnnnnn, (number) the index of the block that contains the "accept" order
"amount" : "n.nnnnnnnn" (string) the number of tokens accepted
},
...
]
},
...
]
Examples:
> omnicore-cli getactivedexsells_MP
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getactivedexsells_MP", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getallbalancesforaddress_MP
getallbalancesforaddress_MP "address"
Returns a list of all token balances for a given address.
Arguments:
1. address (string, required) the address
Result:
[ (array of JSON objects)
{
"propertyid" : n, (number) the property identifier
"balance" : "n.nnnnnnnn", (string) the available balance of the address
"reserved" : "n.nnnnnnnn" (string) the amount reserved by sell offers and accepts
},
...
]
Examples:
> omnicore-cli getallbalancesforaddress_MP 1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getallbalancesforaddress_MP", "params": [1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getallbalancesforid_MP
getallbalancesforid_MP propertyid
Returns a list of token balances for a given currency or property identifier.
Arguments:
1. propertyid (number, required) the property identifier
Result:
[ (array of JSON objects)
{
"address" : "address", (string) the address
"balance" : "n.nnnnnnnn", (string) the available balance of the address
"reserved" : "n.nnnnnnnn" (string) the amount reserved by sell offers and accepts
},
...
]
Examples:
> omnicore-cli getallbalancesforid_MP 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getallbalancesforid_MP", "params": [1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getbalance_MP
getbalance_MP "address" propertyid
Returns the token balance for a given address and property.
Arguments:
1. address (string, required) the address
2. propertyid (number, required) the property identifier
Result:
{
"balance" : "n.nnnnnnnn", (string) the available balance of the address
"reserved" : "n.nnnnnnnn" (string) the amount reserved by sell offers and accepts
}
Examples:
> omnicore-cli getbalance_MP "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P" 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance_MP", "params": ["1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getcrowdsale_MP
getcrowdsale_MP propertyid ( verbose )
Returns information about a crowdsale.
Arguments:
1. propertyid (number, required) the identifier of the crowdsale
2. verbose (boolean, optional) list crowdsale participants (default: false)
Result:
{
"propertyid" : n, (number) the identifier of the crowdsale
"name" : "name", (string) the name of the tokens issued via the crowdsale
"active" : true|false, (boolean) whether the crowdsale is still active
"issuer" : "address", (string) the Bitcoin address of the issuer on record
"propertyiddesired" : n, (number) the identifier of the tokens eligible to participate in the crowdsale
"tokensperunit" : "n.nnnnnnnn", (string) the amount of tokens granted per unit invested in the crowdsale
"earlybonus" : n, (number) an early bird bonus for participants in percent per week
"percenttoissuer" : n, (number) a percentage of tokens that will be granted to the issuer
"starttime" : nnnnnnnnnn, (number) the start time of the of the crowdsale as Unix timestamp
"deadline" : nnnnnnnnnn, (number) the deadline of the crowdsale as Unix timestamp
"amountraised" : "n.nnnnnnnn", (string) the amount of tokens invested by participants
"tokensissued" : "n.nnnnnnnn", (string) the total number of tokens issued via the crowdsale
"addedissuertokens" : "n.nnnnnnnn", (string) the amount of tokens granted to the issuer as bonus
"closedearly" : true|false, (boolean) whether the crowdsale ended early (if not active)
"maxtokens" : true|false, (boolean) whether the crowdsale ended early due to reaching the limit of max. issuable tokens (if not active)
"endedtime" : nnnnnnnnnn, (number) the time when the crowdsale ended (if closed early)
"closetx" : "hash", (string) the hex-encoded hash of the transaction that closed the crowdsale (if closed manually)
"participanttransactions": [ (array of JSON objects) a list of crowdsale participations (if verbose=true)
{
"txid" : "hash", (string) the hex-encoded hash of participation transaction
"amountsent" : "n.nnnnnnnn", (string) the amount of tokens invested by the participant
"participanttokens" : "n.nnnnnnnn", (string) the tokens granted to the participant
"issuertokens" : "n.nnnnnnnn" (string) the tokens granted to the issuer as bonus
},
...
]
}
Examples:
> omnicore-cli getcrowdsale_MP 3 true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getcrowdsale_MP", "params": [3, true] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getgrants_MP
getgrants_MP propertyid
Retusn information about granted and revoked units of managed tokens.
Arguments:
1. propertyid (number, required) the identifier of the managed tokens to lookup
Result:
{
"propertyid" : n, (number) the identifier of the managed tokens
"name" : "name", (string) the name of the tokens
"issuer" : "address", (string) the Bitcoin address of the issuer on record
"creationtxid" : "hash", (string) the hex-encoded creation transaction hash
"totaltokens" : "n.nnnnnnnn", (string) the total number of tokens in existence
"issuances": [ (array of JSON objects) a list of the granted and revoked tokens
{
"txid" : "hash", (string) the hash of the transaction that granted tokens
"grant" : "n.nnnnnnnn" (string) the number of tokens granted by this transaction
},
{
"txid" : "hash", (string) the hash of the transaction that revoked tokens
"grant" : "n.nnnnnnnn" (string) the number of tokens revoked by this transaction
},
...
]
}
Examples:
> omnicore-cli getgrants_MP 31
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getgrants_MP", "params": [31] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getinfo_MP
getinfo_MP
Returns various state information of the client and protocol.
Result:
{
"mastercoreversion" : "x.x.x.x-xxx", (string) client version
"bitcoincoreversion" : "x.x.x", (string) Bitcoin Core version
"commitinfo" : "xxxxxxx", (string) build commit identifier
"block" : nnnnnn, (number) index of the last processed block
"blocktime" : nnnnnnnnnn, (number) timestamp of the last processed block
"blocktransactions" : nnnn, (number) Omni transactions found in the last processed block
"totaltransactions" : nnnnnnnn, (number) Omni transactions processed in total
"alert" : { (object) active protocol alert (if any)
"alerttype" : "xxx" (string) alert type
"expiryvalue" : "x" (string) block when the alert expires
"alertmessage" : "xxx" (string) information about the alert
}
}
Examples:
> omnicore-cli getinfo_MP
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getinfo_MP", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getorderbook_MP
getorderbook_MP propertyid ( propertyid )
List active offers on the distributed token exchange.
Arguments:
1. propertyid (number, required) filter orders by propertyid for sale
2. propertyid (number, optional) filter orders by propertyid desired
Result:
[ (array of JSON objects)
{
"address" : "address", (string) the Bitcoin address of the trader
"txid" : "hash", (string) the hex-encoded hash of the transaction of the order
"ecosystem" : "main"|"test", (string) the ecosytem in which the order was made
"propertyidforsale" : n, (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", (string) the amount of tokens initially offered
"amountremaining" : "n.nnnnnnnn", (string) the amount of tokens still up for sale
"propertyiddesired" : n, (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", (string) the amount of tokens initially desired
"amounttofill" : "n.nnnnnnnn", (string) the amount of tokens still needed to fill the offer completely
"action" : n, (number) the action of the transaction: (1) trade, (2) cancel-price, (3) cancel-pair, (4) cancel-ecosystem
"block" : nnnnnn, (number) the index of the block that contains the transaction
"blocktime" : nnnnnnnnnn (number) the timestamp of the block that contains the transaction
},
...
]
Examples:
> omnicore-cli getorderbook_MP 2
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getorderbook_MP", "params": [2] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getproperty_MP
getproperty_MP propertyid
Returns details for about the tokens or smart property to lookup.
Arguments:
1. propertyid (number, required) the identifier of the tokens or property
Result:
{
"propertyid" : n, (number) the identifier
"name" : "name", (string) the name of the tokens
"category" : "category", (string) the category used for the tokens
"subcategory" : "subcategory", (string) the subcategory used for the tokens
"data" : "information", (string) additional information or a description
"url" : "uri", (string) an URI, for example pointing to a website
"divisible" : true|false, (boolean) whether the tokens are divisible
"issuer" : "address", (string) the Bitcoin address of the issuer on record
"creationtxid" : "hash", (string) the hex-encoded creation transaction hash
"fixedissuance" : true|false, (boolean) whether the token supply is fixed
"totaltokens" : "n.nnnnnnnn" (string) the total number of tokens in existence
}
Examples:
> omnicore-cli getproperty_MP 3
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getproperty_MP", "params": [3] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help getsto_MP
getsto_MP "txid" "recipientfilter"
Get information and recipients of a send-to-owners transaction.
Arguments:
1. txid (string, required) the hash of the transaction to lookup
2. recipientfilter (string, optional) a filter for recipients (wallet by default, "*" for all)
Result:
{
"txid" : "hash", (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", (string) the Bitcoin address of the sender
"ismine" : true|false, (boolean) whether the transaction involes an address in the wallet
"confirmations" : nnnnnnnnnn, (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, (number) the timestamp of the block that contains the transaction
"valid" : true|false, (boolean) whether the transaction is valid
"version" : n, (number) the transaction version
"type_int" : n, (number) the transaction type as number
"type" : "type", (string) the transaction type as string
"propertyid" : n, (number) the identifier of sent tokens
"divisible" : true|false, (boolean) whether the sent tokens are divisible
"amount" : "n.nnnnnnnn", (string) the number of tokens sent to owners
"totalstofee" : "n.nnnnnnnn", (string) the fee paid by the sender, nominated in MSC or TMSC
"recipients": [ (array of JSON objects) a list of recipients
{
"address" : "address", (string) the Bitcoin address of the recipient
"amount" : "n.nnnnnnnn" (string) the number of tokens sent to this recipient
},
...
]
}
Examples:
> omnicore-cli getsto_MP "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getsto_MP", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help gettrade_MP
gettrade_MP "txid"
Get detailed information and trade matches for orders on the distributed token exchange.
Arguments:
1. txid (string, required) the hash of the order to lookup
Result:
{
"txid" : "hash", (string) the hex-encoded hash of the transaction of the order
"sendingaddress" : "address", (string) the Bitcoin address of the trader
"ismine" : true|false, (boolean) whether the order involes an address in the wallet
"confirmations" : nnnnnnnnnn, (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, (number) the timestamp of the block that contains the transaction
"valid" : true|false, (boolean) whether the transaction is valid
"version" : n, (number) the transaction version
"type_int" : n, (number) the transaction type as number
"type" : "type", (string) the transaction type as string
"propertyidforsale" : n, (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", (string) the amount of tokens initially offered
"propertyiddesired" : n, (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", (string) the amount of tokens initially desired
"unitprice" : "n.nnnnnnnnnnn..." (string) the unit price nominated in MSC or TMSC
"status" : "status" (string) the status of the order ("open", "cancelled", "filled", ...)
"canceltxid" : "hash", (string) the hash of the transaction that cancelled the order (if cancelled)
"matches": [ (array of JSON objects) a list of matched orders and executed trades
{
"txid" : "hash", (string) the hash of the transaction that was matched against
"block" : nnnnnn, (number) the index of the block that contains this transaction
"address" : "address", (string) the Bitcoin address of the other trader
"amountsold" : "n.nnnnnnnn", (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn" (string) the number of tokens traded in exchange
},
...
]
}
Note:
The documentation only covers the output for a trade, but there are also cancel transactions with different properties.
Examples:
> omnicore-cli gettrade_MP "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettrade_MP", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help gettradehistoryforaddress_OMNI
gettradehistoryforaddress_OMNI "address" ( count propertyid )
Retrieves the history of orders on the distributed exchange for the supplied address.
Arguments:
1. address (string, required) address to retrieve history for
2. count (number, optional) number of orders to retrieve (default: 10)
3. propertyid (number, optional) filter by propertyid transacted (default: no filter)
Result:
[ (array of JSON objects)
{
"txid" : "hash", (string) the hex-encoded hash of the transaction of the order
"sendingaddress" : "address", (string) the Bitcoin address of the trader
"ismine" : true|false, (boolean) whether the order involes an address in the wallet
"confirmations" : nnnnnnnnnn, (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, (number) the timestamp of the block that contains the transaction
"valid" : true|false, (boolean) whether the transaction is valid
"version" : n, (number) the transaction version
"type_int" : n, (number) the transaction type as number
"type" : "type", (string) the transaction type as string
"propertyidforsale" : n, (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", (string) the amount of tokens initially offered
"propertyiddesired" : n, (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", (string) the amount of tokens initially desired
"unitprice" : "n.nnnnnnnnnnn..." (string) the unit price nominated in MSC or TMSC
"status" : "status" (string) the status of the order ("open", "cancelled", "filled", ...)
"canceltxid" : "hash", (string) the hash of the transaction that cancelled the order (if cancelled)
"matches": [ (array of JSON objects) a list of matched orders and executed trades
{
"txid" : "hash", (string) the hash of the transaction that was matched against
"block" : nnnnnn, (number) the index of the block that contains this transaction
"address" : "address", (string) the Bitcoin address of the other trader
"amountsold" : "n.nnnnnnnn", (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn" (string) the number of tokens traded in exchange
},
...
]
},
...
]
Note:
The documentation only covers the output for a trade, but there are also cancel transactions with different properties.
Examples:
> omnicore-cli gettradehistoryforaddress_OMNI "1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettradehistoryforaddress_OMNI", "params": ["1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help gettradehistoryforpair_OMNI
gettradehistoryforpair_OMNI propertyid propertyid ( count )
Retrieves the history of trades on the distributed token exchange for the specified market.
Arguments:
1. propertyid (number, required) the first side of the traded pair
2. propertyid (number, required) the second side of the traded pair
3. count (number, optional) number of trades to retrieve (default: 10)
Result:
[ (array of JSON objects)
{
"block" : nnnnnn, (number) the index of the block that contains the trade match
"unitprice" : "n.nnnnnnnnnnn..." , (string) the unit price used to execute this trade (received/sold)
"inverseprice" : "n.nnnnnnnnnnn...", (string) the inverse unit price (sold/received)
"sellertxid" : "hash", (string) the hash of the transaction of the seller
"address" : "address", (string) the Bitcoin address of the seller
"amountsold" : "n.nnnnnnnn", (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn", (string) the number of tokens traded in exchange
"matchingtxid" : "hash", (string) the hash of the transaction that was matched against
"matchingaddress" : "address" (string) the Bitcoin address of the other party of this trade
},
...
]
Examples:
> omnicore-cli gettradehistoryforpair_OMNI 1 12 500
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettradehistoryforpair_OMNI", "params": [1, 12, 500] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help gettransaction_MP
gettransaction_MP "txid"
Get detailed information about an Omni transaction.
Arguments:
1. txid (string, required) the hash of the transaction to lookup
Result:
{
"txid" : "hash", (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", (string) the Bitcoin address of the sender
"referenceaddress" : "address", (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, (boolean) whether the transaction involes an address in the wallet
"confirmations" : nnnnnnnnnn, (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, (number) the timestamp of the block that contains the transaction
"valid" : true|false, (boolean) whether the transaction is valid
"version" : n, (number) the transaction version
"type_int" : n, (number) the transaction type as number
"type" : "type", (string) the transaction type as string
[...] (mixed) other transaction type specific properties
}
Examples:
> omnicore-cli gettransaction_MP "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction_MP", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help listblocktransactions_MP
listblocktransactions_MP index
Lists all Omni transactions in a block.
Arguments:
1. index (number, required) the block height or block index
Result:
[ (array of string)
"hash", (string) the hash of the transaction
...
]
Examples:
> omnicore-cli listblocktransactions_MP 279007
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listblocktransactions_MP", "params": [279007] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help listproperties_MP
listproperties_MP
Lists all tokens or smart properties.
Result:
[ (array of JSON objects)
{
"propertyid" : n, (number) the identifier of the tokens
"name" : "name", (string) the name of the tokens
"category" : "category", (string) the category used for the tokens
"subcategory" : "subcategory", (string) the subcategory used for the tokens
"data" : "information", (string) additional information or a description
"url" : "uri", (string) an URI, for example pointing to a website
"divisible" : true|false (boolean) whether the tokens are divisible
},
...
]
Examples:
> omnicore-cli listproperties_MP
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listproperties_MP", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help listtransactions_MP
listtransactions_MP ( "address" count skip startblock endblock )
List wallet transactions, optionally filtered by an address and block boundaries.
Arguments:
1. address (string, optional) address filter (default: "*")
2. count (number, optional) show at most n transactions (default: 10)
3. skip (number, optional) skip the first n transactions (default: 0)
4. startblock (number, optional) first block to begin the search (default: 0)
5. endblock (number, optional) last block to include in the search (default: 999999)
Result:
[ (array of JSON objects)
{
"txid" : "hash", (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", (string) the Bitcoin address of the sender
"referenceaddress" : "address", (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, (boolean) whether the transaction involes an address in the wallet
"confirmations" : nnnnnnnnnn, (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, (number) the timestamp of the block that contains the transaction
"valid" : true|false, (boolean) whether the transaction is valid
"version" : n, (number) the transaction version
"type_int" : n, (number) the transaction type as number
"type" : "type", (string) the transaction type as string
[...] (mixed) other transaction type specific properties
},
...
]
Examples:
> omnicore-cli listtransactions_MP
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listtransactions_MP", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help send_OMNI
send_OMNI "fromaddress" "toaddress" propertyid "amount" ( "redeemaddress" "referenceamount" )
Create and broadcast a simple send transaction.
Arguments:
1. fromaddress (string, required) the address to send from
2. toaddress (string, required) the address of the receiver
3. propertyid (number, required) the identifier of the tokens to send
4. amount (string, required) the amount to send
5. redeemaddress (string, optional) an address that can spent the transaction dust (sender by default)
6. referenceamount (string, optional) a bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli send_OMNI "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "100.0"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "send_OMNI", "params": ["3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY", "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa", 1, "100.0"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendcancelalltrades_OMNI
sendcancelalltrades_OMNI "fromaddress" ecosystem
Cancel all offers on the distributed token exchange.
Arguments:
1. fromaddress (string, required) the address to trade with
2. ecosystem (number, required) the ecosystem of the offers to cancel: (0) both, (1) main, (2) test
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendcancelalltrades_OMNI "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendcancelalltrades_OMNI", "params": ["3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendcanceltradesbypair_OMNI
sendcanceltradesbypair_OMNI "fromaddress" propertyidforsale propertiddesired
Cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
1. fromaddress (string, required) the address to trade with
2. propertyidforsale (number, required) the identifier of the tokens listed for sale
3. propertiddesired (number, required) the identifier of the tokens desired in exchange
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendcanceltradesbypair_OMNI "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1 31
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendcanceltradesbypair_OMNI", "params": ["3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR", 1, 31] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendcanceltradesbyprice_OMNI
sendcanceltradesbyprice_OMNI "fromaddress" propertyidforsale "amountforsale" propertiddesired "amountdesired"
Cancel offers on the distributed token exchange with the specified price.
Arguments:
1. fromaddress (string, required) the address to trade with
2. propertyidforsale (number, required) the identifier of the tokens listed for sale
3. amountforsale (string, required) the amount of tokens to listed for sale
4. propertiddesired (number, required) the identifier of the tokens desired in exchange
5. amountdesired (string, required) the amount of tokens desired in exchange
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendcanceltradesbyprice_OMNI "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "100.0" 1 "5.0"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendcanceltradesbyprice_OMNI", "params": ["3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR", 31, "100.0", 1, "5.0"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendchangeissuer_OMNI
sendchangeissuer_OMNI "fromaddress" "toaddress" propertyid
Change the issuer on record of the given tokens.
Arguments:
1. fromaddress (string, required) the address associated with the tokens
2. toaddress (string, required) the address to transfer administrative control to
3. propertyid (number, required) the identifier of the tokens
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendtrade_OMNI "1ARjWDkZ7kT9fwjPrjcQyvbXDkEySzKHwu" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 3
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtrade_OMNI", "params": ["1ARjWDkZ7kT9fwjPrjcQyvbXDkEySzKHwu", "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs", 3] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendclosecrowdsale_OMNI
sendclosecrowdsale_OMNI "fromaddress" propertyid
Manually close a crowdsale.
Arguments:
1. fromaddress (string, required) the address associated with the crowdsale to close
2. propertyid (number, required) the identifier of the crowdsale to close
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendclosecrowdsale_OMNI "3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 70
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendclosecrowdsale_OMNI", "params": ["3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo", 70] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help senddexaccept_OMNI
senddexaccept_OMNI "fromaddress" "toaddress" propertyid "amount" ( override )
Create and broadcast an accept offer for the specified token and amount.
Arguments:
1. fromaddress (string, required) the address to send from
2. toaddress (string, required) the address of the seller
3. propertyid (number, required) the identifier of the token to purchase
4. amount (string, required) the amount to accept
5. override (boolean, optional) override minimum accept fee and payment window checks (use with caution!)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli senddexaccept_OMNI "35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "15.0"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "senddexaccept_OMNI", "params": ["35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8", "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa", 1, "15.0"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help senddexsell_OMNI
senddexsell_OMNI "fromaddress" propertyidforsale "amountforsale" "amountdesired" paymentwindow minacceptfee action
Place, update or cancel a sell offer on the traditional distributed MSC/BTC exchange.
Arguments:
1. fromaddress (string, required) the address to send from
2. propertyidforsale (number, required) the identifier of the tokens to list for sale (must be MSC or TMSC)
3. amountforsale (string, required) the amount of tokens to list for sale
4. amountdesired (string, required) the amount of bitcoins desired
5. paymentwindow (number, required) a time limit in blocks a buyer has to pay following a successful accept
6. minacceptfee (string, required) a minimum mining fee a buyer has to pay to accept the offer
7. action (number, required) the action to take: (1) new, (2) update, (3) cancel
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli senddexsell_OMNI "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "1.5" "0.75" 25 "0.0005" 1
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "senddexsell_OMNI", "params": ["37FaKponF7zqoMLUjEiko25pDiuVH5YLEa", 1, "1.5", "0.75", 25, "0.0005", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendgrant_OMNI
sendgrant_OMNI "fromaddress" "toaddress" propertyid "amount" ( "memo" )
Issue or grant new units of managed tokens.
Arguments:
1. fromaddress (string, required) the address to send from
2. toaddress (string, optional) the receiver of the tokens (sender by default)
3. propertyid (number, required) the identifier of the tokens to grant
4. amount (string, required) the amount of tokens to create
5. memo (string, optional) a text note attached to this transaction (none by default)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendgrant_OMNI "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "7000"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendgrant_OMNI", "params": ["3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH", "", 51, "7000"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendissuancecrowdsale_OMNI
sendissuancecrowdsale_OMNI "fromaddress" ecosystem type previousid "category" "subcategory" "name" "url" "data" propertyiddesired tokensperunit deadline ( earlybonus issuerpercentage )
Create new tokens as crowdsale.
Arguments:
1. fromaddress (string, required) the address to send from
2. ecosystem (string, required) the ecosystem to create the tokens in: (1) main, (2) test
3. type (number, required) the type of the tokens to create: (1) indivisible, (2) divisible
4. previousid (number, optional) an identifier of a predecessor token (0 for new crowdsales)
5. category (string, optional) a category for the new tokens (can be "")
6. subcategory (string, optional) a subcategory for the new tokens (can be "")
7. name (string, required) the name of the new tokens to create
8. url (string, optional) an URL for further information about the new tokens (can be "")
9. data (string, optional) a description for the new tokens (can be "")
10. propertyiddesired (number, required) the identifier of a token eligible to participate in the crowdsale
11. tokensperunit (string, required) the amount of tokens granted per unit invested in the crowdsale
12. deadline (number, required) the deadline of the crowdsale as Unix timestamp
13. earlybonus (number, required) an early bird bonus for participants in percent per week (default: 0)
14. issuerpercentage (number, required) a percentage of tokens that will be granted to the issuer (default: 0)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendissuancecrowdsale_OMNI "3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" 1 "100" 1483228800 30 2
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendissuancecrowdsale_OMNI", "params": ["3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo", 2, 1, 0, "Companies", "Bitcoin Mining", "Quantum Miner", "", "", 1, "100", 1483228800, 30, 2] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendissuancefixed_OMNI
sendissuancefixed_OMNI "fromaddress" ecosystem type previousid "category" "subcategory" "name" "url" "data" "amount"
Create new tokens with fixed supply.
Arguments:
1. fromaddress (string, required) the address to send from
2. ecosystem (string, required) the ecosystem to create the tokens in: (1) main, (2) test
3. type (number, required) the type of the tokens to create: (1) indivisible, (2) divisible
4. previousid (number, optional) an identifier of a predecessor token (0 for new tokens)
5. category (string, optional) a category for the new tokens (can be "")
6. subcategory (string, optional) a subcategory for the new tokens (can be "")
7. name (string, required) the name of the new tokens to create
8. url (string, optional) an URL for further information about the new tokens (can be "")
9. data (string, optional) a description for the new tokens (can be "")
10. amount (string, required) the number of tokens to create
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendissuancefixed_OMNI "3Ck2kEGLJtZw9ENj2tameMCtS3HB7uRar3" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" "1000000"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendissuancefixed_OMNI", "params": ["3Ck2kEGLJtZw9ENj2tameMCtS3HB7uRar3", 2, 1, 0, "Companies", "Bitcoin Mining", "Quantum Miner", "", "", "1000000"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendissuancemanaged_OMNI
sendissuancemanaged_OMNI "fromaddress" ecosystem type previousid "category" "subcategory" "name" "url" "data"
Create new tokens with manageable supply.
Arguments:
1. fromaddress (string, required) the address to send from
2. ecosystem (string, required) the ecosystem to create the tokens in: (1) main, (2) test
3. type (number, required) the type of the tokens to create: (1) indivisible, (2) divisible
4. previousid (number, optional) an identifier of a predecessor token (0 for new tokens)
5. category (string, optional) a category for the new tokens (can be "")
6. subcategory (string, optional) a subcategory for the new tokens (can be "")
7. name (string, required) the name of the new tokens to create
8. url (string, optional) an URL for further information about the new tokens (can be "")
9. data (string, optional) a description for the new tokens (can be "")
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendissuancemanaged_OMNI "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" ""
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendissuancemanaged_OMNI", "params": ["3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH", 2, 1, 0, "Companies", "Bitcoin Mining", "Quantum Miner", "", ""] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendrawtx_MP
sendrawtx_MP "fromaddress" "rawtransaction" ( "referenceaddress" "redeemaddress" "referenceamount" )
Broadcasts a raw Omni transaction.
Arguments:
1. fromaddress (string, required) the address to send from
2. rawtransaction (string, required) the hex-encoded raw transaction
3. referenceaddress (string, optional) a reference address (empty by default)
4. redeemaddress (string, optional) an address that can spent the transaction dust (sender by default)
5. referenceamount (string, optional) a bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendrawtx_MP "1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8" "000000000000000100000000017d7840" "1EqTta1Rt8ixAA32DuC29oukbsSWU62qAV"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendrawtx_MP", "params": ["1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8", "000000000000000100000000017d7840", "1EqTta1Rt8ixAA32DuC29oukbsSWU62qAV"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendrevoke_OMNI
sendrevoke_OMNI "fromaddress" propertyid "amount" ( "memo" )
Revoke units of managed tokens.
Arguments:
1. fromaddress (string, required) the address to revoke the tokens from
2. propertyid (number, required) the identifier of the tokens to revoke
3. amount (string, required) the amount of tokens to revoke
4. memo (string, optional) a text note attached to this transaction (none by default)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendrevoke_OMNI "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "100"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendrevoke_OMNI", "params": ["3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH", "", 51, "100"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendsto_OMNI
sendsto_OMNI "fromaddress" propertyid "amount" ( "redeemaddress" )
Create and broadcast a send-to-owners transaction.
Arguments:
1. fromaddress (string, required) the address to send from
2. propertyid (number, required) the identifier of the tokens to distribute
3. amount (string, required) the amount to distribute
4. redeemaddress (string, optional) an address that can spent the transaction dust (sender by default)
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendsto_OMNI "32Z3tJccZuqQZ4PhJR2hxHC3tjgjA8cbqz" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 3 "5000"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendsto_OMNI", "params": ["32Z3tJccZuqQZ4PhJR2hxHC3tjgjA8cbqz", "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa", 3, "5000"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help sendtrade_OMNI
sendtrade_OMNI "fromaddress" propertyidforsale "amountforsale" propertiddesired "amountdesired"
Place a trade offer on the distributed token exchange.
Arguments:
1. fromaddress (string, required) the address to trade with
2. propertyidforsale (number, required) the identifier of the tokens to list for sale
3. amountforsale (string, required) the amount of tokens to list for sale
4. propertiddesired (number, required) the identifier of the tokens desired in exchange
5. amountdesired (string, required) the amount of tokens desired in exchange
Result:
"hash" (string) the hex-encoded transaction hash
Examples:
> omnicore-cli sendtrade_OMNI "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "250.0" 1 "10.0"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtrade_OMNI", "params": ["3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR", 31, "250.0", 1, "10.0"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
$ ./src/omnicore-cli help setautocommit_OMNI
setautocommit_OMNI flag
Sets the global flag that determines whether transactions are automatically committed and broadcast.
Arguments:
1. flag (boolean, required) the flag
Result:
true|false (boolean) the updated flag status
Examples:
> omnicore-cli setautocommit false
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setautocommit", "params": [false] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment