Skip to main content

NeverminedOptions

@nevermined-io/sdk - v3.0.44 / NeverminedOptions

Class: NeverminedOptions

Hierarchy​

Table of contents​

Constructors​

Properties​

Constructors​

constructor​

• new NeverminedOptions(): NeverminedOptions

Returns​

NeverminedOptions

Properties​

accounts​

• Optional accounts: NvmAccount[]

Defined in​

src/models/NeverminedOptions.ts:73

appUrl​

• Optional appUrl: string

The Nevermined App URL.

Defined in​

src/models/NeverminedOptions.ts:16

artifactsFolder​

• Optional artifactsFolder: string

The folder where the nevermined contract artifacts are located.

Defined in​

src/models/NeverminedOptions.ts:67

chainId​

• Optional chainId: number

Defined in​

src/models/NeverminedOptions.ts:5

circuitsFolder​

• Optional circuitsFolder: string

The folder where the nevermined contract circuits are located.

Defined in​

src/models/NeverminedOptions.ts:71

contractsVersion​

• Optional contractsVersion: string

Contracts version

Defined in​

src/models/NeverminedOptions.ts:99

gasMultiplier​

• Optional gasMultiplier: number

Gas multiplier for the fees. Can be used to speed up the transactions.

Defined in​

src/models/NeverminedOptions.ts:57

gasStationUri​

• Optional gasStationUri: string

Use a gas station to calculate transaction fees

Defined in​

src/models/NeverminedOptions.ts:89

graphHttpUri​

• Optional graphHttpUri: string

Enpoint for the graph-node http query

Defined in​

src/models/NeverminedOptions.ts:62

ipfsGateway​

• Optional ipfsGateway: string = 'https://ipfs.io'

IPFS variables enable the resolution of DDOs (via assets.resolve) from CID urls INFO: For performance purposes, it is recommended to setup a IPFS Infura endpoint to accelerate the asset resolution requests.

Defined in​

src/models/NeverminedOptions.ts:80

ipfsProjectId​

• Optional ipfsProjectId: string

Defined in​

src/models/NeverminedOptions.ts:82

ipfsProjectSecret​

• Optional ipfsProjectSecret: string

Defined in​

src/models/NeverminedOptions.ts:84

marketplaceAuthToken​

• Optional marketplaceAuthToken: string

Marketplace auth token.

Defined in​

src/models/NeverminedOptions.ts:41

marketplaceUri​

• marketplaceUri: string

URL to the MarketPlace API use to record some Nevermined assets metadata. In a Nevermined network there could be multiple Marketplace API instances. Each of them typically records the metadata of a specific domain/vertical deployed on a Nevermined network.

See

https://docs.nevermined.io/docs/architecture/marketplace-api/

Defined in​

src/models/NeverminedOptions.ts:23

neverminedNodeAddress​

• Optional neverminedNodeAddress: string

The public address of the Nevermined Node.

See

neverminedNodeUri

Defined in​

src/models/NeverminedOptions.ts:36

neverminedNodeUri​

• neverminedNodeUri: string

URL to an existing Nevermined Node. A Nevermined network can have multiple running Nodes. Each of them facilitate the access control and the data and infrastructure interaction with web2 elements.

See

https://docs.nevermined.io/docs/architecture/node/

Defined in​

src/models/NeverminedOptions.ts:30

verbose​

• Optional verbose: boolean | LogLevel

Log level.

Defined in​

src/models/NeverminedOptions.ts:51

web3Provider​

• Optional web3Provider: any

Web3 Provider.

Defined in​

src/models/NeverminedOptions.ts:46

web3ProviderUri​

• Optional web3ProviderUri: string

Ethereum Web3 Provider URL. This Url allows the SDK to connect to a blockchain. This provider depends on the network where you want to connect (Ethereum Mainnet, Rinkeby, Polygon Matic, etc). It's possible to use a public available provider or a private/paid one like Infura, Alchemy, etc.

Defined in​

src/models/NeverminedOptions.ts:11

zeroDevProjectId​

• Optional zeroDevProjectId: string

ZeroDev project id

Defined in​

src/models/NeverminedOptions.ts:94