Accounts

@nevermined-io/nevermined-sdk-js / Accounts

Class: Accounts

Account submodule of Nevermined.

Hierarchy

• Instantiable

  ↳ Accounts

Table of contents

Constructors

• constructor

Accessors

• artifactsFolder
• config
• instanceConfig
• instantiableConfig
• logger
• nevermined
• web3

Methods

• addresses
• balance
• checkExists
• findSigner
• list
• requestEthFromFaucet
• requestList
• requestTokens
• setInstanceConfig
• addressesStatic
• findSignerStatic
• getInstance
• setInstanceConfig

Constructors

constructor

• new Accounts()

Inherited from

Instantiable.constructor

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

---

balance

▸ balance(account): Promise<default>

Return account balance.

Parameters

Name	Type	Description
account	Account	Account instance.

Returns

Promise<default>

Ether and Nevermined Token balance.

Defined in

src/nevermined/Accounts.ts:47

---

checkExists

▸ Protected checkExists(address): Promise<boolean>

Returns true of contract exists else it throws.

Parameters

Name	Type
address	string

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

Name	Type
from	string

Returns

Promise<Signer>

Inherited from

Instantiable.findSigner

Defined in

src/Instantiable.abstract.ts:105

---

list

▸ list(): Promise<Account[]>

Returns the list of accounts.

Returns

Promise<Account[]>

The list of accounts.

Defined in

src/nevermined/Accounts.ts:26

---

requestEthFromFaucet

▸ requestEthFromFaucet(address): Promise<boolean>

Parameters

Name	Type
address	string

Returns

Promise<boolean>

Defined in

src/nevermined/Accounts.ts:70

---

requestList

▸ requestList(): Promise<Account[]>

Returns the list of accounts including the addresses not controlled by the node, only can be used by providers like metamask, Status or Trustwallet but not by default provider

Returns

Promise<Account[]>

Defined in

src/nevermined/Accounts.ts:38

---

requestTokens

▸ requestTokens(account, amount, params?): Promise<boolean>

Request tokens for an account.

Parameters

Name	Type	Description
account	Account	Account instance.
amount	number	Token amount.
params?	TxParameters	-

Returns

Promise<boolean>

true if the call was successful. false otherwise.

Defined in

src/nevermined/Accounts.ts:57

---

setInstanceConfig

▸ Protected setInstanceConfig(config): void

Parameters

Name	Type
config	InstantiableConfig

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:171

---

addressesStatic

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

Parameters

Name	Type
config	Config
web3	JsonRpcProvider

Returns

Promise<string[]>

Inherited from

Instantiable.addressesStatic

Defined in

src/Instantiable.abstract.ts:142

---

findSignerStatic

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

Parameters

Name	Type
config	Config
web3	JsonRpcProvider
from	string

Returns

Promise<Signer>

Inherited from

Instantiable.findSignerStatic

Defined in

src/Instantiable.abstract.ts:115

---

getInstance

▸ Static getInstance(config): Promise<Accounts>

Returns the instance of Accounts.

Parameters

Name	Type
config	InstantiableConfig

Returns

Promise<Accounts>

Accounts

Overrides

Instantiable.getInstance

Defined in

src/nevermined/Accounts.ts:14

---

setInstanceConfig

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

Type parameters

Name	Type
T	extends Instantiable<T>

Parameters

Name	Type
instance	T
instantiableConfig	InstantiableConfig

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162