Wallets

A wallet manages a private/public key pair which is used to cryptographically sign transactions and prove ownership on the Ethereum network.

---

Creating Instances

new ^ethers . Wallet( privateKey [ , provider ] )

Creates a new instance from privateKey and optionally connect a provider

^{ethers . Wallet} . createRandom ( [ options ] )

Creates a new random wallet; options may specify extraEntropy to stir into the random source (make sure this wallet is stored somewhere safe; if lost there is no way to recover it)

^{ethers . Wallet} . fromEncryptedWallet ( json, password [ , progressCallback ] )

Decrypt an encrypted Secret Storage JSON Wallet (from Geth, or that was created using prototype.encrypt )

^{ethers . Wallet} . fromMnemonic ( mnemonic [ , path ] )

Generate a BIP39 + BIP32 wallet from a mnemonic deriving path

default: path=”m/44’/60’/0’/0/0”

^{ethers . Wallet} . fromBrainWallet ( username , password [ , progressCallback ] )

Generate a wallet from a username and password

Examples

Private Key

var privateKey = "0x0123456789012345678901234567890123456789012345678901234567890123";
var wallet = new Wallet(privateKey);

console.log("Address: " + wallet.address);
// "Address: 0x14791697260E4c9A71f18484C9f997B308e59325"

Random Wallet

var wallet = Wallet.createRandom();
console.log("Address: " + wallet.address);
// "Address: ... this will be different every time ..."

Secret Storage Wallet (e.g. Geth or Parity)

var data = {
    id: "fb1280c0-d646-4e40-9550-7026b1be504a",
    address: "88a5c2d9919e46f883eb62f7b8dd9d0cc45bc290",
    Crypto: {
        kdfparams: {
            dklen: 32,
            p: 1,
            salt: "bbfa53547e3e3bfcc9786a2cbef8504a5031d82734ecef02153e29daeed658fd",
            r: 8,
            n: 262144
        },
        kdf: "scrypt",
        ciphertext: "10adcc8bcaf49474c6710460e0dc974331f71ee4c7baa7314b4a23d25fd6c406",
        mac: "1cf53b5ae8d75f8c037b453e7c3c61b010225d916768a6b145adf5cf9cb3a703",
        cipher: "aes-128-ctr",
        cipherparams: {
            iv: "1dcdf13e49cea706994ed38804f6d171"
         }
    },
    "version" : 3
};

var json = JSON.stringify(data);
var password = "foo";
Wallet.fromEncryptedWallet(json, password).then(function(wallet) {
    console.log("Address: " + wallet.address);
    // "Address: 0x88a5C2d9919e46F883EB62F7b8Dd9d0CC45bc290"
});

Mnemonic Phrase

var mnemonic = "radar blur cabbage chef fix engine embark joy scheme fiction master release";
var wallet = Wallet.fromMnemonic(mnemonic);

console.log("Address: " + wallet.address);
// "Address: 0xaC39b311DCEb2A4b2f5d8461c1cdaF756F4F7Ae9"

Brain Wallet

var username = "support@ethers.io";
var password = "password123";
Wallet.fromBrainWallet(username, password).then(function(wallet) {
    console.log("Address: " + wallet.address);
    // "Address: 0x7Ee9AE2a2eAF3F0df8D323d555479be562ac4905"
});

---

Prototype

^prototype . address

The public address of a wallet

^prototype . privateKey

The private key of a wallet; keep this secret

^prototype . provider

Optional; a connected Provider which allows the wallet to connect to the Ethereum network to query its state and send transactions

^prototype . getAddress ( )

A function which returns the address; for Wallet, this simply returns the address property

^prototype . sign ( transaction )

Signs transaction and returns the signed transaction as a hex string. See Transaction Requests.

^prototype . signMessage ( message )

Signs message and returns the signature as a hex string.

^prototype . encrypt ( password [ , options ] [ , progressCallback ] )

Returns a Promise with the wallet encrypted as a Secret Storage JSON Wallet; options may include overrides for the scrypt parameters.

Examples

Signing Transactions

var ethers = require('ethers');
var Wallet = ethers.Wallet;
var utils = ethers.utils;
var providers = ethers.providers;

var privateKey = "0x0123456789012345678901234567890123456789012345678901234567890123";
var wallet = new Wallet(privateKey);

console.log('Address: ' + wallet.address);
// "Address: 0x14791697260E4c9A71f18484C9f997B308e59325".

var transaction = {
    nonce: 0,
    gasLimit: 21000,
    gasPrice: utils.bigNumberify("20000000000"),

    to: "0x88a5C2d9919e46F883EB62F7b8Dd9d0CC45bc290",

    value: utils.parseEther("1.0"),
    data: "0x",

    // This ensures the transaction cannot be replayed on different networks
    chainId: providers.networks.homestead.chainId

};

var signedTransaction = wallet.sign(transaction);

console.log(signedTransaction);
// "0xf86c808504a817c8008252089488a5c2d9919e46f883eb62f7b8dd9d0cc45bc2" +
//   "90880de0b6b3a7640000801ca0d7b10eee694f7fd9acaa0baf51e91da5c3d324" +
//   "f67ad827fbe4410a32967cbc32a06ffb0b4ac0855f146ff82bef010f6f2729b4" +
//   "24c57b3be967e2074220fca13e79"

// This can now be sent to the Ethereum network
var provider = providers.getDefaultProvider();
provider.sendTransaction(signedTransaction).then(function(hash) {
    console.log('Hash: ' + hash);
    // Hash:
});

Encrypting

var password = "password123";

function callback(percent) {
    console.log("Encrypting: " + parseInt(percent * 100) + "% complete");
}

var encryptPromise = wallet.encrypt(password, callback);

encryptPromise.then(function(json) {
    console.log(json);
});

---

Blockchain Operations

These operations require the wallet have a provider attached to it.

^prototype . getBalance ( [ blockTag ] )

Returns a Promise with the balance of the wallet (as a BigNumber, in wei) at the blockTag.

default: blockTag=”latest”

^prototype . getTransactionCount ( [ blockTag ] )

Returns a Promise with the number of transactions this account has ever sent (also called the nonce) at the blockTag.

default: blockTag=”latest”

^prototype . estimateGas ( transaction )

Returns a Promise with the estimated cost for transaction (in gas, as a BigNumber)

^prototype . sendTransaction ( transaction )

Sends the transaction to the network and returns a Promise with the transaction details. It is highly recommended to omit transaction.chainId, it will be filled in by provider.

^prototype . send ( addressOrName, amountWei [ , options ] )

Sends amountWei to addressOrName on the network and returns a Promise with the transaction details.

Examples

Query the Network

var privateKey = '0x0123456789012345678901234567890123456789012345678901234567890123';
var wallet = new ethers.Wallet(privateKey);
wallet.provider = ethers.providers.getDefaultProvider();

var balancePromise = wallet.getBalance();

balancePromise.then(function(balance) {
    console.log(balance);
});

var transactionCountPromise = wallet.getTransactionCount();

transactionCountPromise.then(function(transactionCount) {
    console.log(transactionCount);
});

Transfer Ether

var privateKey = '0x0123456789012345678901234567890123456789012345678901234567890123';
var wallet = new ethers.Wallet(privateKey);
wallet.provider = ethers.providers.getDefaultProvider();

// We must pass in the amount as wei (1 ether = 1e18 wei), so we use
// this convenience function to convert ether to wei.
var amount = ethers.utils.parseEther('1.0');

var address = '0x88a5c2d9919e46f883eb62f7b8dd9d0cc45bc290';
var sendPromise = wallet.send(address, amount);

sendPromise.then(function(transactionHash) {
    console.log(transactionHash);
});


// These will query the network for appropriate values
var options = {
    //gasLimit: 21000
    //gasPrice: utils.bigNumberify("20000000000")
};

var promiseSend = wallet.send(address, amount, options);

promiseSend.then(function(transaction) {
    console.log(transaction);
});

Sending (Complex) Transactions

var privateKey = '0x0123456789012345678901234567890123456789012345678901234567890123';
var wallet = new ethers.Wallet(privateKey);
wallet.provider = ethers.providers.getDefaultProvider('ropsten');

var transaction = {
    // Recommendation: omit nonce; the provider will query the network
    // nonce: 0,

    // Gas Limit; 21000 will send ether to another use, but to execute contracts
    // larger limits are required. The provider.estimateGas can be used for this.
    gasLimit: 1000000,

    // Recommendations: omit gasPrice; the provider will query the network
    //gasPrice: utils.bigNumberify("20000000000"),

    // Required; unless deploying a contract (in which case omit)
    to: "0x88a5C2d9919e46F883EB62F7b8Dd9d0CC45bc290",

    // Optional
    data: "0x",

    // Optional
    value: ethers.utils.parseEther("1.0"),

    // Recommendation: omit chainId; the provider will populate this
    // chaindId: providers.networks.homestead.chainId
};

// Estimate the gas cost for the transaction
//var estimateGasPromise = wallet.estimateGas(transaction);

//estimateGasPromise.then(function(gasEstimate) {
//    console.log(gasEstimate);
//});

// Send the transaction
var sendTransactionPromise = wallet.sendTransaction(transaction);

sendTransactionPromise.then(function(transactionHash) {
    console.log(transactionHash);
});

---

Parsing Transactions

^Wallet . parseTransaction ( hexStringOrArrayish )

Parses a raw hexStringOrArrayish into a Transaction.

Examples

// Mainnet:
var ethers = require('ethers');
var Wallet = ethers.Wallet;
var utils = ethers.utils;
var privateKey = '0x0123456789012345678901234567890123456789012345678901234567890123';
var wallet = new ethers.Wallet(privateKey);

var raw = "0xf87083154262850500cf6e0083015f9094c149be1bcdfa69a94384b46a1f913" +
            "50e5f81c1ab880de6c75de74c236c8025a05b13ef45ce3faf69d1f40f9d15b007" +
            "0cc9e2c92f"

var transaction = {
    nonce: 1393250,
    gasLimit: 21000,
    gasPrice: utils.bigNumberify("20000000000"),

    to: "0xc149Be1bcDFa69a94384b46A1F91350E5f81c1AB",

    value: utils.parseEther("1.0"),
    data: "0x",

    // This ensures the transaction cannot be replayed on different networks
    chainId: ethers.providers.networks.homestead.chainId
};

var signedTransaction = wallet.sign(transaction);
var transaction = Wallet.parseTransaction(signedTransaction);

console.log(transaction);
// { nonce: 1393250,
//   gasPrice: BigNumber { _bn: <BN: 4a817c800> },
//   gasLimit: BigNumber { _bn: <BN: 5208> },
//   to: '0xc149Be1bcDFa69a94384b46A1F91350E5f81c1AB',
//   value: BigNumber { _bn: <BN: de0b6b3a7640000> },
//   data: '0x',
//   v: 38,
//   r: '0x3cf1f5af8bd11963193451096d86635aed589572c184ac8696dd99c9c044ded3',
//   s: '0x08c52dbf1383492c72598511bb135179ec93b062032d2a0d002214644ba39a2c',
//   chainId: 1,
//   from: '0x14791697260E4c9A71f18484C9f997B308e59325' }

---

Verifying Messages

^{ethers . Wallet} . verifyMessage ( message , signature )

Returns the address that signed message with signature.

Examples

var signature = "0xddd0a7290af9526056b4e35a077b9a11b513aa0028ec6c9880948544508f3c63" +
                  "265e99e47ad31bb2cab9646c504576b3abc6939a1710afc08cbf3034d73214b8" +
                  "1c";
var address = Wallet.verifyMessage('hello world', signature);
console.log(address);
// '0x14791697260E4c9A71f18484C9f997B308e59325'

---