Class SendBuilder

Builder for composing a send or swap.

Remarks

If you only customise the send side, keep is omitted so the wallet may still attempt an offline exact match selection where possible.

Example

const { keep, send } = await wallet.ops
    	.send(5, proofs)
    	.asDeterministic() // counter 0 means auto reserve via CounterSource
    	.keepAsRandom()
    	.includeFees(true) // sender pays receiver’s future spend fee
    	.run();

Constructors

constructor

new SendBuilder(wallet: Wallet, amount: number, proofs: Proof[]): SendBuilder
Parameters
- wallet: Wallet
- amount: number
- proofs: Proof[]
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:82

Methods

asCustom

asCustom(data: OutputDataLike<HasKeysetKeys>[]): SendBuilder
Provide pre created OutputData for the sent proofs.
Parameters
- data: OutputDataLike<HasKeysetKeys>[]
  Fully formed OutputData. Their amounts must sum to the send amount, otherwise the wallet will throw.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:137

asDeterministic

asDeterministic(counter?: number, denoms?: number[]): SendBuilder
Use deterministic outputs for the sent proofs.
Parameters
- counter: number = 0
  Starting counter. Zero means auto reserve using the wallet’s CounterSource.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:104

asFactory

asFactory(factory: OutputDataFactory, denoms?: number[]): SendBuilder
Use a factory to generate OutputData for the sent proofs.
Parameters
- factory: OutputDataFactory
  OutputDataFactory used to produce blinded messages.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:126

asP2PK

asP2PK(options: P2PKOptions, denoms?: number[]): SendBuilder
Use P2PK locked outputs for the sent proofs.
Parameters
- options: P2PKOptions
  NUT 11 options like pubkey and locktime.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:115

asRandom

asRandom(denoms?: number[]): SendBuilder
Use random blinding for the sent outputs.
Parameters
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:93

includeFees

includeFees(on?: boolean): SendBuilder
Make the sender cover the receiver’s future spend fee.
Parameters
- on: boolean = true
  When true, include fees in the sent amount. Default true if called.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:200

keepAsCustom

keepAsCustom(data: OutputDataLike<HasKeysetKeys>[]): SendBuilder
Provide pre created OutputData for change.
Parameters
- data: OutputDataLike<HasKeysetKeys>[]
  Fully formed OutputData for the keep (change) amount.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:190

keepAsDeterministic

keepAsDeterministic(counter?: number, denoms?: number[]): SendBuilder
Use deterministic outputs for change.
Parameters
- counter: number = 0
  Starting counter. Zero means auto reserve using the wallet’s CounterSource.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:158

keepAsFactory

keepAsFactory(factory: OutputDataFactory, denoms?: number[]): SendBuilder
Use a factory to generate OutputData for change.
Parameters
- factory: OutputDataFactory
  OutputDataFactory used to produce blinded messages.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:180

keepAsP2PK

keepAsP2PK(options: P2PKOptions, denoms?: number[]): SendBuilder
Use P2PK locked change (NUT 11).
Parameters
- options: P2PKOptions
  Locking options applied to the kept proofs.
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:169

keepAsRandom

keepAsRandom(denoms?: number[]): SendBuilder
Use random blinding for change outputs.
Parameters
- Optionaldenoms: number[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:147

keyset

keyset(id: string): SendBuilder
Use a specific keyset for the operation.
Parameters
- id: string
  Keyset id to use for mint keys and fee lookup.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:210

offlineCloseMatch

offlineCloseMatch(requireDleq?: boolean): SendBuilder
Force a pure offline selection that allows a close match, overspend permitted per wallet RGLI. No mint calls are made. Returns the best offline subset found, or throws if funds are insufficient.
Parameters
- requireDleq: boolean = false
  Only consider proofs with a DLEQ when true.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:265

offlineExactOnly

offlineExactOnly(requireDleq?: boolean): SendBuilder
Force a pure offline, exact match selection. No mint calls are made. If an exact match cannot be found, this throws.
Parameters
- requireDleq: boolean = false
  Only consider proofs with a DLEQ when true.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:253

onCountersReserved

onCountersReserved(cb: OnCountersReserved): SendBuilder
Receive a callback once counters are atomically reserved for deterministic outputs.
Parameters
- cb: OnCountersReserved
  Called with OperationCounters when counters are reserved.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:242

prepare

prepare(): Promise<SwapPreview>
Prepare the swap to send.

Returns Promise<SwapPreview>
A SwapPreview containing inputs, outputs, amount, fee and unselectedProofs.

Remarks
Call wallet.completeSwap(SwapPreview) to complete the send.
- Defined in src/wallet/WalletOps.ts:277

privkey

privkey(k: string | string[]): SendBuilder
Private key(s) used to sign P2PK locked proofs.
Parameters
- k: string | string[]
  Single key or array of multisig keys.
Returns SendBuilder
- Defined in src/wallet/WalletOps.ts:220

proofsWeHave

proofsWeHave(p: Proof[]): SendBuilder
Provide existing proofs to help optimise denomination selection.
Parameters
- p: Proof[]
  Proofs currently held by the wallet, used to hit denomination targets.
Returns SendBuilder
Remarks
Has no effect if denominations (custom split) was specified.
- Defined in src/wallet/WalletOps.ts:232

run

run(): Promise<SendResponse>
Execute the send.

Returns Promise<SendResponse>
The split result with kept and sent proofs.
- Defined in src/wallet/WalletOps.ts:291

Class SendBuilder

Remarks

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SendBuilder

Methods

asCustom

Parameters

Returns SendBuilder

asDeterministic

Parameters

Returns SendBuilder

asFactory

Parameters

Returns SendBuilder

asP2PK

Parameters

Returns SendBuilder

asRandom

Parameters

Returns SendBuilder

includeFees

Parameters

Returns SendBuilder

keepAsCustom

Parameters

Returns SendBuilder

keepAsDeterministic

Parameters

Returns SendBuilder

keepAsFactory

Parameters

Returns SendBuilder

keepAsP2PK

Parameters

Returns SendBuilder

keepAsRandom

Parameters

Returns SendBuilder

keyset

Parameters

Returns SendBuilder

offlineCloseMatch

Parameters

Returns SendBuilder

offlineExactOnly

Parameters

Returns SendBuilder

onCountersReserved

Parameters

Returns SendBuilder

prepare

Returns Promise<SwapPreview>

Remarks

privkey

Parameters

Returns SendBuilder

proofsWeHave

Parameters

Returns SendBuilder

Remarks

run

Returns Promise<SendResponse>

Settings

On This Page