Class MoneroTxConfig

Configures a transaction to send, sweep, or create a payment URI.

Hierarchy

  • MoneroTxConfig

Constructors

constructor

Properties

accountIndex address amount belowAmount canSplit destinations fee keyImage note paymentId priority recipientName relay subaddressIndex subaddressIndices subtractFeeFrom sweepEachSubaddress

Methods

addDestination copy getAccountIndex getAddress getAmount getBelowAmount getCanSplit getDestinations getFee getKeyImage getNote getPaymentId getPriority getRecipientName getRelay getSubaddressIndices getSubtractFeeFrom getSweepEachSubaddress setAccountIndex setAddress setAmount setBelowAmount setCanSplit setDestination setDestinations setFee setKeyImage setNote setPaymentId setPriority setRecipientName setRelay setSubaddressIndex setSubaddressIndices setSubtractFeeFrom setSweepEachSubaddress toJson

Constructors

constructor

  • Generic request to transfer funds from a wallet.

    Example:

    let config1 = new MoneroTxConfig({
       accountIndex: 0,
       address: "59aZULsUF3YN...",
       amount: 500000n,
       priority: MoneroTxPriority.NORMAL,
       relay: true
    });

    Parameters

    • Optional config: Partial<MoneroTxConfig>

      configures the transaction to create (optional)

    Returns MoneroTxConfig

Properties

accountIndex

accountIndex: number

Source account index to transfer funds from (required unless sweeping key image).

address

address: string

Single destination address (required unless destinations provided).

amount

amount: bigint

Single destination amount (required unless `destinations provided).

belowAmount

belowAmount: bigint

For sweep requests, include outputs below this amount when sweeping wallet, account, subaddress, or all unlocked funds.

canSplit

canSplit: boolean

Allow funds to be transferred using multiple transactions if necessary (default false).

destinations

destinations: Partial<MoneroDestination>[]

Multiple destinations to send funds to, if applicable.

fee

fee: bigint

Miner fee (calculated automatically).

keyImage

keyImage: string

For sweep requests, key image of the output to sweep.

note

note: string

Transaction note saved locally with the wallet (optional).

paymentId

paymentId: string

Payment ID for the transaction.

priority

priority: MoneroTxPriority

Transaction priority to adjust the miner fee (default MoneroTxPriority.NORMAL).

recipientName

recipientName: string

Recipient name saved locally with the wallet (optional).

relay

relay: boolean

Relay the transaction to peers to commit to the blockchain if true (default false).

subaddressIndex

subaddressIndex: number

Source subaddress index to send funds from (default all).

subaddressIndices

subaddressIndices: number[]

Source subaddresses to send funds from (default all).

subtractFeeFrom

subtractFeeFrom: number[]

List of destination indices to split the miner fee (optional).

sweepEachSubaddress

sweepEachSubaddress: boolean

For sweep requests, sweep each subaddress individually instead of together if true.

Methods

addDestination

copy

getAccountIndex

  • Returns number

getAddress

  • Get the address of a single-destination configuration.

    Returns string

    the address of the single destination

getAmount

  • Get the amount of a single-destination configuration.

    Returns bigint

    the amount of the single destination

getBelowAmount

  • Returns bigint

getCanSplit

  • Returns boolean

getDestinations

getFee

  • Returns bigint

getKeyImage

  • Get the key image hex of the output to sweep.

    return {string} is the key image hex of the output to sweep

    Returns string

getNote

  • Returns string

getPaymentId

  • Returns string

getPriority

  • Returns number

getRecipientName

  • Returns string

getRelay

  • Returns boolean

getSubaddressIndices

  • Returns number[]

getSubtractFeeFrom

  • Returns number[]

getSweepEachSubaddress

  • Returns boolean

setAccountIndex

setAddress

  • Set the address of a single-destination configuration.

    Parameters

    • address: string

      the address to set for the single destination

    Returns MoneroTxConfig

    this configuration for chaining

setAmount

  • Set the amount of a single-destination configuration.

    Parameters

    • amount: bigint

      the amount to set for the single destination

    Returns MoneroTxConfig

    this configuration for chaining

setBelowAmount

setCanSplit

setDestination

setDestinations

setFee

setKeyImage

  • Set the key image hex of the output to sweep.

    Parameters

    • keyImage: any

      is the key image hex of the output to sweep

    Returns MoneroTxConfig

setNote

setPaymentId

setPriority

setRecipientName

setRelay

setSubaddressIndex

setSubaddressIndices

setSubtractFeeFrom

setSweepEachSubaddress

toJson

  • Returns any

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc