Skip to main content

Account

@nevermined-io/nevermined-sdk-js / Account

Class: Account

Account information.

Hierarchy​

  • Instantiable

    ↳ Account

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

• new Account(id?, config?)

Parameters​

NameTypeDefault value
idstring'0x0'
config?InstantiableConfigundefined

Overrides​

Instantiable.constructor

Defined in​

src/nevermined/Account.ts:20

Properties​

babySecret​

• Optional babySecret: string

Defined in​

src/nevermined/Account.ts:18

babyX​

• Optional babyX: string

Defined in​

src/nevermined/Account.ts:16

babyY​

• Optional babyY: string

Defined in​

src/nevermined/Account.ts:17

id​

• Private id: string = '0x0'

Defined in​

src/nevermined/Account.ts:20

password​

• Private Optional password: string

Defined in​

src/nevermined/Account.ts:12

token​

• Private Optional token: string

Defined in​

src/nevermined/Account.ts:14

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

authenticate​

▸ authenticate(): Promise<void>

Authenticate the account.

Returns​

Promise<void>

Defined in​

src/nevermined/Account.ts:82

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

getBalance​

▸ getBalance(): Promise<default>

Balances of Ether and Nevermined Token.

Returns​

Promise<default>

Defined in​

src/nevermined/Account.ts:108

getEtherBalance​

▸ getEtherBalance(): Promise<default>

Balance of Ether.

Returns​

Promise<default>

Defined in​

src/nevermined/Account.ts:100

getId​

▸ getId(): string

Returns​

string

Defined in​

src/nevermined/Account.ts:27

getNeverminedBalance​

▸ getNeverminedBalance(): Promise<default>

Balance of Nevermined Token.

Returns​

Promise<default>

Defined in​

src/nevermined/Account.ts:90

getPassword​

▸ getPassword(): string

Returns account password.

Returns​

string

The account password.

Defined in​

src/nevermined/Account.ts:51

getPublic​

▸ getPublic(): string

Returns​

string

Defined in​

src/nevermined/Account.ts:35

getToken​

▸ getToken(): Promise<string>

Returns account token.

Returns​

Promise<string>

Account token.

Defined in​

src/nevermined/Account.ts:67

isTokenStored​

▸ isTokenStored(): Promise<boolean>

Returns if account token is stored.

Returns​

Promise<boolean>

true if the token is stored.

Defined in​

src/nevermined/Account.ts:75

requestTokens​

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

Request Nevermined Tokens.

Parameters​

NameTypeDescription
amountstring | number | defaultTokens to be requested.
params?TxParameters-

Returns​

Promise<string>

Defined in​

src/nevermined/Account.ts:120

setId​

▸ setId(id): void

Parameters​

NameType
idany

Returns​

void

Defined in​

src/nevermined/Account.ts:31

setInstanceConfig​

▸ Protected setInstanceConfig(config): void

Parameters​

NameType
configInstantiableConfig

Returns​

void

Inherited from​

Instantiable.setInstanceConfig

Defined in​

src/Instantiable.abstract.ts:171

setPassword​

▸ setPassword(password): void

Set account password.

Parameters​

NameTypeDescription
passwordstringPassword for account.

Returns​

void

Defined in​

src/nevermined/Account.ts:43

setToken​

▸ setToken(token): void

Set account token.

Parameters​

NameTypeDescription
tokenstringToken for account.

Returns​

void

Defined in​

src/nevermined/Account.ts:59

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(..._args): any

Parameters​

NameType
..._argsany

Returns​

any

Inherited from​

Instantiable.getInstance

Defined in​

src/Instantiable.abstract.ts:158

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