Monero

v0.11.0

Monero v0.11.0 Monero.Wallet View Source

Operations on Monero wallet RPC. See https://getmonero.org/resources/developer-guides/wallet-rpc.html or https://lessless.github.io/#wallet-json-rpc-calls temporarly.

Link to this section Summary

Types

transfer_destination()
transfer_opts()

Functions

create_wallet(filename, password, language)

Create a new wallet. You need to have set the argument --wallet-dir when launching monero-wallet-rpc to make this work

get_payments(payment_id)

Get a list of incoming payments using a given payment id

get_transfer_by_txid(txid, opts \\ [])

Show information about a transfer to/from this address

getaddress()

Return the wallet's address

getbalance()

Return the wallet's balance

incoming_transfers(transfer_type)

Return a list of incoming transfers to the wallet

open_wallet(filename, password)

Open a wallet. You need to have set the argument --wallet-dir when launching monero-wallet-rpc to make this work

sign(data)

Sign a string

transfer(destinations, opts \\ [])

Send monero to a number of recipients

verify(data, address, signature)

Verify a signature on a string

Link to this section Types

Link to this type

transfer_destination() View Source 
transfer_destination() :: %{amount: String.t(), address: String.t()}

Link to this type

transfer_opts() View Source 
transfer_opts() ::
  {:payment_id, String.t()}
  | {:get_tx_key, boolean()}
  | {:priority, non_neg_integer()}
  | {:do_not_relay, boolean()}
  | {:get_tx_hex, boolean()}

Link to this section Functions

Link to this function

create_wallet(filename, password, language) View Source 
create_wallet(Strint.t(), Strint.t(), Strint.t()) :: Monero.Operation.Query.t()

Create a new wallet. You need to have set the argument --wallet-dir when launching monero-wallet-rpc to make this work.

Args:

  • filename - Filename for your wallet.
  • password - Password for your wallet.
  • language - Language for your wallets' seed.
Link to this function

get_payments(payment_id) View Source 
get_payments(String.t()) :: Monero.Operation.Query.t()

Get a list of incoming payments using a given payment id.

Args:

  • payment_id - Payment id of incoming payments.
Link to this function

get_transfer_by_txid(txid, opts \\ []) View Source

Show information about a transfer to/from this address.

Args:

  • txid - string; Transaction ID used to find the transfer.
  • account_index - unsigned int; (Optional) Index of the account to query for the transfer.
Link to this function

getaddress() View Source 
getaddress() :: Monero.Operation.Query.t()

Return the wallet's address.

Link to this function

getbalance() View Source 
getbalance() :: Monero.Operation.Query.t()

Return the wallet's balance.

Link to this function

incoming_transfers(transfer_type) View Source 
incoming_transfers(Strint.t()) :: Monero.Operation.Query.t()

Return a list of incoming transfers to the wallet.

Args:

  • transfer_type - may be one of the:

    • "all" - for all the transfers.
    • "available" - for only transfers which are not yet spent.
    • "unavailable" - for only transfers which are already spent.
Link to this function

open_wallet(filename, password) View Source 
open_wallet(Strint.t(), Strint.t()) :: Monero.Operation.Query.t()

Open a wallet. You need to have set the argument --wallet-dir when launching monero-wallet-rpc to make this work.

Args:

  • filename - Filename for your wallet.
  • password - Password for your wallet.
Link to this function

sign(data) View Source

Sign a string.

Args:

  • data - data - string; Anything you need to sign.
Link to this function

transfer(destinations, opts \\ []) View Source 
transfer([transfer_destination()], transfer_opts()) ::
  Monero.Operation.Query.t()

Send monero to a number of recipients.

Args:

  • destinations - List of destinations to receive XMR.
  • optional arguments in a form of keyword list as described in the documentation

NOTE: destination amount is in atomic units, means 1e12 = 1 XMR

Link to this function

verify(data, address, signature) View Source

Verify a signature on a string.

Args:

  • data - data - string; Anything you need to sign.
  • address - string; Public address of the wallet used to sign the data. *signature` - string; signature generated by sign method.