Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/account-lib/src/coin/baseCoin/enum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ export enum TransactionType {
AddressInitialization,
// Flush tokens from a forwarder address to its base address
FlushTokens,
// Flush native coins (eg. ETH) from a forwarder address to base address
FlushCoins,
// Send a raw single-sig transaction
SingleSigSend,
// Update an account on-chain (e.g. Public key revelation operation for Tezos)
Expand Down
22 changes: 22 additions & 0 deletions modules/account-lib/src/coin/eth/transactionBuilder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { KeyPair } from './keyPair';
import { Fee, SignatureParts, TxData } from './iface';
import {
calculateForwarderAddress,
flushCoinsData,
flushTokensData,
getAddressInitializationData,
getCommon,
Expand Down Expand Up @@ -98,6 +99,8 @@ export class TransactionBuilder extends BaseTransactionBuilder {
return this.buildAddressInitializationTransaction();
case TransactionType.FlushTokens:
return this.buildFlushTokensTransaction();
case TransactionType.FlushCoins:
return this.buildFlushCoinsTransaction();
case TransactionType.SingleSigSend:
return this.buildBase('0x');
default:
Expand Down Expand Up @@ -153,6 +156,12 @@ export class TransactionBuilder extends BaseTransactionBuilder {
this.forwarderAddress(forwarderAddress);
this.tokenAddress(tokenAddress);
break;
case TransactionType.FlushCoins:
if (transactionJson.to === undefined) {
throw new BuildTransactionError('Undefined recipient address');
}
this.contract(transactionJson.to);
break;
case TransactionType.Send:
if (transactionJson.to === undefined) {
throw new BuildTransactionError('Undefined recipient address');
Expand Down Expand Up @@ -261,6 +270,9 @@ export class TransactionBuilder extends BaseTransactionBuilder {
case TransactionType.AddressInitialization:
this.validateContractAddress();
break;
case TransactionType.FlushCoins:
this.validateContractAddress();
break;
case TransactionType.FlushTokens:
this.validateContractAddress();
this.validateForwarderAddress();
Expand Down Expand Up @@ -377,6 +389,7 @@ export class TransactionBuilder extends BaseTransactionBuilder {
this._value = value;
}

// set args that are required for all types of eth transactions
protected buildBase(data: string): TxData {
return {
gasLimit: this._fee.gasLimit,
Expand Down Expand Up @@ -543,6 +556,15 @@ export class TransactionBuilder extends BaseTransactionBuilder {
private buildFlushTokensTransaction(): TxData {
return this.buildBase(flushTokensData(this._forwarderAddress, this._tokenAddress));
}

/**
* Build a transaction to flush tokens from a forwarder.
*
* @returns {TxData} The Ethereum transaction data
*/
private buildFlushCoinsTransaction(): TxData {
return this.buildBase(flushCoinsData());
}
//endregion

/** @inheritdoc */
Expand Down
13 changes: 13 additions & 0 deletions modules/account-lib/src/coin/eth/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ import { KeyPair } from './keyPair';
import {
createForwarderMethodId,
flushForwarderTokensMethodId,
flushCoinsMethodId,
flushTokensTypes,
flushCoinsTypes,
sendMultisigMethodId,
sendMultisigTokenMethodId,
sendMultiSigTokenTypes,
Expand Down Expand Up @@ -154,6 +156,16 @@ export function flushTokensData(forwarderAddress, tokenAddress): string {
return addHexPrefix(Buffer.concat([method, args]).toString('hex'));
}

/**
* Get the data required to make a flush native coins contract call
*/
export function flushCoinsData(): string {
const params = [];
const method = EthereumAbi.methodID('flush', flushCoinsTypes);
const args = EthereumAbi.rawEncode(flushCoinsTypes, params);
Comment thread
glowang marked this conversation as resolved.
Resolved
return addHexPrefix(Buffer.concat([method, args]).toString('hex'));
}

/**
* Returns the create forwarder method calling data
*
Expand Down Expand Up @@ -337,6 +349,7 @@ const transactionTypesMap = {
[createForwarderMethodId]: TransactionType.AddressInitialization,
[sendMultisigMethodId]: TransactionType.Send,
[flushForwarderTokensMethodId]: TransactionType.FlushTokens,
[flushCoinsMethodId]: TransactionType.FlushCoins,
[sendMultisigTokenMethodId]: TransactionType.Send,
[LockMethodId]: TransactionType.StakingLock,
[VoteMethodId]: TransactionType.StakingVote,
Expand Down
2 changes: 2 additions & 0 deletions modules/account-lib/src/coin/eth/walletUtil.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ export const sendMultisigTokenMethodId = '0x0dcd7a6c';
export const createForwarderMethodId = '0xa68a76cc';
export const walletInitializationFirstBytes = '0x60606040';
export const flushForwarderTokensMethodId = '0x2da03409';
export const flushCoinsMethodId = '0x6b9f96ea';

/*
Steps to reproduce:
Expand All @@ -16,6 +17,7 @@ export const walletSimpleByteCode =

export const walletSimpleConstructor = ['address[]'];
export const flushTokensTypes = ['address', 'address'];
export const flushCoinsTypes = [];

export const walletSimpleAbi = [
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
import should from 'should';
import { TransactionType } from '../../../../../src/coin/baseCoin';
import { getBuilder, Eth } from '../../../../../src';
import { Transaction } from '../../../../../src/coin/eth';
import { Fee } from '../../../../../src/coin/eth/iface';
import { flushCoinsMethodId } from '../../../../../src/coin/eth/walletUtil';

describe('Eth Transaction builder flush native coins', function() {
const sourcePrv =
'xprv9s21ZrQH143K3D8TXfvAJgHVfTEeQNW5Ys9wZtnUZkqPzFzSjbEJrWC1vZ4GnXCvR7rQL2UFX3RSuYeU9MrERm1XBvACow7c36vnz5iYyj2';
const pub1 =
'xpub661MyMwAqRbcGpyL5QvWah4XZYHuTK21mSQ4NVwYaX67A35Kzb42nmTdf2WArW4tettXrWpfpwFbEFdEVqcSvnHLB8F6p1D41ssmbnRMXpc';
const pub2 =
'xpub661MyMwAqRbcFWzoz8qnYRDYEFQpPLYwxVFoG6WLy3ck5ZupRGJTG4ju6yGb7Dj3ey6GsC4kstLRER2nKzgjLtmxyPgC4zHy7kVhUt6yfGn';
const defaultKeyPair = new Eth.KeyPair({
prv: 'FAC4D04AA0025ECF200D74BC9B5E4616E4B8338B69B61362AAAD49F76E68EF28',
});

interface FlushCoinsDetails {
contractAddress?: string;
counter?: number;
fee?: Fee;
key?: Eth.KeyPair;
}

const buildTransaction = async function(details: FlushCoinsDetails): Promise<Transaction> {
const txBuilder: any = getBuilder('teth');
txBuilder.type(TransactionType.FlushCoins);

if (details.fee !== undefined) {
txBuilder.fee(details.fee);
}

if (details.contractAddress !== undefined) {
txBuilder.contract(details.contractAddress);
}

if (details.counter !== undefined) {
txBuilder.counter(details.counter);
}

if (details.key !== undefined) {
txBuilder.sign({ key: details.key.getKeys().prv });
}

return await txBuilder.build();
};

describe('should build', () => {
it('a wallet flush forwarder transaction', async () => {
const tx = await buildTransaction({
fee: {
fee: '10',
gasLimit: '1000',
},
counter: 1,
contractAddress: '0x8f977e912ef500548a0c3be6ddde9899f1199b81',
});

console.log('DEBUG tx type')
console.log(tx.type)
console.log(TransactionType.FlushCoins)
console.log(TransactionType)
tx.type.should.equal(TransactionType.FlushCoins);
const txJson = tx.toJson();
txJson.gasLimit.should.equal('1000');
txJson.gasPrice.should.equal('10');
should.equal(txJson.nonce, 1);
txJson.data.should.startWith(flushCoinsMethodId);
});

it('a wallet flush forwarder transaction with nonce 0', async () => {
const tx = await buildTransaction({
fee: {
fee: '10',
gasLimit: '1000',
},
counter: 0,
contractAddress: '0x8f977e912ef500548a0c3be6ddde9899f1199b81',
});

tx.type.should.equal(TransactionType.FlushCoins);
const txJson = tx.toJson();
txJson.gasLimit.should.equal('1000');
txJson.gasPrice.should.equal('10');
should.equal(txJson.nonce, 0);
});

it('an unsigned flush transaction from serialized', async () => {
const tx = await buildTransaction({
fee: {
fee: '10',
gasLimit: '1000',
},
counter: 0,
contractAddress: '0x8f977e912ef500548a0c3be6ddde9899f1199b81',
});
const serialized = tx.toBroadcastFormat();

// now rebuild from the signed serialized tx and make sure it stays the same
const newTxBuilder: any = getBuilder('eth');
newTxBuilder.from(serialized);
const newTx = await newTxBuilder.build();
should.equal(newTx.toBroadcastFormat(), serialized);
newTx.toJson().data.should.startWith(flushCoinsMethodId);
});

it('a signed flush coin transaction from serialized', async () => {
const tx = await buildTransaction({
fee: {
fee: '10',
gasLimit: '1000',
},
counter: 0,
contractAddress: '0x8f977e912ef500548a0c3be6ddde9899f1199b81',
key: defaultKeyPair,
});
const serialized = tx.toBroadcastFormat();

// now rebuild from the signed serialized tx and make sure it stays the same
const newTxBuilder: any = getBuilder('teth');
newTxBuilder.from(serialized);
const newTx = await newTxBuilder.build();
should.equal(newTx.toBroadcastFormat(), serialized);
const txJson = newTx.toJson();
should.exist(txJson.v);
should.exist(txJson.r);
should.exist(txJson.s);
should.exist(txJson.from);
});
});

describe('should fail to build', () => {
it('a transaction without fee', async () => {
await buildTransaction({
counter: 0,
contractAddress: '0x8f977e912ef500548a0c3be6ddde9899f1199b81',
}).should.be.rejectedWith('Invalid transaction: missing fee');
});

it('a transaction without contractAddress', async () => {
await buildTransaction({
fee: {
fee: '10',
gasLimit: '10',
},
counter: 0,
}).should.be.rejectedWith('Invalid transaction: missing contract address');
});

it('a transaction with invalid counter', async () => {
await buildTransaction({
fee: {
fee: '10',
gasLimit: '10',
},
counter: -1,
}).should.be.rejectedWith('Invalid counter: -1');
});
});
});