open-index/open-npm huggingface dataset:
npm package: @quantnetwork/overledger-aws-provider
Description: Quant Network Overledger aws provider package to be used by the other packages
Latest version: 2.3.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-provider

Class used for the [Overledger SDK][repo] Gateway connection.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-provider
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-provider
```

## API Reference

<a name="module_overledger-aws-provider"></a>

## overledger-aws-provider
npm package: @quantnetwork/overledger-bundle
Description: Quant Network Overledger software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-bundle

This is the suite of packages of the [Overledger SDK][repo]. It bundles together the packages required for support of all availabled DLTS. Please read the official [documentation][docs] for more.

## Installation

```bash
npm install @quantnetwork/overledger-bundle
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-bundle
```
npm package: @quantnetwork/overledger-dlt-abstract
Description: Quant Network Overledger Bitcoin software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-dlt-abstract

[Overledger SDK][repo] abstract class for dlt functions.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-dlt-abstract
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-dlt-abstract
```

## API Reference

<a name="module_overledger-dlt-abstract"></a>

## overledger-dlt-abstract

* [overledger-dlt-abstract](#module_overledger-dlt-abstract)

    * [.AbstractDLT](#module_overledger-dlt-abstract.AbstractDLT)

        * [new AbstractDLT(sdk)](#new_module_overledger-dlt-abstract.AbstractDLT_new)

        * [.createAccount()](#module_overledger-dlt-abstract.AbstractDLT+createAccount)

        * [.setAccount(AccountInfo)](#module_overledger-dlt-abstract.AbstractDLT+setAccount)

        * [.getEcho()](#module_overledger-dlt-abstract.AbstractDLT+getEcho)

    * [.default](#module_overledger-dlt-abstract.default)


<a name="module_overledger-dlt-abstract.AbstractDLT"></a>

### *overledger-dlt-abstract*.AbstractDLT

* [.AbstractDLT](#module_overledger-dlt-abstract.AbstractDLT)

    * [new AbstractDLT(sdk)](#new_module_overledger-dlt-abstract.AbstractDLT_new)

    * [.createAccount()](#module_overledger-dlt-abstract.AbstractDLT+createAccount)

    * [.setAccount(AccountInfo)](#module_overledger-dlt-abstract.AbstractDLT+setAccount)

    * [.getEcho()](#module_overledger-dlt-abstract.AbstractDLT+getEcho)


<a name="new_module_overledger-dlt-abstract.AbstractDLT_new"></a>

#### new AbstractDLT(sdk)

| Param | Type |
| --- | --- |
| sdk | <code>any</code> | 

<a name="module_overledger-dlt-abstract.AbstractDLT+createAccount"></a>

#### *abstractDLT*.createAccount()
Create an account for a specific DLT

Abstract method to be implemented in each DLT

<a name="module_overledger-dlt-abstract.AbstractDLT+setAccount"></a>

#### *abstractDLT*.setAccount(AccountInfo)

| Param | Type | Description |
| --- | --- | --- |
| AccountInfo | <code>Account</code> | The standardised Account Object |

Set an account for signing transactions for a specific DLT

Abstract method to be implemented in each DLT

<a name="module_overledger-dlt-abstract.AbstractDLT+getEcho"></a>

#### *abstractDLT*.getEcho()
<a name="module_overledger-dlt-abstract.default"></a>

### *overledger-dlt-abstract*.default
Abstract class for DLT modules. All DLT packages need to extend this class.
npm package: @quantnetwork/overledger-dlt-bitcoin
Description: Quant Network Overledger Bitcoin software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-dlt-bitcoin

[Overledger SDK][repo] module for interaction with the Bitcoin distributed ledger technology.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-dlt-bitcoin
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-dlt-bitcoin
```

## API Reference

## Modules

<dl>
<dt><a href="#module_overledger-dlt-bitcoin">overledger-dlt-bitcoin</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Bitcoin">Bitcoin</a></dt>
<dd></dd>
</dl>

<a name="module_overledger-dlt-bitcoin"></a>

## overledger-dlt-bitcoin

* [overledger-dlt-bitcoin](#module_overledger-dlt-bitcoin)

    * [.default](#module_overledger-dlt-bitcoin.default)

    * [.log](#module_overledger-dlt-bitcoin.log)


<a name="module_overledger-dlt-bitcoin.default"></a>

### *overledger-dlt-bitcoin*.default
Development package for Bitcoin blockchain.

<a name="module_overledger-dlt-bitcoin.log"></a>

### *overledger-dlt-bitcoin*.log
<a name="Bitcoin"></a>

## Bitcoin

* [Bitcoin](#Bitcoin)

    * [new Bitcoin(sdk, options)](#new_Bitcoin_new)

    * [.name](#Bitcoin+name)

    * [.symbol](#Bitcoin+symbol)

    * [.createAccount()](#Bitcoin+createAccount)

    * [.setAccount(accountInfo)](#Bitcoin+setAccount)


<a name="new_Bitcoin_new"></a>

### new Bitcoin(sdk, options)

| Param | Type | Description |
| --- | --- | --- |
| sdk | <code>any</code> | the sdk instance |
| options | <code>Object</code> | any additional options to instantiate this dlt |

<a name="Bitcoin+name"></a>

### *bitcoin*.name
Name of the DLT

<a name="Bitcoin+symbol"></a>

### *bitcoin*.symbol
Symbol of the DLT

<a name="Bitcoin+createAccount"></a>

### *bitcoin*.createAccount()
Create a Bitcoin account

**Returns**: <code>Account</code> - the new Bitcoin account  
<a name="Bitcoin+setAccount"></a>

### *bitcoin*.setAccount(accountInfo)

| Param | Type | Description |
| --- | --- | --- |
| accountInfo | <code>Account</code> | The standardised account information |

Set an account for signing transactions for a specific DLT
npm package: @quantnetwork/overledger-dlt-ethereum
Description: Quant Network Overledger Ethereum software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-dlt-ethereum

[Overledger SDK][repo] module for interaction with the Ethereum distributed ledger technology.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-dlt-ethereum
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-dlt-ethereum
```

## API Reference

## Modules

<dl>
<dt><a href="#module_overledger-dlt-ethereum">overledger-dlt-ethereum</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Ethereum">Ethereum</a></dt>
<dd></dd>
</dl>

<a name="module_overledger-dlt-ethereum"></a>

## overledger-dlt-ethereum

* [overledger-dlt-ethereum](#module_overledger-dlt-ethereum)

    * [.default](#module_overledger-dlt-ethereum.default)

    * [.log](#module_overledger-dlt-ethereum.log)


<a name="module_overledger-dlt-ethereum.default"></a>

### *overledger-dlt-ethereum*.default
Development package for Ethereum.

<a name="module_overledger-dlt-ethereum.log"></a>

### *overledger-dlt-ethereum*.log
<a name="Ethereum"></a>

## Ethereum

* [Ethereum](#Ethereum)

    * [new Ethereum(sdk)](#new_Ethereum_new)

    * [.name](#Ethereum+name)

    * [.symbol](#Ethereum+symbol)

    * [.createAccount()](#Ethereum+createAccount)

    * [.setAccount(accountInfo)](#Ethereum+setAccount)


<a name="new_Ethereum_new"></a>

### new Ethereum(sdk)

| Param | Type | Description |
| --- | --- | --- |
| sdk | <code>any</code> | the sdk instance |

<a name="Ethereum+name"></a>

### *ethereum*.name
Name of the DLT

<a name="Ethereum+symbol"></a>

### *ethereum*.symbol
Symbol of the DLT

<a name="Ethereum+createAccount"></a>

### *ethereum*.createAccount()
Create an Ethereum account

**Returns**: <code>Account</code> - the new Ethereum account  
<a name="Ethereum+setAccount"></a>

### *ethereum*.setAccount(accountInfo)

| Param | Type | Description |
| --- | --- | --- |
| accountInfo | <code>Account</code> | The standardised account information |

Set an account for signing transactions for a specific DLT
npm package: @quantnetwork/overledger-dlt-substrate
Description: Quant Network Overledger Substrate software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-dlt-substrate

[Overledger SDK][repo] module for interaction with the Substrate distributed ledger technology.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-dlt-substrate
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-dlt-substrate
```

## API Reference

## Modules

<dl>
<dt><a href="#module_overledger-dlt-substrate">overledger-dlt-substrate</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Substrate">Substrate</a></dt>
<dd></dd>
</dl>

<a name="module_overledger-dlt-substrate"></a>

## overledger-dlt-substrate

* [overledger-dlt-substrate](#module_overledger-dlt-substrate)

    * [.default](#module_overledger-dlt-substrate.default)

    * [.log](#module_overledger-dlt-substrate.log)


<a name="module_overledger-dlt-substrate.default"></a>

### *overledger-dlt-substrate*.default
Development package for Substrate.

<a name="module_overledger-dlt-substrate.log"></a>

### *overledger-dlt-substrate*.log
<a name="Substrate"></a>

## Substrate

* [Substrate](#Substrate)

    * [new Substrate(sdk, options)](#new_Substrate_new)

    * [.createAccount()](#Substrate+createAccount)

    * [.setAccount(accountInfo)](#Substrate+setAccount)


<a name="new_Substrate_new"></a>

### new Substrate(sdk, options)

| Param | Type | Description |
| --- | --- | --- |
| sdk | <code>any</code> | the sdk instance |
| options | <code>Object</code> | any additional options to instantiate this dlt |

<a name="Substrate+createAccount"></a>

### *substrate*.createAccount()
Create a Substrate account

**Returns**: <code>Account</code> - the new Substrate account  
<a name="Substrate+setAccount"></a>

### *substrate*.setAccount(accountInfo)

| Param | Type | Description |
| --- | --- | --- |
| accountInfo | <code>Account</code> | The standardised account information |

Set an account for signing transactions for a specific DLT
npm package: @quantnetwork/overledger-dlt-xrp-ledger
Description: Quant Network Overledger Ripple software development kit (SDK) for the JavaScript (JS) programming language.
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-dlt-xrp-ledger

[Overledger SDK][repo] module for interaction with the Ripple distributed ledger technology.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-dlt-xrp-ledger
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-dlt-xrp-ledger
```

## API Reference

## Modules

<dl>
<dt><a href="#module_overledger-dlt-xrp-ledger">overledger-dlt-xrp-ledger</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Ripple">Ripple</a></dt>
<dd></dd>
</dl>

<a name="module_overledger-dlt-xrp-ledger"></a>

## overledger-dlt-xrp-ledger

* [overledger-dlt-xrp-ledger](#module_overledger-dlt-xrp-ledger)

    * [.default](#module_overledger-dlt-xrp-ledger.default)

    * [.log](#module_overledger-dlt-xrp-ledger.log)


<a name="module_overledger-dlt-xrp-ledger.default"></a>

### *overledger-dlt-xrp-ledger*.default
Development package for Ripple (XRP Ledger).

<a name="module_overledger-dlt-xrp-ledger.log"></a>

### *overledger-dlt-xrp-ledger*.log
<a name="Ripple"></a>

## Ripple

* [Ripple](#Ripple)

    * [new Ripple(sdk)](#new_Ripple_new)

    * [.name](#Ripple+name)

    * [.symbol](#Ripple+symbol)

    * [.createAccount()](#Ripple+createAccount)

    * [.setAccount(accountInfo)](#Ripple+setAccount)

    * [.isValidSeed()](#Ripple+isValidSeed)


<a name="new_Ripple_new"></a>

### new Ripple(sdk)

| Param | Type |
| --- | --- |
| sdk | <code>any</code> | 

<a name="Ripple+name"></a>

### *ripple*.name
Name of the DLT

<a name="Ripple+symbol"></a>

### *ripple*.symbol
Symbol of the DLT

<a name="Ripple+createAccount"></a>

### *ripple*.createAccount()
Create an XRP account

**Returns**: <code>Account</code> - (privateKey, address)  
<a name="Ripple+setAccount"></a>

### *ripple*.setAccount(accountInfo)

| Param | Type | Description |
| --- | --- | --- |
| accountInfo | <code>Account</code> | The standardised account information |

Set an account for signing for a specific DLT

<a name="Ripple+isValidSeed"></a>

### *ripple*.isValidSeed()
ripple seed validation
npm package: @quantnetwork/overledger-oauth-provider
Description: Quant Network Overledger oauth provider package to be used by the other packages
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-oauth-provider

Class used for the [Overledger SDK][repo] Gateway connection.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-oauth-provider
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-oauth-provider
```

## API Reference

<a name="module_overledger-oauth-provider"></a>

## overledger-oauth-provider

* [overledger-oauth-provider](#module_overledger-oauth-provider)

    * [.default](#module_overledger-oauth-provider.default)

    * [.log](#module_overledger-oauth-provider.log)


<a name="module_overledger-oauth-provider.default"></a>

### *overledger-oauth-provider*.default
Oauth provider package.

<a name="module_overledger-oauth-provider.log"></a>

### *overledger-oauth-provider*.log
npm package: @quantnetwork/overledger-provider
Description: Quant Network Overledger provider package to be used by the other packages
Latest version: 2.4.1
Deprecated: Package is deprecated. See overledger.dev for alternatives.

[docs]: https://github.com/quantnetwork/overledger-sdk-javascript-v2/blob/master/README.md
[repo]: https://github.com/quantnetwork/overledger-sdk-javascript-v2

# @quantnetwork/overledger-provider

Class used for the [Overledger SDK][repo] Gateway connection.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @quantnetwork/overledger-provider
```

Or, if you prefer using [yarn](https://yarnpkg.com/):

```
yarn add @quantnetwork/overledger-provider
```

## API Reference

## Modules

<dl>
<dt><a href="#module_overledger-provider">overledger-provider</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Provider">Provider</a></dt>
<dd></dd>
</dl>

<a name="module_overledger-provider"></a>

## overledger-provider

* [overledger-provider](#module_overledger-provider)

    * [.TESTNET](#module_overledger-provider.TESTNET)

    * [.MAINNET](#module_overledger-provider.MAINNET)

    * [.default](#module_overledger-provider.default)

    * [.log](#module_overledger-provider.log)


<a name="module_overledger-provider.TESTNET"></a>

### *overledger-provider*.TESTNET
Constant for the testnet URL.

<a name="module_overledger-provider.MAINNET"></a>

### *overledger-provider*.MAINNET
Constant for the mainnet URL (placeholder).

<a name="module_overledger-provider.default"></a>

### *overledger-provider*.default
Network provider package.

<a name="module_overledger-provider.log"></a>

### *overledger-provider*.log
<a name="Provider"></a>

## Provider

* [Provider](#Provider)

    * [new Provider(ProviderOptions)](#new_Provider_new)

    * [.createRequest(path, accessToken, contentType, acceptString)](#Provider+createRequest)


<a name="new_Provider_new"></a>

### new Provider(ProviderOptions)

| Param | Type | Description |
| --- | --- | --- |
| ProviderOptions | <code>ProviderOptions</code> | Overledger network provider options |

<a name="Provider+createRequest"></a>

### *provider*.createRequest(path, accessToken, contentType, acceptString)

| Param |
| --- |
| path | 
| accessToken | 
| contentType | 
| acceptString | 

Creating a request, making this as flexible as possible with the possible values in the headers being passed in the method signature