Class: MoneroTransferQuery

MoneroTransferQuery(config)

Configuration to query wallet transfers.

Constructor

new MoneroTransferQuery(config)

Construct the transfer query.

Example:

// get incoming transfers to account 0, subaddress 1
let transfers = await wallet.getTransfers({
   accountIndex: 0,
   subaddressIndex: 0
});

All configuration is optional. All transfers are returned except those that don't meet criteria defined in this query.

Parameters:
Name Type Description
config object transfer query configuration (optional)
Properties
Name Type Description
amount BigInteger get transfers with this amount
accountIndex int get transfers to/from this account index
subaddressIndex int get transfers to/from this subaddress index
subaddressIndices Array.<int> get transfers to/from these subaddress indices
address string get transfers to/from this wallet address
addresses Array.<string> get transfers to/from these wallet addresses
isIncoming boolean get transfers which are incoming if true
isOutgoing boolean get transfers which are outgoing if true
hasDestinations boolean get transfers with known destinations if true (destinations are only stored locally with the wallet)
txQuery object | MoneroTxQuery get transfers whose tx match this tx query
Source:

Extends

Methods

copy()

Overrides:
Source:

getAccountIndex()

Overrides:
Source:

getAddress()

Source:

getAddresses()

Source:

getAmount()

Overrides:
Source:

getDestinations()

Source:

getSubaddressIndex()

Source:

getSubaddressIndices()

Source:

getTx()

Overrides:
Source:

getTxQuery()

Source:

hasDestinations()

Source:

isIncoming()

Overrides:
Source:

isOutgoing()

Overrides:
Source:

meetsCriteria()

Source:

merge(transfer) → {MoneroTransfer}

Updates this transaction by merging the latest information from the given transaction. Merging can modify or build references to the transfer given so it should not be re-used or it should be copied before calling this method.
Parameters:
Name Type Description
transfer is the transfer to merge into this one
Overrides:
Source:
Returns:
the merged transfer
Type
MoneroTransfer

setAccountIndex()

Overrides:
Source:

setAddress()

Source:

setAddresses()

Source:

setAmount()

Overrides:
Source:

setDestinations()

Source:

setHasDestinations()

Source:

setIsIncoming()

Source:

setIsLocked(isLocked) → {MoneroOutputQuery}

Convenience method to query outputs by the locked state of their tx.
Parameters:
Name Type Description
isLocked specifies if the output's tx must be locked or unlocked (optional)
Source:
Returns:
this query for chaining
Type
MoneroOutputQuery

setIsOutgoing()

Source:

setSubaddressIndex()

Source:

setSubaddressIndices()

Source:

setTx()

Overrides:
Source:

setTxQuery()

Source:

toJson()

Overrides:
Source:

toString()

Overrides:
Source: