Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration parameters used to initialize the Nash Protocol.

Used to generate a Config.

Hierarchy

  • InitParams

Index

Properties

aead

aead: AEAD

A user's AEAD. When initializing, this is received from the CAS after authenticating.

Refer to the documentation for the AEAD interface.

Optional assetData

assetData: undefined | object

A record of asset names to asset parameters.

For more information, refer to the Asset interface.

encryptionKey

encryptionKey: Buffer

The secret key needed to decrypt the AEAD. If operating on the AEAD returned by the CAS after authenticating, this should be the encryption key derived from the user's password.

Refer to the documentation for getHKDFKeysFromPassword.md.

Optional marketData

marketData: undefined | object

A record of market names to market parameters.

For more information, refer to the Market interface.

Optional net

net: "MainNet" | "TestNet" | "LocalNet"

The blockchain network to use.

walletIndices

walletIndices: object

A record of wallet types to chain index.

For more information, refer to the BIP-44 spec.

Type declaration

  • [key: string]: number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc