@oceanprotocol/lib 7.0.0-next.0 → 7.0.0-next.10

package/docs/classes/SmartContract.md

@@ -1,193 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / SmartContract
-
-# Class: SmartContract
-
-## Hierarchy
-
-- **`SmartContract`**
-
-  ↳ [`SmartContractWithAddress`](SmartContractWithAddress.md)
-
-  ↳ [`Datatoken`](Datatoken.md)
-
-  ↳ [`Nft`](Nft.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](SmartContract.md#constructor)
-
-### Properties
-
-- [abi](SmartContract.md#abi)
-- [config](SmartContract.md#config)
-- [signer](SmartContract.md#signer)
-
-### Methods
-
-- [amountToUnits](SmartContract.md#amounttounits)
-- [getContract](SmartContract.md#getcontract)
-- [getDefaultAbi](SmartContract.md#getdefaultabi)
-- [getFairGasPrice](SmartContract.md#getfairgasprice)
-- [unitsToAmount](SmartContract.md#unitstoamount)
-
-## Constructors
-
-### constructor
-
-• **new SmartContract**(`signer`, `network?`, `config?`, `abi?`)
-
-Instantiate the smart contract.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `signer` | `Signer` | The signer object. |
-| `network?` | `string` \| `number` | Network id or name |
-| `config?` | [`Config`](Config.md) | The configuration object. |
-| `abi?` | [`AbiItem`](../interfaces/AbiItem.md)[] | ABI array of the smart contract |
-
-#### Defined in
-
-[contracts/SmartContract.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L25)
-
-## Properties
-
-### abi
-
-• **abi**: [`AbiItem`](../interfaces/AbiItem.md)[]
-
-#### Defined in
-
-[contracts/SmartContract.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L14)
-
-___
-
-### config
-
-• **config**: [`Config`](Config.md)
-
-#### Defined in
-
-[contracts/SmartContract.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L13)
-
-___
-
-### signer
-
-• **signer**: `Signer`
-
-#### Defined in
-
-[contracts/SmartContract.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L12)
-
-## Methods
-
-### amountToUnits
-
-▸ `Protected` **amountToUnits**(`token`, `amount`, `tokenDecimals?`): `Promise`<`string`\>
-
-Converts an amount of tokens to units
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `token` | `string` | The token to convert |
-| `amount` | `string` | The amount of tokens to convert |
-| `tokenDecimals?` | `number` | The number of decimals of the token |
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The converted amount in units
-
-#### Defined in
-
-[contracts/SmartContract.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L43)
-
-___
-
-### getContract
-
-▸ `Protected` **getContract**(`address`, `abi?`): `Contract`
-
-Returns a contract instance for the given address
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `address` | `string` | The address of the contract |
-| `abi?` | [`AbiItem`](../interfaces/AbiItem.md)[] | The ABI of the contract |
-
-#### Returns
-
-`Contract`
-
-- The contract instance
-
-#### Defined in
-
-[contracts/SmartContract.ts:80](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L80)
-
-___
-
-### getDefaultAbi
-
-▸ `Abstract` **getDefaultAbi**(): `any`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[contracts/SmartContract.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L16)
-
-___
-
-### getFairGasPrice
-
-▸ `Protected` **getFairGasPrice**(): `Promise`<`string`\>
-
-Retruns the gas price
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The fair gas price
-
-#### Defined in
-
-[contracts/SmartContract.ts:70](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L70)
-
-___
-
-### unitsToAmount
-
-▸ `Protected` **unitsToAmount**(`token`, `amount`, `tokenDecimals?`): `Promise`<`string`\>
-
-Converts an amount of units to tokens
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `token` | `string` | The token to convert |
-| `amount` | `string` | The amount of units to convert |
-| `tokenDecimals?` | `number` | The number of decimals in the token |
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The converted amount in tokens
-
-#### Defined in
-
-[contracts/SmartContract.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L58)

package/docs/classes/SmartContractWithAddress.md

@@ -1,268 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / SmartContractWithAddress
-
-# Class: SmartContractWithAddress
-
-## Hierarchy
-
-- [`SmartContract`](SmartContract.md)
-
-  ↳ **`SmartContractWithAddress`**
-
-  ↳↳ [`Dispenser`](Dispenser.md)
-
-  ↳↳ [`FixedRateExchange`](FixedRateExchange.md)
-
-  ↳↳ [`Router`](Router.md)
-
-  ↳↳ [`NftFactory`](NftFactory.md)
-
-  ↳↳ [`VeOcean`](VeOcean.md)
-
-  ↳↳ [`VeFeeDistributor`](VeFeeDistributor.md)
-
-  ↳↳ [`VeFeeEstimate`](VeFeeEstimate.md)
-
-  ↳↳ [`VeAllocate`](VeAllocate.md)
-
-  ↳↳ [`DfRewards`](DfRewards.md)
-
-  ↳↳ [`DfStrategyV1`](DfStrategyV1.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](SmartContractWithAddress.md#constructor)
-
-### Properties
-
-- [abi](SmartContractWithAddress.md#abi)
-- [address](SmartContractWithAddress.md#address)
-- [config](SmartContractWithAddress.md#config)
-- [contract](SmartContractWithAddress.md#contract)
-- [signer](SmartContractWithAddress.md#signer)
-
-### Methods
-
-- [amountToUnits](SmartContractWithAddress.md#amounttounits)
-- [getContract](SmartContractWithAddress.md#getcontract)
-- [getDefaultAbi](SmartContractWithAddress.md#getdefaultabi)
-- [getFairGasPrice](SmartContractWithAddress.md#getfairgasprice)
-- [unitsToAmount](SmartContractWithAddress.md#unitstoamount)
-
-## Constructors
-
-### constructor
-
-• **new SmartContractWithAddress**(`address`, `signer`, `network?`, `config?`, `abi?`)
-
-Instantiate the smart contract.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `address` | `string` | The address of the contract. |
-| `signer` | `Signer` | The signer object. |
-| `network?` | `string` \| `number` | Network id or name |
-| `config?` | [`Config`](Config.md) | The configuration object. |
-| `abi?` | [`AbiItem`](../interfaces/AbiItem.md)[] | ABI array of the smart contract |
-
-#### Overrides
-
-[SmartContract](SmartContract.md).[constructor](SmartContract.md#constructor)
-
-#### Defined in
-
-[contracts/SmartContractWithAddress.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContractWithAddress.ts#L17)
-
-## Properties
-
-### abi
-
-• **abi**: [`AbiItem`](../interfaces/AbiItem.md)[]
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[abi](SmartContract.md#abi)
-
-#### Defined in
-
-[contracts/SmartContract.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L14)
-
-___
-
-### address
-
-• **address**: `string`
-
-#### Defined in
-
-[contracts/SmartContractWithAddress.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContractWithAddress.ts#L6)
-
-___
-
-### config
-
-• **config**: [`Config`](Config.md)
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[config](SmartContract.md#config)
-
-#### Defined in
-
-[contracts/SmartContract.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L13)
-
-___
-
-### contract
-
-• **contract**: `Contract`
-
-#### Defined in
-
-[contracts/SmartContractWithAddress.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContractWithAddress.ts#L7)
-
-___
-
-### signer
-
-• **signer**: `Signer`
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[signer](SmartContract.md#signer)
-
-#### Defined in
-
-[contracts/SmartContract.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L12)
-
-## Methods
-
-### amountToUnits
-
-▸ `Protected` **amountToUnits**(`token`, `amount`, `tokenDecimals?`): `Promise`<`string`\>
-
-Converts an amount of tokens to units
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `token` | `string` | The token to convert |
-| `amount` | `string` | The amount of tokens to convert |
-| `tokenDecimals?` | `number` | The number of decimals of the token |
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The converted amount in units
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[amountToUnits](SmartContract.md#amounttounits)
-
-#### Defined in
-
-[contracts/SmartContract.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L43)
-
-___
-
-### getContract
-
-▸ `Protected` **getContract**(`address`, `abi?`): `Contract`
-
-Returns a contract instance for the given address
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `address` | `string` | The address of the contract |
-| `abi?` | [`AbiItem`](../interfaces/AbiItem.md)[] | The ABI of the contract |
-
-#### Returns
-
-`Contract`
-
-- The contract instance
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[getContract](SmartContract.md#getcontract)
-
-#### Defined in
-
-[contracts/SmartContract.ts:80](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L80)
-
-___
-
-### getDefaultAbi
-
-▸ `Abstract` **getDefaultAbi**(): `any`
-
-#### Returns
-
-`any`
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[getDefaultAbi](SmartContract.md#getdefaultabi)
-
-#### Defined in
-
-[contracts/SmartContract.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L16)
-
-___
-
-### getFairGasPrice
-
-▸ `Protected` **getFairGasPrice**(): `Promise`<`string`\>
-
-Retruns the gas price
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The fair gas price
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[getFairGasPrice](SmartContract.md#getfairgasprice)
-
-#### Defined in
-
-[contracts/SmartContract.ts:70](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L70)
-
-___
-
-### unitsToAmount
-
-▸ `Protected` **unitsToAmount**(`token`, `amount`, `tokenDecimals?`): `Promise`<`string`\>
-
-Converts an amount of units to tokens
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `token` | `string` | The token to convert |
-| `amount` | `string` | The amount of units to convert |
-| `tokenDecimals?` | `number` | The number of decimals in the token |
-
-#### Returns
-
-`Promise`<`string`\>
-
-- The converted amount in tokens
-
-#### Inherited from
-
-[SmartContract](SmartContract.md).[unitsToAmount](SmartContract.md#unitstoamount)
-
-#### Defined in
-
-[contracts/SmartContract.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/contracts/SmartContract.ts#L58)

package/docs/enums/LogLevel.md

@@ -1,63 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / LogLevel
-
-# Enumeration: LogLevel
-
-## Table of contents
-
-### Enumeration Members
-
-- [Error](LogLevel.md#error)
-- [Log](LogLevel.md#log)
-- [None](LogLevel.md#none)
-- [Verbose](LogLevel.md#verbose)
-- [Warn](LogLevel.md#warn)
-
-## Enumeration Members
-
-### Error
-
-• **Error** = ``0``
-
-#### Defined in
-
-[utils/Logger.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/utils/Logger.ts#L4)
-
-___
-
-### Log
-
-• **Log** = ``2``
-
-#### Defined in
-
-[utils/Logger.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/utils/Logger.ts#L6)
-
-___
-
-### None
-
-• **None** = ``-1``
-
-#### Defined in
-
-[utils/Logger.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/utils/Logger.ts#L3)
-
-___
-
-### Verbose
-
-• **Verbose** = ``3``
-
-#### Defined in
-
-[utils/Logger.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/utils/Logger.ts#L7)
-
-___
-
-### Warn
-
-• **Warn** = ``1``
-
-#### Defined in
-
-[utils/Logger.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/utils/Logger.ts#L5)

package/docs/interfaces/AbiInput.md

@@ -1,63 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AbiInput
-
-# Interface: AbiInput
-
-## Table of contents
-
-### Properties
-
-- [components](AbiInput.md#components)
-- [indexed](AbiInput.md#indexed)
-- [internalType](AbiInput.md#internaltype)
-- [name](AbiInput.md#name)
-- [type](AbiInput.md#type)
-
-## Properties
-
-### components
-
-• `Optional` **components**: [`AbiInput`](AbiInput.md)[]
-
-#### Defined in
-
-[@types/Contracts.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L8)
-
-___
-
-### indexed
-
-• `Optional` **indexed**: `boolean`
-
-#### Defined in
-
-[@types/Contracts.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L7)
-
-___
-
-### internalType
-
-• `Optional` **internalType**: `string`
-
-#### Defined in
-
-[@types/Contracts.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L9)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[@types/Contracts.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L5)
-
-___
-
-### type
-
-• **type**: `string`
-
-#### Defined in
-
-[@types/Contracts.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L6)

package/docs/interfaces/AbiItem.md

@@ -1,107 +0,0 @@
-[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / AbiItem
-
-# Interface: AbiItem
-
-## Table of contents
-
-### Properties
-
-- [anonymous](AbiItem.md#anonymous)
-- [constant](AbiItem.md#constant)
-- [gas](AbiItem.md#gas)
-- [inputs](AbiItem.md#inputs)
-- [name](AbiItem.md#name)
-- [outputs](AbiItem.md#outputs)
-- [payable](AbiItem.md#payable)
-- [stateMutability](AbiItem.md#statemutability)
-- [type](AbiItem.md#type)
-
-## Properties
-
-### anonymous
-
-• `Optional` **anonymous**: `boolean`
-
-#### Defined in
-
-[@types/Contracts.ts:20](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L20)
-
-___
-
-### constant
-
-• `Optional` **constant**: `boolean`
-
-#### Defined in
-
-[@types/Contracts.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L21)
-
-___
-
-### gas
-
-• `Optional` **gas**: `number`
-
-#### Defined in
-
-[@types/Contracts.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L28)
-
-___
-
-### inputs
-
-• `Optional` **inputs**: [`AbiInput`](AbiInput.md)[]
-
-#### Defined in
-
-[@types/Contracts.ts:22](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L22)
-
-___
-
-### name
-
-• `Optional` **name**: `string`
-
-#### Defined in
-
-[@types/Contracts.ts:23](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L23)
-
-___
-
-### outputs
-
-• `Optional` **outputs**: [`AbiOutput`](AbiOutput.md)[]
-
-#### Defined in
-
-[@types/Contracts.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L24)
-
-___
-
-### payable
-
-• `Optional` **payable**: `boolean`
-
-#### Defined in
-
-[@types/Contracts.ts:25](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L25)
-
-___
-
-### stateMutability
-
-• `Optional` **stateMutability**: [`StateMutabilityType`](../modules.md#statemutabilitytype)
-
-#### Defined in
-
-[@types/Contracts.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L26)
-
-___
-
-### type
-
-• **type**: [`AbiType`](../modules.md#abitype)
-
-#### Defined in
-
-[@types/Contracts.ts:27](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Contracts.ts#L27)