Omni Core is a fork of Bitcoin Core, with Omni Protocol feature support added as a new layer of functionality on top. As such interacting with the API is done in the same manner (JSON-RPC) as Bitcoin Core, simply with additional RPCs available for utilizing Omni Protocol features.
As all existing Bitcoin Core functionality is inherent to Omni Core, the RPC port by default remains as 8332
as per Bitcoin Core. If you wish to run Omni Core in tandem with Bitcoin Core (eg. via a separate datadir) you may utilize the -rpcport<port>
option to nominate an alternative port number.
All available commands can be listed with "help"
, and information about a specific command can be retrieved with "help <command>"
.
Please note: this document may not always be up-to-date. There may be errors, omissions or inaccuracies present.
The RPCs for transaction creation can be used to create and broadcast Omni Protocol transactions.
A hash of the broadcasted transaction is returned as result.
Create and broadcast a simple send transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
toaddress | string | required | the address of the receiver |
propertyid | number | required | the identifier of the tokens to send |
amount | string | required | the amount to send |
redeemaddress | string | optional | an address that can spend the transaction dust (sender by default) |
referenceamount | string | optional | a bitcoin amount that is sent to the receiver (minimal by default) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_send" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "100.0"
Place, update or cancel a sell offer on the traditional distributed OMNI/BTC exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
propertyidforsale | number | required | the identifier of the tokens to list for sale (must be 1 for OMNI or 2 for TOMNI ) |
amountforsale | string | required | the amount of tokens to list for sale |
amountdesired | string | required | the amount of bitcoins desired |
paymentwindow | number | required | a time limit in blocks a buyer has to pay following a successful accepting order |
minacceptfee | string | required | a minimum mining fee a buyer has to pay to accept the offer |
action | number | required | the action to take (1 for new offers, 2 to update, 3 to cancel) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddexsell" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "1.5" "0.75" 25 "0.0005" 1
Create and broadcast an accept offer for the specified token and amount.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
toaddress | string | required | the address of the seller |
propertyid | number | required | the identifier of the token to purchase |
amount | string | required | the amount to accept |
override | boolean | required | override minimum accept fee and payment window checks (use with caution!) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddexaccept" "35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "15.0"
Create new tokens as crowdsale.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (0 for new crowdsales) |
category | string | required | a category for the new tokens (can be "" ) |
subcategory | string | required | a subcategory for the new tokens (can be "" ) |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "" ) |
data | string | required | a description for the new tokens (can be "" ) |
propertyiddesired | number | required | the identifier of a token eligible to participate in the crowdsale |
tokensperunit | string | required | the amount of tokens granted per unit invested in the crowdsale |
deadline | number | required | the deadline of the crowdsale as Unix timestamp |
earlybonus | number | required | an early bird bonus for participants in percent per week |
issuerpercentage | number | required | a percentage of tokens that will be granted to the issuer |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancecrowdsale" "3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" 2 "100" 1483228800 30 2
Create new tokens with fixed supply.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (0 for new tokens) |
category | string | required | a category for the new tokens (can be "" ) |
subcategory | string | required | a subcategory for the new tokens (can be "" ) |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "" ) |
data | string | required | a description for the new tokens (can be "" ) |
amount | string | required | the number of tokens to create |
tokensperunit | string | required | the amount of tokens granted per unit invested in the crowdsale |
deadline | number | required | the deadline of the crowdsale as Unix timestamp |
earlybonus | number | required | an early bird bonus for participants in percent per week |
issuerpercentage | number | required | a percentage of tokens that will be granted to the issuer |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancefixed" "3Ck2kEGLJtZw9ENj2tameMCtS3HB7uRar3" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" "1000000"
Create new tokens with manageable supply.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (0 for new tokens) |
category | string | required | a category for the new tokens (can be "" ) |
subcategory | string | required | a subcategory for the new tokens (can be "" ) |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "" ) |
data | string | required | a description for the new tokens (can be "" ) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancemanaged" "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" ""
Create and broadcast a send-to-owners transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
propertyid | number | required | the identifier of the tokens to distribute |
amount | string | required | the amount to distribute |
redeemaddress | string | optional | an address that can spend the transaction dust (sender by default) |
distributionproperty | number | optional | the identifier of the property holders to distribute to |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendsto" "32Z3tJccZuqQZ4PhJR2hxHC3tjgjA8cbqz" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 3 "5000"
Issue or grant new units of managed tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
toaddress | string | required | the receiver of the tokens (sender by default, can be "" ) |
propertyid | number | required | the identifier of the tokens to grant |
amount | string | required | the amount of tokens to create |
memo | string | optional | a text note attached to this transaction (none by default) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendgrant" "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "7000"
Revoke units of managed tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
propertyid | number | required | the identifier of the tokens to revoke |
amount | string | required | the amount of tokens to revoke |
memo | string | optional | a text note attached to this transaction (none by default) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendrevoke" "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "100"
Manually close a crowdsale.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address associated with the crowdsale to close |
propertyid | number | required | the identifier of the crowdsale to close |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendclosecrowdsale" "3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 70
Place a trade offer on the distributed token exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to trade with |
propertyidforsale | number | required | the identifier of the tokens to list for sale |
amountforsale | string | required | the amount of tokens to list for sale |
propertiddesired | number | required | the identifier of the tokens desired in exchange |
amountdesired | string | required | the amount of tokens desired in exchange |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendtrade" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "250.0" 1 "10.0"
Cancel offers on the distributed token exchange with the specified price.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to trade with |
propertyidforsale | number | required | the identifier of the tokens listed for sale |
amountforsale | string | required | the amount of tokens to listed for sale |
propertiddesired | number | required | the identifier of the tokens desired in exchange |
amountdesired | string | required | the amount of tokens desired in exchange |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcanceltradesbyprice" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "100.0" 1 "5.0"
Cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to trade with |
propertyidforsale | number | required | the identifier of the tokens listed for sale |
propertiddesired | number | required | the identifier of the tokens desired in exchange |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcanceltradesbypair" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1 31
Cancel all offers on the distributed token exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to trade with |
ecosystem | number | required | the ecosystem of the offers to cancel (1 for main ecosystem, 2 for test ecosystem) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcancelalltrades" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1
Change the issuer on record of the given tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address associated with the tokens |
toaddress | string | required | the address to transfer administrative control to |
propertyid | number | required | the identifier of the tokens |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendchangeissuer" "1ARjWDkZ7kT9fwjPrjcQyvbXDkEySzKHwu" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 3
Transfers all available tokens in the given ecosystem to the recipient.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
toaddress | string | required | the address of the receiver |
ecosystem | number | required | the ecosystem of the tokens to send (1 for main ecosystem, 2 for test ecosystem) |
redeemaddress | string | optional | an address that can spend the transaction dust (sender by default) |
referenceamount | string | optional | a bitcoin amount that is sent to the receiver (minimal by default) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendall" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 2
Enables address freezing for a centrally managed property.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from (must be issuer of a managed property) |
propertyid | number | required | the identifier of the tokens |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendenablefreezing" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" 2
Disables address freezing for a centrally managed property.
IMPORTANT NOTE: Disabling freezing for a property will UNFREEZE all frozen addresses for that property!
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from (must be issuer of a managed property) |
propertyid | number | required | the identifier of the tokens |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddisablefreezing" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" 2
Freeze an address for a centrally managed token.
Note: Only the issuer may freeze tokens, and only if the token is of the managed type with the freezing option enabled.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from (must be issuer of a managed property with freezing enabled |
toaddress | string | required | the address to freeze |
propertyid | number | required | the identifier of the tokens to freeze |
amount | string | required | the amount to freeze (note: currently unused, frozen addresses cannot transact the property) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendfreeze" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 2 1000
Unfreeze an address for a centrally managed token.
Note: Only the issuer may unfreeze tokens
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from (must be issuer of a managed property with freezing enabled |
toaddress | string | required | the address to unfreeze |
propertyid | number | required | the identifier of the tokens to unfreeze |
amount | string | required | the amount to unfreeze (note: currently unused |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendunfreeze" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 2 1000
Broadcasts a raw Omni Layer transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
fromaddress | string | required | the address to send from |
rawtransaction | string | required | the hex-encoded raw transaction |
referenceaddress | string | optional | a reference address (none by default) |
redeemaddress | string | optional | an address that can spend the transaction dust (sender by default) |
referenceamount | string | optional | a bitcoin amount that is sent to the receiver (minimal by default) |
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendrawtx" "1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8" "000000000000000100000000017d7840" "1EqTta1Rt8ixAA32DuC29oukbsSWU62qAV"
The RPCs for data retrieval can be used to get information about the state of the Omni ecosystem.
Returns various state information of the client and protocol.
Arguments:
None
Result:
Result:{ "omnicoreversion_int" : xxxxxxx, // (number) client version as integer "omnicoreversion" : "x.x.x.x-xxx", // (string) client version "mastercoreversion" : "x.x.x.x-xxx", // (string) client version (DEPRECIATED) "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 "alerts" : [ // (array of JSON objects) active protocol alert (if any) { "alerttype" : n // (number) alert type as integer "alerttype" : "xxx" // (string) alert type (can be "alertexpiringbyblock", "alertexpiringbyblocktime", "alertexpiringbyclientversion" or "error") "alertexpiry" : "nnnnnnnnnn" // (string) expiration criteria (can refer to block height, timestamp or client verion) "alertmessage" : "xxx" // (string) information about the alert }, ... ]}
Example:
$ omnicore-cli "omni_getinfo"
Returns the token balance for a given address and property.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
address | string | required | the address |
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 "frozen" : "n.nnnnnnnn" // (string) the amount frozen by the issuer (applies to managed properties only)}
Example:
$ omnicore-cli "omni_getbalance", "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P" 1
Returns a list of token balances for a given currency or property identifier.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 }, ...]
Example:
$ omnicore-cli "omni_getallbalancesforid" 1
Returns a list of all token balances for a given address.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 }, ...]
Example:
$ omnicore-cli "omni_getallbalancesforaddress" "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P"
Get detailed information about an Omni transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 "positioninblock" : n, // (number) the position (index) of the transaction within the block "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}
Example:
$ omnicore-cli "omni_gettransaction" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
List wallet transactions, optionally filtered by an address and block boundaries.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
txid | string | optional | address filter (default: "*" ) |
count | number | optional | show at most n transactions (default: 10 ) |
skip | number | optional | skip the first n transactions (default: 0 ) |
startblock | number | optional | first block to begin the search (default: 0 ) |
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 involves 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 "positioninblock" : n, // (number) the position (index) of the transaction within the block "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 }, ...]
Example:
$ omnicore-cli "omni_listtransactions"
Lists all Omni transactions in a block.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
index | number | required | the block height or block index |
Result:
[ // (array of string) "hash", // (string) the hash of the transaction ...]
Example:
$ omnicore-cli "omni_listblocktransactions" 279007
Returns a list of unconfirmed Omni transactions, pending in the memory pool.
Note: the validity of pending transactions is uncertain, and the state of the memory pool may change at any moment. It is recommended to check transactions after confirmation, and pending transactions should be considered as invalid.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
address | string | optional | filter results by address (default: "" for no filter) |
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 "fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins "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 }, ...]
Example:
$ omnicore-cli "omni_listpendingtransactions"
Returns currently active offers on the distributed exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 "blocksleft" : nn, // (number) the number of blocks left to pay "amount" : "n.nnnnnnnn" // (string) the amount of tokens accepted and reserved "amounttopay" : "n.nnnnnnnn" // (string) the amount in bitcoins needed finalize the trade }, ... ] }, ...]
Example:
$ omnicore-cli "omni_getactivedexsells"
Lists all tokens or smart properties.
Arguments:
None
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 }, ...]
Example:
$ omnicore-cli "omni_listproperties"
Returns details for about the tokens or smart property to lookup.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 "managedissuance" : true|false, // (boolean) whether the token supply is managed by the issuer "freezingenabled" : true|false, // (boolean) whether freezing is enabled for the property (managed properties only) "totaltokens" : "n.nnnnnnnn" // (string) the total number of tokens in existence}
Example:
$ omnicore-cli "omni_getproperty" 3
Lists currently active crowdsales.
Arguments:
None
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 }, ...]
Example:
$ omnicore-cli "omni_getactivecrowdsales"
Returns information about a crowdsale.
Arguments:,
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the crowdsale |
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 }, ... ]}
Example:
$ omnicore-cli "omni_getcrowdsale" 3 true
Returns information about granted and revoked units of managed tokens.
Arguments:
None
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 }, ... ]}
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the managed tokens to lookup |
Example:
$ omnicore-cli "omni_getgrants" 31
Get information and recipients of a send-to-owners transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
txid | string | required | the hash of the transaction to lookup |
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 "positioninblock" : n, // (number) the position (index) of the transaction within the block "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 OMNI or TOMNI "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 }, ... ]}
Example:
$ omnicore-cli "omni_getsto" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" "*"
Get detailed information and trade matches for orders on the distributed token exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
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 "positioninblock" : n, // (number) the position (index) of the transaction within the block "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 (shown in the property desired) "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 }, ... ]}
Example:
$ omnicore-cli "omni_gettrade" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
List active offers on the distributed token exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | filter orders by propertyid for sale |
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 (if "cancel-ecosystem") "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 }, ...]
Example:
$ omnicore-cli "omni_getorderbook" 2
Retrieves the history of trades on the distributed token exchange for the specified market.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the first side of the traded pair |
propertyid | number | required | the second side of the traded pair |
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 }, ...]
Example:
$ omnicore-cli "omni_gettradehistoryforpair" 1 12 500
Retrieves the history of orders on the distributed exchange for the supplied address.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
address | string | required | address to retrieve history for |
count | number | optional | number of orders to retrieve (default: 10 ) |
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 "positioninblock" : n, // (number) the position (index) of the transaction within the block "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 (shown in the property desired) "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 }, ... ] }, ...]
Example:
$ omnicore-cli "omni_gettradehistoryforaddress" "1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8"
Returns pending and completed feature activations.
Result:
{ "pendingactivations": [ // (array of JSON objects) a list of pending feature activations { "featureid" : n, // (number) the id of the feature "featurename" : "xxxxxxxx", // (string) the name of the feature "activationblock" : n, // (number) the block the feature will be activated "minimumversion" : n // (number) the minimum client version needed to support this feature }, ... ] "completedactivations": [ // (array of JSON objects) a list of completed feature activations { "featureid" : n, // (number) the id of the feature "featurename" : "xxxxxxxx", // (string) the name of the feature "activationblock" : n, // (number) the block the feature will be activated "minimumversion" : n // (number) the minimum client version needed to support this feature }, ... ]}
Example:
$ omnicore-cli "omni_getactivations"
Get the payload for an Omni transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
txid | string | required | the hash of the transaction to retrieve payload |
Result:
{ "payload" : "payloadmessage", // (string) the decoded Omni payload message "payloadsize" : n // (number) the size of the payload}
Example:
$ omnicore-cli "omni_getactivations" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
Returns a list of blocks containing Omni transactions for use in seed block filtering.
WARNING: The Exodus crowdsale is not stored in LevelDB, thus this is currently only safe to use to generate seed blocks after block 255365.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
startblock | number | required | the first block to look for Omni transactions (inclusive) |
endblock | number | required | the last block to look for Omni transactions (inclusive) |
Result:
[ // (array of numbers) a list of seed blocks nnnnnnn, // the block height of the seed block ...]
Example:
$ omnicore-cli "omni_getseedblocks" 290000 300000
Returns the consensus hash covering the state of the current block.
Arguments:
None
Result:
{ "block" : nnnnnn, // (number) the index of the block this consensus hash applies to "blockhash" : "hash", // (string) the hash of the corresponding block "consensushash" : "hash" // (string) the consensus hash for the block}
Example:
$ omnicore-cli "omni_getcurrentconsensushash"
The RPCs for raw transactions/payloads can be used to decode or create raw Omni transactions.
Decodes an Omni transaction.
If the inputs of the transaction are not in the chain, then they must be provided, because the transaction inputs are used to identify the sender of a transaction.
A block height can be provided, which is used to determine the parsing rules.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to decode |
prevtxs | string | optional | a JSON array of transaction inputs (default: none) |
height | number | optional | the parsing block height (default: 0 for chain height) |
The format of prevtxs
is as following:
[ { "txid" : "hash", // (string, required) the transaction hash "vout" : n, // (number, required) the output number "scriptPubKey" : "hex", // (string, required) the output script "value" : n.nnnnnnnn // (number, required) the output value } ,...]
Result:
{ "txid" : "hash", // (string) the hex-encoded hash of the transaction "fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins "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 "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}
Example:
$ omnicore-cli "omni_decodetransaction" "010000000163af14ce6d477e1c793507e32a5b7696288fa89705c0d02a3f66beb3c \ 5b8afee0100000000ffffffff02ac020000000000004751210261ea979f6a06f9dafe00fb1263ea0aca959875a7073556a088cdf \ adcd494b3752102a3fd0a8a067e06941e066f78d930bfc47746f097fcd3f7ab27db8ddf37168b6b52ae22020000000000001976a \ 914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000" "[{\"txid\":\"eeafb8c5b3be663f2ad0c00597a88f2896765b2ae30735791c7e476dce14af63\",\"vout\":1, \ \"scriptPubKey\":\"76a9149084c0bd89289bc025d0264f7f23148fb683d56c88ac\",\"value\":0.0001123}]"
Adds a payload with class C (op-return) encoding to the transaction.
If no raw transaction is provided, a new transaction is created.
If the data encoding fails, then the transaction is not modified.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to extend (can be null ) |
payload | string | required | the hex-encoded payload to add |
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_opreturn" "01000000000000000000" "00000000000000020000000006dac2c0"
Adds a payload with class B (bare-multisig) encoding to the transaction.
If no raw transaction is provided, a new transaction is created.
If the data encoding fails, then the transaction is not modified.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to extend (can be null ) |
payload | string | required | the hex-encoded payload to add |
seed | string | required | the seed for obfuscation |
payload | string | required | a public key or address for dust redemption |
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_multisig" "0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff01aa0a00000 \ 00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac00000000" "00000000000000020000000000989680" "1LifmeXYHeUe2qdKWBGVwfbUCMMrwYtoMm" "0252ce4bdd3ce38b4ebbc5a6e1343608230da508ff12d23d85b58c964204c4cef3"
Adds a transaction input to the transaction.
If no raw transaction is provided, a new transaction is created.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to extend (can be null ) |
txid | string | required | the hash of the input transaction |
n | number | required | the index of the transaction output used as input |
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_input" "01000000000000000000" "b006729017df05eda586df9ad3f8ccfee5be340aadf88155b784d1fc0e8342ee" 0
Adds a reference output to the transaction.
If no raw transaction is provided, a new transaction is created.
The output value is set to at least the dust threshold.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to extend (can be null ) |
destination | string | required | the reference address or destination |
amount | number | optional | the optional reference amount (minimal by default) |
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_reference" "0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff03aa0a00000 00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac5c0d0000000000004751210252ce4bdd3ce38b4ebbc5a 6e1343608230da508ff12d23d85b58c964204c4cef3210294cc195fc096f87d0f813a337ae7e5f961b1c8a18f1f8604a909b3a51 21f065b52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000" "1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 0.005
Adds a change output to the transaction.
The provided inputs are not added to the transaction, but only used to determine the change. It is assumed that the inputs were previously added, for example via "createrawtransaction"
.
Optionally a position can be provided, where the change output should be inserted, starting with 0
. If the number of outputs is smaller than the position, then the change output is added to the end. Change outputs should be inserted before reference outputs, and as per default, the change output is added to the`first position.
If the change amount would be considered as dust, then no change output is added.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
rawtx | string | required | the raw transaction to extend |
prevtxs | string | required | a JSON array of transaction inputs |
destination | string | required | the destination for the change |
fee | number | required | the desired transaction fees |
position | number | optional | the position of the change output (default: first position) |
The format of prevtxs
is as following:
[ { "txid" : "hash", // (string, required) the transaction hash "vout" : n, // (number, required) the output number "scriptPubKey" : "hex", // (string, required) the output script "value" : n.nnnnnnnn // (number, required) the output value } ,...]
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_change" "0100000001b15ee60431ef57ec682790dec5a3c0d83a0c360633ea8308fbf6d5fc10a779670400000000ffffffff025c0d00000 \ 000000047512102f3e471222bb57a7d416c82bf81c627bfcd2bdc47f36e763ae69935bba4601ece21021580b888ff56feb27f17f \ 08802ebed26258c23697d6a462d43fc13b565fda2dd52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2 \ 339d24288ac00000000" "[{\"txid\":\"6779a710fcd5f6fb0883ea3306360c3ad8c0a3c5de902768ec57ef3104e65eb1\",\"vout\":4, \ \"scriptPubKey\":\"76a9147b25205fd98d462880a3e5b0541235831ae959e588ac\",\"value\":0.00068257}]" "1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 0.000035 1
Create the payload for a simple send transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the tokens to send |
amount | string | required | the amount to send |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_simplesend" 1 "100.0"
Create the payload for a send all transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
ecosystem | number | required | the ecosystem of the tokens to send (1 for main ecosystem, 2 for test ecosystem) |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_sendall" 2
Create a payload to place, update or cancel a sell offer on the traditional distributed OMNI/BTC exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyidforsale | number | required | the identifier of the tokens to list for sale (must be 1 for OMNI or 2 for TOMNI) |
amountforsale | string | required | the amount of tokens to list for sale |
amountdesired | string | required | the amount of bitcoins desired |
paymentwindow | number | required | a time limit in blocks a buyer has to pay following a successful accepting order |
minacceptfee | string | required | a minimum mining fee a buyer has to pay to accept the offer |
action | number | required | the action to take (1 for new offers, 2 to update", 3 to cancel) |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_dexsell" 1 "1.5" "0.75" 25 "0.0005" 1
Create the payload for an accept offer for the specified token and amount.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the token to purchase |
amount | string | required | the amount to accept |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_dexaccept" 1 "15.0"
Creates the payload for a send-to-owners transaction.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the token to distribute |
amount | string | required | the amount to distribute |
distributionproperty | number | optional | the identifier of the property holders to distribute to |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_sto" 3 "5000"
Creates the payload for a new tokens issuance with fixed supply.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (use 0 for new tokens) |
category | string | required | a category for the new tokens (can be "") |
subcategory | string | required | a subcategory for the new tokens (can be "") |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "") |
data | string | required | a description for the new tokens (can be "") |
amount | string | required | the number of tokens to create |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancefixed" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" "1000000"
Creates the payload for a new tokens issuance with crowdsale.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (use 0 for new tokens) |
category | string | required | a category for the new tokens (can be "") |
subcategory | string | required | a subcategory for the new tokens (can be "") |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "") |
data | string | required | a description for the new tokens (can be "") |
propertyiddesired | number | required | the identifier of a token eligible to participate in the crowdsale |
tokensperunit | string | required | the amount of tokens granted per unit invested in the crowdsale |
deadline | number | required | the deadline of the crowdsale as Unix timestamp |
earlybonus | number | required | an early bird bonus for participants in percent per week |
issuerpercentage | number | required | a percentage of tokens that will be granted to the issuer |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancecrowdsale" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" 2 "100" 1483228800 30 2
Creates the payload for a new tokens issuance with manageable supply.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
ecosystem | number | required | the ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem) |
type | number | required | the type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens) |
previousid | number | required | an identifier of a predecessor token (use 0 for new tokens) |
category | string | required | a category for the new tokens (can be "") |
subcategory | string | required | a subcategory for the new tokens (can be "") |
name | string | required | the name of the new tokens to create |
url | string | required | an URL for further information about the new tokens (can be "") |
data | string | required | a description for the new tokens (can be "") |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancemanaged" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" ""
Creates the payload to manually close a crowdsale.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the crowdsale to close |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_closecrowdsale" 70
Creates the payload to issue or grant new units of managed tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the tokens to grant |
amount | string | required | the amount of tokens to create |
memo | string | optional | a text note attached to this transaction (none by default) |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_grant" 51 "7000"
Creates the payload to revoke units of managed tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the tokens to revoke |
amount | string | required | the amount of tokens to revoke |
memo | string | optional | a text note attached to this transaction (none by default) |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_revoke" 51 "100"
Creates the payload to change the issuer on record of the given tokens.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the tokens |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_changeissuer" 3
Creates the payload to place a trade offer on the distributed token exchange.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyidforsale | number | required | the identifier of the tokens to list for sale |
amountforsale | string | required | the amount of tokens to list for sale |
propertyiddesired | number | required | the identifier of the tokens desired in exchange |
amountdesired | string | required | the amount of tokens desired in exchange |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_trade" 31 "250.0" 1 "10.0"
Creates the payload to cancel offers on the distributed token exchange with the specified price.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyidforsale | number | required | the identifier of the tokens to list for sale |
amountforsale | string | required | the amount of tokens to list for sale |
propertyiddesired | number | required | the identifier of the tokens desired in exchange |
amountdesired | string | required | the amount of tokens desired in exchange |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_canceltradesbyprice" 31 "100.0" 1 "5.0"
Creates the payload to cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyidforsale | number | required | the identifier of the tokens to list for sale |
propertyiddesired | number | required | the identifier of the tokens desired in exchange |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_canceltradesbypair" 1 31
Creates the payload to cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
ecosystem | number | required | the ecosystem of the offers to cancel (1 for main ecosystem, 2 for test ecosystem) |
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_cancelalltrades" 1
The RPCs for the fee system can be used to obtain data about the fee system and fee distributions.
Obtains the current amount of fees cached (pending distribution).
If a property ID is supplied the results will be filtered to show this property ID only. If no property ID is supplied the results will contain all properties that currently have fees cached pending distribution.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | optional | the identifier of the property to filter results on |
Result:
[ // (array of JSON objects) { "propertyid" : nnnnnnn, // (number) the property id "cachedfees" : "n.nnnnnnnn", // (string) the amount of fees cached for this property },...]
Example:
$ omnicore-cli "omni_getfeecache" 31
Obtains the amount at which cached fees will be distributed.
If a property ID is supplied the results will be filtered to show this property ID only. If no property ID is supplied the results will contain all properties.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | optional | the identifier of the property to filter results on |
Result:
[ // (array of JSON objects) { "propertyid" : nnnnnnn, // (number) the property id "feetrigger" : "n.nnnnnnnn", // (string) the amount of fees required to trigger distribution },...]
Example:
$ omnicore-cli "omni_getfeetrigger" 31
Obtains the current percentage share of fees addresses would receive if a distribution were to occur.
If an address is supplied the results will be filtered to show this address only. If no address is supplied the results will be filtered to show wallet addresses only. If a wildcard is provided ("*"
) the results will contain all addresses that would receive a share.
If an ecosystem is supplied the results will reflect the fee share for that ecosystem (main or test). If no ecosystem is supplied the results will reflect the main ecosystem.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
address | string | optional | the address to filter results on |
ecosystem | number | optional | the ecosystem to obtain the current percentage fee share (1 = main, 2 = test) |
Result:
[ // (array of JSON objects) { "address" : "address" // (string) the adress that would receive a share of fees "feeshare" : "n.nnnn%", // (string) the percentage of fees this address will receive based on the current state },...]
Example:
$ omnicore-cli "omni_getfeeshare" "1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 1
Obtains data for a past distribution of fees.
A distribution ID must be supplied to identify the distribution to obtain data for.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
distributionid | number | required | the identifier of the distribution to obtain data for |
Result:
{ "distributionid" : n, // (number) the distribution id "propertyid" : n, // (number) the property id of the distributed tokens "block" : n, // (number) the block the distribution occurred "amount" : "n.nnnnnnnn", // (string) the amount that was distributed "recipients": [ // (array of JSON objects) a list of recipients { "address" : "address", // (string) the address of the recipient "amount" : "n.nnnnnnnn" // (string) the amount of fees received by the recipient }, ... ]}
Example:
$ omnicore-cli "omni_getfeedistribution" 1
Obtains data for past distributions of fees for a property.
A property ID must be supplied to retrieve past distributions for.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
propertyid | number | required | the identifier of the property to retrieve past distributions for |
Result:
[ // (array of JSON objects) { "distributionid" : n, // (number) the distribution id "propertyid" : n, // (number) the property id of the distributed tokens "block" : n, // (number) the block the distribution occurred "amount" : "n.nnnnnnnn", // (string) the amount that was distributed "recipients": [ // (array of JSON objects) a list of recipients { "address" : "address", // (string) the address of the recipient "amount" : "n.nnnnnnnn" // (string) the amount of fees received by the recipient }, ... ] }, ...]
Example:
$ omnicore-cli "omni_getfeedistributions" 31
The RPCs for the configuration can be used to alter Omni Core settings.
Sets the global flag that determines whether transactions are automatically committed and broadcasted.
Arguments:
Name | Type | Presence | Description |
---|---|---|---|
flag | boolean | required | the flag |
Result:
true|false // (boolean) the updated flag status
Example:
$ omnicore-cli "omni_setautocommit" false
To ensure backwards compatibility, depreciated RPCs are kept for at least one major version.
The following calls are replaced in Omni Core 0.0.10, and queries with the old command are forwarded.
send_MP
by omni_send
sendtoowners_MP
by omni_sendsto
sendrawtx_MP
by omni_sendrawtx
getinfo_MP
by omni_getinfo
getbalance_MP
by omni_getbalance
getallbalancesforid_MP
by omni_getallbalancesforid
getallbalancesforaddress_MP
by omni_getallbalancesforaddress
gettransaction_MP
by omni_gettransaction
listtransactions_MP
by omni_listtransactions
listblocktransactions_MP
by omni_listblocktransactions
getactivedexsells_MP
by omni_getactivedexsells
listproperties_MP
by omni_listproperties
getproperty_MP
by omni_getproperty
getactivecrowdsales_MP
by omni_getactivecrowdsales
getcrowdsale_MP
by omni_getcrowdsale
getgrants_MP
by omni_getgrants
getsto_MP
by omni_getsto
or omni_gettransaction
联系客服