Class ReceiveBuilder

Builder for receiving a token.

Remarks

If you do not call a type method, the wallet’s policy default is used.

Example

const proofs = await wallet.ops
    	.receive(token) // or array of proofs
    	.asDeterministic() // counter 0 auto reserves
    	.requireDleq(true)
    	.run();

Index

Constructors

constructor

Methods

asCustom asDeterministic asFactory asP2PK asRandom keyset onCountersReserved prepare privkey proofsWeHave requireDleq run

Constructors

constructor

new ReceiveBuilder(
wallet: Wallet,
token: string | Proof[] | Token,
): ReceiveBuilder
Parameters
- wallet: Wallet
- token: string | Proof[] | Token
Returns ReceiveBuilder
- Defined in src/wallet/WalletOps.ts:362

Methods

asCustom

asCustom(data: OutputDataLike[]): ReceiveBuilder
Provide pre created OutputData for received proofs.
Parameters
- data: OutputDataLike[]
  Fully formed OutputData for the final amount.
Returns ReceiveBuilder
- Defined in src/wallet/WalletOps.ts:423

asDeterministic

asDeterministic(counter?: number, denoms?: AmountLike[]): ReceiveBuilder
Use deterministic outputs for the received proofs.
Parameters
- counter: number = 0
  Starting counter. Zero means auto reserve using the wallet’s CounterSource.
- Optionaldenoms: AmountLike[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns ReceiveBuilder
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:387

asFactory

asFactory(factory: OutputDataFactory, denoms?: AmountLike[]): ReceiveBuilder
Use a factory to generate OutputData for received proofs.
Parameters
- factory: OutputDataFactory
  OutputDataFactory used to produce blinded messages.
- Optionaldenoms: AmountLike[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns ReceiveBuilder
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:413

asP2PK

asP2PK(options: P2PKOptions, denoms?: AmountLike[]): ReceiveBuilder
Use P2PK locked outputs for the received proofs.
Parameters
- options: P2PKOptions
  NUT 11 options like pubkey and locktime.
- Optionaldenoms: AmountLike[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns ReceiveBuilder
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:400

asRandom

asRandom(denoms?: AmountLike[]): ReceiveBuilder
Use random blinding for the received outputs.
Parameters
- Optionaldenoms: AmountLike[]
  Optional custom split. Can be partial if you only need SOME specific amounts.
Returns ReceiveBuilder
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:374

keyset

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

onCountersReserved

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

prepare

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

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

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

privkey

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

proofsWeHave

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

requireDleq

requireDleq(on?: boolean): ReceiveBuilder
Require all incoming proofs to have a valid DLEQ for the selected keyset.
Parameters
- on: boolean = true
  When true, proofs without DLEQ are rejected.
Returns ReceiveBuilder
- Defined in src/wallet/WalletOps.ts:443

run

run(): Promise<Proof[]>
Execute the receive.

Returns Promise<Proof[]>
The new proofs.
- Defined in src/wallet/WalletOps.ts:496

Class ReceiveBuilder

Remarks

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ReceiveBuilder

Methods

asCustom

Parameters

Returns ReceiveBuilder

asDeterministic

Parameters

Returns ReceiveBuilder

Remarks

asFactory

Parameters

Returns ReceiveBuilder

Remarks

asP2PK

Parameters

Returns ReceiveBuilder

Remarks

asRandom

Parameters

Returns ReceiveBuilder

Remarks

keyset

Parameters

Returns ReceiveBuilder

onCountersReserved

Parameters

Returns ReceiveBuilder

prepare

Returns Promise<SwapPreview>

Remarks

privkey

Parameters

Returns ReceiveBuilder

proofsWeHave

Parameters

Returns ReceiveBuilder

Remarks

requireDleq

Parameters

Returns ReceiveBuilder

run

Returns Promise<Proof[]>

Settings

On This Page