Class UserWallet

Index

Methods

getCryptoSectionAsJSON save toJSON toJSONWhenKindIsMnemonic decrypt decryptMnemonic decryptSecretKey edFromJSON fromMnemonic fromSecretKey loadSecretKey

Methods

getCryptoSectionAsJSON

getCryptoSectionAsJSON(): any
Returns any
- Defined in src/wallet/userWallet.ts:217

save

save(path: PathLike, addressHrp?: string): void
Parameters
- path: PathLike
- addressHrp: string = LibraryConfig.DefaultAddressHrp
Returns void
- Defined in src/wallet/userWallet.ts:247

toJSON

toJSON(addressHrp?: string): any
Converts the encrypted keyfile to plain JavaScript object.
Parameters
- OptionaladdressHrp: string
Returns any
- Defined in src/wallet/userWallet.ts:190

toJSONWhenKindIsMnemonic

toJSONWhenKindIsMnemonic(): any
Returns any
- Defined in src/wallet/userWallet.ts:236

`Static`decrypt

decrypt(
    keyFileObject: any,
    password: string,
    addressIndex?: number,
): UserSecretKey
Parameters
- keyFileObject: any
- password: string
- OptionaladdressIndex: number
Returns UserSecretKey
- Defined in src/wallet/userWallet.ts:109

`Static`decryptMnemonic

decryptMnemonic(keyFileObject: any, password: string): Mnemonic
Parameters
- keyFileObject: any
- password: string
Returns Mnemonic
- Defined in src/wallet/userWallet.ts:157

`Static`decryptSecretKey

decryptSecretKey(keyFileObject: any, password: string): UserSecretKey
Copied from: https://github.com/multiversx/mx-deprecated-core-js/blob/v1.28.0/src/account.js#L42 Notes: adjustements (code refactoring, no change in logic), in terms of:
- typing (since this is the TypeScript version)
- error handling (in line with sdk-core's error system)
- references to crypto functions
- references to object members
From an encrypted keyfile, given the password, loads the secret key and the public key.
Parameters
- keyFileObject: any
- password: string
Returns UserSecretKey
- Defined in src/wallet/userWallet.ts:138

`Static`edFromJSON

edFromJSON(keyfileObject: any): EncryptedData
Parameters
- keyfileObject: any
Returns EncryptedData
- Defined in src/wallet/userWallet.ts:168

`Static`fromMnemonic

fromMnemonic(
    __namedParameters: {
        mnemonic: string;
        password: string;
        randomness?: IRandomness;
    },
): UserWallet
Parameters
- __namedParameters: { mnemonic: string; password: string; randomness?: IRandomness }
Returns UserWallet
- Defined in src/wallet/userWallet.ts:63

`Static`fromSecretKey

fromSecretKey(
    __namedParameters: {
        password: string;
        randomness?: IRandomness;
        secretKey: UserSecretKey;
    },
): UserWallet
Parameters
- __namedParameters: { password: string; randomness?: IRandomness; secretKey: UserSecretKey }
Returns UserWallet
- Defined in src/wallet/userWallet.ts:41

`Static`loadSecretKey

loadSecretKey(
    filePath: string,
    password: string,
    addressIndex?: number,
): UserSecretKey
Parameters
- filePath: string
- password: string
- OptionaladdressIndex: number
Returns UserSecretKey
- Defined in src/wallet/userWallet.ts:84