@ocap/client 1.31.0 → 1.31.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/bridge.js ADDED
@@ -0,0 +1,290 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * SDK helpers for the on-chain bridge governance (bridge/docs/ocap-protocols.md §v2.2).
5
+ *
6
+ * A v2 bridge is a `RollupState` whose `data.value.version == 2`. These helpers build, sign and submit the governance
7
+ * transactions of the existing rollup protocols for such a bridge:
8
+ *
9
+ * - pure builders (no network): `buildCreateItx`, `signMembership`, `buildMembershipData`, `buildUpdateData`, ...
10
+ * - flows on a client: `client.bridge.create / update / join / leave / pause / resume / close / migrateVault /
11
+ * migrateReserve`, each building the itx, collecting the signatures of the listed wallets and sending the tx.
12
+ *
13
+ * Wallets are `@ocap/wallet` objects. Governance approvals (BridgeMembership, BridgeOwnerAttestation) are EIP-712
14
+ * signatures made with the wallet's secp256k1 key, so owners, validators and the Ethereum owner must hold such keys.
15
+ */
16
+ const {
17
+ BRIDGE_MEMBERSHIP_ACTION,
18
+ computeBridgeEndpointsHash,
19
+ computeBridgeMembershipDigest,
20
+ computeBridgeOwnerAttestationDigest,
21
+ signBridgeDigest
22
+ } = require('@ocap/mcrypto');
23
+ const { toRollupAddress: toRollupAddressCbor, toBridgeReserveAddress } = require('@arcblock/did-util/cbor');
24
+ const { toHex, toBuffer } = require('@ocap/util');
25
+
26
+ const lc = s => String(s).toLowerCase();
27
+ const sortAddresses = list => [...new Set(list.map(lc))].sort((a, b) => BigInt(a) < BigInt(b) ? -1 : BigInt(a) > BigInt(b) ? 1 : 0);
28
+
29
+ const secretOf = wallet => {
30
+ const sk = wallet.secretKey;
31
+ if (!sk) throw new Error('A wallet with a secret key is required to sign a bridge approval');
32
+ return typeof sk === 'string' ? toBuffer(sk) : sk;
33
+ };
34
+
35
+ /** EIP-712 digest of a BridgeMembership message (validators are sorted ascending for you). */
36
+ function membershipDigest(msg) {
37
+ const validators = sortAddresses(msg.validators);
38
+ // `endpoints`: { address -> url } of every listed validator; it is bound into the digest
39
+ const endpointsHash = computeBridgeEndpointsHash(validators.map(a => msg.endpoints[a] || msg.endpoints[lc(a)]));
40
+ const rest = Object.assign({}, msg);
41
+ delete rest.endpoints;
42
+ return computeBridgeMembershipDigest(Object.assign(rest, { validators, endpointsHash }));
43
+ }
44
+
45
+ /** Sign a BridgeMembership message with the secp256k1 key of `wallet`. */
46
+ function signMembership(wallet, msg) {
47
+ return signBridgeDigest(membershipDigest(msg), secretOf(wallet));
48
+ }
49
+
50
+ /** Sign a BridgeOwnerAttestation message (the Ethereum owner of the token proves it consents to this bridge). */
51
+ function signOwnerAttestation(wallet, msg) {
52
+ return signBridgeDigest(computeBridgeOwnerAttestationDigest(msg), secretOf(wallet));
53
+ }
54
+
55
+ const PARAM_KEYS = ['minDeposit', 'minWithdraw', 'maxWithdraw', 'releaseDailyCap', 'refundDailyCap', 'releaseGrace', 'refundDelay', 'transitionPeriod'];
56
+
57
+ /**
58
+ * Build the itx of a v2 `create_rollup`, address and all approvals included.
59
+ *
60
+ * @param {object} o
61
+ * @param {string} o.chainId - OCAP chain id (part of every signed struct)
62
+ * @param {string} o.tokenAddress - the OCAP token
63
+ * @param {string} o.ethToken - the Ethereum token (contract_address)
64
+ * @param {string} [o.vaultAddress] - the Ethereum vault
65
+ * @param {object} o.owner - wallet of the token owner (authority); becomes the bridge owner
66
+ * @param {string} o.ownerEndpoint - endpoint recorded for the owner seed
67
+ * @param {string} o.ethChainId
68
+ * @param {string} o.gateway
69
+ * @param {object} o.params - minDeposit, minWithdraw, maxWithdraw, releaseDailyCap, refundDailyCap, releaseGrace, refundDelay, transitionPeriod
70
+ * @param {Array<{wallet: object, endpoint: string}>} o.validators - epoch-1 operators, each signs a consent
71
+ * @param {number} o.threshold
72
+ * @param {number} o.voucherValidity
73
+ * @param {object} o.ethOwner - wallet of the Ethereum owner signing the attestation
74
+ * @param {string} o.salt - bytes32 hex
75
+ * @param {string} [o.initialReserve='0']
76
+ * @param {string[]} [o.pausers]
77
+ * @param {number} [o.minBlockConfirmation=12]
78
+ * @param {Function} [o.toRollupAddress] - address function matching the tx encoding (defaults to cbor)
79
+ */
80
+ function buildCreateItx(o) {
81
+ const toRollupAddress = o.toRollupAddress || toRollupAddressCbor;
82
+ const validators = sortAddresses(o.validators.map(x => x.wallet.address));
83
+ const epoch = {
84
+ epoch: 1,
85
+ activeFrom: 0,
86
+ threshold: o.threshold,
87
+ validators,
88
+ voucherValidity: o.voucherValidity
89
+ };
90
+ const value = Object.assign({
91
+ version: 2,
92
+ ethChainId: String(o.ethChainId),
93
+ gateway: lc(o.gateway)
94
+ }, Object.fromEntries(PARAM_KEYS.map(k => [k, o.params[k]])), {
95
+ withdrawFee: '0',
96
+ epochs: [epoch],
97
+ salt: lc(o.salt),
98
+ initialReserve: o.initialReserve || '0'
99
+ });
100
+ if (o.pausers) value.pausers = o.pausers;
101
+
102
+ const itx = {
103
+ address: '',
104
+ tokenAddress: o.tokenAddress,
105
+ vaultAddress: o.vaultAddress || '',
106
+ contractAddress: o.ethToken,
107
+ seedValidators: [{ pk: o.owner.publicKey, address: o.owner.address, endpoint: o.ownerEndpoint }],
108
+ minBlockConfirmation: o.minBlockConfirmation || 12,
109
+ data: { type: 'json', value }
110
+ };
111
+ // The bridge address is computed over the itx WITHOUT the attestation and the consents (they sign over it)
112
+ itx.address = toRollupAddress(itx);
113
+
114
+ const attestation = {
115
+ address: lc(o.ethOwner.address),
116
+ signature: signOwnerAttestation(o.ethOwner, {
117
+ ocapChainId: o.chainId,
118
+ salt: value.salt,
119
+ ocapToken: o.tokenAddress,
120
+ ethChainId: value.ethChainId,
121
+ gateway: value.gateway,
122
+ ethToken: lc(o.ethToken)
123
+ })
124
+ };
125
+ const endpoints = Object.fromEntries(o.validators.map(x => [lc(x.wallet.address), x.endpoint]));
126
+ const consents = o.validators.map(({ wallet, endpoint }) => ({
127
+ address: wallet.address,
128
+ endpoint,
129
+ signature: signMembership(wallet, {
130
+ ocapChainId: o.chainId,
131
+ bridge: itx.address,
132
+ epoch: 1,
133
+ validators,
134
+ threshold: o.threshold,
135
+ activeFrom: 0,
136
+ voucherValidity: o.voucherValidity,
137
+ endpoints,
138
+ action: BRIDGE_MEMBERSHIP_ACTION.CREATE
139
+ })
140
+ }));
141
+
142
+ return Object.assign({}, itx, {
143
+ data: { type: 'json', value: Object.assign({}, value, { ethOwnerAttestation: attestation, consents }) }
144
+ });
145
+ }
146
+
147
+ /**
148
+ * Next epoch of a join / leave computed from the bridge body. `change` = { validator, threshold, activeFrom,
149
+ * voucherValidity }. Returns the epoch the chain will derive, to be signed by owner + quorum (+ joiner).
150
+ */
151
+ function planMembership(body, action, change) {
152
+ const last = body.epochs[body.epochs.length - 1];
153
+ const v = lc(change.validator);
154
+ const validators = action === 'join' ? sortAddresses([...last.validators, v]) : sortAddresses(last.validators.filter(x => x !== v));
155
+ return {
156
+ epoch: last.epoch + 1,
157
+ validators,
158
+ threshold: change.threshold,
159
+ activeFrom: change.activeFrom,
160
+ voucherValidity: change.voucherValidity
161
+ };
162
+ }
163
+
164
+ /**
165
+ * Build `itx.data` of a join / leave and sign it with `approvers` (owner, quorum members, and the joiner for a join).
166
+ */
167
+ function buildMembershipData({ chainId, bridge, body, action, change, approvers }) {
168
+ const epoch = planMembership(body, action, change);
169
+ // endpoints of the stored members; a joiner brings its own (`change.endpoint`, also sent as itx.endpoint)
170
+ const endpoints = {};
171
+ Object.keys(body.members).forEach(k => {
172
+ endpoints[lc(k)] = body.members[k].endpoint;
173
+ });
174
+ if (action === 'join') endpoints[lc(change.validator)] = change.endpoint;
175
+ const msg = Object.assign({ ocapChainId: chainId, bridge }, epoch, {
176
+ endpoints,
177
+ action: action === 'join' ? BRIDGE_MEMBERSHIP_ACTION.JOIN : BRIDGE_MEMBERSHIP_ACTION.LEAVE
178
+ });
179
+ return {
180
+ type: 'json',
181
+ value: {
182
+ validator: change.validator,
183
+ threshold: change.threshold,
184
+ activeFrom: change.activeFrom,
185
+ voucherValidity: change.voucherValidity,
186
+ signatures: approvers.map(w => signMembership(w, msg))
187
+ }
188
+ };
189
+ }
190
+
191
+ const wrap = value => ({ type: 'json', value });
192
+
193
+ /** Typed `update_rollup` itx. `patch` holds allow-listed keys only (see the design doc). */
194
+ function buildUpdateItx(rollup, patch) {
195
+ return { rollup, data: wrap(patch) };
196
+ }
197
+
198
+ function createBridgeGovernance(client, deps = {}) {
199
+ const sendMulti = async (kind, { wallet, signers = [], itx }, extra) => {
200
+ const tx = {
201
+ from: wallet.address,
202
+ pk: wallet.publicKey,
203
+ itx,
204
+ signatures: signers.map(w => ({ signer: w.address, pk: w.publicKey, signature: '' }))
205
+ };
206
+ let encoded = (await client[`encode${kind}`]({ tx, wallet })).object;
207
+ for (const w of signers) {
208
+ // eslint-disable-next-line no-await-in-loop
209
+ encoded = await client[`multiSign${kind}`]({ tx: encoded, wallet: w });
210
+ }
211
+ return client[`send${kind}`]({ tx: encoded, wallet }, extra);
212
+ };
213
+
214
+ return {
215
+ buildCreateItx,
216
+ signMembership,
217
+ signOwnerAttestation,
218
+ membershipDigest,
219
+ planMembership,
220
+ buildMembershipData,
221
+ buildUpdateItx,
222
+ toBridgeReserveAddress,
223
+ toHex,
224
+
225
+ /** create a bridge; `owner` signs (and, for the official token, must be the moderator) */
226
+ create: async (opts, extra) => {
227
+ const itx = buildCreateItx(Object.assign({ chainId: (await client.getContext()).chainId, toRollupAddress: deps.toRollupAddress }, opts));
228
+ const hash = await client.sendCreateRollupTx({ tx: { itx }, wallet: opts.owner }, extra);
229
+ return { hash, address: itx.address, reserve: toBridgeReserveAddress(itx.address) };
230
+ },
231
+
232
+ /** owner + quorum `update_rollup` with a typed patch; use `proposeOwner` / `cancelOwnerProposal` keys for ownership */
233
+ update: ({ rollup, patch, wallet, signers }, extra) => sendMulti('UpdateRollupTx', { wallet, signers, itx: buildUpdateItx(rollup, patch) }, extra),
234
+
235
+ /** join: the joiner, the owner and an active-epoch quorum approve BridgeMembership; anyone submits */
236
+ join: async ({ rollup, body, change, endpoint, approvers, wallet }, extra) => {
237
+ const chainId = (await client.getContext()).chainId;
238
+ const data = buildMembershipData({
239
+ chainId,
240
+ bridge: rollup,
241
+ body,
242
+ action: 'join',
243
+ change: Object.assign({ endpoint }, change),
244
+ approvers
245
+ });
246
+ return client.sendJoinRollupTx({ tx: { itx: { rollup, endpoint, data } }, wallet }, extra);
247
+ },
248
+
249
+ /** leave: the owner and an active-epoch quorum approve BridgeMembership; anyone submits */
250
+ leave: async ({ rollup, body, change, approvers, wallet }, extra) => {
251
+ const chainId = (await client.getContext()).chainId;
252
+ const data = buildMembershipData({ chainId, bridge: rollup, body, action: 'leave', change, approvers });
253
+ return client.sendLeaveRollupTx({ tx: { itx: { rollup, data } }, wallet }, extra);
254
+ },
255
+
256
+ /** quorum pause (owner + quorum in `signers`) or lone pause (a pauser as `wallet`, no `signers`) */
257
+ pause: ({ rollup, wallet, signers = [] }, extra) => sendMulti('PauseRollupTx', { wallet, signers, itx: { rollup } }, extra),
258
+
259
+ resume: ({ rollup, wallet, signers = [] }, extra) => sendMulti('ResumeRollupTx', { wallet, signers, itx: { rollup } }, extra),
260
+
261
+ /** close needs a quorum pause; `depositCutoffEthBlock` is the Ethereum block of the gateway `setParams` tx */
262
+ close: ({ rollup, wallet, signers = [], message = 'close', depositCutoffEthBlock }, extra) => sendMulti('CloseRollupTx', {
263
+ wallet,
264
+ signers,
265
+ itx: { rollup, message, data: wrap({ depositCutoffEthBlock: String(depositCutoffEthBlock) }) }
266
+ }, extra),
267
+
268
+ migrateVault: ({ rollup, to, wallet, signers = [], message = 'migrate vault' }, extra) => sendMulti('MigrateRollupTx', { wallet, signers, itx: { rollup, to, type: 'vault', message } }, extra),
269
+
270
+ /**
271
+ * Reserve migration of a final bridge to `to` (a live v2 bridge): action `announce` and `execute` are signed by
272
+ * the source owner and the TARGET quorum, `cancel` by the token authority alone (no `signers`).
273
+ */
274
+ migrateReserve: ({ rollup, to, action, wallet, signers = [], message = 'migrate reserve' }, extra) => sendMulti('MigrateRollupTx', { wallet, signers, itx: { rollup, to, type: 'reserve', message, data: wrap({ action }) } }, extra)
275
+ };
276
+ }
277
+
278
+ module.exports = {
279
+ BRIDGE_MEMBERSHIP_ACTION,
280
+ buildCreateItx,
281
+ buildMembershipData,
282
+ buildUpdateItx,
283
+ createBridgeGovernance,
284
+ membershipDigest,
285
+ planMembership,
286
+ signMembership,
287
+ signOwnerAttestation,
288
+ sortAddresses
289
+ };
290
+ //# sourceMappingURL=bridge.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/bridge.js"],"names":["BRIDGE_MEMBERSHIP_ACTION","computeBridgeEndpointsHash","computeBridgeMembershipDigest","computeBridgeOwnerAttestationDigest","signBridgeDigest","require","toRollupAddress","toRollupAddressCbor","toBridgeReserveAddress","toHex","toBuffer","lc","s","String","toLowerCase","sortAddresses","list","Set","map","sort","a","b","BigInt","secretOf","wallet","sk","secretKey","Error","membershipDigest","msg","validators","endpointsHash","endpoints","rest","Object","assign","signMembership","signOwnerAttestation","PARAM_KEYS","buildCreateItx","o","x","address","epoch","activeFrom","threshold","voucherValidity","value","version","ethChainId","gateway","fromEntries","k","params","withdrawFee","epochs","salt","initialReserve","pausers","itx","tokenAddress","vaultAddress","contractAddress","ethToken","seedValidators","pk","owner","publicKey","endpoint","ownerEndpoint","minBlockConfirmation","data","type","attestation","ethOwner","signature","ocapChainId","chainId","ocapToken","consents","bridge","action","CREATE","ethOwnerAttestation","planMembership","body","change","last","length","v","validator","filter","buildMembershipData","approvers","keys","members","forEach","JOIN","LEAVE","signatures","w","wrap","buildUpdateItx","rollup","patch","createBridgeGovernance","client","deps","sendMulti","kind","signers","extra","tx","from","signer","encoded","object","create","opts","getContext","hash","sendCreateRollupTx","reserve","update","join","sendJoinRollupTx","leave","sendLeaveRollupTx","pause","resume","close","message","depositCutoffEthBlock","migrateVault","to","migrateReserve","module","exports"],"mappings":";;AAAA;;;;;;;;;;;;;AAaA,MAAM;AACJA,0BADI;AAEJC,4BAFI;AAGJC,+BAHI;AAIJC,qCAJI;AAKJC;AALI,IAMFC,QAAQ,eAAR,CANJ;AAOA,MAAM,EAAEC,iBAAiBC,mBAAnB,EAAwCC,sBAAxC,KAAmEH,QAAQ,yBAAR,CAAzE;AACA,MAAM,EAAEI,KAAF,EAASC,QAAT,KAAsBL,QAAQ,YAAR,CAA5B;;AAEA,MAAMM,KAAMC,CAAD,IAAOC,OAAOD,CAAP,EAAUE,WAAV,EAAlB;AACA,MAAMC,gBAAiBC,IAAD,IACpB,CAAC,GAAG,IAAIC,GAAJ,CAAQD,KAAKE,GAAL,CAASP,EAAT,CAAR,CAAJ,EAA2BQ,IAA3B,CAAgC,CAACC,CAAD,EAAIC,CAAJ,KAAWC,OAAOF,CAAP,IAAYE,OAAOD,CAAP,CAAZ,GAAwB,CAAC,CAAzB,GAA6BC,OAAOF,CAAP,IAAYE,OAAOD,CAAP,CAAZ,GAAwB,CAAxB,GAA4B,CAApG,CADF;;AAGA,MAAME,WAAYC,MAAD,IAAY;AAC3B,QAAMC,KAAKD,OAAOE,SAAlB;AACA,MAAI,CAACD,EAAL,EAAS,MAAM,IAAIE,KAAJ,CAAU,kEAAV,CAAN;AACT,SAAO,OAAOF,EAAP,KAAc,QAAd,GAAyBf,SAASe,EAAT,CAAzB,GAAwCA,EAA/C;AACD,CAJD;;AAMA;AACA,SAASG,gBAAT,CAA0BC,GAA1B,EAA+B;AAC7B,QAAMC,aAAaf,cAAcc,IAAIC,UAAlB,CAAnB;AACA;AACA,QAAMC,gBAAgB9B,2BAA2B6B,WAAWZ,GAAX,CAAgBE,CAAD,IAAOS,IAAIG,SAAJ,CAAcZ,CAAd,KAAoBS,IAAIG,SAAJ,CAAcrB,GAAGS,CAAH,CAAd,CAA1C,CAA3B,CAAtB;AACA,QAAMa,OAAOC,OAAOC,MAAP,CAAc,EAAd,EAAkBN,GAAlB,CAAb;AACA,SAAOI,KAAKD,SAAZ;AACA,SAAO9B,8BAA8BgC,OAAOC,MAAP,CAAcF,IAAd,EAAoB,EAAEH,UAAF,EAAcC,aAAd,EAApB,CAA9B,CAAP;AACD;;AAED;AACA,SAASK,cAAT,CAAwBZ,MAAxB,EAAgCK,GAAhC,EAAqC;AACnC,SAAOzB,iBAAiBwB,iBAAiBC,GAAjB,CAAjB,EAAwCN,SAASC,MAAT,CAAxC,CAAP;AACD;;AAED;AACA,SAASa,oBAAT,CAA8Bb,MAA9B,EAAsCK,GAAtC,EAA2C;AACzC,SAAOzB,iBAAiBD,oCAAoC0B,GAApC,CAAjB,EAA2DN,SAASC,MAAT,CAA3D,CAAP;AACD;;AAED,MAAMc,aAAa,CACjB,YADiB,EAEjB,aAFiB,EAGjB,aAHiB,EAIjB,iBAJiB,EAKjB,gBALiB,EAMjB,cANiB,EAOjB,aAPiB,EAQjB,kBARiB,CAAnB;;AAWA;;;;;;;;;;;;;;;;;;;;;;;AAuBA,SAASC,cAAT,CAAwBC,CAAxB,EAA2B;AACzB,QAAMlC,kBAAkBkC,EAAElC,eAAF,IAAqBC,mBAA7C;AACA,QAAMuB,aAAaf,cAAcyB,EAAEV,UAAF,CAAaZ,GAAb,CAAkBuB,CAAD,IAAOA,EAAEjB,MAAF,CAASkB,OAAjC,CAAd,CAAnB;AACA,QAAMC,QAAQ;AACZA,WAAO,CADK;AAEZC,gBAAY,CAFA;AAGZC,eAAWL,EAAEK,SAHD;AAIZf,cAJY;AAKZgB,qBAAiBN,EAAEM;AALP,GAAd;AAOA,QAAMC,QAAQb,OAAOC,MAAP,CACZ;AACEa,aAAS,CADX;AAEEC,gBAAYpC,OAAO2B,EAAES,UAAT,CAFd;AAGEC,aAASvC,GAAG6B,EAAEU,OAAL;AAHX,GADY,EAMZhB,OAAOiB,WAAP,CAAmBb,WAAWpB,GAAX,CAAgBkC,CAAD,IAAO,CAACA,CAAD,EAAIZ,EAAEa,MAAF,CAASD,CAAT,CAAJ,CAAtB,CAAnB,CANY,EAOZ;AACEE,iBAAa,GADf;AAEEC,YAAQ,CAACZ,KAAD,CAFV;AAGEa,UAAM7C,GAAG6B,EAAEgB,IAAL,CAHR;AAIEC,oBAAgBjB,EAAEiB,cAAF,IAAoB;AAJtC,GAPY,CAAd;AAcA,MAAIjB,EAAEkB,OAAN,EAAeX,MAAMW,OAAN,GAAgBlB,EAAEkB,OAAlB;;AAEf,QAAMC,MAAM;AACVjB,aAAS,EADC;AAEVkB,kBAAcpB,EAAEoB,YAFN;AAGVC,kBAAcrB,EAAEqB,YAAF,IAAkB,EAHtB;AAIVC,qBAAiBtB,EAAEuB,QAJT;AAKVC,oBAAgB,CAAC,EAAEC,IAAIzB,EAAE0B,KAAF,CAAQC,SAAd,EAAyBzB,SAASF,EAAE0B,KAAF,CAAQxB,OAA1C,EAAmD0B,UAAU5B,EAAE6B,aAA/D,EAAD,CALN;AAMVC,0BAAsB9B,EAAE8B,oBAAF,IAA0B,EANtC;AAOVC,UAAM,EAAEC,MAAM,MAAR,EAAgBzB,KAAhB;AAPI,GAAZ;AASA;AACAY,MAAIjB,OAAJ,GAAcpC,gBAAgBqD,GAAhB,CAAd;;AAEA,QAAMc,cAAc;AAClB/B,aAAS/B,GAAG6B,EAAEkC,QAAF,CAAWhC,OAAd,CADS;AAElBiC,eAAWtC,qBAAqBG,EAAEkC,QAAvB,EAAiC;AAC1CE,mBAAapC,EAAEqC,OAD2B;AAE1CrB,YAAMT,MAAMS,IAF8B;AAG1CsB,iBAAWtC,EAAEoB,YAH6B;AAI1CX,kBAAYF,MAAME,UAJwB;AAK1CC,eAASH,MAAMG,OAL2B;AAM1Ca,gBAAUpD,GAAG6B,EAAEuB,QAAL;AANgC,KAAjC;AAFO,GAApB;AAWA,QAAM/B,YAAYE,OAAOiB,WAAP,CAAmBX,EAAEV,UAAF,CAAaZ,GAAb,CAAkBuB,CAAD,IAAO,CAAC9B,GAAG8B,EAAEjB,MAAF,CAASkB,OAAZ,CAAD,EAAuBD,EAAE2B,QAAzB,CAAxB,CAAnB,CAAlB;AACA,QAAMW,WAAWvC,EAAEV,UAAF,CAAaZ,GAAb,CAAiB,CAAC,EAAEM,MAAF,EAAU4C,QAAV,EAAD,MAA2B;AAC3D1B,aAASlB,OAAOkB,OAD2C;AAE3D0B,YAF2D;AAG3DO,eAAWvC,eAAeZ,MAAf,EAAuB;AAChCoD,mBAAapC,EAAEqC,OADiB;AAEhCG,cAAQrB,IAAIjB,OAFoB;AAGhCC,aAAO,CAHyB;AAIhCb,gBAJgC;AAKhCe,iBAAWL,EAAEK,SALmB;AAMhCD,kBAAY,CANoB;AAOhCE,uBAAiBN,EAAEM,eAPa;AAQhCd,eARgC;AAShCiD,cAAQjF,yBAAyBkF;AATD,KAAvB;AAHgD,GAA3B,CAAjB,CAAjB;;AAgBA,SAAOhD,OAAOC,MAAP,CAAc,EAAd,EAAkBwB,GAAlB,EAAuB;AAC5BY,UAAM,EAAEC,MAAM,MAAR,EAAgBzB,OAAOb,OAAOC,MAAP,CAAc,EAAd,EAAkBY,KAAlB,EAAyB,EAAEoC,qBAAqBV,WAAvB,EAAoCM,QAApC,EAAzB,CAAvB;AADsB,GAAvB,CAAP;AAGD;;AAED;;;;AAIA,SAASK,cAAT,CAAwBC,IAAxB,EAA8BJ,MAA9B,EAAsCK,MAAtC,EAA8C;AAC5C,QAAMC,OAAOF,KAAK9B,MAAL,CAAY8B,KAAK9B,MAAL,CAAYiC,MAAZ,GAAqB,CAAjC,CAAb;AACA,QAAMC,IAAI9E,GAAG2E,OAAOI,SAAV,CAAV;AACA,QAAM5D,aACJmD,WAAW,MAAX,GAAoBlE,cAAc,CAAC,GAAGwE,KAAKzD,UAAT,EAAqB2D,CAArB,CAAd,CAApB,GAA6D1E,cAAcwE,KAAKzD,UAAL,CAAgB6D,MAAhB,CAAwBlD,CAAD,IAAOA,MAAMgD,CAApC,CAAd,CAD/D;AAEA,SAAO;AACL9C,WAAO4C,KAAK5C,KAAL,GAAa,CADf;AAELb,cAFK;AAGLe,eAAWyC,OAAOzC,SAHb;AAILD,gBAAY0C,OAAO1C,UAJd;AAKLE,qBAAiBwC,OAAOxC;AALnB,GAAP;AAOD;;AAED;;;AAGA,SAAS8C,mBAAT,CAA6B,EAAEf,OAAF,EAAWG,MAAX,EAAmBK,IAAnB,EAAyBJ,MAAzB,EAAiCK,MAAjC,EAAyCO,SAAzC,EAA7B,EAAmF;AACjF,QAAMlD,QAAQyC,eAAeC,IAAf,EAAqBJ,MAArB,EAA6BK,MAA7B,CAAd;AACA;AACA,QAAMtD,YAAY,EAAlB;AACAE,SAAO4D,IAAP,CAAYT,KAAKU,OAAjB,EAA0BC,OAA1B,CAAmC5C,CAAD,IAAO;AACvCpB,cAAUrB,GAAGyC,CAAH,CAAV,IAAmBiC,KAAKU,OAAL,CAAa3C,CAAb,EAAgBgB,QAAnC;AACD,GAFD;AAGA,MAAIa,WAAW,MAAf,EAAuBjD,UAAUrB,GAAG2E,OAAOI,SAAV,CAAV,IAAkCJ,OAAOlB,QAAzC;AACvB,QAAMvC,MAAMK,OAAOC,MAAP,CAAc,EAAEyC,aAAaC,OAAf,EAAwBG,MAAxB,EAAd,EAAgDrC,KAAhD,EAAuD;AACjEX,aADiE;AAEjEiD,YAAQA,WAAW,MAAX,GAAoBjF,yBAAyBiG,IAA7C,GAAoDjG,yBAAyBkG;AAFpB,GAAvD,CAAZ;AAIA,SAAO;AACL1B,UAAM,MADD;AAELzB,WAAO;AACL2C,iBAAWJ,OAAOI,SADb;AAEL7C,iBAAWyC,OAAOzC,SAFb;AAGLD,kBAAY0C,OAAO1C,UAHd;AAILE,uBAAiBwC,OAAOxC,eAJnB;AAKLqD,kBAAYN,UAAU3E,GAAV,CAAekF,CAAD,IAAOhE,eAAegE,CAAf,EAAkBvE,GAAlB,CAArB;AALP;AAFF,GAAP;AAUD;;AAED,MAAMwE,OAAQtD,KAAD,KAAY,EAAEyB,MAAM,MAAR,EAAgBzB,KAAhB,EAAZ,CAAb;;AAEA;AACA,SAASuD,cAAT,CAAwBC,MAAxB,EAAgCC,KAAhC,EAAuC;AACrC,SAAO,EAAED,MAAF,EAAUhC,MAAM8B,KAAKG,KAAL,CAAhB,EAAP;AACD;;AAED,SAASC,sBAAT,CAAgCC,MAAhC,EAAwCC,OAAO,EAA/C,EAAmD;AACjD,QAAMC,YAAY,OAAOC,IAAP,EAAa,EAAErF,MAAF,EAAUsF,UAAU,EAApB,EAAwBnD,GAAxB,EAAb,EAA4CoD,KAA5C,KAAsD;AACtE,UAAMC,KAAK;AACTC,YAAMzF,OAAOkB,OADJ;AAETuB,UAAIzC,OAAO2C,SAFF;AAGTR,SAHS;AAITwC,kBAAYW,QAAQ5F,GAAR,CAAakF,CAAD,KAAQ,EAAEc,QAAQd,EAAE1D,OAAZ,EAAqBuB,IAAImC,EAAEjC,SAA3B,EAAsCQ,WAAW,EAAjD,EAAR,CAAZ;AAJH,KAAX;AAMA,QAAIwC,UAAU,CAAC,MAAMT,OAAQ,SAAQG,IAAK,EAArB,EAAwB,EAAEG,EAAF,EAAMxF,MAAN,EAAxB,CAAP,EAAgD4F,MAA9D;AACA,SAAK,MAAMhB,CAAX,IAAgBU,OAAhB,EAAyB;AACvB;AACAK,gBAAU,MAAMT,OAAQ,YAAWG,IAAK,EAAxB,EAA2B,EAAEG,IAAIG,OAAN,EAAe3F,QAAQ4E,CAAvB,EAA3B,CAAhB;AACD;AACD,WAAOM,OAAQ,OAAMG,IAAK,EAAnB,EAAsB,EAAEG,IAAIG,OAAN,EAAe3F,MAAf,EAAtB,EAA+CuF,KAA/C,CAAP;AACD,GAbD;;AAeA,SAAO;AACLxE,kBADK;AAELH,kBAFK;AAGLC,wBAHK;AAILT,oBAJK;AAKLwD,kBALK;AAMLQ,uBANK;AAOLU,kBAPK;AAQL9F,0BARK;AASLC,SATK;;AAWL;AACA4G,YAAQ,OAAOC,IAAP,EAAaP,KAAb,KAAuB;AAC7B,YAAMpD,MAAMpB,eACVL,OAAOC,MAAP,CAAc,EAAE0C,SAAS,CAAC,MAAM6B,OAAOa,UAAP,EAAP,EAA4B1C,OAAvC,EAAgDvE,iBAAiBqG,KAAKrG,eAAtE,EAAd,EAAuGgH,IAAvG,CADU,CAAZ;AAGA,YAAME,OAAO,MAAMd,OAAOe,kBAAP,CAA0B,EAAET,IAAI,EAAErD,GAAF,EAAN,EAAenC,QAAQ8F,KAAKpD,KAA5B,EAA1B,EAA+D6C,KAA/D,CAAnB;AACA,aAAO,EAAES,IAAF,EAAQ9E,SAASiB,IAAIjB,OAArB,EAA8BgF,SAASlH,uBAAuBmD,IAAIjB,OAA3B,CAAvC,EAAP;AACD,KAlBI;;AAoBL;AACAiF,YAAQ,CAAC,EAAEpB,MAAF,EAAUC,KAAV,EAAiBhF,MAAjB,EAAyBsF,OAAzB,EAAD,EAAqCC,KAArC,KACNH,UAAU,gBAAV,EAA4B,EAAEpF,MAAF,EAAUsF,OAAV,EAAmBnD,KAAK2C,eAAeC,MAAf,EAAuBC,KAAvB,CAAxB,EAA5B,EAAqFO,KAArF,CAtBG;;AAwBL;AACAa,UAAM,OAAO,EAAErB,MAAF,EAAUlB,IAAV,EAAgBC,MAAhB,EAAwBlB,QAAxB,EAAkCyB,SAAlC,EAA6CrE,MAA7C,EAAP,EAA8DuF,KAA9D,KAAwE;AAC5E,YAAMlC,UAAU,CAAC,MAAM6B,OAAOa,UAAP,EAAP,EAA4B1C,OAA5C;AACA,YAAMN,OAAOqB,oBAAoB;AAC/Bf,eAD+B;AAE/BG,gBAAQuB,MAFuB;AAG/BlB,YAH+B;AAI/BJ,gBAAQ,MAJuB;AAK/BK,gBAAQpD,OAAOC,MAAP,CAAc,EAAEiC,QAAF,EAAd,EAA4BkB,MAA5B,CALuB;AAM/BO;AAN+B,OAApB,CAAb;AAQA,aAAOa,OAAOmB,gBAAP,CAAwB,EAAEb,IAAI,EAAErD,KAAK,EAAE4C,MAAF,EAAUnC,QAAV,EAAoBG,IAApB,EAAP,EAAN,EAA2C/C,MAA3C,EAAxB,EAA6EuF,KAA7E,CAAP;AACD,KApCI;;AAsCL;AACAe,WAAO,OAAO,EAAEvB,MAAF,EAAUlB,IAAV,EAAgBC,MAAhB,EAAwBO,SAAxB,EAAmCrE,MAAnC,EAAP,EAAoDuF,KAApD,KAA8D;AACnE,YAAMlC,UAAU,CAAC,MAAM6B,OAAOa,UAAP,EAAP,EAA4B1C,OAA5C;AACA,YAAMN,OAAOqB,oBAAoB,EAAEf,OAAF,EAAWG,QAAQuB,MAAnB,EAA2BlB,IAA3B,EAAiCJ,QAAQ,OAAzC,EAAkDK,MAAlD,EAA0DO,SAA1D,EAApB,CAAb;AACA,aAAOa,OAAOqB,iBAAP,CAAyB,EAAEf,IAAI,EAAErD,KAAK,EAAE4C,MAAF,EAAUhC,IAAV,EAAP,EAAN,EAAiC/C,MAAjC,EAAzB,EAAoEuF,KAApE,CAAP;AACD,KA3CI;;AA6CL;AACAiB,WAAO,CAAC,EAAEzB,MAAF,EAAU/E,MAAV,EAAkBsF,UAAU,EAA5B,EAAD,EAAmCC,KAAnC,KACLH,UAAU,eAAV,EAA2B,EAAEpF,MAAF,EAAUsF,OAAV,EAAmBnD,KAAK,EAAE4C,MAAF,EAAxB,EAA3B,EAAiEQ,KAAjE,CA/CG;;AAiDLkB,YAAQ,CAAC,EAAE1B,MAAF,EAAU/E,MAAV,EAAkBsF,UAAU,EAA5B,EAAD,EAAmCC,KAAnC,KACNH,UAAU,gBAAV,EAA4B,EAAEpF,MAAF,EAAUsF,OAAV,EAAmBnD,KAAK,EAAE4C,MAAF,EAAxB,EAA5B,EAAkEQ,KAAlE,CAlDG;;AAoDL;AACAmB,WAAO,CAAC,EAAE3B,MAAF,EAAU/E,MAAV,EAAkBsF,UAAU,EAA5B,EAAgCqB,UAAU,OAA1C,EAAmDC,qBAAnD,EAAD,EAA6ErB,KAA7E,KACLH,UACE,eADF,EAEE;AACEpF,YADF;AAEEsF,aAFF;AAGEnD,WAAK,EAAE4C,MAAF,EAAU4B,OAAV,EAAmB5D,MAAM8B,KAAK,EAAE+B,uBAAuBvH,OAAOuH,qBAAP,CAAzB,EAAL,CAAzB;AAHP,KAFF,EAOErB,KAPF,CAtDG;;AAgELsB,kBAAc,CAAC,EAAE9B,MAAF,EAAU+B,EAAV,EAAc9G,MAAd,EAAsBsF,UAAU,EAAhC,EAAoCqB,UAAU,eAA9C,EAAD,EAAkEpB,KAAlE,KACZH,UAAU,iBAAV,EAA6B,EAAEpF,MAAF,EAAUsF,OAAV,EAAmBnD,KAAK,EAAE4C,MAAF,EAAU+B,EAAV,EAAc9D,MAAM,OAApB,EAA6B2D,OAA7B,EAAxB,EAA7B,EAA+FpB,KAA/F,CAjEG;;AAmEL;;;;AAIAwB,oBAAgB,CAAC,EAAEhC,MAAF,EAAU+B,EAAV,EAAcrD,MAAd,EAAsBzD,MAAtB,EAA8BsF,UAAU,EAAxC,EAA4CqB,UAAU,iBAAtD,EAAD,EAA4EpB,KAA5E,KACdH,UACE,iBADF,EAEE,EAAEpF,MAAF,EAAUsF,OAAV,EAAmBnD,KAAK,EAAE4C,MAAF,EAAU+B,EAAV,EAAc9D,MAAM,SAApB,EAA+B2D,OAA/B,EAAwC5D,MAAM8B,KAAK,EAAEpB,MAAF,EAAL,CAA9C,EAAxB,EAFF,EAGE8B,KAHF;AAxEG,GAAP;AA8ED;;AAEDyB,OAAOC,OAAP,GAAiB;AACfzI,0BADe;AAEfuC,gBAFe;AAGfqD,qBAHe;AAIfU,gBAJe;AAKfG,wBALe;AAMf7E,kBANe;AAOfwD,gBAPe;AAQfhD,gBARe;AASfC,sBATe;AAUftB;AAVe,CAAjB","file":"bridge.js","sourcesContent":["/**\n * SDK helpers for the on-chain bridge governance (bridge/docs/ocap-protocols.md §v2.2).\n *\n * A v2 bridge is a `RollupState` whose `data.value.version == 2`. These helpers build, sign and submit the governance\n * transactions of the existing rollup protocols for such a bridge:\n *\n * - pure builders (no network): `buildCreateItx`, `signMembership`, `buildMembershipData`, `buildUpdateData`, ...\n * - flows on a client: `client.bridge.create / update / join / leave / pause / resume / close / migrateVault /\n * migrateReserve`, each building the itx, collecting the signatures of the listed wallets and sending the tx.\n *\n * Wallets are `@ocap/wallet` objects. Governance approvals (BridgeMembership, BridgeOwnerAttestation) are EIP-712\n * signatures made with the wallet's secp256k1 key, so owners, validators and the Ethereum owner must hold such keys.\n */\nconst {\n BRIDGE_MEMBERSHIP_ACTION,\n computeBridgeEndpointsHash,\n computeBridgeMembershipDigest,\n computeBridgeOwnerAttestationDigest,\n signBridgeDigest,\n} = require('@ocap/mcrypto');\nconst { toRollupAddress: toRollupAddressCbor, toBridgeReserveAddress } = require('@arcblock/did-util/cbor');\nconst { toHex, toBuffer } = require('@ocap/util');\n\nconst lc = (s) => String(s).toLowerCase();\nconst sortAddresses = (list) =>\n [...new Set(list.map(lc))].sort((a, b) => (BigInt(a) < BigInt(b) ? -1 : BigInt(a) > BigInt(b) ? 1 : 0));\n\nconst secretOf = (wallet) => {\n const sk = wallet.secretKey;\n if (!sk) throw new Error('A wallet with a secret key is required to sign a bridge approval');\n return typeof sk === 'string' ? toBuffer(sk) : sk;\n};\n\n/** EIP-712 digest of a BridgeMembership message (validators are sorted ascending for you). */\nfunction membershipDigest(msg) {\n const validators = sortAddresses(msg.validators);\n // `endpoints`: { address -> url } of every listed validator; it is bound into the digest\n const endpointsHash = computeBridgeEndpointsHash(validators.map((a) => msg.endpoints[a] || msg.endpoints[lc(a)]));\n const rest = Object.assign({}, msg);\n delete rest.endpoints;\n return computeBridgeMembershipDigest(Object.assign(rest, { validators, endpointsHash }));\n}\n\n/** Sign a BridgeMembership message with the secp256k1 key of `wallet`. */\nfunction signMembership(wallet, msg) {\n return signBridgeDigest(membershipDigest(msg), secretOf(wallet));\n}\n\n/** Sign a BridgeOwnerAttestation message (the Ethereum owner of the token proves it consents to this bridge). */\nfunction signOwnerAttestation(wallet, msg) {\n return signBridgeDigest(computeBridgeOwnerAttestationDigest(msg), secretOf(wallet));\n}\n\nconst PARAM_KEYS = [\n 'minDeposit',\n 'minWithdraw',\n 'maxWithdraw',\n 'releaseDailyCap',\n 'refundDailyCap',\n 'releaseGrace',\n 'refundDelay',\n 'transitionPeriod',\n];\n\n/**\n * Build the itx of a v2 `create_rollup`, address and all approvals included.\n *\n * @param {object} o\n * @param {string} o.chainId - OCAP chain id (part of every signed struct)\n * @param {string} o.tokenAddress - the OCAP token\n * @param {string} o.ethToken - the Ethereum token (contract_address)\n * @param {string} [o.vaultAddress] - the Ethereum vault\n * @param {object} o.owner - wallet of the token owner (authority); becomes the bridge owner\n * @param {string} o.ownerEndpoint - endpoint recorded for the owner seed\n * @param {string} o.ethChainId\n * @param {string} o.gateway\n * @param {object} o.params - minDeposit, minWithdraw, maxWithdraw, releaseDailyCap, refundDailyCap, releaseGrace, refundDelay, transitionPeriod\n * @param {Array<{wallet: object, endpoint: string}>} o.validators - epoch-1 operators, each signs a consent\n * @param {number} o.threshold\n * @param {number} o.voucherValidity\n * @param {object} o.ethOwner - wallet of the Ethereum owner signing the attestation\n * @param {string} o.salt - bytes32 hex\n * @param {string} [o.initialReserve='0']\n * @param {string[]} [o.pausers]\n * @param {number} [o.minBlockConfirmation=12]\n * @param {Function} [o.toRollupAddress] - address function matching the tx encoding (defaults to cbor)\n */\nfunction buildCreateItx(o) {\n const toRollupAddress = o.toRollupAddress || toRollupAddressCbor;\n const validators = sortAddresses(o.validators.map((x) => x.wallet.address));\n const epoch = {\n epoch: 1,\n activeFrom: 0,\n threshold: o.threshold,\n validators,\n voucherValidity: o.voucherValidity,\n };\n const value = Object.assign(\n {\n version: 2,\n ethChainId: String(o.ethChainId),\n gateway: lc(o.gateway),\n },\n Object.fromEntries(PARAM_KEYS.map((k) => [k, o.params[k]])),\n {\n withdrawFee: '0',\n epochs: [epoch],\n salt: lc(o.salt),\n initialReserve: o.initialReserve || '0',\n }\n );\n if (o.pausers) value.pausers = o.pausers;\n\n const itx = {\n address: '',\n tokenAddress: o.tokenAddress,\n vaultAddress: o.vaultAddress || '',\n contractAddress: o.ethToken,\n seedValidators: [{ pk: o.owner.publicKey, address: o.owner.address, endpoint: o.ownerEndpoint }],\n minBlockConfirmation: o.minBlockConfirmation || 12,\n data: { type: 'json', value },\n };\n // The bridge address is computed over the itx WITHOUT the attestation and the consents (they sign over it)\n itx.address = toRollupAddress(itx);\n\n const attestation = {\n address: lc(o.ethOwner.address),\n signature: signOwnerAttestation(o.ethOwner, {\n ocapChainId: o.chainId,\n salt: value.salt,\n ocapToken: o.tokenAddress,\n ethChainId: value.ethChainId,\n gateway: value.gateway,\n ethToken: lc(o.ethToken),\n }),\n };\n const endpoints = Object.fromEntries(o.validators.map((x) => [lc(x.wallet.address), x.endpoint]));\n const consents = o.validators.map(({ wallet, endpoint }) => ({\n address: wallet.address,\n endpoint,\n signature: signMembership(wallet, {\n ocapChainId: o.chainId,\n bridge: itx.address,\n epoch: 1,\n validators,\n threshold: o.threshold,\n activeFrom: 0,\n voucherValidity: o.voucherValidity,\n endpoints,\n action: BRIDGE_MEMBERSHIP_ACTION.CREATE,\n }),\n }));\n\n return Object.assign({}, itx, {\n data: { type: 'json', value: Object.assign({}, value, { ethOwnerAttestation: attestation, consents }) },\n });\n}\n\n/**\n * Next epoch of a join / leave computed from the bridge body. `change` = { validator, threshold, activeFrom,\n * voucherValidity }. Returns the epoch the chain will derive, to be signed by owner + quorum (+ joiner).\n */\nfunction planMembership(body, action, change) {\n const last = body.epochs[body.epochs.length - 1];\n const v = lc(change.validator);\n const validators =\n action === 'join' ? sortAddresses([...last.validators, v]) : sortAddresses(last.validators.filter((x) => x !== v));\n return {\n epoch: last.epoch + 1,\n validators,\n threshold: change.threshold,\n activeFrom: change.activeFrom,\n voucherValidity: change.voucherValidity,\n };\n}\n\n/**\n * Build `itx.data` of a join / leave and sign it with `approvers` (owner, quorum members, and the joiner for a join).\n */\nfunction buildMembershipData({ chainId, bridge, body, action, change, approvers }) {\n const epoch = planMembership(body, action, change);\n // endpoints of the stored members; a joiner brings its own (`change.endpoint`, also sent as itx.endpoint)\n const endpoints = {};\n Object.keys(body.members).forEach((k) => {\n endpoints[lc(k)] = body.members[k].endpoint;\n });\n if (action === 'join') endpoints[lc(change.validator)] = change.endpoint;\n const msg = Object.assign({ ocapChainId: chainId, bridge }, epoch, {\n endpoints,\n action: action === 'join' ? BRIDGE_MEMBERSHIP_ACTION.JOIN : BRIDGE_MEMBERSHIP_ACTION.LEAVE,\n });\n return {\n type: 'json',\n value: {\n validator: change.validator,\n threshold: change.threshold,\n activeFrom: change.activeFrom,\n voucherValidity: change.voucherValidity,\n signatures: approvers.map((w) => signMembership(w, msg)),\n },\n };\n}\n\nconst wrap = (value) => ({ type: 'json', value });\n\n/** Typed `update_rollup` itx. `patch` holds allow-listed keys only (see the design doc). */\nfunction buildUpdateItx(rollup, patch) {\n return { rollup, data: wrap(patch) };\n}\n\nfunction createBridgeGovernance(client, deps = {}) {\n const sendMulti = async (kind, { wallet, signers = [], itx }, extra) => {\n const tx = {\n from: wallet.address,\n pk: wallet.publicKey,\n itx,\n signatures: signers.map((w) => ({ signer: w.address, pk: w.publicKey, signature: '' })),\n };\n let encoded = (await client[`encode${kind}`]({ tx, wallet })).object;\n for (const w of signers) {\n // eslint-disable-next-line no-await-in-loop\n encoded = await client[`multiSign${kind}`]({ tx: encoded, wallet: w });\n }\n return client[`send${kind}`]({ tx: encoded, wallet }, extra);\n };\n\n return {\n buildCreateItx,\n signMembership,\n signOwnerAttestation,\n membershipDigest,\n planMembership,\n buildMembershipData,\n buildUpdateItx,\n toBridgeReserveAddress,\n toHex,\n\n /** create a bridge; `owner` signs (and, for the official token, must be the moderator) */\n create: async (opts, extra) => {\n const itx = buildCreateItx(\n Object.assign({ chainId: (await client.getContext()).chainId, toRollupAddress: deps.toRollupAddress }, opts)\n );\n const hash = await client.sendCreateRollupTx({ tx: { itx }, wallet: opts.owner }, extra);\n return { hash, address: itx.address, reserve: toBridgeReserveAddress(itx.address) };\n },\n\n /** owner + quorum `update_rollup` with a typed patch; use `proposeOwner` / `cancelOwnerProposal` keys for ownership */\n update: ({ rollup, patch, wallet, signers }, extra) =>\n sendMulti('UpdateRollupTx', { wallet, signers, itx: buildUpdateItx(rollup, patch) }, extra),\n\n /** join: the joiner, the owner and an active-epoch quorum approve BridgeMembership; anyone submits */\n join: async ({ rollup, body, change, endpoint, approvers, wallet }, extra) => {\n const chainId = (await client.getContext()).chainId;\n const data = buildMembershipData({\n chainId,\n bridge: rollup,\n body,\n action: 'join',\n change: Object.assign({ endpoint }, change),\n approvers,\n });\n return client.sendJoinRollupTx({ tx: { itx: { rollup, endpoint, data } }, wallet }, extra);\n },\n\n /** leave: the owner and an active-epoch quorum approve BridgeMembership; anyone submits */\n leave: async ({ rollup, body, change, approvers, wallet }, extra) => {\n const chainId = (await client.getContext()).chainId;\n const data = buildMembershipData({ chainId, bridge: rollup, body, action: 'leave', change, approvers });\n return client.sendLeaveRollupTx({ tx: { itx: { rollup, data } }, wallet }, extra);\n },\n\n /** quorum pause (owner + quorum in `signers`) or lone pause (a pauser as `wallet`, no `signers`) */\n pause: ({ rollup, wallet, signers = [] }, extra) =>\n sendMulti('PauseRollupTx', { wallet, signers, itx: { rollup } }, extra),\n\n resume: ({ rollup, wallet, signers = [] }, extra) =>\n sendMulti('ResumeRollupTx', { wallet, signers, itx: { rollup } }, extra),\n\n /** close needs a quorum pause; `depositCutoffEthBlock` is the Ethereum block of the gateway `setParams` tx */\n close: ({ rollup, wallet, signers = [], message = 'close', depositCutoffEthBlock }, extra) =>\n sendMulti(\n 'CloseRollupTx',\n {\n wallet,\n signers,\n itx: { rollup, message, data: wrap({ depositCutoffEthBlock: String(depositCutoffEthBlock) }) },\n },\n extra\n ),\n\n migrateVault: ({ rollup, to, wallet, signers = [], message = 'migrate vault' }, extra) =>\n sendMulti('MigrateRollupTx', { wallet, signers, itx: { rollup, to, type: 'vault', message } }, extra),\n\n /**\n * Reserve migration of a final bridge to `to` (a live v2 bridge): action `announce` and `execute` are signed by\n * the source owner and the TARGET quorum, `cancel` by the token authority alone (no `signers`).\n */\n migrateReserve: ({ rollup, to, action, wallet, signers = [], message = 'migrate reserve' }, extra) =>\n sendMulti(\n 'MigrateRollupTx',\n { wallet, signers, itx: { rollup, to, type: 'reserve', message, data: wrap({ action }) } },\n extra\n ),\n };\n}\n\nmodule.exports = {\n BRIDGE_MEMBERSHIP_ACTION,\n buildCreateItx,\n buildMembershipData,\n buildUpdateItx,\n createBridgeGovernance,\n membershipDigest,\n planMembership,\n signMembership,\n signOwnerAttestation,\n sortAddresses,\n};\n"]}
package/lib/extension.js CHANGED
@@ -1,15 +1,18 @@
1
1
  'use strict';
2
2
 
3
3
  const { get, set, omit, camelCase } = require('./helpers/lite');
4
+
4
5
  const { isValid, isFromPublicKey, toTypeInfo } = require('@arcblock/did');
5
6
  const ocapProto = require('@ocap/proto/schema');
6
- const { toTxHash } = require('@ocap/mcrypto');
7
+ const { toTxHash, parseStrictEthAddress, buildBridgeWithdrawEnvelopeExtra } = require('@ocap/mcrypto');
7
8
  const { fromPublicKey } = require('@ocap/wallet');
8
9
  const { encodeTx: encodeTxCbor, decodeTx: decodeTxCbor } = require('@ocap/message/cbor');
9
10
  const { bytesToHex, toBase58, toBase64, toHex, toBuffer, fromTokenToUnit, fromUnitToToken } = require('@ocap/util');
10
11
  const { DEFAULT_TOKEN_DECIMAL } = require('@ocap/util/lib/constant');
12
+
11
13
  const { formatFactoryState, preMintFromFactory: preMintFromFactoryCbor } = require('@ocap/asset/mint/client');
12
14
  const { verifyTxInclusion } = require('./verify');
15
+ const { createBridgeGovernance } = require('./bridge');
13
16
  const {
14
17
  toDelegateAddress,
15
18
  toAssetAddress: toAssetAddressCbor,
@@ -17,11 +20,15 @@ const {
17
20
  toTokenAddress: toTokenAddressCbor,
18
21
  toTokenFactoryAddress: toTokenFactoryAddressCbor,
19
22
  toStakeAddress,
20
- toRollupAddress: toRollupAddressCbor
23
+ toRollupAddress: toRollupAddressCbor,
24
+ toBridgeReserveAddress
21
25
  } = require('@arcblock/did-util/cbor');
22
26
 
23
27
  const debug = require('debug')(require('../package.json').name);
24
28
 
29
+ // An encoded tx carries `signature: new Uint8Array(0)` until it is signed; an empty value is not a signature.
30
+ const hasSignature = s => !!s && (typeof s === 'string' ? s.length > 0 && s !== '0x' : s.length === undefined || s.length > 0);
31
+
25
32
  const { transactions, typeUrls, toTypeUrl, multiSignTxs, multiSignV2Txs } = ocapProto;
26
33
 
27
34
  // Default CBOR-only dependency bundle. `@ocap/client/legacy` re-invokes
@@ -429,7 +436,7 @@ const createExtensionMethods = (client, deps = defaultDeps) => {
429
436
  if (signature) {
430
437
  encoded = tx;
431
438
  encoded.signature = signature;
432
- } else if (tx.signature) {
439
+ } else if (hasSignature(tx.signature)) {
433
440
  const res = await txEncodeFn({ tx, wallet, delegator });
434
441
  encoded = res.object;
435
442
  } else {
@@ -660,6 +667,97 @@ const createExtensionMethods = (client, deps = defaultDeps) => {
660
667
  toWallet: to
661
668
  }, extra);
662
669
 
670
+ /**
671
+ * Build and sign a bridge withdraw (a `transfer_v2` into the bridge reserve, #1465), ready for `sendTransferV2Tx`.
672
+ *
673
+ * Signing modes (`signing`):
674
+ * - `eip712` (default for Ethereum-type wallets): `ArcBridgeWithdraw` clear-signing envelope, shows amount, token and
675
+ * Ethereum destination in the wallet UI;
676
+ * - `eip191`: personal_sign over the canonical text, which carries the same three fields;
677
+ * - `raw`: the plain transaction signature (what `sendTransferV2Tx` does by default). The chain only accepts it from
678
+ * signers that do not use wallet envelopes.
679
+ *
680
+ * @memberof GraphQLClient
681
+ * @function
682
+ * @name GraphQLClient#buildBridgeWithdrawTx
683
+ * @param {object} params
684
+ * @param {WalletObject} params.wallet - the sender
685
+ * @param {string} params.bridge - address of the bridge (rollup); the reserve (`itx.to`) is derived from it
686
+ * @param {string|number|bigint} params.amount - amount in base units
687
+ * @param {string} params.ethRecipient - Ethereum recipient, `0x` + 40 hex, lowercase or EIP-55 (checked locally)
688
+ * @param {string} [params.token] - the bridge's OCAP token, defaults to the chain's official token
689
+ * @param {string} [params.signing='eip712'] - `eip712` | `eip191` | `raw`
690
+ * @param {string|number} [params.nonce] - defaults to Date.now()
691
+ * @param {string} [params.chainId] - defaults to the connected chain
692
+ * @param {object} [params.domain] - `{ name, version }` of the envelope domain, defaults to the chain's default
693
+ * @returns {Promise<{ tx: object, signature: string, extra: string }>} pass as `client.sendTransferV2Tx({ tx, signature, extra })`
694
+ */
695
+ client.buildBridgeWithdrawTx = async ({
696
+ wallet,
697
+ bridge,
698
+ amount,
699
+ ethRecipient,
700
+ token,
701
+ signing = 'eip712',
702
+ nonce,
703
+ chainId,
704
+ domain = {}
705
+ }) => {
706
+ if (!bridge) throw new Error('buildBridgeWithdrawTx requires the bridge address');
707
+ const recipient = parseStrictEthAddress(ethRecipient);
708
+ if (!recipient.ok) throw new Error(`Invalid Ethereum recipient: ${recipient.reason}`);
709
+ const amountStr = String(amount);
710
+ if (!/^[1-9][0-9]*$/.test(amountStr)) throw new Error('amount must be a positive integer in base units');
711
+ const context = await client.getContext();
712
+ const tokenAddress = token || get(context, 'token.address');
713
+ if (!tokenAddress) throw new Error('token is required when the chain has no official token');
714
+
715
+ const tx = {
716
+ itx: {
717
+ to: toBridgeReserveAddress(bridge),
718
+ tokens: [{ address: tokenAddress, value: amountStr }],
719
+ data: { typeUrl: 'fg:x:address', value: ethRecipient }
720
+ }
721
+ };
722
+ if (nonce !== undefined) tx.nonce = nonce;
723
+ if (chainId) tx.chainId = chainId;
724
+ const { object, buffer } = await client.encodeTransferV2Tx({ tx, wallet });
725
+
726
+ if (signing === 'raw') {
727
+ return { tx: object, signature: await wallet.sign(bytesToHex(buffer)), extra: '' };
728
+ }
729
+ if (signing !== 'eip712' && signing !== 'eip191') throw new Error(`Unknown signing mode ${signing}`);
730
+ const envelopeExtra = buildBridgeWithdrawEnvelopeExtra({
731
+ envelope: signing,
732
+ chainId: object.chainId,
733
+ from: wallet.address,
734
+ nonce: String(object.nonce),
735
+ bridge,
736
+ amount: amountStr,
737
+ token: tokenAddress,
738
+ ethRecipient,
739
+ domainName: domain.name,
740
+ domainVersion: domain.version
741
+ });
742
+ const signed = await wallet.signEnvelope(buffer, envelopeExtra);
743
+ return { tx: object, signature: signed.signature, extra: signed.extra };
744
+ };
745
+
746
+ /**
747
+ * Build, sign and send a bridge withdraw, see `buildBridgeWithdrawTx`.
748
+ *
749
+ * @memberof GraphQLClient
750
+ * @function
751
+ * @name GraphQLClient#bridgeWithdraw
752
+ * @param {object} params - same as `buildBridgeWithdrawTx`, plus `commit`
753
+ * @param {object} extra - other param to underlying client implementation
754
+ * @returns {Promise<string>} the transaction hash once resolved
755
+ */
756
+ client.bridgeWithdraw = async (params, extra) => {
757
+ const { tx, signature, extra: txExtra } = await client.buildBridgeWithdrawTx(omit(params, ['commit']));
758
+ return client.sendTransferV2Tx({ tx, signature, commit: !!params.commit, extra: txExtra }, extra);
759
+ };
760
+
663
761
  /**
664
762
  * Delegate some privileges to another account
665
763
  * So that that account can send transactions on behalf of the delegator
@@ -1526,7 +1624,7 @@ const createExtensionMethods = (client, deps = defaultDeps) => {
1526
1624
  * @name GraphQLClient#burnToken
1527
1625
  * @param {object} params
1528
1626
  * @param {string} params.address - token factory address
1529
- * @param {number} params.feeRate - fee for the mint and burn
1627
+ * @param {number} params.feeRate - fee for the mint and burn, can only be lowered after creation: the chain rejects an increase
1530
1628
  * @param {object} params.token - token factory token payload
1531
1629
  * @param {object} params.data - token factory data payload
1532
1630
  * @param {WalletObject} params.wallet - the wallet who is the owner
@@ -1673,6 +1771,15 @@ const createExtensionMethods = (client, deps = defaultDeps) => {
1673
1771
  * @returns {Promise<{ verified: boolean, reason?: string }>}
1674
1772
  */
1675
1773
  client.verifyTxInclusion = params => verifyTxInclusion(params);
1774
+
1775
+ /**
1776
+ * On-chain bridge governance helpers (create, update, join, leave, pause, resume, close, migrate).
1777
+ * See `@ocap/client/bridge` and bridge/docs/ocap-protocols.md §v2.2.
1778
+ *
1779
+ * @memberof GraphQLClient
1780
+ * @name GraphQLClient#bridge
1781
+ */
1782
+ client.bridge = createBridgeGovernance(client, deps);
1676
1783
  };
1677
1784
 
1678
1785
  module.exports = { createExtensionMethods, defaultDeps };