Class CashuAuthMint

Class represents Cashu Auth Mint API. This class contains Lower level functions that are implemented by CashuAuthWallet.

Index

Constructors

Accessors

Methods

getKeys getKeySets mint getKeys getKeySets mint

Constructors

constructor

new CashuAuthMint(
_mintUrl: string,
_customRequest?: <T>(options: RequestOptions) => Promise<T>,
): CashuAuthMint
Parameters
- _mintUrl: string
  Requires mint URL to create this object.
- Optional_customRequest: <T>(options: RequestOptions) => Promise<T>
  If passed, use custom request implementation for network communication with the mint.
Returns CashuAuthMint
- Defined in src/auth/CashuAuthMint.ts:20

Accessors

mintUrl

get mintUrl(): string
Returns string
- Defined in src/auth/CashuAuthMint.ts:28

Methods

getKeys

getKeys(keysetId?: string, mintUrl?: string): Promise<MintActiveKeys>
Get the mints public NUT-22 keys.
Parameters
- OptionalkeysetId: string
  Optional param to get the keys for a specific keyset. If not specified, the keys from all active keysets are fetched.
- OptionalmintUrl: string
Returns Promise<MintActiveKeys>
The mints public keys.
- Defined in src/auth/CashuAuthMint.ts:109

getKeySets

getKeySets(): Promise<MintAllKeysets>
Get the mints NUT-22 keysets in no specific order.

Returns Promise<MintAllKeysets>
All the mints past and current keysets.
- Defined in src/auth/CashuAuthMint.ts:139

mint

mint(
mintPayload: BlindAuthMintPayload,
clearAuthToken: string,
): Promise<BlindAuthMintResponse>
Mints new Blinded Authentication tokens by requesting blind signatures on the provided outputs.
Parameters
- mintPayload: BlindAuthMintPayload
  Payload containing the outputs to get blind signatures on.
- clearAuthToken: string
  A NUT-21 clear auth token.
Returns Promise<BlindAuthMintResponse>
Serialized blinded signatures.
- Defined in src/auth/CashuAuthMint.ts:71

`Static`getKeys

getKeys(
    mintUrl: string,
    keysetId?: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<MintActiveKeys>
Get the mints public NUT-22 keys.
Parameters
- mintUrl: string
- OptionalkeysetId: string
  Optional param to get the keys for a specific keyset. If not specified, the keys from all active keysets are fetched.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<MintActiveKeys>
- Defined in src/auth/CashuAuthMint.ts:84

`Static`getKeySets

getKeySets(
mintUrl: string,
customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<MintAllKeysets>
Get the mints NUT-22 keysets in no specific order.
Parameters
- mintUrl: string
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<MintAllKeysets>
All the mints past and current keysets.
- Defined in src/auth/CashuAuthMint.ts:124

`Static`mint

mint(
    mintUrl: string,
    mintPayload: BlindAuthMintPayload,
    clearAuthToken: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<BlindAuthMintResponse>
Mints new Blinded Authentication tokens by requesting blind signatures on the provided outputs.
Parameters
- mintUrl: string
- mintPayload: BlindAuthMintPayload
  Payload containing the outputs to get blind signatures on.
- clearAuthToken: string
  A NUT-21 clear auth token.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<BlindAuthMintResponse>
Serialized blinded signatures.
- Defined in src/auth/CashuAuthMint.ts:41