Class CashuMint

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

Hierarchy

CashuMint

Index

Constructors

constructor

Properties

_mintUrl

Accessors

mintUrl

Methods

check checkFees getInfo getKeySets getKeys melt mint requestMint split check checkFees getInfo getKeySets getKeys melt mint requestMint split

Constructors

constructor

new CashuMint(_mintUrl): CashuMint
Parameters
- _mintUrl: string
  
  requires mint URL to create this object
Returns CashuMint
- Defined in src/CashuMint.ts:25

Properties

`Private` _mintUrl

_mintUrl: string

requires mint URL to create this object

Accessors

mintUrl

get mintUrl(): string
Returns string
- Defined in src/CashuMint.ts:27

Methods

check

check(checkPayload): Promise<CheckSpendableResponse>
Checks if specific proofs have already been redeemed
Parameters
- checkPayload: CheckSpendablePayload
Returns Promise<CheckSpendableResponse>

redeemed and unredeemed ordered list of booleans
- Defined in src/CashuMint.ts:267

checkFees

checkFees(checkfeesPayload): Promise<{
fee: number;
}>
Estimate fees for a given LN invoice
Parameters
- checkfeesPayload: {
  pr: string;
  }
  
  Payload containing LN invoice that needs to get a fee estimate
  - pr: string
Returns Promise<{
fee: number;
}>

estimated Fee
- Defined in src/CashuMint.ts:237

getInfo

getInfo(): Promise<GetInfoResponse>
fetches mints info at the /info endpoint

Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:41

getKeySets

getKeySets(): Promise<{
keysets: string[];
}>
Get the mints keysets in no specific order

Returns Promise<{
keysets: string[];
}>

all the mints past and current keysets.
- Defined in src/CashuMint.ts:144

getKeys

getKeys(keysetId?): Promise<MintKeys>
Get the mints public keys
Parameters
- Optional keysetId: string
  
  optional param to get the keys for a specific keyset. If not specified, the keys from the active keyset are fetched
Returns Promise<MintKeys>

the mints public keys
- Defined in src/CashuMint.ts:127

melt

melt(meltPayload): Promise<MeltResponse>
Ask mint to perform a melt operation. This pays a lightning invoice and destroys tokens matching its amount + fees
Parameters
- meltPayload: MeltPayload
Returns Promise<MeltResponse>
- Defined in src/CashuMint.ts:203

mint

mint(payloads, hash): Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>
Requests the mint to perform token minting after the LN invoice has been paid
Parameters
- payloads: {
  outputs: SerializedBlindedMessage[];
  }
  
  outputs (Blinded messages) that can be written
  - outputs: SerializedBlindedMessage[]
- hash: string
  
  hash (id) used for by the mint to keep track of wether the invoice has been paid yet
Returns Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>

serialized blinded signatures
- Defined in src/CashuMint.ts:105

requestMint

requestMint(amount): Promise<RequestMintResponse>
Starts a minting process by requesting an invoice from the mint
Parameters
- amount: number
  
  Amount requesting for mint.
Returns Promise<RequestMintResponse>

the mint will create and return a Lightning invoice for the specified amount
- Defined in src/CashuMint.ts:62

split

split(splitPayload): Promise<SplitResponse>
Ask mint to perform a split operation
Parameters
- splitPayload: SplitPayload
  
  data needed for performing a token split
Returns Promise<SplitResponse>

split tokens
- Defined in src/CashuMint.ts:172

`Static` check

check(mintUrl, checkPayload): Promise<CheckSpendableResponse>
Checks if specific proofs have already been redeemed
Parameters
- mintUrl: string
- checkPayload: CheckSpendablePayload
Returns Promise<CheckSpendableResponse>

redeemed and unredeemed ordered list of booleans
- Defined in src/CashuMint.ts:246

`Static` checkFees

checkFees(mintUrl, checkfeesPayload): Promise<{
fee: number;
}>
Estimate fees for a given LN invoice
Parameters
- mintUrl: string
- checkfeesPayload: {
  pr: string;
  }
  
  Payload containing LN invoice that needs to get a fee estimate
  - pr: string
Returns Promise<{
fee: number;
}>

estimated Fee
- Defined in src/CashuMint.ts:212

`Static` getInfo

getInfo(mintUrl): Promise<GetInfoResponse>
fetches mints info at the /info endpoint
Parameters
- mintUrl: string
Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:34

`Static` getKeySets

getKeySets(mintUrl): Promise<{
keysets: string[];
}>
Get the mints keysets in no specific order
Parameters
- mintUrl: string
Returns Promise<{
keysets: string[];
}>

all the mints past and current keysets.
- Defined in src/CashuMint.ts:135

`Static` getKeys

getKeys(mintUrl, keysetId?): Promise<MintKeys>
Get the mints public keys
Parameters
- mintUrl: string
- Optional keysetId: string
  
  optional param to get the keys for a specific keyset. If not specified, the keys from the active keyset are fetched
Returns Promise<MintKeys>
- Defined in src/CashuMint.ts:114

`Static` melt

melt(mintUrl, meltPayload): Promise<MeltResponse>
Ask mint to perform a melt operation. This pays a lightning invoice and destroys tokens matching its amount + fees
Parameters
- mintUrl: string
- meltPayload: MeltPayload
Returns Promise<MeltResponse>
- Defined in src/CashuMint.ts:181

`Static` mint

mint(mintUrl, payloads, hash): Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>
Requests the mint to perform token minting after the LN invoice has been paid
Parameters
- mintUrl: string
- payloads: {
  outputs: SerializedBlindedMessage[];
  }
  
  outputs (Blinded messages) that can be written
  - outputs: SerializedBlindedMessage[]
- hash: string
  
  hash (id) used for by the mint to keep track of wether the invoice has been paid yet
Returns Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>

serialized blinded signatures
- Defined in src/CashuMint.ts:72

`Static` requestMint

requestMint(mintUrl, amount): Promise<RequestMintResponse>
Starts a minting process by requesting an invoice from the mint
Parameters
- mintUrl: string
- amount: number
  
  Amount requesting for mint.
Returns Promise<RequestMintResponse>

the mint will create and return a Lightning invoice for the specified amount
- Defined in src/CashuMint.ts:50

`Static` split

split(mintUrl, splitPayload): Promise<SplitResponse>
Ask mint to perform a split operation
Parameters
- mintUrl: string
- splitPayload: SplitPayload
  
  data needed for performing a token split
Returns Promise<SplitResponse>

split tokens
- Defined in src/CashuMint.ts:154

Class CashuMint

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_mintUrl: string

Returns CashuMint

Properties

Private _mintUrl

Accessors

mintUrl

Returns string

Methods

check

Parameters

checkPayload: CheckSpendablePayload

Returns Promise<CheckSpendableResponse>

checkFees

Parameters

checkfeesPayload: { pr: string; }

pr: string

Returns Promise<{ fee: number; }>

getInfo

Returns Promise<GetInfoResponse>

getKeySets

Returns Promise<{ keysets: string[]; }>

getKeys

Parameters

Optional keysetId: string

Returns Promise<MintKeys>

melt

Parameters

meltPayload: MeltPayload

Returns Promise<MeltResponse>

mint

Parameters

payloads: { outputs: SerializedBlindedMessage[]; }

outputs: SerializedBlindedMessage[]

hash: string

Returns Promise<{ promises: SerializedBlindedSignature[]; } & ApiError>

requestMint

Parameters

amount: number

Returns Promise<RequestMintResponse>

split

Parameters

splitPayload: SplitPayload

Returns Promise<SplitResponse>

Static check

Parameters

mintUrl: string

checkPayload: CheckSpendablePayload

Returns Promise<CheckSpendableResponse>

Static checkFees

Parameters

mintUrl: string

checkfeesPayload: { pr: string; }

pr: string

Returns Promise<{ fee: number; }>

Static getInfo

Parameters

mintUrl: string

Returns Promise<GetInfoResponse>

Static getKeySets

Parameters

mintUrl: string

Returns Promise<{ keysets: string[]; }>

Static getKeys

Parameters

mintUrl: string

Optional keysetId: string

Returns Promise<MintKeys>

Static melt

Parameters

mintUrl: string

`Private` _mintUrl

checkfeesPayload: {
pr: string;
}

Returns Promise<{
fee: number;
}>

Returns Promise<{
keysets: string[];
}>

`Optional` keysetId: string

payloads: {
outputs: SerializedBlindedMessage[];
}

Returns Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>

`Static` check

`Static` checkFees

checkfeesPayload: {
pr: string;
}

Returns Promise<{
fee: number;
}>

`Static` getInfo

`Static` getKeySets

Returns Promise<{
keysets: string[];
}>

`Static` getKeys

`Optional` keysetId: string

`Static` melt

`Static` mint

payloads: {
outputs: SerializedBlindedMessage[];
}

Returns Promise<{
promises: SerializedBlindedSignature[];
} & ApiError>

`Static` requestMint

`Static` split