Type alias NoteGenInput

NoteGenInput: {
    amount: string;
    backend: Backend;
    blinding?: Uint8Array;
    curve: Curve;
    denomination: string;
    exponentiation: string;
    hashFunction: HashFunction;
    index?: number;
    privateKey?: Uint8Array;
    protocol: NoteProtocol;
    secrets?: string;
    sourceChain: string;
    sourceIdentifyingData: string;
    targetChain: string;
    targetIdentifyingData: string;
    tokenSymbol: string;
    version?: string;
    width: string;
}

The note input used to generate a Note instance.

Param

The shielded pool protocol to use.

Param

The version of the note to use.

Param

The source chain id.

Param

source identifying data.

Param

The target chain id.

Param

target identifying data.

Param

The backend to use. Different values include 'Arkworks' and 'Circom'

Param

The hash function to use. Different values include 'Poseidon' and 'Pederson'

Param

The curve to use. Different values include 'Bn254' and 'Bls381'

Param

The token symbol to use.

Param

The amount to use.

Param

The denomination to use. Commonly used denominations include '18' for ETH and '12' for DOT

Param

The width to use. Related to the amount of secret parameters hashed together.

Param

Optional secrets to use. When passed, secret generation is skipped for the resulting note instance.

Param

The exponentiation to use. This is the exponentiation of the SBOX hash function component (for Poseidon)

Param

UTXO index. Useful identifying information for deposits in merkle trees.

Param

Utxo private key used for generation VAnchor notes

Param

Utxo blinding value used for generation VAnchor notes

Type declaration

  • amount: string
  • backend: Backend
  • Optional blinding?: Uint8Array
  • curve: Curve
  • denomination: string
  • exponentiation: string
  • hashFunction: HashFunction
  • Optional index?: number
  • Optional privateKey?: Uint8Array
  • protocol: NoteProtocol
  • Optional secrets?: string
  • sourceChain: string
  • sourceIdentifyingData: string
  • targetChain: string
  • targetIdentifyingData: string
  • tokenSymbol: string
  • Optional version?: string
  • width: string

Settings

Member Visibility

Theme

Generated using TypeDoc