embarklabs
/
embarkjs-plasma
mirror of https://github.com/embarklabs/embarkjs-plasma.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove need to sign typed data tx 

If the node does not support `eth_signTypedData_v3`, the tx is signed locally.

Bump version.

NOTE: This means that there is still a private key being passed in to `EmbarkJS.Plasma` constructor and will be written in to `embarkjs.js` and stored on disk. We are looking at ways to remove the need to pass a private key altogether when not using metamsk.
This commit is contained in:
emizzle 2019-06-26 12:42:02 +10:00
parent 93db99cd08
commit dc50751f20
No known key found for this signature in database
GPG Key ID: 1FD4BAB3C37EE9BA
3 changed files with 33 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "embarkjs-plasma",
"version": "1.0.2",
"version": "1.0.3",
"description": "EmbarkJS library for the OmiseGO Plasma plugin for Embark",
"main": "dist/index.js",
"browser": {

97
src/index.js
View File

@ -14,14 +14,14 @@ const ERC20_ABI = require("human-standard-token-abi");
const web3Options = {transactionConfirmationBlocks: 1};
export default class EmbarkJSPlasma {
constructor({pluginConfig, logger}) {
constructor({pluginConfig, logger, accounts}) {
this.logger = logger;
this.initing = false;
this.inited = false;
this.currentAddress = "";
// TODO: Remove PK support in favour of signing in Embark proxy
this.currentPrivateKey = "";
this.maxDeposit = 0;
this.configAccounts = accounts || [];
this.state = {
account: {
address: "",
@ -43,7 +43,7 @@ export default class EmbarkJSPlasma {
};
}
async init(embarkWeb3, useEmbarkWeb3 = false, configAccounts = []) {
async init(embarkWeb3, useEmbarkWeb3 = false) {
try {
if (this.initing) {
const message = "Already intializing the Plasma chain, please wait...";
@ -68,8 +68,8 @@ export default class EmbarkJSPlasma {
this.childChain = new ChildChain(this.config.watcherUrl); //, this.config.childChainUrl);
let accounts = [];
if (configAccounts.length) {
const account = configAccounts.length > 1 ? configAccounts[1] : configAccounts[0];
if (!this.isMetaMask && this.configAccounts.length) {
const account = this.configAccounts.length > 1 ? this.configAccounts[1] : this.configAccounts[0];
this.currentAddress = account.address;
this.currentPrivateKey = account.privateKey; // TODO: remove PK in favour of signing in Embark
this.web3.eth.accounts.wallet.add(account.privateKey);
@ -80,18 +80,6 @@ export default class EmbarkJSPlasma {
this.currentAddress = address;
}
// check account balance on the main chain
// try {
// this.maxDeposit = await this.web3.eth.getBalance(this.currentAddress);
// if (!this.maxDeposit || new BigNumber(this.maxDeposit).lte(0)) {
// throw new Error("The configured account does not have enough funds. Please make sure this account has Rinkeby ETH.");
// }
// this.maxDeposit = new BigNumber(this.maxDeposit);
// }
// catch (e) {
// this.logger.warn(`Error getting balance for account ${this.currentAddress}: ${e}`);
// }
// set lifecycle state vars
this.initing = false;
this.inited = true;
@ -114,14 +102,6 @@ export default class EmbarkJSPlasma {
const message = "You must deposit more than 0 wei.";
throw new Error(message);
}
// if (amount.gt(this.maxDeposit) && this.maxDeposit.gt(0)) {
// // recheck balance in case it was updated in a recent tx
// this.maxDeposit = await this.web3.eth.getBalance(this.currentAddress);
// if (amount.gt(this.maxDeposit)) {
// const message = `You do not have enough funds for this deposit. Please deposit more funds in to ${this.currentAddress} and then try again.`;
// throw new Error(message);
// }
// }
// Create the deposit transaction
const depositTx = transaction.encodeDeposit(this.currentAddress, amount, currency);
@ -171,64 +151,25 @@ export default class EmbarkJSPlasma {
throw new Error(`No utxo big enough to cover the amount ${amount}`);
}
// const txBody = {
// inputs: utxosToSpend,
// outputs: [
// {
// owner: toAddress,
// currency,
// amount: amount.toString()
// }
// ]
// };
// const bnAmount = new BigNumber(utxosToSpend[0].amount);
// if (bnAmount.gt(new BigNumber(amount))) {
// // Need to add a 'change' output
// const CHANGE_AMOUNT = bnAmount.sub(new BigNumber(amount));
// txBody.outputs.push({
// owner: this.currentAddress,
// currency,
// amount: CHANGE_AMOUNT
// });
// }
// if (currency !== transaction.ETH_CURRENCY && utxosToSpend.length > 1) {
// // The fee input can be returned
// txBody.outputs.push({
// owner: this.currentAddress,
// currency: utxosToSpend[utxosToSpend.length - 1].currency,
// amount: utxosToSpend[utxosToSpend.length - 1].amount
// });
// }
const txBody = transaction.createTransactionBody(this.currentAddress, utxosToSpend, toAddress, amount, currency);
// Get the transaction data
const typedData = transaction.getTypedData(txBody, verifyingContract);
let signature;
if (this.isMetaMask) {
let signature = await signTypedData(
this.web3,
this.web3.utils.toChecksumAddress(this.currentAddress),
typedData,
this.childChain,
this.currentPrivateKey
);
// We should really sign each input separately but in this we know that they're all
// from the same address, so we can sign once and use that signature for each input.
//
// const sigs = await Promise.all(utxosToSpend.map(input => signTypedData(web3, web3.utils.toChecksumAddress(from), typedData)))
//
signature = await signTypedData(
this.web3,
this.web3.utils.toChecksumAddress(this.currentAddress),
JSON.stringify(typedData)
);
} else {
// Sign the hashed data (once for each input spent)
signature = await this.childChain.signTransaction(typedData, [this.currentPrivateKey]);
//signature = await this.web3.eth.accounts.signTransaction(typedData, this.currentPrivateKey);
}
const sigs = new Array(utxosToSpend.length).fill(signature);
// ensure we have an array
signature = signature instanceof Array ? signature : [signature];
// Build the signed transaction
const signedTx = this.childChain.buildSignedTransaction(typedData, this.isMetaMask ? sigs : signature);
const signedTx = this.childChain.buildSignedTransaction(typedData, signature);
// Submit the signed transaction to the childchain
const result = await this.childChain.submitTransaction(signedTx);
@ -261,6 +202,7 @@ export default class EmbarkJSPlasma {
throw new Error(message);
}
const errors = [];
const messages = [];
utxos.forEach(async utxo => {
const exitData = await this.childChain.getExitData(utxo);
@ -275,11 +217,11 @@ export default class EmbarkJSPlasma {
}
);
return `Exited UTXO from address ${fromAddress} with value ${
messages.push(`Exited UTXO from address ${fromAddress} with value ${
utxo.amount
}. View the transaction: https://rinkeby.etherscan.io/tx/${
receipt.transactionHash
}`;
}`);
} catch (e) {
const message = `Error exiting the Plasma chain for UTXO ${JSON.stringify(
utxo
@ -290,6 +232,7 @@ export default class EmbarkJSPlasma {
if (errors.length) {
throw new Error(errors.join("\n\n"));
}
return messages.join("\n");
}
async exitUtxo(from, utxoToExit) {

14
src/utils.js
View File

@ -94,8 +94,18 @@ export function selectUtxos(utxos, amount, currency, includeFee) {
}
}
export function signTypedData(web3, signer, data) {
return web3.currentProvider.send('eth_signTypedData_v3', [signer, data]);
export async function signTypedData(web3, signer, data, childChain, pk) {
try {
return await web3.currentProvider.send('eth_signTypedData_v3', [signer, JSON.stringify(data)]);
} catch(e) {
if (e.message.includes("The method eth_signTypedData_v3 does not exist/is not available")) {
// the node we're connecting to doesn't support this message, so we have to sign it ourselves.
// TODO: this needs to be removed along with passing in the account's private key in favour of
// intercepting this request in embark and signing the tx on the embark side.
// Once we get ride of the PK, we also don't need to pass in the childchain param
return await childChain.signTransaction(data, [pk]);
}
}
}
export function normalizeUrl(url) {