debeem-wallet

Interface WalletEntityItem

interface WalletEntityItem {
    address: string;
    avatar?: string;
    chainCode?: string;
    chainId: number;
    depth?: number;
    fingerprint?: string;
    freePayment?: boolean;
    index: number;
    isHD: boolean;
    mnemonic?: string;
    name: string;
    parentFingerprint?: string;
    password: string;
    path?: null | string;
    pinCode: string;
    privateKey: string;
    publicKey: string;
    remark?: string;
}

Hierarchy

  • TWalletItem
    • WalletEntityItem

Properties

address avatar? chainCode? chainId depth? fingerprint? freePayment? index isHD mnemonic? name parentFingerprint? password path? pinCode privateKey publicKey remark?

Properties

address

address: string

address of wallet. this, wallet address is the globally unique stored key for storage

Optional avatar

avatar?: string

wallet avatar

Optional chainCode

chainCode?: string

The chaincode, which is effectively a public key used to derive children.

chainId

chainId: number

chainId/network

Optional depth

depth?: number

The depth of this wallet, which is the number of components in its path.

Optional fingerprint

fingerprint?: string

The fingerprint.

A fingerprint allows quick qay to detect parent and child nodes,
but developers should be prepared to deal with collisions as it is only 4 bytes.

Optional freePayment

freePayment?: boolean

Pay freely

index

index: number

The index of the generated wallet address. For non-HD wallets, the index will always be 0

isHD

isHD: boolean

HD wallet?

Optional mnemonic

mnemonic?: string

mnemonic phrase, a word list

name

name: string

the wallet name

Optional parentFingerprint

parentFingerprint?: string

The parent fingerprint.

password

password: string

The password of the wallet, used to encrypt mnemonic and privateKey. If password is not empty, mnemonic and privateKey should be ciphertext

Optional path

path?: null | string

Wallet path. For non-HD wallets, the path is empty

pinCode

pinCode: string

the PIN code password for encrypting the local database storage

privateKey

privateKey: string

private key and public key

publicKey

publicKey: string

Optional remark

remark?: string

remark text