@quantnetwork/overledger-types
Package including all the types used by the Overledger SDK.
Installation
Install using npm:
npm install @quantnetwork/overledger-types
Or, if you prefer using yarn:
yarn add @quantnetwork/overledger-types
Reference
Modules
Typedefs
-
Account :
Object -
An Overledger Account instance for a single DLT.
-
DLTOptions :
Object -
Options for loading a DLT in the SDK.
-
NetworkOptions :
string -
Overledger network options.
-
ProviderOptions :
Object -
Overledger network provider options.
-
SDKOptions :
Object -
Overledger SDK options.
overledger-types
overledger-types.DltNameOptions
Account
Properties
| Name | Type | Description |
|---|---|---|
| privateKey | string |
The private key of the account, used for signing transactions. |
| address | string |
The address of the account, used for receiving messages |
| publicKey | string |
The public key of the account. The address parameter will be a representation of this public key. |
| password | string |
For some accounts, they may be protected by a password, or a password is used instead of a private key |
| provider | string |
If the account is stored or managed not by the user, then this person is the provider |
An Overledger Account instance for a single DLT.
DLTOptions
Properties
| Name | Type | Description |
|---|---|---|
| dlt | string |
The distributed ledger technology. |
| [privateKey] | string |
The private key of an account for the respecitve dlt. |
Options for loading a DLT in the SDK.
NetworkOptions
Overledger network options.
ProviderOptions
Properties
| Name | Type | Description |
|---|---|---|
| [network] | NetworkOptions |
The network, either testnet, mainnet or custom. |
| [timeout] | number |
Request timeout period specified in milliseconds. |
Overledger network provider options.
SDKOptions
Properties
| Name | Type | Description |
|---|---|---|
| dlts | Array.<DLTOptions> |
The dlts to be loaded. |
| [provider] | ProviderOptions |
The network provider options. |
Overledger SDK options.