git.iko.soy/bridge
on master help sign in
bridge/src/lib/reticket.js
286 lines 7.3 kB history raw
1import * as azimuth from 'azimuth-js';
2import * as tank from './tank';
4import { hexify } from './txn';
5import {
6 deriveNetworkSeedFromUrbitWallet,
7 deriveNetworkKeys,
8 CRYPTO_SUITE_VERSION,
9} from './keys';
10import { addHexPrefix } from './utils/address';
11import {
12 sendAndAwaitAllSerial,
13 signTransaction,
14 sendSignedTransaction,
15} from './txn';
16import getSuggestedGasPrice from './getSuggestedGasPrice';
17import { GAS_LIMITS, INITIAL_NETWORK_KEY_REVISION } from './constants';
18import { toBN } from 'web3-utils';
19import { gweiToWei } from './lib';
20import { isGalaxy, isPlanet } from './utils/point';
22export const TRANSACTION_PROGRESS = {
23 GENERATING: 0.01,
24 SIGNING: 0.15,
25 FUNDING: 0.3,
26 TRANSFERRING: 0.55,
27 CLEANING: 0.95,
28 DONE: 1.0,
29};
31export async function reticketPointBetweenWallets({
32 fromWallet,
33 fromWalletType,
34 fromWalletHdPath,
35 toWallet,
36 point,
37 web3,
38 contracts,
39 networkType,
40 onUpdate,
41 transferEth = false,
42 nextRevision = INITIAL_NETWORK_KEY_REVISION,
43 txnSigner,
44 txnSender,
45 doSetSpawnProxy = true,
46}) {
47 const askForFunding = (address, minBalance, balance) =>
48 onUpdate({
49 type: 'askFunding',
50 value: { address, minBalance, balance },
51 });
53 const gotFunding = () => onUpdate({ type: 'gotFunding' });
54 const progress = state => onUpdate({ type: 'progress', state });
56 //
57 // generate transactions
58 //
60 progress(TRANSACTION_PROGRESS.GENERATING);
62 // transfer to invite wallet, so it can configure
63 //NOTE doing this in the invite wallet instead of the final wallet makes
64 // failure cases "solvable" by just telling the user to fully retry.
65 // in other words, the invite flow is effectively idempotent.
67 //TODO no harm done if we already owned it, but should still get a bool arg
68 // for skipping this, if it isn't too big a burden for callers
69 const transferTmpTx = azimuth.ecliptic.transferPoint(
70 contracts,
71 point,
72 fromWallet.address,
73 false
74 );
75 transferTmpTx.gas = GAS_LIMITS.TRANSFER;
77 // configure networking public keys
78 const seed = await deriveNetworkSeedFromUrbitWallet(toWallet, nextRevision);
80 const networkSeed = seed.matchWith({
81 Nothing: () => {
82 throw new Error('network seed not derived');
83 },
84 Just: p => p.value,
85 });
87 const networkKeys = deriveNetworkKeys(networkSeed);
89 const keysTx = azimuth.ecliptic.configureKeys(
90 contracts,
91 point,
92 addHexPrefix(networkKeys.crypt.public),
93 addHexPrefix(networkKeys.auth.public),
94 CRYPTO_SUITE_VERSION,
95 /* discontinuous */ false
96 );
97 keysTx.gas = GAS_LIMITS.CONFIGURE_KEYS;
99 // configure management proxy
101 const managementTx = azimuth.ecliptic.setManagementProxy(
102 contracts,
103 point,
104 toWallet.management.keys.address
105 );
106 managementTx.gas = GAS_LIMITS.SET_PROXY;
108 // set spawn & voting proxies situationally
110 // skip this step if reticketing an L1 point with L2-migrated spawn proxy
111 let txs = [transferTmpTx, keysTx, managementTx];
112 if (!isPlanet(point) && doSetSpawnProxy) {
113 const spawnTx = azimuth.ecliptic.setSpawnProxy(
114 contracts,
115 point,
116 toWallet.spawn.keys.address
117 );
118 spawnTx.gas = GAS_LIMITS.SET_PROXY;
119 txs.push(spawnTx);
120 }
122 if (isGalaxy(point)) {
123 const votingTx = azimuth.ecliptic.setVotingProxy(
124 contracts,
125 point,
126 toWallet.voting.keys.address
127 );
128 votingTx.gas = GAS_LIMITS.SET_PROXY;
129 txs.push(votingTx);
130 }
132 // transfer configured point to user's new wallet
134 const transferFinalTx = azimuth.ecliptic.transferPoint(
135 contracts,
136 point,
137 toWallet.ownership.keys.address,
138 false
139 );
140 transferFinalTx.gas = GAS_LIMITS.TRANSFER;
141 txs.push(transferFinalTx);
143 //
144 // finalizing & signing transactions
145 //
147 progress(TRANSACTION_PROGRESS.SIGNING);
149 const gasPriceData = (await getSuggestedGasPrice(networkType, web3)).average;
150 const chainId = await web3.eth.net.getId();
151 const gasPriceWeiBN = gweiToWei(gasPriceData.price);
152 let inviteNonce = await web3.eth.getTransactionCount(fromWallet.address);
153 const totalCost = txs.reduce(
154 (acc, tx) => acc.add(gasPriceWeiBN.mul(toBN(tx.gas))),
155 toBN(0)
156 );
158 let txPairs = [];
160 // Must be done in serial else hardware will give nonce errors
161 for (let i = 0; i < txs.length; i++) {
162 const stx = await signTransaction({
163 wallet: fromWallet,
164 walletType: fromWalletType,
165 walletHdPath: fromWalletHdPath,
166 networkType,
167 txn: txs[i],
168 nonce: inviteNonce + i,
169 chainId,
170 gasPriceData,
171 gasLimit: txs[i].gas,
172 txnSigner,
173 txnSender,
174 web3,
175 });
176 txPairs.push({
177 raw: hexify(stx.serialize()),
178 signed: stx,
179 });
180 }
182 inviteNonce = inviteNonce + txs.length;
184 //
185 // ensuring funding for transactions
186 //
188 progress(TRANSACTION_PROGRESS.FUNDING);
190 const usedTank = await tank.ensureFundsFor(
191 web3,
192 point,
193 fromWallet.address,
194 fromWalletType,
195 totalCost,
196 txPairs.map(p => p.raw),
197 askForFunding,
198 gotFunding
199 );
201 //
202 // sending and awaiting transactions
203 //
205 progress(TRANSACTION_PROGRESS.TRANSFERRING);
207 const receipts = await sendAndAwaitAllSerial(
208 web3,
209 txPairs.map(p => p.signed),
210 usedTank
211 );
213 const realCost = gasPriceWeiBN.mul(
214 receipts.reduce((sum, receipt) => {
215 return sum.add(toBN(receipt.gasUsed));
216 }, toBN(0))
217 );
219 //
220 // move leftover eth
221 //
223 progress(TRANSACTION_PROGRESS.CLEANING);
225 let balance = toBN(await web3.eth.getBalance(fromWallet.address));
226 const gasLimit = GAS_LIMITS.SEND_ETH;
227 const sendEthCost = gasPriceWeiBN.mul(toBN(gasLimit));
229 // if we have funds left over from what the gas tank gave us, send those back
230 if (usedTank && realCost.add(sendEthCost).lt(totalCost)) {
231 try {
232 const remainder = totalCost.sub(realCost).sub(sendEthCost);
233 console.log('returning to gas tank', remainder.toString());
234 const txn = { to: tank.TANK_ADDRESS, value: remainder };
235 const stx = await signTransaction({
236 wallet: fromWallet,
237 walletType: fromWalletType,
238 walletHdPath: fromWalletHdPath,
239 txn,
240 chainId,
241 networkType,
242 gasPriceData,
243 gasLimit,
244 nonce: inviteNonce,
245 web3,
246 });
247 sendSignedTransaction(web3, stx);
249 // only update these after the above succeeded
250 inviteNonce++;
251 balance = balance.sub(remainder).sub(sendEthCost);
252 } catch (err) {
253 console.log('error returning gas, safely ignored:');
254 console.log(err);
255 }
256 }
258 // if non-trivial eth left in invite wallet, transfer to new ownership
259 if (transferEth && balance.gt(sendEthCost)) {
260 try {
261 const value = balance.sub(sendEthCost);
262 const txn = {
263 to: toWallet.ownership.keys.address,
264 value: value,
265 };
266 const stx = await signTransaction({
267 wallet: fromWallet,
268 walletType: fromWalletType,
269 walletHdPath: fromWalletHdPath,
270 txn,
271 chainId,
272 networkType,
273 gasPriceData,
274 gasLimit,
275 nonce: inviteNonce,
276 web3,
277 });
278 sendSignedTransaction(web3, stx);
279 } catch (err) {
280 console.log('error sending value tx, safely ignored:');
281 console.log(err);
282 }
283 }
285 progress(TRANSACTION_PROGRESS.DONE);