Class MintBuilder<M, HasPrivKey>

Builder for minting proofs from a quote.

Remarks

Bolt12 requires privkey by default, bolt11 only for locked quotes. The compiler will throw an error if bolt12 and privkey() is omitted: MintBuilder<"bolt12", false>' is not assignable...

Use this builder for the typed, first-class mint methods. For arbitrary or future mint methods, use the generic wallet.prepareMint(method, …) / wallet.completeMint() flow.

Example

const proofs = await wallet.ops
    	.mintBolt11(100, quote)
    	.asDeterministic() // counter 0 auto reserves
    	.onCountersReserved((info) => console.log(info))
    	.privkey('sk')
    	.run();

Type Parameters

M extends MintMethod
HasPrivKey extends boolean = M extends "bolt12" ? false : true

Index

Constructors

constructor

Methods

asCustom asDeterministic asFactory asP2PK asRandom keyset onCountersReserved prepare privkey proofsWeHave run

Constructors

constructor

new MintBuilder<
    M extends MintMethod,
    HasPrivKey extends boolean = M extends "bolt12" ? false : true,
>(
    wallet: Wallet,
    method: M,
    amount: AmountLike,
    quote: MintQuoteFor<M>,
): MintBuilder<M, HasPrivKey>
Type Parameters
- M extends MintMethod
- HasPrivKey extends boolean = M extends "bolt12" ? false : true
Parameters
- wallet: Wallet
- method: M
- amount: AmountLike
- quote: MintQuoteFor<M>
Returns MintBuilder<M, HasPrivKey>
- Defined in src/wallet/WalletOps.ts:530

Methods

asCustom

asCustom(data: OutputDataLike[]): MintBuilder<M, HasPrivKey>
Provide pre created OutputData for minted proofs.
Parameters
- data: OutputDataLike[]
  Fully formed OutputData for the final amount.
Returns MintBuilder<M, HasPrivKey>
- Defined in src/wallet/WalletOps.ts:596

asDeterministic

asDeterministic(
counter?: number,
denoms?: AmountLike[],
): MintBuilder<M, HasPrivKey>
Use deterministic outputs for the minted 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 MintBuilder<M, HasPrivKey>
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:560

asFactory

asFactory(
factory: OutputDataFactory,
denoms?: AmountLike[],
): MintBuilder<M, HasPrivKey>
Use a factory to generate OutputData for minted 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 MintBuilder<M, HasPrivKey>
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:586

asP2PK

asP2PK(options: P2PKOptions, denoms?: AmountLike[]): MintBuilder<M, HasPrivKey>
Use P2PK locked outputs for the minted 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 MintBuilder<M, HasPrivKey>
Remarks
If denoms specified, proofsWeHave() will have no effect.
- Defined in src/wallet/WalletOps.ts:573

asRandom

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

keyset

keyset(id: string): MintBuilder<M, HasPrivKey>
Use a specific keyset for the operation.
Parameters
- id: string
  Keyset id to use for mint keys and fee lookup.
Returns MintBuilder<M, HasPrivKey>
- Defined in src/wallet/WalletOps.ts:606

onCountersReserved

onCountersReserved(cb: OnCountersReserved): MintBuilder<M, HasPrivKey>
Receive a callback once counters are atomically reserved for deterministic outputs.
Parameters
- cb: OnCountersReserved
  Called with OperationCounters when counters are reserved.
Returns MintBuilder<M, HasPrivKey>
- Defined in src/wallet/WalletOps.ts:640

prepare

prepare(
    this: MintBuilder<M, true>,
): Promise<
    M extends "bolt11"
        ? MintPreview<MintQuoteBolt11Response>
        : MintPreview<MintQuoteBolt12Response>,
>
Prepare the mint.
Parameters
- this: MintBuilder<M, true>
Returns Promise<
    M extends "bolt11"
        ? MintPreview<MintQuoteBolt11Response>
        : MintPreview<MintQuoteBolt12Response>,
>
A MintPreview containing the payload and output data needed to complete the mint.

Remarks
Call wallet.completeMint(MintPreview) to complete the mint. This method can only be called for bolt12 quotes when .privkey() is set.
- Defined in src/wallet/WalletOps.ts:653

privkey

privkey(k: string): MintBuilder<M, true>
Private key to sign locked mint quotes.
Parameters
- k: string
  Private key for locked quotes.
Returns MintBuilder<M, true>
- Defined in src/wallet/WalletOps.ts:616

proofsWeHave

proofsWeHave(p: Pick<Proof, "amount">[]): MintBuilder<M, HasPrivKey>
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 MintBuilder<M, HasPrivKey>
Remarks
Has no effect if denominations (custom split) was specified.
- Defined in src/wallet/WalletOps.ts:630

run

run(this: MintBuilder<M, true>): Promise<Proof[]>
Execute minting against the quote.
Parameters
- this: MintBuilder<M, true>
Returns Promise<Proof[]>
The newly minted proofs.

Remarks
This is equivalent to const preview = await prepare(); await wallet.completeMint(preview). This method can only be called for bolt12 quotes when .privkey() is set.
- Defined in src/wallet/WalletOps.ts:707

Class MintBuilder<M, HasPrivKey>

Remarks

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MintBuilder<M, HasPrivKey>

Methods

asCustom

Parameters

Returns MintBuilder<M, HasPrivKey>

asDeterministic

Parameters

Returns MintBuilder<M, HasPrivKey>

Remarks

asFactory

Parameters

Returns MintBuilder<M, HasPrivKey>

Remarks

asP2PK

Parameters

Returns MintBuilder<M, HasPrivKey>

Remarks

asRandom

Parameters

Returns MintBuilder<M, HasPrivKey>

Remarks

keyset

Parameters

Returns MintBuilder<M, HasPrivKey>

onCountersReserved

Parameters

Returns MintBuilder<M, HasPrivKey>

prepare

Parameters

Returns Promise< M extends "bolt11" ? MintPreview<MintQuoteBolt11Response> : MintPreview<MintQuoteBolt12Response>,>

Remarks

privkey

Parameters

Returns MintBuilder<M, true>

proofsWeHave

Parameters

Returns MintBuilder<M, HasPrivKey>

Remarks

run

Parameters

Returns Promise<Proof[]>

Remarks

Settings

On This Page

Returns Promise<
M extends "bolt11"
? MintPreview<MintQuoteBolt11Response>
: MintPreview<MintQuoteBolt12Response>,
>