Properties
Optional addressType
addressType: undefined | string
Optional changeAddress
changeAddress: undefined | string
Optional enforceMinConfirmsForChange
enforceMinConfirmsForChange: undefined | false | true
Optional feeRate
feeRate: undefined | number
Optional fromAddresses
fromAddresses: string[]
Optional gasPrice
gasPrice: undefined | number
Optional hop
hop: undefined | false | true
Optional instant
instant: undefined | false | true
Optional lastLedgerSequence
lastLedgerSequence: undefined | number
Optional ledgerSequenceDelta
ledgerSequenceDelta: undefined | string
Optional maxFeeRate
maxFeeRate: undefined | number
Optional maxValue
maxValue: undefined | number
Optional minConfirms
minConfirms: undefined | number
Optional minValue
minValue: undefined | number
Optional noSplitChange
noSplitChange: undefined | false | true
Optional numBlocks
numBlocks: undefined | number
Optional offlineVerification
offlineVerification: undefined | false | true
Optional recipients
recipients: object[]
Optional reservation
reservation: undefined | object
Optional sequenceId
sequenceId: undefined | number
Optional targetWalletUnspents
targetWalletUnspents: undefined | number
Optional unspents
unspents: any[]
Optional validFromBlock
validFromBlock: undefined | number
Optional validToBlock
validToBlock: undefined | number
Optional walletPassphrase
walletPassphrase: undefined | string
A small set of parameters should be used for building a consolidation transaction:
What shouldn't be passed (these will be ignored):