Skip to main content

Nevermined

@nevermined-io/nevermined-sdk-js / Nevermined

Class: Nevermined

Main interface for Nevermined Protocol.

Hierarchy​

  • Instantiable

    ↳ Nevermined

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

• Private new Nevermined()

Overrides​

Instantiable.constructor

Defined in​

src/nevermined/Nevermined.ts:213

Properties​

aaveCredit​

• aaveCredit: AaveCredit

AaveCredit allows taking loans from Aave protocol using NFT tokens as collateral.

Defined in​

src/nevermined/Nevermined.ts:196

accounts​

• accounts: Accounts

Accounts submodule

Defined in​

src/nevermined/Nevermined.ts:156

agreements​

• agreements: Agreements

Agreements submodule

Defined in​

src/nevermined/Nevermined.ts:181

assets​

• assets: Assets

Assets submodule

Defined in​

src/nevermined/Nevermined.ts:166

auth​

• auth: Auth

Auth submodule

Defined in​

src/nevermined/Nevermined.ts:161

bookmarks​

• bookmarks: Bookmarks

Bookmarks instance

Defined in​

src/nevermined/Nevermined.ts:141

contracts​

• contracts: Object

Nevermind very own contract reflector.

Type declaration​

NameType
loadErc20(address: string) => Promise<default>
loadNft721(address: string) => Promise<Nft721>

Defined in​

src/nevermined/Nevermined.ts:97

faucet​

• faucet: Faucet

Metadata instance.

Defined in​

src/nevermined/Nevermined.ts:151

files​

• files: Files

Files submodule

Defined in​

src/nevermined/Nevermined.ts:176

Node​

• Node: Node

Node instance.

Defined in​

src/nevermined/Nevermined.ts:121

keeper​

• keeper: Keeper

Keeper instance.

Defined in​

src/nevermined/Nevermined.ts:92

marketplace​

• marketplace: MarketplaceApi

Marketplace instance.

Defined in​

src/nevermined/Nevermined.ts:131

metadata​

• metadata: Metadata

Metadata instance.

Defined in​

src/nevermined/Nevermined.ts:126

nfts​

• nfts: Nfts

Nfts submodule

Defined in​

src/nevermined/Nevermined.ts:171

permissions​

• permissions: Permissions

Permissions instance

Defined in​

src/nevermined/Nevermined.ts:146

profiles​

• profiles: Profiles

Profiles instance

Defined in​

src/nevermined/Nevermined.ts:136

provenance​

• provenance: Provenance

Provenance submodule

Defined in​

src/nevermined/Nevermined.ts:206

provider​

• provider: Provider

Nevermined probiders submodule

Defined in​

src/nevermined/Nevermined.ts:186

token​

• token: Token

Nevermined tokens submodule

Defined in​

src/nevermined/Nevermined.ts:191

utils​

• utils: Utils

Utils submodule

Defined in​

src/nevermined/Nevermined.ts:211

versions​

• versions: Versions

Versions submodule

Defined in​

src/nevermined/Nevermined.ts:201

Accessors​

artifactsFolder​

• Protected get artifactsFolder(): string

Returns​

string

Inherited from​

Instantiable.artifactsFolder

Defined in​

src/Instantiable.abstract.ts:96

config​

• Protected get config(): Config

Returns​

Config

Inherited from​

Instantiable.config

Defined in​

src/Instantiable.abstract.ts:80

instanceConfig​

• Protected get instanceConfig(): InstantiableConfig

Returns​

InstantiableConfig

Inherited from​

Instantiable.instanceConfig

Defined in​

src/Instantiable.abstract.ts:100

instantiableConfig​

• Protected get instantiableConfig(): InstantiableConfig

Returns​

InstantiableConfig

Inherited from​

Instantiable.instantiableConfig

Defined in​

src/Instantiable.abstract.ts:73

logger​

• Protected get logger(): Logger

Returns​

Logger

Inherited from​

Instantiable.logger

Defined in​

src/Instantiable.abstract.ts:87

nevermined​

• Protected get nevermined(): Nevermined

Returns​

Nevermined

Inherited from​

Instantiable.nevermined

Defined in​

src/Instantiable.abstract.ts:33

web3​

• Protected get web3(): JsonRpcProvider

Returns​

JsonRpcProvider

Inherited from​

Instantiable.web3

Defined in​

src/Instantiable.abstract.ts:63

Methods​

addresses​

▸ addresses(): Promise<string[]>

Returns​

Promise<string[]>

Inherited from​

Instantiable.addresses

Defined in​

src/Instantiable.abstract.ts:129

checkExists​

▸ Protected checkExists(address): Promise<boolean>

Returns true of contract exists else it throws.

Parameters​

NameType
addressstring

Returns​

Promise<boolean>

true if the contract exists.

Inherited from​

Instantiable.checkExists

Defined in​

src/Instantiable.abstract.ts:44

findSigner​

▸ findSigner(from): Promise<Signer>

Parameters​

NameType
fromstring

Returns​

Promise<Signer>

Inherited from​

Instantiable.findSigner

Defined in​

src/Instantiable.abstract.ts:105

setInstanceConfig​

▸ Protected setInstanceConfig(config): void

Parameters​

NameType
configInstantiableConfig

Returns​

void

Inherited from​

Instantiable.setInstanceConfig

Defined in​

src/Instantiable.abstract.ts:171

addressesStatic​

▸ Static addressesStatic(config, web3): Promise<string[]>

Parameters​

NameType
configConfig
web3JsonRpcProvider

Returns​

Promise<string[]>

Inherited from​

Instantiable.addressesStatic

Defined in​

src/Instantiable.abstract.ts:142

findSignerStatic​

▸ Static findSignerStatic(config, web3, from): Promise<Signer>

Parameters​

NameType
configConfig
web3JsonRpcProvider
fromstring

Returns​

Promise<Signer>

Inherited from​

Instantiable.findSignerStatic

Defined in​

src/Instantiable.abstract.ts:115

getInstance​

▸ Static getInstance(config): Promise<Nevermined>

Returns the instance of Nevermined.

Example

import { Nevermined, Config } from '@nevermined-io/nevermied-sdk-js'

const config: Config = {...}
const nevermined = await Nevermined.getInstance(config)

Parameters​

NameTypeDescription
configConfigNevermined instance configuration.

Returns​

Promise<Nevermined>

A Nevermined instance

Overrides​

Instantiable.getInstance

Defined in​

src/nevermined/Nevermined.ts:51

setInstanceConfig​

▸ Static Protected setInstanceConfig<T>(instance, instantiableConfig): void

Type parameters​

NameType
Textends Instantiable<T>

Parameters​

NameType
instanceT
instantiableConfigInstantiableConfig

Returns​

void

Inherited from​

Instantiable.setInstanceConfig

Defined in​

src/Instantiable.abstract.ts:162