Onshore

onshore

Same as transfer_split, but sends XHV by burning xUSD.

Alias: None.

Inputs:

  • destinations – array of destinations to receive XHV:
    • amount – unsigned int; Amount in XHV to send to each destination, in @atomic-units.
    • address – string; Destination public address.
  • account_index – unsigned int; (Optional) Transfer from this account index. (Defaults to 0)
  • subaddr_indices – array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to empty – all indices)
  • mixin – unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).
  • ring_size – unsigned int; Sets ringsize to n (mixin + 1).
  • unlock_time – unsigned int; Number of blocks before the haven can be spent (0 to not add a lock).
  • get_tx_keys – boolean; (Optional) Return the transaction keys after sending.
  • priority – unsigned int; Set a priority for the transactions. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.
  • do_not_relay – boolean; (Optional) If true, the newly created transaction will not be relayed to the haven network. (Defaults to false)
  • get_tx_hex– boolean; Return the transactions as hex string after sending
  • new_algorithm – boolean; True to use the new transaction construction algorithm, defaults to false.
  • get_tx_metadata – boolean; Return list of transaction metadata needed to relay the transfer later.

Outputs:

  • tx_hash_list – array of: string. The tx hashes of every transaction.
  • tx_key_list– array of: string. The transaction keys for every transaction.
  • amount_list – array of: integer. The amount transferred in XHV for every transaction.
  • amount_usd_list – array of: integer. The amount transferred in xUSD for every transaction.
  • fee_list – array of: integer. The amount of fees paid for every transaction.
  • tx_blob_list– array of: string. The tx as hex string for every transaction.
  • tx_metadata_list – array of: string. List of transaction metadata needed to relay the transactions later.
  • multisig_txset – string. The set of signing keys used in a multisig transaction (empty for non-multisig).
  • unsigned_txset – string. Set of unsigned tx for cold-signing purposes.

Example:

$ curl http://127.0.0.1:17751/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"onshore","params":{"destinations":[{"amount":1000000000000,"address":"hvxy5mxT87WWDCfsAYYEtq9K8KNbPTRaEd2nKgLgPN3qP5PpH1AaJ6TaYYec9L2hKZGpuxQ4uZ4tkFFLxjaLHVAY7QZoBmW3g2"},{"amount":2000000000000,"address":"hvxy5mxT87WWDCfsAYYEtq9K8KNbPTRaEd2nKgLgPN3qP5PpH1AaJ6TaYYec9L2hKZGpuxQ4uZ4tkFFLxjaLHVAY7QZoBmW3g2"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_keys": true}}' -H 'Content-Type: application/json'{  "id": "0",  "jsonrpc": "2.0",  "result": {    "amount_list": [3000000000000],    "amount_usd_list": [3000000000000],    "fee_list": [473710000],    "multisig_txset": "",    "tx_hash_list": ["4adcdc1af3f665770cdf8fb7a380887cd07ac53c2b771bd18df5ca375d5e7540"],    "tx_key_list": ["5b455c0f97168be652a2c03c5c68a064bb84cdae4ddef01b5c48d73a0bbb27075fb714f2ca19ea6c8ff592417e606addea6deb1d6530e2969f75681ffcbfc4075677b94a8c9197963ae38fa6f543ee68f0a4c4bbda4c453f39538f00b28e980ea08509730b51c004960101ba2f3adbc34cbbdff0d5af9dba061b523090debd06"],    "unsigned_txset": ""  }}
Previous Offshore
Next Offshore Transfer
en_GBEnglish (UK)