Class CashuMint

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

Hierarchy

CashuMint

Index

Constructors

constructor

new CashuMint(_mintUrl, _customRequest?): CashuMint
Parameters
- _mintUrl: string
  
  requires mint URL to create this object
- Optional _customRequest: (<T>(options) => Promise<T>)
  
  if passed, use custom request implementation for network communication with the mint
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns CashuMint
- Defined in src/CashuMint.ts:26

Properties

`Private` `Optional` _customRequest

_customRequest?: (<T>(options) => Promise<T>)

Type declaration

- <T>(options): Promise<T>
- if passed, use custom request implementation for network communication with the mint
  Type Parameters
  - T
  Parameters
  - options: RequestOptions
  Returns Promise<T>

`Private` _mintUrl

_mintUrl: string

requires mint URL to create this object

Accessors

mintUrl

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

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:300

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:267

getInfo

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

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

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:162

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:141

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:233

mint

mint(payloads, hash): Promise<{
promises: SerializedBlindedSignature[];
}>
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[];
}>
serialized blinded signatures
- Defined in src/CashuMint.ts:112

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:76

restore

restore(restorePayload): Promise<PostRestoreResponse>
Parameters
- restorePayload: {
  outputs: SerializedBlindedMessage[];
  }
  - outputs: SerializedBlindedMessage[]
Returns Promise<PostRestoreResponse>
- Defined in src/CashuMint.ts:323

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:196

`Static` check

check(mintUrl, checkPayload, customRequest?): Promise<CheckSpendableResponse>
Checks if specific proofs have already been redeemed
Parameters
- mintUrl: string
- checkPayload: CheckSpendablePayload
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<CheckSpendableResponse>
redeemed and unredeemed ordered list of booleans
- Defined in src/CashuMint.ts:277

`Static` checkFees

checkFees(mintUrl, checkfeesPayload, customRequest?): 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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<{
fee: number;
}>
estimated Fee
- Defined in src/CashuMint.ts:243

`Static` getInfo

getInfo(mintUrl, customRequest?): Promise<GetInfoResponse>
fetches mints info at the /info endpoint
Parameters
- mintUrl: string
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:40

`Static` getKeySets

getKeySets(mintUrl, customRequest?): Promise<{
keysets: string[];
}>
Get the mints keysets in no specific order
Parameters
- mintUrl: string
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<{
keysets: string[];
}>
all the mints past and current keysets.
- Defined in src/CashuMint.ts:150

`Static` getKeys

getKeys(mintUrl, keysetId?, customRequest?): 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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MintKeys>
- Defined in src/CashuMint.ts:122

`Static` melt

melt(mintUrl, meltPayload, customRequest?): 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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MeltResponse>
- Defined in src/CashuMint.ts:206

`Static` mint

mint(mintUrl, payloads, hash, customRequest?): Promise<{
promises: SerializedBlindedSignature[];
}>
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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<{
promises: SerializedBlindedSignature[];
}>
serialized blinded signatures
- Defined in src/CashuMint.ts:87

`Static` requestMint

requestMint(mintUrl, amount, customRequest?): Promise<RequestMintResponse>
Starts a minting process by requesting an invoice from the mint
Parameters
- mintUrl: string
- amount: number
  
  Amount requesting for mint.
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<RequestMintResponse>
the mint will create and return a Lightning invoice for the specified amount
- Defined in src/CashuMint.ts:60

`Static` restore

restore(mintUrl, restorePayload, customRequest?): Promise<PostRestoreResponse>
Parameters
- mintUrl: string
- restorePayload: {
  outputs: SerializedBlindedMessage[];
  }
  - outputs: SerializedBlindedMessage[]
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<PostRestoreResponse>
- Defined in src/CashuMint.ts:304

`Static` split

split(mintUrl, splitPayload, customRequest?): Promise<SplitResponse>
Ask mint to perform a split operation
Parameters
- mintUrl: string
- splitPayload: SplitPayload
  
  data needed for performing a token split
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<SplitResponse>
split tokens
- Defined in src/CashuMint.ts:173

Class CashuMint

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_mintUrl: string

Optional _customRequest: (<T>(options) => Promise<T>)

Type Parameters

T

Parameters

options: RequestOptions

Returns Promise<T>

Returns CashuMint

Properties

Private Optional _customRequest

Type declaration

Type Parameters

T

Parameters

options: RequestOptions

Returns Promise<T>

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[]; }>

requestMint

Parameters

amount: number

Returns Promise<RequestMintResponse>

restore

Parameters

restorePayload: { outputs: SerializedBlindedMessage[]; }

outputs: SerializedBlindedMessage[]

Returns Promise<PostRestoreResponse>

split

Parameters

splitPayload: SplitPayload

Returns Promise<SplitResponse>

Static check

Parameters

mintUrl: string

checkPayload: CheckSpendablePayload

Optional customRequest: (<T>(options) => Promise<T>)

Type Parameters

T

Parameters

options: RequestOptions

`Optional` _customRequest: (<T>(options) => Promise<T>)

`Private` `Optional` _customRequest

`Private` _mintUrl

checkfeesPayload: {
pr: string;
}

Returns Promise<{
fee: number;
}>

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

`Optional` keysetId: string

payloads: {
outputs: SerializedBlindedMessage[];
}

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

restorePayload: {
outputs: SerializedBlindedMessage[];
}

`Static` check

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` checkFees

checkfeesPayload: {
pr: string;
}

`Optional` customRequest: (<T>(options) => Promise<T>)

Returns Promise<{
fee: number;
}>

`Static` getInfo

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` getKeySets

`Optional` customRequest: (<T>(options) => Promise<T>)

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

`Static` getKeys

`Optional` keysetId: string

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` melt

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` mint

payloads: {
outputs: SerializedBlindedMessage[];
}

`Optional` customRequest: (<T>(options) => Promise<T>)

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

`Static` requestMint