1
0
mirror of https://github.com/oceanprotocol/ocean.js.git synced 2024-11-26 20:39:05 +01:00
ocean.js/docs/classes/Config.md
Alex Coseru 9bf71ba4f0
Features/ethers (#1696)
* add ethers

* global updates

* ve updates

* ve tests

* contract updates

* first test passing

* downgrade to ethers 5.7.2

* add log

* add tx wait

* full NftFactory.test

* add wait

* add Router tests

* fix dispenser

* Nft test

* add dispenser tests

* add fre tests part 1

* WIP datatoken unit tests

* add DFRewards test

* increase gas estimate

* increase gas estimate

* Work datatoken unit tests

* datatoken test more tests

* finished datatoken tests

* fix nft get data

* fix nft transfer tests

* Provider int tests

* Updating CodeExamples.md

* update provider & fix publish flow int test

* wip publish edit consume integration test

* more work on  publish edit consume integration test

* fix edit  publish edit consume integration test

* add 3 int tests

* Updating ComputeExamples.md

* fix signature and download

* fix compute flow integration test

* udapte handleComputeOrder helper

* update datatoken instance

* update datatoken global variable

* mint ocean tokens to consumer as well and added logs

* update compute exammples

* Updating ComputeExamples.md

* wip code examples readme

* update code examples readme

* Updating CodeExamples.md

* run all tests

* update dep in readme

* update readme

* code examples update metadata flags

* update dt instance in code examples md

* set metadata updates

* Updating CodeExamples.md

* update code examples readme structure

* Updating CodeExamples.md

* update readmes table links

* Updating CodeExamples.md

* Updating ComputeExamples.md

* clean-up

* Updating CodeExamples.md

* added missing unit tests for usdc fixed rate exchange tests

* more cleanup and jsdoc updates

* more  jsdoc updates

* donw with jsdoc updates

* handle provider errors

* add missing error handling file

* adds most of the provider errors

* update get compute env return type

* Release 3.0.0-next.0

* adding Typedoc to ethers branch

* update provider signature message

* fix lint

* Release 3.0.0-next.1

* fix lint

* adding Typedoc to ethers branch

* Updating CI to build and commit the documentation

* Updating documentation

* Updating script permissions

* fix todos add missing logic to send tx

* npm package cleanups

* Release 3.0.0-next.2

* update log messages for errors

* Release 3.0.0-next.3

* fix gasFee issue on sendTx

* Release 3.0.0-next.4

* add consume params typings (#1731)

* fix gas fee estimate

* remove comments

* add some delays before resolving datasets

* adds delay to Publish flow tests

* Release 3.0.0-next.5

---------

Co-authored-by: Bogdan Fazakas <bogdan.fazakas@gmail.com>
Co-authored-by: GitHub Actions Bot <>
Co-authored-by: Jamie Hewitt <jamie.hewitt15@gmail.com>
Co-authored-by: Jamie Hewitt <jamie@oceanprotocol.com>
2023-05-29 11:20:38 +03:00

9.9 KiB

@oceanprotocol/lib / Exports / Config

Class: Config

Table of contents

Constructors

Properties

Constructors

constructor

new Config()

Properties

DFRewards

Optional DFRewards: string

Defined in

config/Config.ts:180


DFStrategyV1

Optional DFStrategyV1: string

Defined in

config/Config.ts:181


authMessage

Optional authMessage: string

Message shown when the user creates its own token.

Defined in

config/Config.ts:105


authTokenExpiration

Optional authTokenExpiration: number

Token expiration time in ms.

Defined in

config/Config.ts:111


chainId

chainId: number

Chain ID

Defined in

config/Config.ts:125


datatokensABI

Optional datatokensABI: AbiItem | AbiItem[]

datatokens ABI

Defined in

config/Config.ts:52


dispenserABI

Optional dispenserABI: AbiItem | AbiItem[]

DispenserABI

Defined in

config/Config.ts:76


dispenserAddress

Optional dispenserAddress: string

DispenserAddress

Defined in

config/Config.ts:70


explorerUri

explorerUri: string

Url of the blockchain exporer ex: https://etherscan.io

Defined in

config/Config.ts:143


fixedRateExchangeAddress

Optional fixedRateExchangeAddress: string

FixedRateExchangeAddress

Defined in

config/Config.ts:58


fixedRateExchangeAddressABI

Optional fixedRateExchangeAddressABI: AbiItem | AbiItem[]

FixedRateExchangeAddressABI

Defined in

config/Config.ts:64


gasFeeMultiplier

gasFeeMultiplier: number

Specify the multiplier for the gas fee

Defined in

config/Config.ts:173


metadataCacheUri

Optional metadataCacheUri: string

Metadata Store URL.

Defined in

config/Config.ts:21


network

network: string

Network name ex: mainnet, goerli, polygon

Defined in

config/Config.ts:131


nftFactoryAddress

Optional nftFactoryAddress: string

Factory address

Defined in

config/Config.ts:46


nodeUri

Optional nodeUri: string

Ethereum node URL.

Defined in

config/Config.ts:9


oceanTokenAddress

Optional oceanTokenAddress: string

Ocean Token address

Defined in

config/Config.ts:40


oceanTokenSymbol

oceanTokenSymbol: string

Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls

Defined in

config/Config.ts:149


opfCommunityFeeCollector

Optional opfCommunityFeeCollector: string

OPFCommunityFeeCollector

Defined in

config/Config.ts:82


parityUri

Optional parityUri: string

Parity config

Defined in

config/Config.ts:117


providerAddress

Optional providerAddress: string

Address of Provider.

Defined in

config/Config.ts:15


providerUri

Optional providerUri: string

Provider URL.

Defined in

config/Config.ts:27


sideStakingAddress

Optional sideStakingAddress: string

SideStaking address

Defined in

config/Config.ts:88


startBlock

Optional startBlock: number

block number of the deployment

Defined in

config/Config.ts:94


subgraphUri

subgraphUri: string

Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com

Defined in

config/Config.ts:137


threshold

Optional threshold: number

Defined in

config/Config.ts:119


transactionBlockTimeout

transactionBlockTimeout: number

Specify the transaction Block Timeout

Defined in

config/Config.ts:155


transactionConfirmationBlocks

transactionConfirmationBlocks: number

Specify the transaction Confirmation Blocks

Defined in

config/Config.ts:161


transactionPollingTimeout

transactionPollingTimeout: number

Specify the transaction Polling Blocks Timeout

Defined in

config/Config.ts:167


veAllocate

Optional veAllocate: string

Defined in

config/Config.ts:175


veDelegation

Optional veDelegation: string

Defined in

config/Config.ts:177


veDelegationProxy

Optional veDelegationProxy: string

Defined in

config/Config.ts:179


veFeeDistributor

Optional veFeeDistributor: string

Defined in

config/Config.ts:178


veFeeEstimate

Optional veFeeEstimate: string

Defined in

config/Config.ts:182


veOCEAN

Optional veOCEAN: string

Defined in

config/Config.ts:176


verbose

Optional verbose: boolean | LogLevel

Log level.

Defined in

config/Config.ts:99


web3Provider

Optional web3Provider: any

Web3 Provider.

Defined in

config/Config.ts:34