Class Wallet

Wallet provides methods to create locked and unlocked wallet instances.

Constructors

constructor

Properties

fromEncryptedJson fromExtendedKey fromMnemonic fromSeed generate

Methods

fromAddress fromPrivateKey

Constructors

constructor

Properties

StaticfromEncryptedJson

fromEncryptedJson: ((jsonWallet: string, password: string, provider?: Provider) => Promise<WalletUnlocked>) = WalletUnlocked.fromEncryptedJson

Create a Wallet Unlocked from an encrypted JSON.

Type declaration

    • (jsonWallet, password, provider?): Promise<WalletUnlocked>

    • Create a Wallet Unlocked from an encrypted JSON.

      Parameters

      • jsonWallet: string

        The encrypted JSON keystore.

      • password: string

        The password to decrypt the JSON.

      • Optionalprovider: Provider

        A Provider instance (optional).

      Returns Promise<WalletUnlocked>

      An unlocked wallet instance.

Param: jsonWallet

The encrypted JSON keystore.

Param: password

The password to decrypt the JSON.

Param: provider

A Provider instance (optional).

Returns

An unlocked wallet instance.

StaticfromExtendedKey

fromExtendedKey: ((extendedKey: string, provider?: Provider) => WalletUnlocked) = WalletUnlocked.fromExtendedKey

Create a Wallet Unlocked from an extended key.

Type declaration

    • (extendedKey, provider?): WalletUnlocked

    • Create a Wallet Unlocked from an extended key.

      Parameters

      • extendedKey: string

        The extended key.

      • Optionalprovider: Provider

        A Provider instance (optional).

      Returns WalletUnlocked

      An instance of WalletUnlocked.

Param: extendedKey

The extended key.

Param: provider

A Provider instance (optional).

Returns

An unlocked wallet instance.

StaticfromMnemonic

fromMnemonic: ((mnemonic: string, path?: string, passphrase?: BytesLike, provider?: Provider) => WalletUnlocked) = WalletUnlocked.fromMnemonic

Create a Wallet Unlocked from a mnemonic phrase.

Type declaration

    • (mnemonic, path?, passphrase?, provider?): WalletUnlocked

    • Create a Wallet Unlocked from a mnemonic phrase.

      Parameters

      • mnemonic: string

        The mnemonic phrase.

      • Optionalpath: string

        The derivation path (optional).

      • Optionalpassphrase: BytesLike

        The passphrase for the mnemonic (optional).

      • Optionalprovider: Provider

        A Provider instance (optional).

      Returns WalletUnlocked

      An instance of WalletUnlocked.

Param: mnemonic

The mnemonic phrase.

Param: provider

A Provider instance (optional).

Param: path

The derivation path (optional).

Param: passphrase

The passphrase for the mnemonic (optional).

Returns

An unlocked wallet instance.

StaticfromSeed

fromSeed: ((seed: string, path?: string, provider?: Provider) => WalletUnlocked) = WalletUnlocked.fromSeed

Create a Wallet Unlocked from a seed.

Type declaration

    • (seed, path?, provider?): WalletUnlocked

    • Create a Wallet Unlocked from a seed.

      Parameters

      • seed: string

        The seed phrase.

      • Optionalpath: string

        The derivation path (optional).

      • Optionalprovider: Provider

        A Provider instance (optional).

      Returns WalletUnlocked

      An instance of WalletUnlocked.

Param: seed

The seed phrase.

Param: provider

A Provider instance (optional).

Param: path

The derivation path (optional).

Returns

An unlocked wallet instance.

Staticgenerate

generate: ((generateOptions?: GenerateOptions) => WalletUnlocked) = WalletUnlocked.generate

Generate a new Wallet Unlocked with a random key pair.

Type declaration

    • (generateOptions?): WalletUnlocked

    • Generate a new Wallet Unlocked with a random key pair.

      Parameters

      • OptionalgenerateOptions: GenerateOptions

        Options to customize the generation process (optional).

      Returns WalletUnlocked

      An instance of WalletUnlocked.

Param: generateOptions

Options to customize the generation process (optional).

Returns

An unlocked wallet instance.

Methods

StaticfromAddress

  • fromAddress(address, provider?): WalletLocked

  • Creates a locked wallet instance from an address and a provider.

    Parameters

    • address: string | Address

      The address of the wallet.

    • Optionalprovider: Provider

      A Provider instance (optional).

    Returns WalletLocked

    A locked wallet instance.

StaticfromPrivateKey

  • fromPrivateKey(privateKey, provider?): WalletUnlocked

  • Creates an unlocked wallet instance from a private key and a provider.

    Parameters

    • privateKey: BytesLike

      The private key of the wallet.

    • Optionalprovider: Provider

      A Provider instance (optional).

    Returns WalletUnlocked

    An unlocked wallet instance.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods