cardano-web3-js / Account

Class: Account

Constructors

new Account()

new Account(): Account

Returns

Account

Properties

__config

__config: AccountConfig

Defined in

src/core/account.ts:6

---

__state

__state: AccountState

Defined in

src/core/account.ts:22

Methods

decodeAndUpdateXprvKey()

decodeAndUpdateXprvKey(password): string

Decode key from encrypted state and update internal state

Parameters

• password: string

Password to decrypt the key

Returns

string

Decoded xprv key

Defined in

src/core/account.ts:264

---

decodeXprvKey()

decodeXprvKey(password): string

Decode key from encrypted state

Parameters

• password: string

Password to decrypt the key

Returns

string

Decoded xprv key

Throws

Error if account is not encrypted or account type is wrong

Defined in

src/core/account.ts:252

---

encodeAndUpdateXprvKey()

encodeAndUpdateXprvKey(password): string

Encode key to encrypted state and update internal state

Parameters

• password: string

Password to encrypt the key

Returns

string

Encoded xprv key

Defined in

src/core/account.ts:239

---

encodeXprvKey()

encodeXprvKey(password): string

Encode key to encrypted state

Parameters

• password: string

Password to encrypt the key

Returns

string

Encoded xprv key

Throws

Error if account type is wrong or xprv key is not found

Throws

Error if account is already encrypted

Defined in

src/core/account.ts:227

---

exportAccount()

exportAccount(): AccountExportV1

Export account configuration

Returns

AccountExportV1

Account configuration

Throws

Error if account type is not exportable

Defined in

src/core/account.ts:204

---

updateState()

updateState(): Promise<AccountState>

Get account state and update internal state

Returns

Promise<AccountState>

Account state

Defined in

src/core/account.ts:275

---

fromConnector()

static fromConnector(cw3, connector): Promise<Account>

Create a new account from connector

Parameters

• cw3: CardanoWeb3

CardanoWeb3 instance

• connector: Connector

Connector instance

Returns

Promise<Account>

Account instance

Defined in

src/core/account.ts:120

---

fromMnemonic()

static fromMnemonic(cw3, mnemonic, accountPath, addressPath): Account

Create a new account from mnemonic

Parameters

• cw3: CardanoWeb3

CardanoWeb3 instance

• mnemonic: string

24-word mnemonic

• accountPath: AccountDerivationPath

Account derivation path (e.g. [1852, 1815, 0])

• addressPath: AddressDerivationPath

Address derivation path (e.g. [0, 0])

Returns

Account

Account instance

Defined in

src/core/account.ts:40

---

fromXprvKey()

static fromXprvKey(cw3, xprvKey, accountPath, addressPath): Account

Create a new account from xprv key

Parameters

• cw3: CardanoWeb3

CardanoWeb3 instance

• xprvKey: string

Extended private key

• accountPath: AccountDerivationPath

Account derivation path (e.g. [1852, 1815, 0])

• addressPath: AddressDerivationPath

Address derivation path (e.g. [0, 0])

Returns

Account

Account instance

Defined in

src/core/account.ts:58

---

fromXpubKey()

static fromXpubKey(cw3, xpubKey, addressPath): Account

Create a new account from xpub key (limited functionality)

Parameters

• cw3: CardanoWeb3

CardanoWeb3 instance

• xpubKey: string

Extended public key

• addressPath: AddressDerivationPath

Address derivation path (e.g. [0, 0])

Returns

Account

Account instance

Defined in

src/core/account.ts:92

---

importAccount()

static importAccount(cw3, config): Account

Import an account from configuration

Parameters

• cw3: CardanoWeb3

CardanoWeb3 instance

• config: AccountExportV1

Account configuration

Returns

Account

Account instance

Defined in

src/core/account.ts:175