Class InMemorySpendingKey

Description

holds the spending key, create proof and signature for spend descriptions can instantiate from mnemonic word list or decrypt a encrypted spending key with access to instantiate a InMemoryViewingKey

Index

Constructors

Methods

getProvingKey getSaplingViewingKeyProvider prepareSpendDescription signSpendDescription fromMnemonic

Constructors

constructor

new InMemorySpendingKey(spendingKey, password?): InMemorySpendingKey
Parameters
- spendingKey: string
  unencrypted sask... or encrypted MMXj...
- Optional password: string
  required for MMXj encrypted keys
Returns InMemorySpendingKey
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:26

Methods

getProvingKey

getProvingKey(): Promise<string>
Returns Promise<string>
Description
Return a proof authorizing key from the configured spending key
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:136

getSaplingViewingKeyProvider

getSaplingViewingKeyProvider(): Promise<InMemoryViewingKey>
Returns Promise<InMemoryViewingKey>
InMemoryViewingKey instantiated class
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:58

prepareSpendDescription

prepareSpendDescription(parametersSpendProof): Promise<Omit<SaplingSpendDescription, "signature">>
Parameters
- parametersSpendProof: ParametersSpendProof
Returns Promise<Omit<SaplingSpendDescription, "signature">>
The unsigned spend description

Description
Prepare an unsigned sapling spend description using the spending key
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:80

signSpendDescription

signSpendDescription(parametersSpendSig): Promise<SaplingTransactionInput>
Parameters
- parametersSpendSig: ParametersSpendSig
Returns Promise<SaplingTransactionInput>
The signed spend description

Description
Sign a sapling spend description
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:109

`Static` fromMnemonic

fromMnemonic(mnemonic, derivationPath?): Promise<InMemorySpendingKey>
Parameters
- mnemonic: string
  string of words
- derivationPath: string = 'm/'
  tezos current standard 'm/'
Returns Promise<InMemorySpendingKey>
InMemorySpendingKey class instantiated
- Defined in packages/taquito-sapling/src/sapling-keys/in-memory-spending-key.ts:36

Generated using TypeDoc