本文轉自:https://www.codetd.com/article/1692438
JSON-RPC API
Omni Core是Bitcoin Core的一個分支,其Omni協議功能支持作為頂層的新功能層添加。因此,與API的交互以與Bitcoin Core相同的方式(JSON-RPC)完成,只需使用額外的RPC即可使用Omni協議功能。
由於所有現有的比特幣核心功能都是Omni Core固有的,因此默認情況下RPC端口保持8332
與每個比特幣核心一樣。如果您希望與比特幣核心一起運行Omni Core(例如,通過單獨的數據中心),則可以使用該-rpcport<port>
選項提名替代端口號。
可以列出所有可用的命令"help"
,並且可以通過檢索關於特定命令的信息"help <command>"
。
請注意:本文件可能並不總是最新的。可能存在錯誤,遺漏或不准確之處。
交易創建
用於事務創建的RPC可用於創建和廣播Omni協議事務。
作為結果返回廣播事務的散列。
omni_send
創建並廣播一個簡單的發送事務。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
toaddress |
串 | 需要 | 接收者的地址 |
propertyid |
數 | 需要 | 要發送的令牌的標識符 |
amount |
串 | 需要 | 要發送的金額 |
redeemaddress |
串 | 可選的 | 一個可以花費交易粉塵的地址(默認發件人) |
referenceamount |
串 | 可選的 | 發送給接收方的比特幣金額(默認情況下最小) |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_send ” “ 3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY ” “ 37FaKponF7zqoMLUjEiko25pDiuVH5YLEa ” 1 “ 100.0 ”
omni_senddexsell
在傳統的分布式OMNI / BTC交易平台上放置,更新或取消賣出報價。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
propertyidforsale |
數 | 需要 | 要列出待售的代幣的標識符(必須1 為OMNI 或2 為TOMNI ) |
amountforsale |
串 | 需要 | 要出售的代幣數量 |
amountdesired |
串 | 需要 | 比特幣的數量 |
paymentwindow |
數 | 需要 | 買方在成功接受訂單后必須支付的時間限制 |
minacceptfee |
串 | 需要 | 買方必須支付接受報價的最低采礦費 |
action |
數 | 需要 | 采取的行動(1 對於新的優惠,2 更新,3 取消) |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_senddexsell ” “ 37FaKponF7zqoMLUjEiko25pDiuVH5YLEa ” 1 “ 1.5 ” “ 0.75 ” 25 “ 0.0005 ” 1
omni_senddexaccept
創建並廣播指定代幣和金額的接受優惠。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
toaddress |
串 | 需要 | 賣方的地址 |
propertyid |
數 | 需要 | 要購買的令牌的標識符 |
amount |
串 | 需要 | 接受的金額 |
override |
布爾 | 需要 | 重寫最低接受費用和支付窗口支票(謹慎使用!) |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_senddexaccept ” \ “ 35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8 ” “ 37FaKponF7zqoMLUjEiko25pDiuVH5YLEa ” 1 “ 15.0 ”
omni_sendissuancecrowdsale
創建新的令牌作為crowdsale。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
ecosystem |
數 | 需要 | (1 主要生態系統,2 測試生態系統)中創建令牌的生態系統 |
type |
數 | 需要 | 要創建的令牌的類型:( 1 對於不可分的令牌,2 可分割的令牌) |
previousid |
數 | 需要 | 先前標記的標識符(0 用於新的廣告銷售) |
category |
串 | 需要 | 新令牌的類別(可以"" ) |
subcategory |
串 | 需要 | 新令牌的子類別(可以"" ) |
name |
串 | 需要 | 要創建的新令牌的名稱 |
url |
串 | 需要 | 有關新令牌的更多信息(可以"" ) |
data |
串 | 需要 | 新令牌的描述(可以"" ) |
propertyiddesired |
數 | 需要 | 有資格參與眾包的令牌的標識符 |
tokensperunit |
串 | 需要 | 在眾包中投入的單位授予的令牌數量 |
deadline |
數 | 需要 | 作為Unix時間戳的眾包期限 |
earlybonus |
數 | 需要 | 為參與者提供每周百分比的早期獎金 |
issuerpercentage |
數 | 需要 | 將授予發行人的代幣的百分比 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendissuancecrowdsale ” \ “ 3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo ” 2 1 0 “ Companies ” “ Bitcoin Mining ” \ “ Quantum Miner ” “ ” “ ” 2 “ 100 ” 1483228800 30 2
omni_sendissuancefixed
創建固定供應的新令牌。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
ecosystem |
數 | 需要 | (1 主要生態系統,2 測試生態系統)中創建令牌的生態系統 |
type |
數 | 需要 | 要創建的令牌的類型:( 1 對於不可分的令牌,2 可分割的令牌) |
previousid |
數 | 需要 | 先前令牌的標識符(0 用於新令牌) |
category |
串 | 需要 | 新令牌的類別(可以"" ) |
subcategory |
串 | 需要 | 新令牌的子類別(可以"" ) |
name |
串 | 需要 | 要創建的新令牌的名稱 |
url |
串 | 需要 | 有關新令牌的更多信息(可以"" ) |
data |
串 | 需要 | 新令牌的描述(可以"" ) |
amount |
串 | 需要 | 要創建的令牌的數量 |
tokensperunit |
串 | 需要 | 在眾包中投入的單位授予的令牌數量 |
deadline |
數 | 需要 | 作為Unix時間戳的眾包期限 |
earlybonus |
數 | 需要 | 為參與者提供每周百分比的早期獎金 |
issuerpercentage |
數 | 需要 | 將授予發行人的代幣的百分比 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendissuancefixed ” \ “ 3Ck2kEGLJtZw9ENj2tameMCtS3HB7uRar3 ” 2 1 0 “ Companies ” “ Bitcoin Mining ” \ “ Quantum Miner ” “ ” “ ” “ 1000000 ”
omni_sendissuancemanaged
使用可管理的供應創建新的令牌。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
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" "" ""
omni_sendsto
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"
omni_sendgrant
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"
omni_sendrevoke
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 ”
omni_sendclosecrowdsale
手動關閉眾包。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 與眾包關聯的地址關閉 |
propertyid |
數 | 需要 | 要關閉的眾包標識符 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendclosecrowdsale ” “ 3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo ” 70
omni_sendtrade
在分布式令牌交換機上放置交易報價。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 與之交易的地址 |
propertyidforsale |
數 | 需要 | 標記的標識符以列出待售 |
amountforsale |
串 | 需要 | 要出售的代幣數量 |
propertiddesired |
數 | 需要 | 交換所需令牌的標識符 |
amountdesired |
串 | 需要 | 交換所需的令牌數量 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendtrade ” “ 3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR ” 31 “ 250.0 ” 1 “ 10.0 ”
omni_sendcanceltradesbyprice
以指定價格取消分發令牌交易所的優惠。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 與之交易的地址 |
propertyidforsale |
數 | 需要 | 待售的令牌的標識符 |
amountforsale |
串 | 需要 | 要出售的代幣數量 |
propertiddesired |
數 | 需要 | 交換所需令牌的標識符 |
amountdesired |
串 | 需要 | 交換所需的令牌數量 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-CLI “ omni_sendcanceltradesbyprice ” “ 3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR ” 31 “ 100.0 ” 1 “ 5.0 ”
omni_sendcanceltradesbypair
使用給定的貨幣對取消分發令牌交易的所有優惠。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 與之交易的地址 |
propertyidforsale |
數 | 需要 | 待售的令牌的標識符 |
propertiddesired |
數 | 需要 | 交換所需令牌的標識符 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli "omni_sendcanceltradesbypair" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1 31
omni_sendcancelalltrades
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
omni_sendchangeissuer
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
omni_sendall
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
omni_sendenablefreezing
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
omni_senddisablefreezing
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
omni_sendfreeze
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
omni_sendunfreeze
解凍集中管理令牌的地址。
注意:只有發行人可以解凍令牌
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址(必須是已啟用凍結的托管財產的發行人 |
toaddress |
串 | 需要 | 地址解凍 |
propertyid |
數 | 需要 | 要解凍的標記的標識符 |
amount |
串 | 需要 | 解凍量(注意:目前未使用 |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendunfreeze ” “ 3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY ” “ 3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs ” 2 1000
omni_sendrawtx
廣播原始的Omni Layer交易。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
fromaddress |
串 | 需要 | 要發送的地址 |
rawtransaction |
串 | 需要 | 十六進制編碼的原始事務 |
referenceaddress |
串 | 可選的 | 一個參考地址(默認沒有) |
redeemaddress |
串 | 可選的 | 一個可以花費交易粉塵的地址(默認發件人) |
referenceamount |
串 | 可選的 | 發送給接收方的比特幣金額(默認情況下最小) |
結果:
“ hash ” //(字符串)十六進制編碼的事務散列
例:
$ omnicore-cli “ omni_sendrawtx ” \ “ 1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8 ” “ 000000000000000100000000017d7840 ” \ “ 1EqTta1Rt8ixAA32DuC29oukbsSWU62qAV ”
數據檢索
用於數據檢索的RPC可用於獲取有關Omni生態系統狀態的信息。
omni_getinfo
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"
omni_getbalance
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
omni_getallbalancesforid
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
omni_getallbalancesforaddress
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"
omni_gettransaction
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"
omni_listtransactions
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"
omni_listblocktransactions
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
omni_listpendingtransactions
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"
omni_getactivedexsells
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"
omni_listproperties
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"
omni_getproperty
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
omni_getactivecrowdsales
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"
omni_getcrowdsale
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)crowdsale的標識符 “ name ” : “ name ”, //(字符串)通過crowdsale發布的標記的名稱 “ active ” : true | 假, //(布爾值)的crowdsale是否仍然是活動的 “發行者” : “地址”, propertyiddesired “ : n, //(數字)有資格參與眾包的令牌標識符 ” tokensperunit “ : ” n.nnnnnnnn “, //(字符串)每個單位投入到眾包中的授予令牌數量 ” earlybonus “ : n, //(數字)為參與者提供的早期鳥類獎金,以每周百分比為單位 “百分比” : n, //(數字)將授予發行人的代幣的百分比 “開始時間“ : NNNNNNNNNN, //(號碼)的所述crowdsale如Unix時間戳的開始時間 ”期限“ : NNNNNNNNNN, //(數)crowdsale如Unix時間戳的最后期限 ” amountraised “ : ” n.nnnnnnnn “, //(字符串)參與者投入的令牌數量 “ tokensissued ” : “ n.nnnnnnnn ”, //(字符串)通過眾包發布的令牌總數 “addedissuertokens “ : ” n.nnnnnnnn “ //(字符串)令牌授予發行人的獎金數額 ” closedearly “ : 真| 假, //(Boolean)將crowdsale是否提前結束了(如果不活動) ” maxtokens “ : true | false, //(boolean)由於達到最大可發布標記的限制(如果不是活動的), “終止時間” : nnnnnnnnnn, //(數字)當crowdsale結束(如果早關閉)時間 “ closetx ” : “散列”, //(串),該關閉crowdsale交易的十六進制編碼的哈希值(如果手動關閉) “ participanttransactions ”: [ / /(JSON對象數組)眾包參與列表(如果verbose = true) { “ txid ” : “ hash ”, //(字符串)參與交易的十六進制編碼哈希 “ amountsent ” : “ n.nnnnnnnn ”, //(字符串)參與者投入的令牌數量 “ participanttokens ” : “ n .nnnnnnnn “, //(字符串)授予參與者的令牌 ” issuertokens “ : ” n.nnnnnnnn “ // (串)授予發行人的代幣作為獎金 }, ... ] }
例:
$ omnicore-cli “ omni_getcrowdsale ” 3 true
omni_getgrants
返回有關被管理令牌的已授權和已吊銷單位的信息。
參數:
沒有
結果:
{
“ propertyid ” : n, //(數字)托管標記的標識符 “ name ” : “ name ”, //(字符串)標記的名稱 “ issuer ” : “ address ”, //(字符串)發行人的Bitcoin地址記錄為 “ creationtxid ” : “ hash ”, //(字符串)十六進制編碼創建事務散列 “totaltokens “ : “ n.nnnnnnnn ”, //(字符串)存在的令牌總數 “ issuances ”: [ //(JSON對象數組)列出授予和撤銷的令牌 { “ txid ” : “ hash ”, //(字符串)授予標記的事務的散列 “ grant ” : “ n.nnnnnnnn ” //(字符串)此事務授予的標記數 }, { “ txid ” : “ hash ”, //(字符串)撤銷令牌的事務的散列 “ grant ” : “ n.nnnnnnnn ” //(字符串)此事務撤消的令牌數量 }, ... ] }
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
propertyid |
數 | 需要 | 要查找的托管標記的標識符 |
例:
$ omnicore-cli “ omni_getgrants ” 31
omni_getsto
獲取發送至所有者事務的信息和收件人。
參數:
名稱 | 類型 | 存在 | 描述 |
---|---|---|---|
txid |
串 | 需要 | 要查找的交易的散列 |
recipientfilter |
串 | 可選的 | 收件人篩選器(默認"*" 為所有錢包) |
結果:
{
"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 "