@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/dist/bridge.js ADDED
@@ -0,0 +1,288 @@
1
+ /**
2
+ * SDK helpers for the on-chain bridge governance (bridge/docs/ocap-protocols.md §v2.2).
3
+ *
4
+ * A v2 bridge is a `RollupState` whose `data.value.version == 2`. These helpers build, sign and submit the governance
5
+ * transactions of the existing rollup protocols for such a bridge:
6
+ *
7
+ * - pure builders (no network): `buildCreateItx`, `signMembership`, `buildMembershipData`, `buildUpdateData`, ...
8
+ * - flows on a client: `client.bridge.create / update / join / leave / pause / resume / close / migrateVault /
9
+ * migrateReserve`, each building the itx, collecting the signatures of the listed wallets and sending the tx.
10
+ *
11
+ * Wallets are `@ocap/wallet` objects. Governance approvals (BridgeMembership, BridgeOwnerAttestation) are EIP-712
12
+ * signatures made with the wallet's secp256k1 key, so owners, validators and the Ethereum owner must hold such keys.
13
+ */
14
+ const {
15
+ BRIDGE_MEMBERSHIP_ACTION,
16
+ computeBridgeEndpointsHash,
17
+ computeBridgeMembershipDigest,
18
+ computeBridgeOwnerAttestationDigest,
19
+ signBridgeDigest
20
+ } = require('@ocap/mcrypto');
21
+ const { toRollupAddress: toRollupAddressCbor, toBridgeReserveAddress } = require('@arcblock/did-util/cbor');
22
+ const { toHex, toBuffer } = require('@ocap/util');
23
+
24
+ const lc = s => String(s).toLowerCase();
25
+ const sortAddresses = list => [...new Set(list.map(lc))].sort((a, b) => BigInt(a) < BigInt(b) ? -1 : BigInt(a) > BigInt(b) ? 1 : 0);
26
+
27
+ const secretOf = wallet => {
28
+ const sk = wallet.secretKey;
29
+ if (!sk) throw new Error('A wallet with a secret key is required to sign a bridge approval');
30
+ return typeof sk === 'string' ? toBuffer(sk) : sk;
31
+ };
32
+
33
+ /** EIP-712 digest of a BridgeMembership message (validators are sorted ascending for you). */
34
+ function membershipDigest(msg) {
35
+ const validators = sortAddresses(msg.validators);
36
+ // `endpoints`: { address -> url } of every listed validator; it is bound into the digest
37
+ const endpointsHash = computeBridgeEndpointsHash(validators.map(a => msg.endpoints[a] || msg.endpoints[lc(a)]));
38
+ const rest = Object.assign({}, msg);
39
+ delete rest.endpoints;
40
+ return computeBridgeMembershipDigest(Object.assign(rest, { validators, endpointsHash }));
41
+ }
42
+
43
+ /** Sign a BridgeMembership message with the secp256k1 key of `wallet`. */
44
+ function signMembership(wallet, msg) {
45
+ return signBridgeDigest(membershipDigest(msg), secretOf(wallet));
46
+ }
47
+
48
+ /** Sign a BridgeOwnerAttestation message (the Ethereum owner of the token proves it consents to this bridge). */
49
+ function signOwnerAttestation(wallet, msg) {
50
+ return signBridgeDigest(computeBridgeOwnerAttestationDigest(msg), secretOf(wallet));
51
+ }
52
+
53
+ const PARAM_KEYS = ['minDeposit', 'minWithdraw', 'maxWithdraw', 'releaseDailyCap', 'refundDailyCap', 'releaseGrace', 'refundDelay', 'transitionPeriod'];
54
+
55
+ /**
56
+ * Build the itx of a v2 `create_rollup`, address and all approvals included.
57
+ *
58
+ * @param {object} o
59
+ * @param {string} o.chainId - OCAP chain id (part of every signed struct)
60
+ * @param {string} o.tokenAddress - the OCAP token
61
+ * @param {string} o.ethToken - the Ethereum token (contract_address)
62
+ * @param {string} [o.vaultAddress] - the Ethereum vault
63
+ * @param {object} o.owner - wallet of the token owner (authority); becomes the bridge owner
64
+ * @param {string} o.ownerEndpoint - endpoint recorded for the owner seed
65
+ * @param {string} o.ethChainId
66
+ * @param {string} o.gateway
67
+ * @param {object} o.params - minDeposit, minWithdraw, maxWithdraw, releaseDailyCap, refundDailyCap, releaseGrace, refundDelay, transitionPeriod
68
+ * @param {Array<{wallet: object, endpoint: string}>} o.validators - epoch-1 operators, each signs a consent
69
+ * @param {number} o.threshold
70
+ * @param {number} o.voucherValidity
71
+ * @param {object} o.ethOwner - wallet of the Ethereum owner signing the attestation
72
+ * @param {string} o.salt - bytes32 hex
73
+ * @param {string} [o.initialReserve='0']
74
+ * @param {string[]} [o.pausers]
75
+ * @param {number} [o.minBlockConfirmation=12]
76
+ * @param {Function} [o.toRollupAddress] - address function matching the tx encoding (defaults to cbor)
77
+ */
78
+ function buildCreateItx(o) {
79
+ const toRollupAddress = o.toRollupAddress || toRollupAddressCbor;
80
+ const validators = sortAddresses(o.validators.map(x => x.wallet.address));
81
+ const epoch = {
82
+ epoch: 1,
83
+ activeFrom: 0,
84
+ threshold: o.threshold,
85
+ validators,
86
+ voucherValidity: o.voucherValidity
87
+ };
88
+ const value = Object.assign({
89
+ version: 2,
90
+ ethChainId: String(o.ethChainId),
91
+ gateway: lc(o.gateway)
92
+ }, Object.fromEntries(PARAM_KEYS.map(k => [k, o.params[k]])), {
93
+ withdrawFee: '0',
94
+ epochs: [epoch],
95
+ salt: lc(o.salt),
96
+ initialReserve: o.initialReserve || '0'
97
+ });
98
+ if (o.pausers) value.pausers = o.pausers;
99
+
100
+ const itx = {
101
+ address: '',
102
+ tokenAddress: o.tokenAddress,
103
+ vaultAddress: o.vaultAddress || '',
104
+ contractAddress: o.ethToken,
105
+ seedValidators: [{ pk: o.owner.publicKey, address: o.owner.address, endpoint: o.ownerEndpoint }],
106
+ minBlockConfirmation: o.minBlockConfirmation || 12,
107
+ data: { type: 'json', value }
108
+ };
109
+ // The bridge address is computed over the itx WITHOUT the attestation and the consents (they sign over it)
110
+ itx.address = toRollupAddress(itx);
111
+
112
+ const attestation = {
113
+ address: lc(o.ethOwner.address),
114
+ signature: signOwnerAttestation(o.ethOwner, {
115
+ ocapChainId: o.chainId,
116
+ salt: value.salt,
117
+ ocapToken: o.tokenAddress,
118
+ ethChainId: value.ethChainId,
119
+ gateway: value.gateway,
120
+ ethToken: lc(o.ethToken)
121
+ })
122
+ };
123
+ const endpoints = Object.fromEntries(o.validators.map(x => [lc(x.wallet.address), x.endpoint]));
124
+ const consents = o.validators.map(({ wallet, endpoint }) => ({
125
+ address: wallet.address,
126
+ endpoint,
127
+ signature: signMembership(wallet, {
128
+ ocapChainId: o.chainId,
129
+ bridge: itx.address,
130
+ epoch: 1,
131
+ validators,
132
+ threshold: o.threshold,
133
+ activeFrom: 0,
134
+ voucherValidity: o.voucherValidity,
135
+ endpoints,
136
+ action: BRIDGE_MEMBERSHIP_ACTION.CREATE
137
+ })
138
+ }));
139
+
140
+ return Object.assign({}, itx, {
141
+ data: { type: 'json', value: Object.assign({}, value, { ethOwnerAttestation: attestation, consents }) }
142
+ });
143
+ }
144
+
145
+ /**
146
+ * Next epoch of a join / leave computed from the bridge body. `change` = { validator, threshold, activeFrom,
147
+ * voucherValidity }. Returns the epoch the chain will derive, to be signed by owner + quorum (+ joiner).
148
+ */
149
+ function planMembership(body, action, change) {
150
+ const last = body.epochs[body.epochs.length - 1];
151
+ const v = lc(change.validator);
152
+ const validators = action === 'join' ? sortAddresses([...last.validators, v]) : sortAddresses(last.validators.filter(x => x !== v));
153
+ return {
154
+ epoch: last.epoch + 1,
155
+ validators,
156
+ threshold: change.threshold,
157
+ activeFrom: change.activeFrom,
158
+ voucherValidity: change.voucherValidity
159
+ };
160
+ }
161
+
162
+ /**
163
+ * Build `itx.data` of a join / leave and sign it with `approvers` (owner, quorum members, and the joiner for a join).
164
+ */
165
+ function buildMembershipData({ chainId, bridge, body, action, change, approvers }) {
166
+ const epoch = planMembership(body, action, change);
167
+ // endpoints of the stored members; a joiner brings its own (`change.endpoint`, also sent as itx.endpoint)
168
+ const endpoints = {};
169
+ Object.keys(body.members).forEach(k => {
170
+ endpoints[lc(k)] = body.members[k].endpoint;
171
+ });
172
+ if (action === 'join') endpoints[lc(change.validator)] = change.endpoint;
173
+ const msg = Object.assign({ ocapChainId: chainId, bridge }, epoch, {
174
+ endpoints,
175
+ action: action === 'join' ? BRIDGE_MEMBERSHIP_ACTION.JOIN : BRIDGE_MEMBERSHIP_ACTION.LEAVE
176
+ });
177
+ return {
178
+ type: 'json',
179
+ value: {
180
+ validator: change.validator,
181
+ threshold: change.threshold,
182
+ activeFrom: change.activeFrom,
183
+ voucherValidity: change.voucherValidity,
184
+ signatures: approvers.map(w => signMembership(w, msg))
185
+ }
186
+ };
187
+ }
188
+
189
+ const wrap = value => ({ type: 'json', value });
190
+
191
+ /** Typed `update_rollup` itx. `patch` holds allow-listed keys only (see the design doc). */
192
+ function buildUpdateItx(rollup, patch) {
193
+ return { rollup, data: wrap(patch) };
194
+ }
195
+
196
+ function createBridgeGovernance(client, deps = {}) {
197
+ const sendMulti = async (kind, { wallet, signers = [], itx }, extra) => {
198
+ const tx = {
199
+ from: wallet.address,
200
+ pk: wallet.publicKey,
201
+ itx,
202
+ signatures: signers.map(w => ({ signer: w.address, pk: w.publicKey, signature: '' }))
203
+ };
204
+ let encoded = (await client[`encode${kind}`]({ tx, wallet })).object;
205
+ for (const w of signers) {
206
+ // eslint-disable-next-line no-await-in-loop
207
+ encoded = await client[`multiSign${kind}`]({ tx: encoded, wallet: w });
208
+ }
209
+ return client[`send${kind}`]({ tx: encoded, wallet }, extra);
210
+ };
211
+
212
+ return {
213
+ buildCreateItx,
214
+ signMembership,
215
+ signOwnerAttestation,
216
+ membershipDigest,
217
+ planMembership,
218
+ buildMembershipData,
219
+ buildUpdateItx,
220
+ toBridgeReserveAddress,
221
+ toHex,
222
+
223
+ /** create a bridge; `owner` signs (and, for the official token, must be the moderator) */
224
+ create: async (opts, extra) => {
225
+ const itx = buildCreateItx(Object.assign({ chainId: (await client.getContext()).chainId, toRollupAddress: deps.toRollupAddress }, opts));
226
+ const hash = await client.sendCreateRollupTx({ tx: { itx }, wallet: opts.owner }, extra);
227
+ return { hash, address: itx.address, reserve: toBridgeReserveAddress(itx.address) };
228
+ },
229
+
230
+ /** owner + quorum `update_rollup` with a typed patch; use `proposeOwner` / `cancelOwnerProposal` keys for ownership */
231
+ update: ({ rollup, patch, wallet, signers }, extra) => sendMulti('UpdateRollupTx', { wallet, signers, itx: buildUpdateItx(rollup, patch) }, extra),
232
+
233
+ /** join: the joiner, the owner and an active-epoch quorum approve BridgeMembership; anyone submits */
234
+ join: async ({ rollup, body, change, endpoint, approvers, wallet }, extra) => {
235
+ const chainId = (await client.getContext()).chainId;
236
+ const data = buildMembershipData({
237
+ chainId,
238
+ bridge: rollup,
239
+ body,
240
+ action: 'join',
241
+ change: Object.assign({ endpoint }, change),
242
+ approvers
243
+ });
244
+ return client.sendJoinRollupTx({ tx: { itx: { rollup, endpoint, data } }, wallet }, extra);
245
+ },
246
+
247
+ /** leave: the owner and an active-epoch quorum approve BridgeMembership; anyone submits */
248
+ leave: async ({ rollup, body, change, approvers, wallet }, extra) => {
249
+ const chainId = (await client.getContext()).chainId;
250
+ const data = buildMembershipData({ chainId, bridge: rollup, body, action: 'leave', change, approvers });
251
+ return client.sendLeaveRollupTx({ tx: { itx: { rollup, data } }, wallet }, extra);
252
+ },
253
+
254
+ /** quorum pause (owner + quorum in `signers`) or lone pause (a pauser as `wallet`, no `signers`) */
255
+ pause: ({ rollup, wallet, signers = [] }, extra) => sendMulti('PauseRollupTx', { wallet, signers, itx: { rollup } }, extra),
256
+
257
+ resume: ({ rollup, wallet, signers = [] }, extra) => sendMulti('ResumeRollupTx', { wallet, signers, itx: { rollup } }, extra),
258
+
259
+ /** close needs a quorum pause; `depositCutoffEthBlock` is the Ethereum block of the gateway `setParams` tx */
260
+ close: ({ rollup, wallet, signers = [], message = 'close', depositCutoffEthBlock }, extra) => sendMulti('CloseRollupTx', {
261
+ wallet,
262
+ signers,
263
+ itx: { rollup, message, data: wrap({ depositCutoffEthBlock: String(depositCutoffEthBlock) }) }
264
+ }, extra),
265
+
266
+ migrateVault: ({ rollup, to, wallet, signers = [], message = 'migrate vault' }, extra) => sendMulti('MigrateRollupTx', { wallet, signers, itx: { rollup, to, type: 'vault', message } }, extra),
267
+
268
+ /**
269
+ * Reserve migration of a final bridge to `to` (a live v2 bridge): action `announce` and `execute` are signed by
270
+ * the source owner and the TARGET quorum, `cancel` by the token authority alone (no `signers`).
271
+ */
272
+ migrateReserve: ({ rollup, to, action, wallet, signers = [], message = 'migrate reserve' }, extra) => sendMulti('MigrateRollupTx', { wallet, signers, itx: { rollup, to, type: 'reserve', message, data: wrap({ action }) } }, extra)
273
+ };
274
+ }
275
+
276
+ module.exports = {
277
+ BRIDGE_MEMBERSHIP_ACTION,
278
+ buildCreateItx,
279
+ buildMembershipData,
280
+ buildUpdateItx,
281
+ createBridgeGovernance,
282
+ membershipDigest,
283
+ planMembership,
284
+ signMembership,
285
+ signOwnerAttestation,
286
+ sortAddresses
287
+ };
288
+ //# 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/dist/browser.d.ts CHANGED
@@ -48,6 +48,32 @@ declare class GraphQLClient {
48
48
  to: WalletObject;
49
49
  }, extra?: any): Promise<string>;
50
50
 
51
+ // Bridge withdraw (#1465): transfer_v2 into the bridge reserve with a clear-signing envelope
52
+ buildBridgeWithdrawTx(params: {
53
+ wallet: WalletObject;
54
+ bridge: string;
55
+ amount: string | number | bigint;
56
+ ethRecipient: string;
57
+ token?: string;
58
+ signing?: 'eip712' | 'eip191' | 'raw';
59
+ nonce?: string | number;
60
+ chainId?: string;
61
+ domain?: { name?: string; version?: string };
62
+ }): Promise<{ tx: object; signature: string; extra: string }>;
63
+
64
+ bridgeWithdraw(params: {
65
+ wallet: WalletObject;
66
+ bridge: string;
67
+ amount: string | number | bigint;
68
+ ethRecipient: string;
69
+ token?: string;
70
+ signing?: 'eip712' | 'eip191' | 'raw';
71
+ nonce?: string | number;
72
+ chainId?: string;
73
+ domain?: { name?: string; version?: string };
74
+ commit?: boolean;
75
+ }, extra?: any): Promise<string>;
76
+
51
77
  delegate(params: {
52
78
  from: WalletObject;
53
79
  to: WalletObject;
@@ -353,6 +379,7 @@ sendCreateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.
353
379
  sendUpdateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.UpdateTokenFactoryTx>>, extra?: any): Promise<string>;
354
380
  sendMintTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.MintTokenTx>>, extra?: any): Promise<string>;
355
381
  sendBurnTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.BurnTokenTx>>, extra?: any): Promise<string>;
382
+ sendReleaseBridgeTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.ReleaseBridgeTokenTx>>, extra?: any): Promise<string>;
356
383
  encodeAccountMigrateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.AccountMigrateTx>>): Promise<GraphQLClient.EncodeTxResult>;
357
384
  encodeDelegateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.DelegateTx>>): Promise<GraphQLClient.EncodeTxResult>;
358
385
  encodeRevokeDelegateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.RevokeDelegateTx>>): Promise<GraphQLClient.EncodeTxResult>;
@@ -391,6 +418,7 @@ encodeCreateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClien
391
418
  encodeUpdateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.UpdateTokenFactoryTx>>): Promise<GraphQLClient.EncodeTxResult>;
392
419
  encodeMintTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.MintTokenTx>>): Promise<GraphQLClient.EncodeTxResult>;
393
420
  encodeBurnTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.BurnTokenTx>>): Promise<GraphQLClient.EncodeTxResult>;
421
+ encodeReleaseBridgeTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.ReleaseBridgeTokenTx>>): Promise<GraphQLClient.EncodeTxResult>;
394
422
  signAccountMigrateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.AccountMigrateTx>>): Promise<GraphQLClient.Transaction>;
395
423
  signDelegateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.DelegateTx>>): Promise<GraphQLClient.Transaction>;
396
424
  signRevokeDelegateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.RevokeDelegateTx>>): Promise<GraphQLClient.Transaction>;
@@ -429,6 +457,7 @@ signCreateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.
429
457
  signUpdateTokenFactoryTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.UpdateTokenFactoryTx>>): Promise<GraphQLClient.Transaction>;
430
458
  signMintTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.MintTokenTx>>): Promise<GraphQLClient.Transaction>;
431
459
  signBurnTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.BurnTokenTx>>): Promise<GraphQLClient.Transaction>;
460
+ signReleaseBridgeTokenTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.ReleaseBridgeTokenTx>>): Promise<GraphQLClient.Transaction>;
432
461
  multiSignExchangeV2Tx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.ExchangeV2Tx>>): Promise<GraphQLClient.Transaction>;
433
462
  multiSignAccountMigrateTx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.AccountMigrateTx>>): Promise<GraphQLClient.Transaction>;
434
463
  multiSignTransferV3Tx(param: GraphQLClient.TxParam<PartialDeep<GraphQLClient.TransferV3Tx>>): Promise<GraphQLClient.Transaction>;
@@ -709,6 +738,7 @@ interface AddressFilterInput {
709
738
  sender: string;
710
739
  receiver: string;
711
740
  direction: GraphQLClient.Direction;
741
+ gasPayer: string;
712
742
  }
713
743
 
714
744
  interface AssetFilterInput {
@@ -946,6 +976,8 @@ interface TokenFilterInput {
946
976
 
947
977
  interface TxFilterInput {
948
978
  txs: string[];
979
+ gasPayer: string;
980
+ evidences: string[];
949
981
  }
950
982
 
951
983
  interface TypeFilterInput {
@@ -1757,6 +1789,7 @@ interface IndexedTransaction {
1757
1789
  code: string;
1758
1790
  tokenSymbols: GraphQLClient.TokenMeta[];
1759
1791
  receipts: GraphQLClient.TransactionReceipt[];
1792
+ gasPayer: string;
1760
1793
  }
1761
1794
 
1762
1795
  interface JoinRollupTx {
@@ -1797,7 +1830,7 @@ interface LedgerEntry {
1797
1830
  sequence: number;
1798
1831
  hash: string;
1799
1832
  from: string;
1800
- nonce: number;
1833
+ nonce: string;
1801
1834
  pk: string;
1802
1835
  signature: string;
1803
1836
  txRaw: string;
@@ -1942,6 +1975,21 @@ interface ReceiptChange {
1942
1975
  value: string;
1943
1976
  }
1944
1977
 
1978
+ interface ReleaseBridgeTokenTx {
1979
+ kind: number;
1980
+ evidence: string;
1981
+ ordinal: number;
1982
+ to: string;
1983
+ amount: string;
1984
+ ethChainId: string;
1985
+ epoch: number;
1986
+ ethSender: string;
1987
+ claimSignature: string;
1988
+ signatures: string[];
1989
+ bridge: string;
1990
+ data: GraphQLClient.Any;
1991
+ }
1992
+
1945
1993
  interface ResponseEstimateGas {
1946
1994
  code: string;
1947
1995
  estimate: GraphQLClient.GasEstimate;
@@ -2455,6 +2503,7 @@ interface Transaction {
2455
2503
  serviceFee: string;
2456
2504
  gasFee: string;
2457
2505
  gasPaid: string;
2506
+ gasPayer: string;
2458
2507
  }
2459
2508
 
2460
2509
  interface TransactionConfig {
@@ -2655,6 +2704,7 @@ interface VaultConfig {
2655
2704
  slashedStake: string;
2656
2705
  txFee: string;
2657
2706
  txGas: string[];
2707
+ bridgeReserve: string;
2658
2708
  }
2659
2709
 
2660
2710
  interface VerifyAccountRiskResult {