Class MeltOnchainBuilder`Experimental`

Builder for melting proofs via an onchain Bitcoin transaction.

Remarks

Any overage above the selected quote amount and fee option is offered as NUT-08 change.

Example

// Basic onchain melt (1 fee option)
const result = await wallet.ops.meltOnchain(quote, proofs).privkey('sk').run();

// with custom keyset ID and selected fee option
await wallet.ops
  .meltOnchain(quote, proofs)
  .keyset('01abc...')
  .privkey('sk')
  .feeIndex(0)
  .run();

Onchain support follows NUT-30 semantics and may change.

Index

Constructors

constructor

Methods

feeIndex keyset privkey run

Constructors

constructor

new MeltOnchainBuilder(
    wallet: Wallet,
    quote: MeltQuoteOnchainResponse,
    proofs: ProofLike[],
): MeltOnchainBuilder
Experimental
Parameters
- wallet: Wallet
- quote: MeltQuoteOnchainResponse
- proofs: ProofLike[]
Returns MeltOnchainBuilder
- Defined in src/wallet/WalletOps.ts:928

Methods

feeIndex

feeIndex(index: number): MeltOnchainBuilder
Experimental
Select a fee option by its fee_index.
Parameters
- index: number
  fee_index value from the quote's fee_options.
Returns MeltOnchainBuilder
- Defined in src/wallet/WalletOps.ts:959

keyset

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

privkey

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

run

run(): Promise<MeltProofsResponse<MeltQuoteOnchainResponse>>
Experimental
Execute the onchain melt against the quote.

Returns Promise<MeltProofsResponse<MeltQuoteOnchainResponse>>
The melt result: { quote, change, outputData }. Use outputData with the polled quote's change to unblind deferred change after broadcast.
- Defined in src/wallet/WalletOps.ts:970

Class MeltOnchainBuilder`Experimental`

Remarks

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MeltOnchainBuilder

Methods

feeIndex

Parameters

Returns MeltOnchainBuilder

keyset

Parameters

Returns MeltOnchainBuilder

privkey

Parameters

Returns MeltOnchainBuilder

run

Returns Promise<MeltProofsResponse<MeltQuoteOnchainResponse>>

Settings

On This Page

Class MeltOnchainBuilderExperimental

Remarks

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MeltOnchainBuilder

Methods

feeIndex

Parameters

Returns MeltOnchainBuilder

keyset

Parameters

Returns MeltOnchainBuilder

privkey

Parameters

Returns MeltOnchainBuilder

run

Returns Promise<MeltProofsResponse<MeltQuoteOnchainResponse>>

Settings

On This Page

Class MeltOnchainBuilder`Experimental`