Starting Wallet-API

Start wallet-api like this:

./wallet-api --rpc-password somepassword

An RPC password is always required, and you should then provide this password as the key parameter while initializing the wrapper.

You can now use the wrapper for Wallet-API.

Usage

class WalletAPI(key, host = '127.0.0.1', port = 8070, ssl = False, timeout=5)

Integrates with the JSON-PRC interface of Wallet-API.

1. open_wallet(filename, password, daemon_host = '127.0.0.1', daemon_port = 11898)

Opens an already existing wallet.

Return Type : int

If the operation was successful, 200 is returned else a ValueError is raised, with the relevant error message.

2. import_wallet_key(filename, password, private_view_key, private_spend_key, daemon_host = 'localhost', daemon_port = 11898, scan_height = None)

Imports a wallet with a private view and spend key.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

3. import_wallet_seed(filename, password, seed, daemon_host = '127.0.0.1', daemon_port = 11898, scan_height = None)

Imports a wallet using a mnemonic seed.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

4. import_wallet_view(filename, password, private_view_key, address, daemon_host = 127.0.0.1, daemon_port = 11898, scan_height = None)

Imports a view only wallet with a private view key and public address.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

5. create_wallet(filename, password, daemon_host = None, daemon_port = None)

Creates a new wallet.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

6. delete_wallet()

Closes and saves the opened wallet.

NO INPUT

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

7. addresses()

Gets a list of all addresses in the wallet container.

NO INPUT

Return Type: dict

#Expected Output
​
{
  "addresses": [
    "TRTLv2cT32cZbF6KvnU69LNxptYFBMCKs3yqLmCAVjPW4rNTExpB7RpGKGJEkD1E9MVmM8SUUJfUh42Ajo1Hgz5wUN6budvzaq"
  ]
}

8. delete_address(address)

Deletes the given sub-wallet from the container.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

9. primary_address()

Gets the 'primary' address.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "address": "TRTLv2cT32cZbF6KvnU69LNxptYFBMCKs3yqLmCAVjPW4rNTExpB7RpGKGJEkD1E9MVmM8SUUJfUh42Ajo1Hgz5wUN6budvzaq"
}

10. create_address()

Creates a new, random address in the wallet container.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "address": "TRTLv2cT32cZbF6KvnU69LNxptYFBMCKs3yqLmCAVjPW4rNTExpB7RpGKGJEkD1E9MVmM8SUUJfUh42Ajo1Hgz5wUN6budvzaq",
  "privateSpendKey": "6d4a7c160cbd4c9de33eeb161ff30539d2e28b447eb5af73523cc3379c591c83",
  "publicSpendKey": "6d4a7c160cbd4c9de33eeb161ff30539d2e28b447eb5af73523cc3379c591c83"
}

11. import_address(private_spend_key, scan_height = None)

Imports a sub-wallet with the given private spend key. It is HIGHLY recommended you provide a scan height with this operation - wallet syncing will have to begin again from the scan height given (defaults to zero) if the scan height is less than the height of the current wallet sync status.

Return Type : dict

#Expected Output
​
{
  "address": "TRTLv2cT32cZbF6KvnU69LNxptYFBMCKs3yqLmCAVjPW4rNTExpB7RpGKGJEkD1E9MVmM8SUUJfUh42Ajo1Hgz5wUN6budvzaq"
}

12. import_address_view(public_spend_key, scan_height = None)

Imports a view only sub-wallet with the given public_spend_key. It is HIGHLY recommended you provide a scan height with this operation - wallet syncing will have to begin again from the scan_height given (defaults to zero) if the scan height is less than the height of the current wallet sync status.

Return Type : dict

#Expected Output
​
{
  "address": "TRTLv2cT32cZbF6KvnU69LNxptYFBMCKs3yqLmCAVjPW4rNTExpB7RpGKGJEkD1E9MVmM8SUUJfUh42Ajo1Hgz5wUN6budvzaq"
}

13. integrated_address(address, payment_id)

Creates an integrated address from an address and payment ID.

Return Type : dict

#Expected Output
​
{
  "integratedAddress": "TRTLuxiNXhy96RNDkv2jx29jL7GdTWYBmA4r7K8KRpDWA4hJJnTZEgFHFzxqvmBLtz94oF4uPokQdHbV9j2g7S6LA4hKPvjZEFS2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3BoCpXD"
}

14. get_node()

Gets the node address, port, fee, and fee address.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "daemonHost": "127.0.0.1",
  "daemonPort": 11898,
  "nodeFee": 1000,
  "nodeAddress": "TRTLv2Fyavy8CXG8BPEbNeCHFZ1fuDCYCZ3vW5H5LXN4K2M2MHUpTENip9bbavpHvvPwb4NDkBWrNgURAd5DB38FHXWZyoBh4wW"
}

15. set_node(daemon_host, daemon_port)

Sets the node address and port.

If the operation was successful, no value is returned. Otherwise, a ValueError is raised with the relevant error message.

16. wallet_keys()

Gets the wallet containers shared private view key.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "privateViewKey": "85baeb8ae23bf266c68a5845f1ff13af7ff221f46e4dfc1293eec9a3e211a90a"
}

17. address_keys(address)

Gets the public and private spend key for the given address. Note that this method cannot be used with a view only wallet.

Return Type : dict

#Expected Output
​
{
  "privateSpendKey": "85baeb8ae23bf266c68a5845f1ff13af7ff221f46e4dfc1293eec9a3e211a90a",
  "publicSpendKey": "85baeb8ae23bf266c68a5845f1ff13af7ff221f46e4dfc1293eec9a3e211a90a"
}

18. mnemonic(address)

Gets the mnemonic seed for the given address, if possible. Note that this method cannot be used with a view only wallet.

Return type : dict

#Excepted Output
​
{
  "mnemonicSeed": "leech lifestyle newt tarnished vials weavers decay nerves buying taken sample after jailed cupcake token pavements welders gifts ferry keep humid abbey emails entrance leech"
}

19. transactions()

Returns a list of all transactions in the wallet container.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "transactions": [
    {
      "blockHeight": 800000,
      "fee": 10,
      "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
      "isCoinbaseTransaction": false,
      "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
      "timestamp": 1543222082,
      "unlockTime": 0,
      "transfers": {
        "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
        "amount": 1234
      }
    }
  ]
}

20. transaction_details(txn_hash)

Returns details on the given transaction, if found.

Return Type : dict

#Expected Output
​
{
  "transactions": {
    "blockHeight": 800000,
    "fee": 10,
    "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
    "isCoinbaseTransaction": false,
    "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
    "timestamp": 1543222082,
    "unlockTime": 0,
    "transfers": {
      "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
      "amount": 1234
    }
  }
}

21. unconfirmed_transactions()

Gets a list of all unconfirmed, outgoing transactions in the wallet container. Note that this DOES NOT include incoming transactions in the pool. This only applies to transactions that have been sent by this wallet file, and have not been added to a block yet.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "transactions": [
    {
      "blockHeight": 800000,
      "fee": 10,
      "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
      "isCoinbaseTransaction": false,
      "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
      "timestamp": 1543222082,
      "unlockTime": 0,
      "transfers": {
        "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
        "amount": 1234
      }
    }
  ]
}

22. unconfirmed_address(address)

Returns a list of unconfirmed, outgoing transactions, for the given address. Note that this DOES NOT include incoming transactions in the pool. This only applies to transactions that have been sent by this wallet file, and have not been added to a block yet.

Return Type : dict

#Expected Output
​
{
  "transactions": [
    {
      "blockHeight": 800000,
      "fee": 10,
      "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
      "isCoinbaseTransaction": false,
      "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
      "timestamp": 1543222082,
      "unlockTime": 0,
      "transfers": {
        "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
        "amount": 1234
      }
    }
  ]
}

23. transactions_height(start_height, end_height = None)

Returns transactions for the wallet starting at start height for 1,000 blocks (or until end height if specified). Note that start height must be < end height.

Return Type : dict

#Expected Output
​
{
  "transactions": [
    {
      "blockHeight": 800000,
      "fee": 10,
      "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
      "isCoinbaseTransaction": false,
      "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
      "timestamp": 1543222082,
      "unlockTime": 0,
      "transfers": {
        "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
        "amount": 1234
      }
    }
  ]
}

24. transactions_height_address(address, start_height, end_height = None)

Returns transactions for the wallet starting at start height for 1,000 blocks, that belong to the given address (or until end height if specified). Note that start height must be < end height. Also note that the transfers list will still contain transfers to other addresses, if present.

Return Type : dict

#Expected Output
​
{
  "transactions": [
    {
      "blockHeight": 800000,
      "fee": 10,
      "hash": "8e2dc89659409ea9c34a2e28f7350cefba304159c04cc4926acd12035a8b2379",
      "isCoinbaseTransaction": false,
      "paymentID": "7fe73bd90ef05dea0b5c15fc78696619c50dd5f2ba628f2fd16a2e3445b1922f",
      "timestamp": 1543222082,
      "unlockTime": 0,
      "transfers": {
        "address": "TRTLv3ErzkY2CiAj6DL8isYELmTec8Z9BK56oL1KMhjMRSMyfwYaogKg17hQKC23CHPBcHqrHHGzdRYUk3HGqkMwXbHg3Dy2rH",
        "amount": 1234
      }
    }
  ]
}

25. send_basic(address, amount, payment_id = None)

Sends a transaction. This method will take funds from all sub-wallets as needed, and will use the primary address as the change address. It also uses a default fee, and default mixin. If this is not acceptable, please use the send_advanced method instead.

Return Type : dict

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f",
  "fee": 1000,
  "relayedToNetwork": true
}

26. prepare_basic(amount, address = None, payment_id = None)

Creates a transaction but does not relay it to the network. This method will take funds from all sub-wallets as needed, and will use the primary address as the change address. It also uses a default fee, and default mixin. If this is not acceptable, please use the prepare_advanced method instead. Allows you to review the created transactions fee before deciding whether to commit to paying that fee. Prepared transactions can be sent using send_prepared method, or cancelled with cancel_prepared method.

Return Type : dict (Also note that the fee returned is in atomic units. Divide it by 100 to get the amount in TRTL)

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f",
  "fee": 1000,
  "relayedToNetwork": false
}

27. send_advanced(destination, mixin=None, fee=None, fee_per_byte=None,payment_id=None, source_addresses=None, change_address=None, unlock_time=None, extra=None)

Sends a transaction. Custom configurations for sending transactions are available here.

Return Type : dict

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f",
  "fee": 1000,
  "relayedToNetwork": true
}

28. prepare_advanced(destination, mixin=None, fee=None, fee_per_byte=None, payment_id=None, source_addresses=None, change_address=None, unlock_time=None, extra=None)

Creates a transaction but does not relay it to the network. Custom configurations for sending transactions are available here.

Return Type : dict

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f",
  "fee": 1000,
  "relayedToNetwork": false
}

29. send_prepared(txn_hash)

Sends a previously prepared transaction.

Return Type : dict

#Expected Output
​
{
  "transactionHash": "1982d8903c5e2b0914e6586e5b715758823e4903c2bacda7aa519ff6feb1476e"
}

30. cancel_prepared(txn_hash)

Cancels a previously prepared transaction. While it is not mandatory to call this method for a prepared transaction you do not wish to send, it is highly advised, as it will free up RAM.

Return Type : No value returned.

31. send_fusion_basic()

Fusion transactions are zero fee, and seek to combine small inputs into larger ones, to allow for larger transactions. Many fusions may be required to fully optimize a wallet.

NO INPUT

Return Type: dict

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f"
}

32. send_fusion_advanced(mixin=None, destination=None, source_addresses=None, optimize_target=None)

Fusion transactions are zero fee, and seek to combine small inputs into larger ones, to allow for larger transactions. Many fusions may be required to fully optimize a wallet.

Return Type : dict

#Expected Output
​
{
  "transactionHash": "396e2a782c9ce9993982c6f93e305b05306d0e5794f57157fbac78581443c55f"
}

33. transactions_private_key(txn_hash)

Gets the transaction private key of the given transaction. This can be used to audit a transaction.The transaction must have been sent by this wallet container. If the wallet container has been re-imported,it will not be present.

Return Type : dict

#Expected Output
​
{
  "transactionPrivateKey": "199c0b9c40e192f1917a2f317c72fb6684081c744c3286793e6d63b5d3f6930a"
}

34. wallet_balance()

Get the balance for the entire wallet container.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "unlocked": 1234,
  "locked": 123
}

35. address_balance(address)

Get the balance for a specific address.

Return Type : dict (Please note that the amount returned is in shells, divide by 100 to get the amount in TRTL)

#Expected Output
​
{
  "unlocked": 1234,
  "locked": 123
}

37. balances()

Get the balance for every address.

NO INPUT

Return Type : list

#Expected Output
​
[
  {
    "unlocked": 1234,
    "locked": 123,
    "address": "TRTLv2Fyavy8CXG8BPEbNeCHFZ1fuDCYCZ3vW5H5LXN4K2M2MHUpTENip9bbavpHvvPwb4NDkBWrNgURAd5DB38FHXWZyoBh4wW"
  }
]

38. save()

Save the wallet state.

NO INPUT

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

39. export(path = None)

Exports the wallet data to JSON into the file-path given.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

40. reset(scan_height = None)

Resets and saves the wallet, beginning scanning from height if given.

Return Type : None

If the operation was successful, no value is returned else a ValueError is raised, with the relevant error message.

41. validate(address)

Validate an address.

Return Type : For valid address - dict. For invalid address - bool (False)

#Expected Output (Only for valid address)
​
{
  "isIntegrated": true,
  "paymentID": "",
  "actualAddress": "TRTLv2Fyavy8CXG8BPEbNeCHFZ1fuDCYCZ3vW5H5LXN4K2M2MHUpTENip9bbavpHvvPwb4NDkBWrNgURAd5DB38FHXWZyoBh4w",
  "publicSpendKey": "88032068e8209480bc634a48a00795c6a24c248a50f0937c168ac96ad0ba240d",
  "publicViewKey": "8d635efe0077ec70006732a847a36adbc5b108a3e7cebdbb93e0cfc35fcd8d45"
}

42. status()

Get the wallet sync status, peer count, and hash rate.

NO INPUT

Return Type : dict

#Expected Output
​
{
  "walletBlockCount": 100000,
  "localDaemonBlockCount": 800000,
  "networkBlockCount": 900000,
  "peerCount": 20,
  "hashrate": 123456789,
  "isViewWallet": false,
  "subWalletCount": 1
}