Skip to main content

ReceiveOptions

@cashu/cashu-ts

@cashu/cashu-ts / ReceiveOptions

Type Alias: ReceiveOptions

ReceiveOptions = object

Defined in: cashu-ts/src/model/types/index.ts:27

Param​

Optional configuration for token processing:

  • keysetId: Override the default keyset ID with a custom one fetched from the /keysets endpoint.
  • outputAmounts: Specify output amounts for keeping or sending.
  • proofsWeHave: Provide stored proofs for optimal output derivation.
  • counter: Set a counter to deterministically derive secrets (requires CashuWallet initialized with a seed phrase).
  • pubkey: Lock eCash to a public key (non-deterministic, even with a counter set).
  • privkey: Create a signature for token secrets.
  • requireDleq: Verify DLEQ proofs for all provided proofs; reject the token if any proof fails verification.

Properties​

counter?​

optional counter: number

Defined in: cashu-ts/src/model/types/index.ts:31

keysetId?​

optional keysetId: string

Defined in: cashu-ts/src/model/types/index.ts:28

outputAmounts?​

optional outputAmounts: OutputAmounts

Defined in: cashu-ts/src/model/types/index.ts:29

outputData?​

optional outputData: OutputDataLike[] | OutputDataFactory

Defined in: cashu-ts/src/model/types/index.ts:35

p2pk?​

optional p2pk: object

Defined in: cashu-ts/src/model/types/index.ts:36

locktime?​

optional locktime: number

pubkey​

pubkey: string

refundKeys?​

optional refundKeys: string[]

privkey?​

optional privkey: string

Defined in: cashu-ts/src/model/types/index.ts:33

proofsWeHave?​

optional proofsWeHave: Proof[]

Defined in: cashu-ts/src/model/types/index.ts:30

pubkey?​

optional pubkey: string

Defined in: cashu-ts/src/model/types/index.ts:32

requireDleq?​

optional requireDleq: boolean

Defined in: cashu-ts/src/model/types/index.ts:34