284 lines
11 KiB
TypeScript
284 lines
11 KiB
TypeScript
'use strict';
|
|
|
|
import assert from "assert";
|
|
|
|
import { ethers } from "ethers";
|
|
import { loadTests, TestCase } from "@ethersproject/testcases";
|
|
|
|
import * as utils from "./utils";
|
|
|
|
|
|
describe('Test JSON Wallets', function() {
|
|
|
|
let tests: Array<TestCase.Wallet> = loadTests('wallets');
|
|
tests.forEach(function(test) {
|
|
it(('decrypts wallet - ' + test.name), function() {
|
|
this.timeout(1200000);
|
|
|
|
if (test.hasAddress) {
|
|
assert.ok((ethers.utils.getJsonWalletAddress(test.json) !== null),
|
|
'detect encrypted JSON wallet');
|
|
}
|
|
|
|
return ethers.Wallet.fromEncryptedJson(test.json, test.password).then((wallet) => {
|
|
assert.equal(wallet.privateKey, test.privateKey,
|
|
'generated correct private key - ' + wallet.privateKey);
|
|
assert.equal(wallet.address.toLowerCase(), test.address,
|
|
'generate correct address - ' + wallet.address);
|
|
if (test.mnemonic) {
|
|
assert.equal(wallet.mnemonic, test.mnemonic,
|
|
'mnemonic enabled encrypted wallet has a mnemonic');
|
|
}
|
|
});
|
|
});
|
|
});
|
|
|
|
// A few extra test cases to test encrypting/decrypting
|
|
['one', 'two', 'three'].forEach(function(i) {
|
|
let password = 'foobar' + i;
|
|
let wallet = ethers.Wallet.createRandom({ path: "m/56'/82", extraEntropy: utils.randomHexString('test-' + i, 32) });
|
|
|
|
it('encrypts and decrypts a random wallet - ' + i, function() {
|
|
this.timeout(1200000);
|
|
|
|
return wallet.encrypt(password).then((json: string) => {
|
|
return ethers.Wallet.fromEncryptedJson(json, password).then((decryptedWallet) => {
|
|
assert.equal(decryptedWallet.address, wallet.address,
|
|
'decrypted wallet - ' + wallet.privateKey);
|
|
assert.equal(decryptedWallet.mnemonic, wallet.mnemonic,
|
|
"decrypted wallet menonic - " + wallet.privateKey);
|
|
assert.equal(decryptedWallet.path, wallet.path,
|
|
"decrypted wallet path - " + wallet.privateKey);
|
|
return decryptedWallet.encrypt(password).then((encryptedWallet) => {
|
|
let parsedWallet = JSON.parse(encryptedWallet);
|
|
assert.equal(decryptedWallet.address.toLowerCase().substring(2), parsedWallet.address,
|
|
're-encrypted wallet - ' + wallet.privateKey);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Test Transaction Signing and Parsing', function() {
|
|
type TestCase = {
|
|
name: string;
|
|
accountAddress: string;
|
|
privateKey: string;
|
|
|
|
signedTransaction: string
|
|
unsignedTransaction: string;
|
|
|
|
signedTransactionChainId5: string
|
|
unsignedTransactionChainId5: string;
|
|
|
|
nonce: number;
|
|
gasLimit: string;
|
|
gasPrice: string;
|
|
to: string;
|
|
value: string;
|
|
data: string;
|
|
};
|
|
type TestCaseKey = 'nonce' | 'gasLimit' | 'gasPrice' | 'to' | 'value' | 'data';
|
|
|
|
function checkTransaction(parsedTransaction: any, test: TestCase): any {
|
|
let transaction: any = { };
|
|
|
|
['nonce', 'gasLimit', 'gasPrice', 'to', 'value', 'data'].forEach((key: TestCaseKey) => {
|
|
let expected = test[key];
|
|
|
|
let value = parsedTransaction[key];
|
|
|
|
if ([ "gasLimit", "gasPrice", "value"].indexOf(key) >= 0) {
|
|
assert.ok((ethers.BigNumber.isBigNumber(value)),
|
|
'parsed into a big number - ' + key);
|
|
value = value.toHexString();
|
|
|
|
if (!expected || expected === '0x') { expected = '0x00'; }
|
|
|
|
} else if (key === 'nonce') {
|
|
assert.equal(typeof(value), 'number',
|
|
'parse into a number - nonce');
|
|
|
|
value = ethers.utils.hexlify(value);
|
|
|
|
if (!expected || expected === '0x') { expected = '0x00'; }
|
|
|
|
} else if (key === 'data') {
|
|
if (!expected) { expected = '0x'; }
|
|
|
|
} else if (key === 'to') {
|
|
if (value) {
|
|
// Make sure the address is valid
|
|
ethers.utils.getAddress(value);
|
|
value = value.toLowerCase();
|
|
}
|
|
}
|
|
|
|
assert.equal(value, expected, 'parses ' + key + ' (legacy)');
|
|
|
|
transaction[key] = test[key];
|
|
});
|
|
|
|
return transaction;
|
|
}
|
|
|
|
|
|
let tests: Array<TestCase> = loadTests('transactions');
|
|
tests.forEach((test) => {
|
|
it(('parses and signs transaction - ' + test.name), function() {
|
|
this.timeout(120000);
|
|
|
|
let signingKey = new ethers.utils.SigningKey(test.privateKey);
|
|
let signDigest = signingKey.signDigest.bind(signingKey);
|
|
|
|
// Legacy parsing unsigned transaction
|
|
checkTransaction(ethers.utils.parseTransaction(test.unsignedTransaction), test);
|
|
|
|
let parsedTransaction = ethers.utils.parseTransaction(test.signedTransaction);
|
|
let transaction = checkTransaction(parsedTransaction, test);
|
|
|
|
// Legacy signed transaction ecrecover
|
|
assert.equal(parsedTransaction.from, ethers.utils.getAddress(test.accountAddress),
|
|
'computed from');
|
|
|
|
// Legacy transaction chain ID
|
|
assert.equal(parsedTransaction.chainId, 0, 'parses chainId (legacy)');
|
|
|
|
// Legacy serializes unsigned transaction
|
|
(function() {
|
|
let unsignedTx = ethers.utils.serializeTransaction(transaction);
|
|
assert.equal(unsignedTx, test.unsignedTransaction,
|
|
'serializes undsigned transaction (legacy)');
|
|
|
|
// Legacy signed serialized transaction
|
|
let signature = signDigest(ethers.utils.keccak256(unsignedTx));
|
|
assert.equal(ethers.utils.serializeTransaction(transaction, signature), test.signedTransaction,
|
|
'signs transaction (legacy)');
|
|
})();
|
|
|
|
|
|
// EIP155
|
|
|
|
// EIP-155 parsing unsigned transaction
|
|
let parsedUnsignedTransactionChainId5 = ethers.utils.parseTransaction(test.unsignedTransactionChainId5);
|
|
checkTransaction(parsedUnsignedTransactionChainId5, test);
|
|
assert.equal(parsedUnsignedTransactionChainId5.chainId, 5, 'parses chainId (eip155)');
|
|
|
|
// EIP-155 fields
|
|
let parsedTransactionChainId5 = ethers.utils.parseTransaction(test.signedTransactionChainId5);
|
|
|
|
type TxStringKey = 'data' | 'from' | 'nonce' | 'to';
|
|
['data', 'from', 'nonce', 'to'].forEach((key: TxStringKey) => {
|
|
assert.equal(parsedTransaction[key], parsedTransactionChainId5[key],
|
|
'parses ' + key + ' (eip155)');
|
|
});
|
|
|
|
type TxNumberKey = 'gasLimit' | 'gasPrice' | 'value';
|
|
['gasLimit', 'gasPrice', 'value'].forEach((key: TxNumberKey) => {
|
|
assert.ok(parsedTransaction[key].eq(parsedTransactionChainId5[key]),
|
|
'parses ' + key + ' (eip155)');
|
|
});
|
|
|
|
// EIP-155 chain ID
|
|
assert.equal(parsedTransactionChainId5.chainId, 5,
|
|
'parses chainId (eip155)');
|
|
|
|
transaction.chainId = 5;
|
|
|
|
(function() {
|
|
// EIP-155 serialized unsigned transaction
|
|
let unsignedTx = ethers.utils.serializeTransaction(transaction);
|
|
assert.equal(unsignedTx, test.unsignedTransactionChainId5,
|
|
'serializes unsigned transaction (eip155) ');
|
|
|
|
// EIP-155 signed serialized transaction
|
|
let signature = signDigest(ethers.utils.keccak256(unsignedTx));
|
|
assert.equal(ethers.utils.serializeTransaction(transaction, signature), test.signedTransactionChainId5,
|
|
'signs transaction (eip155)');
|
|
})();
|
|
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Test Signing Messages', function() {
|
|
type TestCase = {
|
|
address: string;
|
|
name: string;
|
|
message: string | Uint8Array;
|
|
messageHash: string;
|
|
privateKey: string;
|
|
signature: string;
|
|
}
|
|
|
|
let tests: Array<TestCase> = [
|
|
// See: https://etherscan.io/verifySig/57
|
|
{
|
|
address: '0x14791697260E4c9A71f18484C9f997B308e59325',
|
|
name: 'string("hello world")',
|
|
message: 'hello world',
|
|
messageHash: '0xd9eba16ed0ecae432b71fe008c98cc872bb4cc214d3220a36f365326cf807d68',
|
|
privateKey: '0x0123456789012345678901234567890123456789012345678901234567890123',
|
|
signature: '0xddd0a7290af9526056b4e35a077b9a11b513aa0028ec6c9880948544508f3c63265e99e47ad31bb2cab9646c504576b3abc6939a1710afc08cbf3034d73214b81c'
|
|
},
|
|
|
|
// See: https://github.com/ethers-io/ethers.js/issues/80
|
|
{
|
|
address: '0xD351c7c627ad5531Edb9587f4150CaF393c33E87',
|
|
name: 'bytes(0x47173285...4cb01fad)',
|
|
message: ethers.utils.arrayify('0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad'),
|
|
messageHash: '0x93100cc9477ba6522a2d7d5e83d0e075b167224ed8aa0c5860cfd47fa9f22797',
|
|
privateKey: '0x51d1d6047622bca92272d36b297799ecc152dc2ef91b229debf84fc41e8c73ee',
|
|
signature: '0x546f0c996fa4cfbf2b68fd413bfb477f05e44e66545d7782d87d52305831cd055fc9943e513297d0f6755ad1590a5476bf7d1761d4f9dc07dfe473824bbdec751b'
|
|
},
|
|
|
|
// See: https://github.com/ethers-io/ethers.js/issues/85
|
|
{
|
|
address: '0xe7deA7e64B62d1Ca52f1716f29cd27d4FE28e3e1',
|
|
name: 'zero-prefixed signature',
|
|
message: ethers.utils.arrayify(ethers.utils.id('0x7f23b5eed5bc7e89f267f339561b2697faab234a2')),
|
|
messageHash: '0x06c9d148d268f9a13d8f94f4ce351b0beff3b9ba69f23abbf171168202b2dd67',
|
|
privateKey: '0x09a11afa58d6014843fd2c5fd4e21e7fadf96ca2d8ce9934af6b8e204314f25c',
|
|
signature: '0x7222038446034a0425b6e3f0cc3594f0d979c656206408f937c37a8180bb1bea047d061e4ded4aeac77fa86eb02d42ba7250964ac3eb9da1337090258ce798491c'
|
|
}
|
|
];
|
|
|
|
tests.forEach(function(test) {
|
|
it(('signs a message "' + test.name + '"'), function() {
|
|
this.timeout(120000);
|
|
let wallet = new ethers.Wallet(test.privateKey);
|
|
return wallet.signMessage(test.message).then(function(signature: string) {
|
|
assert.equal(signature, test.signature, 'computes message signature');
|
|
});
|
|
});
|
|
});
|
|
|
|
tests.forEach(function(test) {
|
|
it(('verifies a message "' + test.name + '"'), function() {
|
|
this.timeout(120000);
|
|
// let address = ethers.utils.verifyMessage(test.message, test.signature);
|
|
// assert.equal(address, test.address, 'verifies message signature');
|
|
});
|
|
});
|
|
|
|
tests.forEach(function(test) {
|
|
it(('hashes a message "' + test.name + '"'), function() {
|
|
this.timeout(120000);
|
|
let hash = ethers.utils.hashMessage(test.message);
|
|
assert.equal(hash, test.messageHash, 'calculates message hash');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("Serialize Transactions", function() {
|
|
it("allows odd-length numeric values", function() {
|
|
const result = ethers.utils.serializeTransaction({
|
|
gasLimit: "0x1",
|
|
gasPrice: "0x1",
|
|
value: "0x1"
|
|
});
|
|
console.log(result);
|
|
});
|
|
});
|