lthn/blockchain

Fork 1

Table of Contents

Wallet RPC Reference

Table of Contents
Balance and Address

getbalance
getaddress
get_wallet_info
get_bare_outs_stats
store

Transfers

transfer
sign_transfer
submit_transfer
sweep_below
sweep_bare_outs

Payment Tracking

get_payments
get_bulk_payments
make_integrated_address
split_integrated_address

Transaction History

get_recent_txs_and_info3
get_recent_txs_and_info2
get_recent_txs_and_info
search_for_transactions2
search_for_transactions
get_mining_history
force_rescan_tx_pool

Confidential Assets

deploy_asset
emit_asset
burn_asset
update_asset
transfer_asset_ownership
attach_asset_descriptor
send_ext_signed_asset_tx

Asset Whitelist

assets_whitelist_add
assets_whitelist_get
assets_whitelist_remove

Marketplace

marketplace_push_offer
marketplace_push_update_offer
marketplace_cancel_offer
marketplace_get_offers_ex

Ionic Swaps

ionic_swap_generate_proposal
ionic_swap_accept_proposal
ionic_swap_get_proposal_info

Aliases

register_alias
update_alias

Gateway

register_gateway_address

Encryption and Signing

encrypt_data
decrypt_data
sign_message

Wallet Recovery

get_restore_info
get_seed_phrase_info

Multi-Wallet

mw_get_wallets
mw_select_wallet

Cold Signing

clear_utxo_cold_sig_reservation

Proxy

proxy_to_daemon

Wallet RPC Reference

Complete reference for the Lethean wallet (lethean-wallet-cli) RPC API. The wallet listens on port 36944 by default when run in RPC mode.

All amounts are in atomic units (1 LTHN = 10^12 atomic units).

Balance and Address
Transfers
Payment Tracking
Transaction History
Confidential Assets
Asset Whitelist
Marketplace
Ionic Swaps
Aliases
Gateway
Encryption and Signing
Wallet Recovery
Multi-Wallet
Cold Signing
Proxy

Balance and Address

getbalance

Return the balances across all whitelisted assets of the wallet

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "getbalance",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "balance": 10000000000,
    "balances": [{
      "asset_info": {
        "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "current_supply": 500000000000000000,
        "decimal_point": 12,
        "full_name": "Lethean wrapped ABC",
        "hidden_supply": false,
        "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
        "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "owner_eth_pub_key": "",
        "ticker": "ZABC",
        "total_max_supply": 1000000000000000000
      },
      "awaiting_in": 1000000000000,
      "awaiting_out": 2000000000000,
      "outs_amount_max": 2000000000000,
      "outs_amount_min": 2000000000000,
      "outs_count": 7,
      "total": 100000000000000,
      "unlocked": 50000000000000
    }],
    "unlocked_balance": 11000000000
  }
}

Response fields:

balance -- Native coins total amount
balances -- Balances groupped by it's asset_id
asset_info -- Asset info details
asset_id -- Asset ID
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
awaiting_in -- Unconfirmed amount for receive
awaiting_out -- Unconfirmed amount for send
outs_amount_max -- Output's maximum amount
outs_amount_min -- Output's minimum amount
outs_count -- Number of total unspent outputs (including locked)
total -- Total coins available(including locked)
unlocked -- Unlocked coins available(the ones that could be used right now)
unlocked_balance -- Native coins total unlocked amount

getaddress

Obtains wallet's public address

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "getaddress",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "address": "iTHNQGNCbu8BH7FhQuzsv5CVsE3veDX1CFCxk9jsqRfA4tFcUPNwQa4DWLFvyaKvs3HGb8xfGDGQq871c9P4iRpt8SFusoqSzJ"
  }
}

Response fields:

address -- string; standard public address of the wallet.

get_wallet_info

Returns wallet helpful wallet information

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_wallet_info",
  "params": {
    "collect_utxo_data": false
  }
}

Parameters:

collect_utxo_data -- Collect utxo statistics data(might slow down request, don't use it by default)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "address": "iTHNQGNCbu8BH7FhQuzsv5CVsE3veDX1CFCxk9jsqRfA4tFcUPNwQa4DWLFvyaKvs3HGb8xfGDGQq871c9P4iRpt8SFusoqSzJ",
    "current_height": 112132,
    "has_bare_unspent_outputs": false,
    "is_whatch_only": false,
    "path": "\/some\/path\/to\/wallet\/file.zan",
    "transfer_entries_count": 24,
    "transfers_count": 11
  }
}

Response fields:

address -- string; standard public address of the wallet.
current_height -- Current wallet/daemon height
has_bare_unspent_outputs -- Shows if the wallet still has UTXO from pre-zarcanum era
is_whatch_only -- Shows if the wallet is watch-only
path -- Path to wallet file location
transfer_entries_count -- Represent number of internal entries count(each entry represent tx output that have been addressed to this wallet)
transfers_count -- Represent number of transactions that happened to this wallet(basically tx history)

get_bare_outs_stats

Return information about wallet's pre-zarcanum era outputs. Those outputs should be converted to post-zarcanum varian with trnasfering it sooner or later. (Only outputs that have been created in Zarcanum era can participaet in staking)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_bare_outs_stats",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "expected_total_fee": 10000000000,
    "total_amount": 12000000000000,
    "total_bare_outs": 112,
    "txs_count": 2
  }
}

Response fields:

expected_total_fee -- Expected total transaction fee required for processing the transaction.
total_amount -- Total amount of native coins involved in bare outputs.
total_bare_outs -- Total number of inspent bare outputs in the wallet.
txs_count -- Total number of transactions needed to convert all bare outputs .

store

Store wallet's data to file

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "store",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "wallet_file_size": 232243
  }
}

Response fields:

wallet_file_size -- Resulting file size in bytes

Transfers

transfer

Make new payment transaction from the wallet

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "transfer",
  "params": {
    "comment": "Thanks for the coffe",
    "destinations": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "amount": 10000000000000,
      "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "payment_id": 1020394
    }],
    "fee": 10000000000,
    "hide_receiver": true,
    "mixin": 15,
    "payment_id": "",
    "push_payer": false,
    "service_entries": [{
      "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
      "flags": 0,
      "instruction": "K",
      "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
      "service_id": "C"
    }],
    "service_entries_permanent": true
  }
}

Parameters:

comment -- Text comment that is displayed in UI
destinations -- List of destinations
address -- Destination address
amount -- Amount to transfer to destination
asset_id -- Asset id to transfer
payment_id -- [optional] Intrinsic 8-byte payment id for this destination. Incompatible with integrated addresses.
fee -- Fee to be paid on behalf of sender's wallet(paid in native coins)
hide_receiver -- [deprecated] This add to transaction information about remote address(destination), might be needed when the wallet restored from seed phrase and fully resynched, if this option were true, then sender won't be able to see remote address for sent transactions anymore.
mixin -- Specifies number of mixins(decoys) that would be used to create input, actual for pre-zarcanum outputs, for post-zarcanum outputs instead of this option, number that is defined by network hard rules(15+)
payment_id -- [deprecated] Legacy tx-wide hex-encoded payment_id, that normally used for user database by exchanges
push_payer -- [deprecated] Reveal information about sender of this transaction, basically add sender address to transaction in encrypted way, so only receiver can see who sent transaction
service_entries -- Service entries that might be used by different apps that works on top of Lethean network, not part of consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
service_entries_permanent -- Point to wallet that service_entries should be placed to 'extra' section of transaction(which won't be pruned after checkpoints)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93",
    "tx_size": 1234,
    "tx_unsigned_hex": "e383d55ca5887b34f158a7365bbcd01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9301220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9301220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93"
  }
}

Response fields:

tx_hash -- Has of the generated transaction(if succeded)
tx_size -- Transaction size in bytes
tx_unsigned_hex -- Has unsigned tx blob in hex encoding

sign_transfer

Sign transaction with the wallet's keys

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "sign_transfer",
  "params": {
    "tx_unsigned_hex": "8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a736"
  }
}

Parameters:

tx_unsigned_hex -- Unsigned transaction hex-encoded blob.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93",
    "tx_signed_hex": "8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a736"
  }
}

Response fields:

tx_hash -- Signed transaction hash.
tx_signed_hex -- Signed transaction hex-encoded blob.

submit_transfer

Relay signed transaction over the network

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "submit_transfer",
  "params": {
    "tx_signed_hex": "8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a736"
  }
}

Parameters:

tx_signed_hex -- Signed transaction hex-encoded blob.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93"
  }
}

Response fields:

tx_hash -- Signed transaction hash.

sweep_below

Tries to transfer all coins with amount below the given limit to the given address

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "sweep_below",
  "params": {
    "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
    "amount": 1000000000000,
    "fee": 10000000000,
    "mixin": 15,
    "payment_id_hex": "1dfe5a88ff9effb3"
  }
}

Parameters:

address -- Public address for sending or receiving native coins.
amount -- Threshold amount of native coins to sweep.
fee -- Transaction fee required for processing the transaction.
mixin -- Number of outputs from the blockchain to mix with when sending a transaction to improve privacy.
payment_id_hex -- Payment ID associated with the transaction in hexadecimal format.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "amount_swept": 101000000000,
    "amount_total": 100000000000,
    "outs_swept": 112,
    "outs_total": 10,
    "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93",
    "tx_unsigned_hex": "8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a7368304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a9334f158a736"
  }
}

Response fields:

amount_swept -- Amount of native coins swept in the transaction.
amount_total -- Total amount of native coins involved in the transaction.
outs_swept -- Number of outputs swept in the transaction.
outs_total -- Total number of outputs in the transaction.
tx_hash -- Transaction ID (hash) format.
tx_unsigned_hex -- Unsigned transaction data in hexadecimal format.

sweep_bare_outs

Execute transactions needed be convert all bare(pre-zarcanum) outputs to post-zarcanum outputs. (Only outputs that have been created in Zarcanum era can participaet in staking)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "sweep_bare_outs",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "amount_swept": 12000000000000,
    "bare_outs_swept": 112,
    "fee_spent": 10000000000,
    "txs_sent": 2
  }
}

Response fields:

amount_swept -- Amount of native coins swept in the transactions.
bare_outs_swept -- Number of bare outputs swept in the transactions.
fee_spent -- Total fee spent on the transactions.
txs_sent -- Total number of transactions sent.

Payment Tracking

get_payments

Gets list of incoming transfers by a given payment ID

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_payments",
  "params": {
    "allow_locked_transactions": false,
    "payment_id": "1dfe5a88ff9effb3"
  }
}

Parameters:

allow_locked_transactions -- Says to wallet if locked transfers should be included or not (false is strongly recomennded)
payment_id -- Payment id that is used to identify transfers

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "payments": [{
      "amount": 100000000000,
      "block_height": 12321,
      "payment_id": "1dfe5a88ff9effb3",
      "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93",
      "unlock_time": 0
    }]
  }
}

Response fields:

payments -- Array of payments that connected to given payment_id
amount -- Amount of native coins transfered
block_height -- Block height that holds transaction
payment_id -- Payment id that related to this payment
tx_hash -- Transaction ID that is holding this payment
unlock_time -- Timestamp/blocknumber after which this money would become availabe, recommended don't count transfers that has this field not 0

get_bulk_payments

Gets list of incoming transfers by a given multiple payment_ids

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_bulk_payments",
  "params": {
    "allow_locked_transactions": false,
    "min_block_height": 0,
    "payment_ids": ["1dfe5a88ff9effb3","1dfe5a88ff9effb3"]
  }
}

Parameters:

allow_locked_transactions -- Says to wallet if locked transfers should be included or not (false is strongly recomennded)
min_block_height -- Minimal block height to consider
payment_ids -- Payment ids that is used to identify transfers

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "payments": [{
      "amount": 100000000000,
      "block_height": 12321,
      "payment_id": "1dfe5a88ff9effb3",
      "tx_hash": "01220e8304d46b940a86e383d55ca5887b34f158a7365bbcdd17c5a305814a93",
      "unlock_time": 0
    }]
  }
}

Response fields:

payments -- Array of payments that connected to given payment_id
amount -- Amount of native coins transfered
block_height -- Block height that holds transaction
payment_id -- Payment id that related to this payment
tx_hash -- Transaction ID that is holding this payment
unlock_time -- Timestamp/blocknumber after which this money would become availabe, recommended don't count transfers that has this field not 0

make_integrated_address

Generate integrated address

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "make_integrated_address",
  "params": {
    "payment_id": "1dfe5a88ff9effb3"
  }
}

Parameters:

payment_id -- Hex-encoded Payment ID to be associated with the this address. If empty then wallet would generate new payment id using system random library

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "integrated_address": "iZ2EMyPD7g28hgBfboZeCENaYrHBYZ1bLFi5cgWvn4WJLaxfgs4kqG6cJi9ai2zrXWSCpsvRXit14gKjeijx6YPCLJEv6Fx4rVm1hdAGQFis",
    "payment_id": "1dfe5a88ff9effb3"
  }
}

Response fields:

integrated_address -- Integrated address combining a standard address and payment ID, if applicable.
payment_id -- Payment ID associated with the this address.

split_integrated_address

Decode integrated address

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "split_integrated_address",
  "params": {
    "integrated_address": "iZ2EMyPD7g28hgBfboZeCENaYrHBYZ1bLFi5cgWvn4WJLaxfgs4kqG6cJi9ai2zrXWSCpsvRXit14gKjeijx6YPCLJEv6Fx4rVm1hdAGQFis"
  }
}

Parameters:

integrated_address -- Integrated address combining a standard address and payment ID, if applicable.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "payment_id": "1dfe5a88ff9effb3",
    "standard_address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"
  }
}

Response fields:

payment_id -- Hex-encoded payment id
standard_address -- Standart address.

Transaction History

get_recent_txs_and_info3

Returns wallet history of transactions V3 (HF6-ready version with intrinsic payment IDs support)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_recent_txs_and_info3",
  "params": {
    "count": 100,
    "exclude_mining_txs": false,
    "exclude_unconfirmed": false,
    "offset": 0,
    "order": "FROM_END_TO_BEGIN",
    "update_provision_info": true
  }
}

Parameters:

count -- How many items to fetch, if items fetched is less then count, then it enumeration is over
exclude_mining_txs -- Exclude mining/staking transactions from results(last_item_index should be used for subsequential calls)
exclude_unconfirmed -- Do not include uncomfirmed transactions in results (it also not included is offset is non zero)
offset -- Offset from what index to start fetching transfers entries(if filters are used then last_item_index could be used from previous call)
order -- Order: "FROM_BEGIN_TO_END" or "FROM_END_TO_BEGIN"
update_provision_info -- If update pi is required, could be false only if need to optimize performance(appliable for a veru big wallets)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "last_item_index": 1,
    "pi": {
      "balance": 100000000000,
      "curent_height": 121212,
      "transfer_entries_count": 3,
      "transfers_count": 1,
      "unlocked_balance": 90000000000
    },
    "total_transfers": 1,
    "transfers": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }]
  }
}

Response fields:

last_item_index -- Last item index
pi -- Details on wallet balance etc
balance -- Current balance of native coins
curent_height -- Current sync height of the wallet
transfer_entries_count -- Number of UTXO entries in wallet
transfers_count -- Number of transfers in wallet
unlocked_balance -- Unlocked balance oof native coins
total_transfers -- Total transfers
transfers -- Transfers
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)

get_recent_txs_and_info2

(deprecated) Returns wallet history of transactions V2 (post-Zarcanum version)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_recent_txs_and_info2",
  "params": {
    "count": 100,
    "exclude_mining_txs": false,
    "exclude_unconfirmed": false,
    "offset": 0,
    "order": "FROM_END_TO_BEGIN",
    "update_provision_info": true
  }
}

Parameters:

count -- How many items to fetch, if items fetched is less then count, then it enumeration is over
exclude_mining_txs -- Exclude mining/staking transactions from results(last_item_index should be used for subsequential calls)
exclude_unconfirmed -- Do not include uncomfirmed transactions in results (it also not included is offset is non zero)
offset -- Offset from what index to start fetching transfers entries(if filters are used then last_item_index could be used from previous call)
order -- Order: "FROM_BEGIN_TO_END" or "FROM_END_TO_BEGIN"
update_provision_info -- If update pi is required, could be false only if need to optimize performance(appliable for a veru big wallets)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "last_item_index": 1,
    "pi": {
      "balance": 100000000000,
      "curent_height": 121212,
      "transfer_entries_count": 3,
      "transfers_count": 1,
      "unlocked_balance": 90000000000
    },
    "total_transfers": 1,
    "transfers": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "payment_id": "00000000ff00ff00",
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers": [{
        "amount": 1000000000000,
        "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
        "is_income": false
      }],
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }]
  }
}

Response fields:

last_item_index -- Last item index
pi -- Details on wallet balance etc
balance -- Current balance of native coins
curent_height -- Current sync height of the wallet
transfer_entries_count -- Number of UTXO entries in wallet
transfers_count -- Number of transfers in wallet
unlocked_balance -- Unlocked balance oof native coins
total_transfers -- Total transfers
transfers -- Transfers
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
payment_id -- HEX-encoded payment id blob, if it was present
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by asset id
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)

get_recent_txs_and_info

(deprecated) Returns wallet history of transactions

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_recent_txs_and_info",
  "params": {
    "count": 100,
    "exclude_mining_txs": false,
    "exclude_unconfirmed": false,
    "offset": 0,
    "order": "FROM_END_TO_BEGIN",
    "update_provision_info": true
  }
}

Parameters:

count -- How many items to fetch, if items fetched is less then count, then it enumeration is over
exclude_mining_txs -- Exclude mining/staking transactions from results(last_item_index should be used for subsequential calls)
exclude_unconfirmed -- Do not include uncomfirmed transactions in results (it also not included is offset is non zero)
offset -- Offset from what index to start fetching transfers entries(if filters are used then last_item_index could be used from previous call)
order -- Order: "FROM_BEGIN_TO_END" or "FROM_END_TO_BEGIN"
update_provision_info -- If update pi is required, could be false only if need to optimize performance(appliable for a veru big wallets)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "last_item_index": 1,
    "pi": {
      "balance": 100000000000,
      "curent_height": 121212,
      "transfer_entries_count": 3,
      "transfers_count": 1,
      "unlocked_balance": 90000000000
    },
    "total_transfers": 1,
    "transfers": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "amount": 1000000000000,
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_income": false,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "payment_id": "00000000ff00ff00",
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }]
  }
}

Response fields:

last_item_index -- Index of last returned item(might be needed if filters are used)
pi -- Additiona details about balance state
balance -- Current balance of native coins
curent_height -- Current sync height of the wallet
transfer_entries_count -- Number of UTXO entries in wallet
transfers_count -- Number of transfers in wallet
unlocked_balance -- Unlocked balance oof native coins
total_transfers -- Total number of transfers in the tx history
transfers -- Transfers history array
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
amount -- Native coins amount
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_income -- If trnasfer entrie is income (taken from native subtransfer)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
payment_id -- HEX-encoded payment id blob, if it was present
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)

search_for_transactions2

Search for transacrions in the wallet by few parameters

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "search_for_transactions2",
  "params": {
    "filter_by_height": true,
    "in": true,
    "max_height": 20000,
    "min_height": 11000,
    "out": true,
    "pool": false,
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Parameters:

filter_by_height -- Do filter transactions by height or not.
in -- Search over incoming transactions.
max_height -- Maximum height for filtering transactions.
min_height -- Minimum height for filtering transactions.
out -- Search over outgoing transactions.
pool -- Search over pool transactions.
tx_id -- Transaction ID represented as a hexadecimal string.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "in": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }],
    "out": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }],
    "pool": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }]
  }
}

Response fields:

in -- List of incoming transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)
out -- List of outgoing transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)
pool -- List of pool transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)

search_for_transactions

Search for transacrions in the wallet by few parameters(legacy version)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "search_for_transactions",
  "params": {
    "filter_by_height": true,
    "in": true,
    "max_height": 20000,
    "min_height": 11000,
    "out": true,
    "pool": false,
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Parameters:

filter_by_height -- Do filter transactions by height or not.
in -- Search over incoming transactions.
max_height -- Maximum height for filtering transactions.
min_height -- Minimum height for filtering transactions.
out -- Search over outgoing transactions.
pool -- Search over pool transactions.
tx_id -- Transaction ID represented as a hexadecimal string.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "in": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "amount": 1000000000000,
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_income": false,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "payment_id": "00000000ff00ff00",
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }],
    "out": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "amount": 1000000000000,
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_income": false,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "payment_id": "00000000ff00ff00",
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }],
    "pool": [{
      "ado": {
        "operation_type": 1,
        "opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
        "opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
        "version": 2
      },
      "amount": 1000000000000,
      "comment": "Comment here",
      "contract": [{
        "cancel_expiration_time": 0,
        "contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
        "expiration_time": 0,
        "height": 0,
        "is_a": false,
        "payment_id": "",
        "private_detailes": {
          "a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "a_pledge": 0,
          "b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
          "b_pledge": 0,
          "c": "",
          "t": "",
          "to_pay": 0
        },
        "state": 0,
        "timestamp": 0
      }],
      "employed_entries": {
      },
      "fee": 10000000000,
      "height": 0,
      "is_income": false,
      "is_mining": false,
      "is_mixing": false,
      "is_service": false,
      "payment_id": "00000000ff00ff00",
      "remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
      "remote_aliases": ["roger"],
      "service_entries": [{
        "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
        "flags": 0,
        "instruction": "K",
        "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
        "service_id": "C"
      }],
      "show_sender": false,
      "subtransfers_by_pid": [{
        "payment_id": "a1a2a3a4a5a6a7a8",
        "subtransfers": [{
          "amount": 1000000000000,
          "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
          "is_income": false
        }]
      }],
      "timestamp": 1712590951,
      "transfer_internal_index": 12,
      "tx_blob_size": 0,
      "tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
      "tx_type": 0,
      "unlock_time": 0
    }]
  }
}

Response fields:

in -- List of incoming transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
amount -- Native coins amount
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_income -- If trnasfer entrie is income (taken from native subtransfer)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
payment_id -- HEX-encoded payment id blob, if it was present
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)
out -- List of outgoing transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
amount -- Native coins amount
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_income -- If trnasfer entrie is income (taken from native subtransfer)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
payment_id -- HEX-encoded payment id blob, if it was present
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)
pool -- List of pool transactions.
ado -- "Asset Descriptor Operation" if it was present in transaction
operation_type -- Asset operation type identifier
opt_amount_commitment -- (optional) Asset operation amount commitment (register/emit/burn).
opt_asset_id -- (optional) ID of an asset (emit/burn/update).
version -- Asset operation type struct version
amount -- Native coins amount
comment -- Some human-readable comment
contract -- Escrow contract if it's part of transaction
employed_entries -- Mark entries from transaction that was connected to this wallet
fee -- Transaction fee
height -- Height of the block that included transaction(0 i transaction is unconfirmed)
is_income -- If trnasfer entrie is income (taken from native subtransfer)
is_mining -- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)
is_mixing -- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)
is_service -- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)
payment_id -- HEX-encoded payment id blob, if it was present
remote_addresses -- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)
remote_aliases -- Aliases for remot addresses, of discovered
service_entries -- Additional entries that might be stored in transaction but not part of it's consensus
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another
show_sender -- If sender is included in tx
subtransfers_by_pid -- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset ID
payment_id -- HEX-encoded payment id, or empty string if not present
subtransfers -- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset ID
amount -- Amount of asset the had been transfered
asset_id -- Asset id
is_income -- Indicates if transfer was income our outgoing
timestamp -- Timestamp of the block that included transaction in blockchain, 0 for unconfirmed
transfer_internal_index -- Index of this entry in the wallet's array of transaction's history
tx_blob_size -- Size of transaction in bytes
tx_hash -- Transaction ID(hash)
tx_type -- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12
unlock_time -- Unlock time of this transfer (if present)

get_mining_history

Returns wallet statistic on mining. As an argument 'v' it receive timestamp from which history is reviewed

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_mining_history",
  "params": {
    "v": 0
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "mined_entries": [{
      "a": 1000000000000,
      "h": 102000,
      "t": 1712683857
    }]
  }
}

Response fields:

mined_entries -- Mined blocks entries.
a -- Mined amount(block reward)
h -- height
t -- Timestamp

force_rescan_tx_pool

Force wallet to fetch tx pool from daemon and go through it's transactions

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "force_rescan_tx_pool",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK"
  }
}

Response fields:

status -- Operation status

Confidential Assets

deploy_asset

Deploy new asset in the system.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "deploy_asset",
  "params": {
    "asset_descriptor": {
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    },
    "destinations": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "amount": 10000000000000,
      "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "payment_id": 1020394
    }],
    "do_not_split_destinations": false
  }
}

Parameters:

asset_descriptor -- Descriptor that holds all information about asset - ticker, emission, description etc
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
destinations -- Addresses where to receive emitted coins. Asset id in the destinations is irreleant and can be omitted.
address -- Destination address
amount -- Amount to transfer to destination
asset_id -- Asset id to transfer
payment_id -- [optional] Intrinsic 8-byte payment id for this destination. Incompatible with integrated addresses.
do_not_split_destinations -- If true, the provided destinations will be used as-is and won't be splitted (or altered) to avoid common issues. Default is false.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "new_asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

new_asset_id -- Issued asset id
tx_id -- Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed

emit_asset

Emmit new coins of the the asset, that is controlled by this wallet.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "emit_asset",
  "params": {
    "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "destinations": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "amount": 10000000000000,
      "asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "payment_id": 1020394
    }],
    "do_not_split_destinations": false
  }
}

Parameters:

asset_id -- Id of the asset to emit more coins
destinations -- Addresses where to receive emitted coins. Asset id in the destinations is irreleant and can be omitted.
address -- Destination address
amount -- Amount to transfer to destination
asset_id -- Asset id to transfer
payment_id -- [optional] Intrinsic 8-byte payment id for this destination. Incompatible with integrated addresses.
do_not_split_destinations -- If true, the provided destinations will be used as-is and won't be splitted (or altered) to avoid common issues. Default is false.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

tx_id -- Id of transaction that emits the required asset.

burn_asset

Burn some owned amount of the coins for the given asset.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "burn_asset",
  "params": {
    "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "burn_amount": 10000000,
    "native_amount": 0,
    "point_tx_to_address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
    "service_entries": [{
      "body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
      "flags": 0,
      "instruction": "K",
      "security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
      "service_id": "C"
    }]
  }
}

Parameters:

asset_id -- Id of the asset to burn
burn_amount -- Amount to burn
native_amount -- [optional] Used when this transaction needs to be visible to a particular wallet.
point_tx_to_address -- [optional] Used when this transaction needs to be visible to a particular wallet.
service_entries -- [optional] Used when service entries need to be included for a burn transaction.
body -- Hex-encoded body of the attachment
flags -- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )
instruction -- Instruction that make sence for this particular service
security -- Hex-encoded public key of the owner, optional
service_id -- Service ID, identificator that diferent one service from another

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

tx_id -- Id of transaction that carries asset burn operation

update_asset

Update asset descriptor(you can change only owner so far)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "update_asset",
  "params": {
    "asset_descriptor": {
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    },
    "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Parameters:

asset_descriptor -- Descriptor that holds all information about asset that need to be updated (only owner could be updated)
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
asset_id -- Id of the asset to update

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

tx_id -- Id of transaction that carries asset registration command, asset would be registered as soon as transaction got confirmed

transfer_asset_ownership

Transfer asset ownership to a new public key.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "transfer_asset_ownership",
  "params": {
    "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "new_owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
    "new_owner_eth_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a84d"
  }
}

Parameters:

asset_id -- The ID of the asset, owned by the wallet, that is to be transferred to someone else.
new_owner -- Public key of the new owner. Standard Ed25519 public key, 32 bytes.
new_owner_eth_pub_key -- Public key of the new owner. ECDSA public key, 33 bytes. Either new_owner or new_owner_eth_pub_key must be specified.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK",
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

status -- Status of the call
tx_id -- Id of the transaction that carries asset transfer ownership operation

attach_asset_descriptor

Attach asset descripto to this wallet instance, if asset descripto attached then ADO operations to this asset can be performed using API of this wallet.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "attach_asset_descriptor",
  "params": {
    "asset_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "do_attach": true
  }
}

Parameters:

asset_id -- Asset id of the ADO that need to be attached to this wallet
do_attach -- If true - asset descriptor attached to wallet, if false - asset detached

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK"
  }
}

Response fields:

status -- Status of the call

send_ext_signed_asset_tx

Inserts externally made asset ownership signature into the given transaction and broadcasts it.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "send_ext_signed_asset_tx",
  "params": {
    "eth_sig": "674bb56a5b4fa562e679ccacc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6add697463498a66de4f1760b2cd40f11c3a00a7a8",
    "expected_tx_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
    "finalized_tx": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC",
    "regular_sig": "674bb56a5b4fa562e679ccacc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6add697463498a66de4f1760b2cd40f11c3a00a7a8",
    "unlock_transfers_on_fail": false,
    "unsigned_tx": "083737bcfd826a973f74bb56a52b4fa562e6579ccaadd2697463498a66de4f1760b2cd40f11c3a00a7a80000"
  }
}

Parameters:

eth_sig -- HEX-encoded ETH signature (64 bytes), used only if regular_sig is empty
expected_tx_id -- The expected transaction id. Tx won't be sent if the calculated one doesn't match this one. Consider using 'verified_tx_id' returned by 'decrypt_tx_details' call.
finalized_tx -- Base64-encoded finalized_tx data structure, which was received from emit_asset call.
regular_sig -- HEX-encoded regular signature (64 bytes)
unlock_transfers_on_fail -- If true, all locked wallet transfers, corresponding to the transaction, will be unlocked on sending failure. False by default.
unsigned_tx -- Base64-encoded unsigned transaction blob, which was received from emit_asset call.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK",
    "transfers_were_unlocked": false
  }
}

Response fields:

status -- Status of the call
transfers_were_unlocked -- If true, all input transfers that were locked when preparing this transaction, are now unlocked and may be spent. Can be true only upon sending failure and if requested.

Asset Whitelist

assets_whitelist_add

Add given asset id to local whitelist. This whitelist is stored with the wallet file and reset in case of wallet resync or restoring wallet from seed phrase.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "assets_whitelist_add",
  "params": {
    "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Parameters:

asset_id -- Asset id that needed to be added to local whitelist, asset_id must exist in the network

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "asset_descriptor": {
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    },
    "status": "OK"
  }
}

Response fields:

asset_descriptor -- Details of the asset, recieved from node
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
status -- Status of the asset

assets_whitelist_get

Get whitelisted assets for this wallet, assets descriptors present in any of the lists in results would be present in balance() call results(if those assets are part of the wallet transfers). Assets that are not included in those lists won't be included in balance even if the wallet own inputs with such assets.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "assets_whitelist_get",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "global_whitelist": [{
      "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    }],
    "local_whitelist": [{
      "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    }],
    "own_assets": [{
      "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "current_supply": 500000000000000000,
      "decimal_point": 12,
      "full_name": "Lethean wrapped ABC",
      "hidden_supply": false,
      "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
      "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "owner_eth_pub_key": "",
      "ticker": "ZABC",
      "total_max_supply": 1000000000000000000
    }]
  }
}

Response fields:

global_whitelist -- Global whitelist, well-known assets with adoption, mantained by the team and community
asset_id -- Asset ID
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
local_whitelist -- Local whitelist, assets that hase been added to this wallet file manually(!)
asset_id -- Asset ID
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
own_assets -- Own assets, the ones that is under control of this wallet
asset_id -- Asset ID
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.

assets_whitelist_remove

Remove given asset id from local whitelist. This whitelist is stored with the wallet file and reset in case of wallet resync or restoring wallet from seed phrase.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "assets_whitelist_remove",
  "params": {
    "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Parameters:

asset_id -- Asset id to be removed from local whitelist

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK"
  }
}

Response fields:

status -- Command result (OK if success)

Marketplace

marketplace_push_offer

Creates new offer and publish it on the blockchain

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "marketplace_push_offer",
  "params": {
    "od": {
      "ap": "100000",
      "at": "10000000",
      "b": "",
      "cat": "",
      "cnt": "Ranko +38211111111",
      "com": "Dobr dan",
      "do": "full amount, by parts",
      "et": 0,
      "fee": 10000000000,
      "index_in_tx": 0,
      "lci": "Kolasin",
      "lco": "Montenegro",
      "ot": 0,
      "p": "LTHN",
      "pt": "lethean",
      "security": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
      "t": "USDT",
      "timestamp": 1712683857,
      "tx_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "tx_original_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "url": ""
    }
  }
}

Parameters:

ap -- Amount of the currency
at -- Smount of other currency or goods
b -- Bonus associated with the offer
cat -- Category of the offer
cnt -- Contacts related to the offer
com -- Comment associated with the offer
do -- Deal option for the offer
et -- Expiration time of the offer
fee -- Fee associated with the transaction
index_in_tx -- Index of the tx_service_attachment entrie in transaction
lci -- City of the offer location
lco -- Country of the offer location
ot -- Type of the offer: OFFER_TYPE_PRIMARY_TO_TARGET(SELL ORDER) - 0, OFFER_TYPE_TARGET_TO_PRIMARY(BUY ORDER) - 1 etc.
p -- Currency for goods
pt -- Types of payment accepted for the offer
security -- Onwer's public key for access control
t -- Target: currency / goods
timestamp -- Timestamp of the transaction
tx_hash -- Transaction hash represented as a hexadecimal string
tx_original_hash -- Origin transaction hash represented as a hexadecimal string(if offer updated)
url -- URL for previewing the offer

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_blob_size": 1234,
    "tx_hash": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Response fields:

tx_blob_size -- Size of the transaction blob
tx_hash -- Transaction hash

marketplace_push_update_offer

Updates existing offer that this wallet created, and publish updated version on the blockchain

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "marketplace_push_update_offer",
  "params": {
    "no": 0,
    "od": {
      "ap": "100000",
      "at": "10000000",
      "b": "",
      "cat": "",
      "cnt": "Ranko +38211111111",
      "com": "Dobr dan",
      "do": "full amount, by parts",
      "et": 0,
      "fee": 10000000000,
      "index_in_tx": 0,
      "lci": "Kolasin",
      "lco": "Montenegro",
      "ot": 0,
      "p": "LTHN",
      "pt": "lethean",
      "security": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
      "t": "USDT",
      "timestamp": 1712683857,
      "tx_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "tx_original_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "url": ""
    },
    "tx_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Parameters:

no -- Number of offer entrie inside transacton(likely 0)
ap -- Amount of the currency
at -- Smount of other currency or goods
b -- Bonus associated with the offer
cat -- Category of the offer
cnt -- Contacts related to the offer
com -- Comment associated with the offer
do -- Deal option for the offer
et -- Expiration time of the offer
fee -- Fee associated with the transaction
index_in_tx -- Index of the tx_service_attachment entrie in transaction
lci -- City of the offer location
lco -- Country of the offer location
ot -- Type of the offer: OFFER_TYPE_PRIMARY_TO_TARGET(SELL ORDER) - 0, OFFER_TYPE_TARGET_TO_PRIMARY(BUY ORDER) - 1 etc.
p -- Currency for goods
pt -- Types of payment accepted for the offer
security -- Onwer's public key for access control
t -- Target: currency / goods
timestamp -- Timestamp of the transaction
tx_hash -- Transaction hash represented as a hexadecimal string
tx_original_hash -- Origin transaction hash represented as a hexadecimal string(if offer updated)
url -- URL for previewing the offer
tx_id -- Transaction ID represented as a hexadecimal string

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_blob_size": 1232,
    "tx_hash": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Response fields:

tx_blob_size -- Size of the transaction blob
tx_hash -- Transaction hash

marketplace_cancel_offer

Cancel existing offer that this wallet created(it actually create transaction that says that existing order got canceled)

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "marketplace_cancel_offer",
  "params": {
    "fee": 10000000000,
    "no": 0,
    "tx_id": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Parameters:

fee -- Fee for operation
no -- Number of offer entrie inside transacton(likely 0)
tx_id -- Transaction ID represented as a hexadecimal string

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_blob_size": 1232,
    "tx_hash": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d"
  }
}

Response fields:

tx_blob_size -- Size of the transaction blob
tx_hash -- Transaction hash

marketplace_get_offers_ex

Fetch wallet's offers listed in the marketplace with given filters

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "marketplace_get_offers_ex",
  "params": {
    "filter": {
      "amount_low_limit": 0,
      "amount_up_limit": 0,
      "bonus": false,
      "category": "",
      "keyword": "tubes",
      "limit": 100,
      "location_city": "",
      "location_country": "",
      "offer_type_mask": 0,
      "offset": 0,
      "order_by": 0,
      "primary": "",
      "rate_low_limit": "0.1",
      "rate_up_limit": "0.1",
      "reverse": false,
      "target": "",
      "timestamp_start": 0,
      "timestamp_stop": 0
    }
  }
}

Parameters:

filter -- Filter options.
amount_low_limit -- Lower limit for the amount of offers
amount_up_limit -- Upper limit for the amount of offers
bonus -- Bonus associated with the offers
category -- Category of the offers
keyword -- Keyword for searching offers
limit -- Maximum number of results to return
location_city -- City of the location for the offers
location_country -- Country of the location for the offers
offer_type_mask -- Mask representing the types of offers to include in the results, conbination of this: OFFER_TYPE_MASK_PRIMARY_TO_TARGET 0x00000001, OFFER_TYPE_MASK_TARGET_TO_PRIMARY 0x00000002, OFFER_TYPE_MASK_GOODS_TO_PRIMARY 0x00000004, OFFER_TYPE_MASK_PRIMARY_TO_GOODS 0x00000008
offset -- Offset for pagination
order_by -- Field to order the results by one on this: ORDER_BY_TIMESTAMP=0,ORDER_BY_AMOUNT_PRIMARY=1,ORDER_BY_AMOUNT_TARGET=2,ORDER_BY_AMOUNT_RATE=3,ORDER_BY_PAYMENT_TYPES=4,ORDER_BY_CONTACTS=5,ORDER_BY_LOCATION=6,ORDER_BY_NAME=7
primary -- Primary field for the offers
rate_low_limit -- Lower limit for the rate
rate_up_limit -- Upper limit for the rate
reverse -- Flag to indicate whether the results should be sorted in reverse order
target -- Target entity of the offers
timestamp_start -- Start timestamp for filtering results
timestamp_stop -- Stop timestamp for filtering results

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "offers": [{
      "ap": "100000",
      "at": "10000000",
      "b": "",
      "cat": "",
      "cnt": "Ranko +38211111111",
      "com": "Dobr dan",
      "do": "full amount, by parts",
      "et": 0,
      "fee": 10000000000,
      "index_in_tx": 0,
      "lci": "Kolasin",
      "lco": "Montenegro",
      "ot": 0,
      "p": "LTHN",
      "pt": "lethean",
      "security": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
      "t": "USDT",
      "timestamp": 1712683857,
      "tx_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "tx_original_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
      "url": ""
    }],
    "status": "OK",
    "total_offers": 1
  }
}

Response fields:

offers -- List of offers related to the operation.
ap -- Amount of the currency
at -- Smount of other currency or goods
b -- Bonus associated with the offer
cat -- Category of the offer
cnt -- Contacts related to the offer
com -- Comment associated with the offer
do -- Deal option for the offer
et -- Expiration time of the offer
fee -- Fee associated with the transaction
index_in_tx -- Index of the tx_service_attachment entrie in transaction
lci -- City of the offer location
lco -- Country of the offer location
ot -- Type of the offer: OFFER_TYPE_PRIMARY_TO_TARGET(SELL ORDER) - 0, OFFER_TYPE_TARGET_TO_PRIMARY(BUY ORDER) - 1 etc.
p -- Currency for goods
pt -- Types of payment accepted for the offer
security -- Onwer's public key for access control
t -- Target: currency / goods
timestamp -- Timestamp of the transaction
tx_hash -- Transaction hash represented as a hexadecimal string
tx_original_hash -- Origin transaction hash represented as a hexadecimal string(if offer updated)
url -- URL for previewing the offer
status -- Status of the operation.
total_offers -- Total number of offers.

Ionic Swaps

ionic_swap_generate_proposal

Generates ionic swap proposal according to details provided in request, result present as hex-encoded blob, that should be passed to recepient to validate this proposal and executing on it

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "ionic_swap_generate_proposal",
  "params": {
    "destination_address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
    "proposal": {
      "fee_paid_by_a": 10000000000,
      "to_finalizer": [{
        "amount": 1000000000000,
        "asset_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
      }],
      "to_initiator": [{
        "amount": 10000000000,
        "asset_id": "d6329b5b1f7c0805b5c345f4957554002a2f557845f64d7645dae0e051a6498a"
      }]
    }
  }
}

Parameters:

destination_address -- Destination address
proposal -- Proposal details
fee_paid_by_a -- Fee paid by party A(initiator)
to_finalizer -- Assets sent to the finalizer
to_initiator -- Assets sent to the initiator

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "hex_raw_proposal": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response fields:

hex_raw_proposal -- Hex-encoded proposal raw data(encrypted with common shared key). Includes half-created transaction template and some extra information that would be needed counterparty to finialize and sign transaction

ionic_swap_accept_proposal

This essential command actually execute proposal that was sent by counter party, by completing and signing transaction template that was in proposal, and sending it to the network.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "ionic_swap_accept_proposal",
  "params": {
    "hex_raw_proposal": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Parameters:

hex_raw_proposal -- Hex-encoded proposal raw data(encrypted with common shared key). Includes half-created transaction template and some extra information that would be needed counterparty to finialize and sign transaction

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "result_tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response fields:

result_tx_id -- Result transaction id

ionic_swap_get_proposal_info

Reads hex-encoded ionic swap proposal info, generated by other user and addressed to this wallet

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "ionic_swap_get_proposal_info",
  "params": {
    "hex_raw_proposal": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Parameters:

hex_raw_proposal -- Hex-encoded proposal raw data(encrypted with common shared key). Includes half-created transaction template and some extra information that would be needed counterparty to finialize and sign transaction

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "proposal": {
      "fee_paid_by_a": 10000000000,
      "to_finalizer": [{
        "amount": 1000000000000,
        "asset_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
      }],
      "to_initiator": [{
        "amount": 10000000000,
        "asset_id": "d6329b5b1f7c0805b5c345f4957554002a2f557845f64d7645dae0e051a6498a"
      }]
    }
  }
}

Response fields:

proposal -- Proposal details
fee_paid_by_a -- Fee paid by party A(initiator)
to_finalizer -- Assets sent to the finalizer
to_initiator -- Assets sent to the initiator

Aliases

register_alias

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "register_alias",
  "params": {
    "al": {
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    },
    "authority_key": ""
  }
}

Parameters:

al -- Alias details
address -- Address of the alias.
alias -- Alias itself, a brief shortcut for an address.
comment -- Arbitrary comment (optional).
tracking_key -- View secret key of the corresponding address (optional).
authority_key -- Key for registering aliases shorter than 6 letters (team)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response fields:

tx_id -- If success - transactions that performs registration(alias becomes available after few confirmations)

update_alias

Update an alias details/transwer alias ownership

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "update_alias",
  "params": {
    "al": {
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    }
  }
}

Parameters:

al -- Alias details
address -- Address of the alias.
alias -- Alias itself, a brief shortcut for an address.
comment -- Arbitrary comment (optional).
tracking_key -- View secret key of the corresponding address (optional).

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response fields:

tx_id -- If success - transactions that performs registration(alias becomes available after few confirmations)

Gateway

register_gateway_address

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "register_gateway_address",
  "params": {
    "descriptor_info": {
      "meta_info": "Some metadata",
      "opt_owner_custom_schnorr_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
      "opt_owner_ecdsa_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8e2",
      "opt_owner_eddsa_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
    },
    "view_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Parameters:

descriptor_info -- Descriptor information for the gateway
meta_info -- Additional metadata about the gateway
opt_owner_custom_schnorr_pub_key -- owner's custom Schnorr signature public key
opt_owner_ecdsa_pub_key -- owner's Ethereum public key
opt_owner_eddsa_pub_key -- owner's EdDSA public key
view_pub_key -- View address to register

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "address": "",
    "address_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
    "status": "OK",
    "tx_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
  }
}

Response fields:

address -- Addres starting from gwZ or gwiZ
address_id -- Registered gateway address id
status -- Result (OK if success)
tx_id -- Transaction id

Encryption and Signing

encrypt_data

Trivially encrypt base64 encoded data message with chacha using wallet spend key

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "encrypt_data",
  "params": {
    "buff": "ZGNjc2Ztc2xrZm12O2xrZm12OydlbGtmdm0nbGtmbXY="
  }
}

Parameters:

buff -- base64 encoded data message to be encrypted

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "res_buff": "ZGNjc2Ztc2xrZm12O2xrZm12OydlbGtmdm0nbGtmbXY="
  }
}

Response fields:

res_buff -- base64 encoded resulted data message

decrypt_data

Trivially decrypt base64 encoded data message with chacha using wallet spend key

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "decrypt_data",
  "params": {
    "buff": "ZGNjc2Ztc2xrZm12O2xrZm12OydlbGtmdm0nbGtmbXY="
  }
}

Parameters:

buff -- base64 encoded data message to be decrypted

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "res_buff": "ZGNjc2Ztc2xrZm12O2xrZm12OydlbGtmdm0nbGtmbXY="
  }
}

Response fields:

res_buff -- base64 encoded resulted data message

sign_message

Trivially sign base64 encoded data message using wallet spend key

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "sign_message",
  "params": {
    "buff": "ZGNjc2Ztc2xrZm12O2xrZm12OydlbGtmdm0nbGtmbXY="
  }
}

Parameters:

buff -- base64 encoded data message to be signed

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "pkey": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc",
    "sig": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response fields:

pkey -- Wallet's public key represented as a hexadecimal string
sig -- Signature represented as a hexadecimal string

Wallet Recovery

get_restore_info

Return wallet seed, which could be password-protected(seed secured with passphrase) or open(unsecured seed). If no password provided it returns open (unsecured) seed.

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_restore_info",
  "params": {
    "seed_password": "010101012"
  }
}

Parameters:

seed_password -- Password to secure wallet's seed

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "creation_timestamp": 212100,
    "derivation_secret": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
    "is_auditable": false,
    "seed_phrase": "girlfriend unlike offer mutter tightly social silent expect constant bid nowhere reach flower bite salt becomeconversation dog rush quietly become usually lightning midnight each secret class"
  }
}

Response fields:

creation_timestamp -- Prety mych self explanatory
derivation_secret -- Wallet's secret that is used for key derivations, presented in hex, 32 bytes
is_auditable -- Point if the wallet is auditable or regular
seed_phrase -- Wallet's seed(secured with password if it was provided in argument)

get_seed_phrase_info

This call is used to validate seed phrase and to fetch additional information about it

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_seed_phrase_info",
  "params": {
    "seed_password": "0101010103",
    "seed_phrase": "girlfriend unlike mutter tightly social silent expect constant bid nowhere reach flower bite salt lightning conversation dog rush quietly become usually midnight each secret offer class"
  }
}

Parameters:

seed_password -- Password used to encrypt or decrypt the mnemonic seed phrase, if applicable.
seed_phrase -- Mnemonic seed phrase used for wallet recovery or generation.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "address": "iTHNQGNCbu8BH7FhQuzsv5CVsE3veDX1CFCxk9jsqRfA4tFcUPNwQa4DWLFvyaKvs3HGb8xfGDGQq871c9P4iRpt8SFusoqSzJ",
    "hash_sum_matched": true,
    "require_password": true,
    "syntax_correct": true,
    "tracking": false
  }
}

Response fields:

address -- Return address of the seed phrase.
hash_sum_matched -- Indicates whether the hash sum matches.
require_password -- Indicates whether a password is required.
syntax_correct -- Indicates whether the syntax is correct.
tracking -- Indicates whether tracking is enabled.

Multi-Wallet

mw_get_wallets

Get loaded wallets list, userful for multi-wallet API

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "mw_get_wallets",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "wallets": [{
      "wallet_id": 2,
      "wi": {
        "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
        "balances": [{
          "asset_info": {
            "asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
            "current_supply": 500000000000000000,
            "decimal_point": 12,
            "full_name": "Lethean wrapped ABC",
            "hidden_supply": false,
            "meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
            "owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
            "owner_eth_pub_key": "",
            "ticker": "ZABC",
            "total_max_supply": 1000000000000000000
          },
          "awaiting_in": 1000000000000,
          "awaiting_out": 2000000000000,
          "outs_amount_max": 2000000000000,
          "outs_amount_min": 2000000000000,
          "outs_count": 7,
          "total": 100000000000000,
          "unlocked": 50000000000000
        }],
        "has_bare_unspent_outputs": false,
        "is_auditable": false,
        "is_watch_only": false,
        "mined_total": 1000000000000,
        "path": "\/some\/path\/to\/wallet\/file.zan",
        "view_sec_key": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
      }
    }]
  }
}

Response fields:

wallets -- Array of wallets
wallet_id -- Wallet ID
address -- Address
balances -- Balances hold by this wallet
asset_info -- Asset info details
asset_id -- Asset ID
current_supply -- Currently emitted supply for the given asset (ignored for REGISTER operation).
decimal_point -- Decimal point.
full_name -- Full name of the asset.
hidden_supply -- This field is reserved for future use and will be documented later.
meta_info -- Any other information associated with the asset, by default in a json format.
owner -- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.
owner_eth_pub_key -- [Optional] Owner's key in the case when ETH signature is used.
ticker -- Ticker associated with the asset.
total_max_supply -- Maximum possible supply for a given asset, cannot be changed after deployment.
awaiting_in -- Unconfirmed amount for receive
awaiting_out -- Unconfirmed amount for send
outs_amount_max -- Output's maximum amount
outs_amount_min -- Output's minimum amount
outs_count -- Number of total unspent outputs (including locked)
total -- Total coins available(including locked)
unlocked -- Unlocked coins available(the ones that could be used right now)
has_bare_unspent_outputs -- Flag indicating whether the wallet has bare unspent outputs(pre-zarcanum outputs)
is_auditable -- Flag indicating whether the wallet is auditable
is_watch_only -- Flag indicating whether the wallet is watch-only
mined_total -- Total amount mined
path -- Path to wallet file
view_sec_key -- View secret key

mw_select_wallet

Select curent active wallet, after that all wallet RPC call would be addressed to this wallet

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "mw_select_wallet",
  "params": {
    "wallet_id": 2
  }
}

Parameters:

wallet_id -- Wallet id

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "status": "OK"
  }
}

Response fields:

status -- Result (OK if success)

Cold Signing

clear_utxo_cold_sig_reservation

Clears cold sig reservation flag for all unspent transaction outputs, that have one. Please, use with CAUTION!

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "clear_utxo_cold_sig_reservation",
  "params": {
  }
}

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "affected_outputs": [{
      "pk": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
    }],
    "status": "OK"
  }
}

Response fields:

affected_outputs -- List of affected outputs (for reference).
pk -- Output's one-time public key
status -- Status of the call

Proxy

proxy_to_daemon

Proxy call to daemon(node), might be not effective in some cases, so need to be carefull with use of it

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "proxy_to_daemon",
  "params": {
    "base64_body": "ewogICAgImpzb25ycGMiOiAiMi4wIiwKICAgICJpZCI6IDAsCiAgICAibWV0aG9kIjogImdldF9taW5pbmdfaGlzdG9yeSIKfQ==",
    "uri": "\/json_rpc"
  }
}

Parameters:

base64_body -- Base64 encoded request body
uri -- URI for daemon API

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "base64_body": "ewogICJpZCI6IDAsCiAgImpzb25ycGMiOiAiMi4wIiwKICAicmVzdWx0IjogewogICAgInBheW1lbnRzIjogWwogICAgICB7CiAgICAgICAgInBheW1lbnRfaWQiOiAiMDAwMDAwMDBmZjAwZmYwMCIsCiAgICAgICAgImFtb3VudCI6IDEwMDAwMDAwMCwKICAgICAgICAiYmxvY2tfaGVpZ2h0IjogMjAyNTU2LAogICAgICAgICJ0eF9oYXNoIjogIjAxMjIwZTgzMDRkNDZiOTQwYTg2ZTM4M2Q1NWNhNTg4N2IzNGYxNThhNzM2NWJiY2RkMTdjNWEzMDU4MTRhOTMiLAogICAgICAgICJ1bmxvY2tfdGltZSI6IDAKICAgICAgfSwKICAgICAgewogICAgICAgICJwYXltZW50X2lkIjogIjAwMDAwMDAwZmYwMGZmMDEiLAogICAgICAgICJhbW91bnQiOiAxMDAwMDAwMDAsCiAgICAgICAgImJsb2NrX2hlaWdodCI6IDIwMjU1NiwKICAgICAgICAidHhfaGFzaCI6ICIwYjVlYjk2ODVjMGMxMWRiNzdlMmNkZDk4NzljOGQzYjgxNTUyM2M2ZTRiZjAzZGNlZTYyYzU4M2I3ZTFmNzcyIiwKICAgICAgICAidW5sb2NrX3RpbWUiOiAwCiAgICAgIH0KICAgIF0KICB9Cn0=",
    "response_code": 200
  }
}

Response fields:

base64_body -- Base64 encoded daemon response body
response_code -- Response code