2.4.1 • Published 1 year ago

@quantnetwork/overledger-core v2.4.1

Weekly downloads
8
License
Apache-2.0
Repository
github
Last release
1 year ago

@quantnetwork/overledger-core

Core Overledger SDK package.

Installation

Install using npm:

npm install @quantnetwork/overledger-core

Or, if you prefer using yarn:

yarn add @quantnetwork/overledger-core

API Reference

Modules

Classes

overledger-core

overledger-core.default

Core Overledger SDK class. Individual dlt packages must be installed manually.

overledger-core.log

**

OverledgerSDK

new OverledgerSDK(options)

ParamTypeDescription
optionsSDKOptionsThe DLT Options and Provider Options

Create the Overledger SDK

overledgerSDK.dlts

The object storing the DLTs loaded by the Overledger SDK

overledgerSDK.validateOptions(options)

ParamTypeDescription
optionsSDKOptionsThe DLT Options and Provider Options

Validate the provided Overledger SDK Options

overledgerSDK.loadDlt(config)

ParamTypeDescription
configDLTOptionsDLT name and an optional Private Key to use as the main account

Load the DLT in the Overledger SDK

Returns: AbstractDLT - The loaded DLT class

overledgerSDK.getEcho(echoRequest)

Param
echoRequest

Calls echoecho endpoint, just used to see if things connect

overledgerSDK.refreshAccessToken()

refresh access token

overledgerSDK.getTokensUsingClientIdAndSecret()

get new set of tokens using username, password, clientId and clientSecret

overledgerSDK.sign(unsignedData)

Param
unsignedData

Signing a prepared object