@openzeppelin/guardian-client 0.19.0-rc.1 → 0.19.0-rc.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/README.md +61 -4
- package/dist/conversion.d.ts +8 -2
- package/dist/conversion.d.ts.map +1 -1
- package/dist/conversion.js +34 -1
- package/dist/conversion.js.map +1 -1
- package/dist/error-codes.d.ts +1 -1
- package/dist/error-codes.d.ts.map +1 -1
- package/dist/error-codes.js +2 -0
- package/dist/error-codes.js.map +1 -1
- package/dist/http.d.ts +24 -1
- package/dist/http.d.ts.map +1 -1
- package/dist/http.js +74 -20
- package/dist/http.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/request-envelope.d.ts +2 -2
- package/dist/request-envelope.d.ts.map +1 -1
- package/dist/request-envelope.js +2 -2
- package/dist/request-envelope.js.map +1 -1
- package/dist/server-types.d.ts +13 -0
- package/dist/server-types.d.ts.map +1 -1
- package/dist/session-request.d.ts +104 -0
- package/dist/session-request.d.ts.map +1 -0
- package/dist/session-request.js +164 -0
- package/dist/session-request.js.map +1 -0
- package/dist/types.d.ts +76 -4
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/conversion.test.ts +17 -0
- package/src/conversion.ts +42 -1
- package/src/error-codes.ts +2 -0
- package/src/http.test.ts +328 -11
- package/src/http.ts +97 -23
- package/src/index.ts +16 -0
- package/src/request-envelope.test.ts +4 -4
- package/src/request-envelope.ts +2 -2
- package/src/server-types.ts +15 -0
- package/src/session-request.test.ts +178 -0
- package/src/session-request.ts +191 -0
- package/src/types.ts +79 -3
package/dist/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { SessionOperation, WriteSequencer } from './session-request.js';
|
|
1
2
|
import type { TransactionRequestEnvelope } from './request-envelope.js';
|
|
2
3
|
import type { RequestAuthPayload } from './auth-request.js';
|
|
3
4
|
import type { ServerExecutionCapability } from './execution.js';
|
|
@@ -77,7 +78,7 @@ export interface SessionGrantFields {
|
|
|
77
78
|
export type SessionEndReason = 'logout' | 'expired' | 'revoked' | 'rejected';
|
|
78
79
|
/**
|
|
79
80
|
* Signs session-eligible requests on behalf of a wallet after a session grant
|
|
80
|
-
* was registered. Requests carry `x-auth-format: session`.
|
|
81
|
+
* was registered. Requests carry `x-auth-format: session-v2`.
|
|
81
82
|
*/
|
|
82
83
|
export interface SessionRequestSigner {
|
|
83
84
|
/** Hex SEC1-compressed P-256 session public key, sent as `x-pubkey`. */
|
|
@@ -89,7 +90,20 @@ export interface SessionRequestSigner {
|
|
|
89
90
|
readonly signerCommitment: string;
|
|
90
91
|
/** Unix seconds. */
|
|
91
92
|
readonly expiresAt: number;
|
|
92
|
-
|
|
93
|
+
/**
|
|
94
|
+
* The next request timestamp (Unix ms) for `accountId`: strictly increasing
|
|
95
|
+
* per account for this session, never more than a second ahead of the
|
|
96
|
+
* clock, and jumped near that limit when `afterReplay` (see
|
|
97
|
+
* `SessionTimestamps`).
|
|
98
|
+
*/
|
|
99
|
+
nextTimestamp(accountId: string, afterReplay: boolean): Promise<number>;
|
|
100
|
+
/** Orders this session's writes per account; shared by every client using it. */
|
|
101
|
+
readonly writeSequencer: WriteSequencer;
|
|
102
|
+
/**
|
|
103
|
+
* Sign the version 2 envelope (see `sessionRequestEnvelope`) of this
|
|
104
|
+
* request over HTTP as `operation`.
|
|
105
|
+
*/
|
|
106
|
+
signRequest(operation: SessionOperation, accountId: string, timestamp: number, requestPayload: RequestAuthPayload): Promise<string> | string;
|
|
93
107
|
/** Sign the account-less `SessionLogoutMessage` for `POST /session/logout`. */
|
|
94
108
|
signLogout(timestampMs: number): Promise<string> | string;
|
|
95
109
|
/** Called once when the client stops using the session. */
|
|
@@ -104,13 +118,23 @@ export interface CreateSessionRequest {
|
|
|
104
118
|
signature: string;
|
|
105
119
|
grant: SessionGrantFields;
|
|
106
120
|
}
|
|
107
|
-
|
|
121
|
+
/** How a Guardian expects session requests to be signed. */
|
|
122
|
+
export interface SessionRequestPolicy {
|
|
123
|
+
/**
|
|
124
|
+
* The session request envelope version; this client signs 2, under which
|
|
125
|
+
* each signed session read is admitted once, within 60 s of server time,
|
|
126
|
+
* except the canonical nonce poll, accepted every time within 60 s behind
|
|
127
|
+
* and 30 s ahead.
|
|
128
|
+
*/
|
|
129
|
+
requestAuthVersion: number;
|
|
130
|
+
}
|
|
131
|
+
export interface CreateSessionResponse extends SessionRequestPolicy {
|
|
108
132
|
signerCommitment: string;
|
|
109
133
|
/** RFC 3339 UTC. */
|
|
110
134
|
expiresAt: string;
|
|
111
135
|
}
|
|
112
136
|
/** Session parameters a Guardian advertises on `GET /status`. */
|
|
113
|
-
export interface SessionsStatus {
|
|
137
|
+
export interface SessionsStatus extends Partial<SessionRequestPolicy> {
|
|
114
138
|
/** Grants may expire at most this many seconds after registration. */
|
|
115
139
|
maxTtlSeconds: number;
|
|
116
140
|
}
|
|
@@ -272,6 +296,45 @@ export interface StateObject {
|
|
|
272
296
|
/** `falcon` or `ecdsa` when the account's cosigners and GUARDIAN share that scheme, `mixed` when they do not. */
|
|
273
297
|
authScheme?: string;
|
|
274
298
|
}
|
|
299
|
+
/** A queued candidate the queue tail replays (`GET /state/tail`). */
|
|
300
|
+
export interface QueuedCandidate {
|
|
301
|
+
/** The account nonce the candidate's transaction leaves the account at. */
|
|
302
|
+
nonce: number;
|
|
303
|
+
/** The state it builds on: the canonical state for the oldest, the previous candidate's `newCommitment` after it. */
|
|
304
|
+
prevCommitment: string;
|
|
305
|
+
/** The state it leaves the account at. */
|
|
306
|
+
newCommitment: string;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* The queue tail (`GET /state/tail`, issue #517): the state a new delta or
|
|
310
|
+
* proposal must build on while the account's candidate queue holds
|
|
311
|
+
* candidates, and the candidates that lead to it.
|
|
312
|
+
*/
|
|
313
|
+
export interface StateTail {
|
|
314
|
+
/**
|
|
315
|
+
* The canonical state with every queued candidate applied, shaped as
|
|
316
|
+
* `getState` returns a state; the canonical state itself when nothing is
|
|
317
|
+
* queued. Not on chain until the queued candidates land.
|
|
318
|
+
*/
|
|
319
|
+
state: StateObject;
|
|
320
|
+
/**
|
|
321
|
+
* The queued candidates, oldest first: the first builds on the canonical
|
|
322
|
+
* state, each later one on the one before it, and the last one's
|
|
323
|
+
* `newCommitment` is the tail's commitment. Empty when nothing is queued.
|
|
324
|
+
*/
|
|
325
|
+
queue: QueuedCandidate[];
|
|
326
|
+
/**
|
|
327
|
+
* Whether the queue takes a delta or proposal built on this tail now.
|
|
328
|
+
* False while the queue is full (at the default depth of 1, whenever
|
|
329
|
+
* anything is queued), while the tail changes the account's signers or
|
|
330
|
+
* guardian key, or while its newest candidate was queued by a server before
|
|
331
|
+
* 0.19.0 under a label other than its nonce: a submission on the tail then
|
|
332
|
+
* gets `conflict_pending_delta`, so wait for the queue to drain and read
|
|
333
|
+
* again. True holds only at this read: the tail can move before the push,
|
|
334
|
+
* and the account's status and the proposal limits still apply.
|
|
335
|
+
*/
|
|
336
|
+
acceptsSubmissions: boolean;
|
|
337
|
+
}
|
|
275
338
|
/**
|
|
276
339
|
* Head of the latest canonical state (`GET /state/nonce`): the account
|
|
277
340
|
* nonce carried by the state GUARDIAN holds as canonical and that state's
|
|
@@ -332,6 +395,15 @@ export interface DeltaProposalRequest {
|
|
|
332
395
|
metadata?: ProposalMetadata;
|
|
333
396
|
/** The request a Guardian-executable proposal stores. Omit for a self-executed one. */
|
|
334
397
|
transactionRequest?: TransactionRequestEnvelope;
|
|
398
|
+
/**
|
|
399
|
+
* Commitment of the state the summary was built on (issue #517). GUARDIAN
|
|
400
|
+
* 0.19.0 and later record the proposal only when it is the queue tail,
|
|
401
|
+
* refusing a base another queued candidate claimed with
|
|
402
|
+
* `conflict_pending_delta` and an unknown one with `commitment_mismatch`.
|
|
403
|
+
* Omit it to be judged by the nonce alone; earlier servers store it with
|
|
404
|
+
* the payload and ignore it.
|
|
405
|
+
*/
|
|
406
|
+
baseCommitment?: string;
|
|
335
407
|
};
|
|
336
408
|
}
|
|
337
409
|
export interface DeltaProposalResponse {
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAExE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAEhE,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,mFAAmF;IACnF,QAAQ,CAAC,iBAAiB,CAAC,EAAE,QAAQ,CAAC;IACtC,mFAAmF;IACnF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,QAAQ,CAAC;IAC1C,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3F,WAAW,CAAC,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC5B,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAEhE;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,CAChB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAEvE;;;;OAIG;IACH,oBAAoB,CAAC,CACnB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,gBAAgB,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC1D,2DAA2D;IAC3D,OAAO,CAAC,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,eAAe,CAAC;IACxB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAExE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAEhE,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,mFAAmF;IACnF,QAAQ,CAAC,iBAAiB,CAAC,EAAE,QAAQ,CAAC;IACtC,mFAAmF;IACnF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,QAAQ,CAAC;IAC1C,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3F,WAAW,CAAC,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC5B,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAEhE;;;;;;;;;;OAUG;IACH,iBAAiB,CAAC,CAChB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,gBAAgB,CAAC,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAEvE;;;;OAIG;IACH,oBAAoB,CAAC,CACnB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,gBAAgB,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,wEAAwE;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxE,iFAAiF;IACjF,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC;;;OAGG;IACH,WAAW,CACT,SAAS,EAAE,gBAAgB,EAC3B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,kBAAkB,GACjC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC1D,2DAA2D;IAC3D,OAAO,CAAC,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,eAAe,CAAC;IACxB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED,4DAA4D;AAC5D,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;IACjE,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,iEAAiE;AACjE,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,oBAAoB,CAAC;IACnE,sEAAsE;IACtE,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG,cAAc,CAAC;AAEjE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD,+GAA+G;AAC/G,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,MAAM,UAAU,GAClB;IACE,cAAc,EAAE;QACd,oBAAoB,EAAE,MAAM,EAAE,CAAC;KAChC,CAAC;CACH,GACD;IACE,UAAU,EAAE;QACV,oBAAoB,EAAE,MAAM,EAAE,CAAC;KAChC,CAAC;CACH;AACH;;;;;GAKG;GACD;IACE,KAAK,EAAE;QACL,SAAS,EAAE,mBAAmB,EAAE,CAAC;QACjC,eAAe,EAAE,eAAe,CAAC;KAClC,CAAC;CACH,CAAC;AAEN,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,WAAW,GACnB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,iBAAiB,EAAE,CAAA;CAAE,GAC/F;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC1C;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AAC5C;;;;;gCAKgC;GAC9B;IACE,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,iBAAiB,GAAG,UAAU,GAAG,UAAU,CAAC;CACtD,GACD;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhE,MAAM,MAAM,YAAY,GACpB,YAAY,GACZ,eAAe,GACf,kBAAkB,GAClB,4BAA4B,GAC5B,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,QAAQ,GAGR,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,iEAAiE;IACjE,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4FAA4F;IAC5F,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE;QACZ,SAAS,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAC5B,UAAU,EAAE,KAAK,CAAC;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,iBAAiB,CAAA;SAAE,CAAC,CAAC;QACtE,QAAQ,CAAC,EAAE,gBAAgB,CAAC;QAC5B,wFAAwF;QACxF,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;KACjD,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,iHAAiH;IACjH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC9B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd,qHAAqH;IACrH,cAAc,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,EAAE,WAAW,CAAC;IACnB;;;;OAIG;IACH,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB;;;;;;;;;OASG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,UAAU,CAAC;IACjB,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE,yBAAyB,CAAC;IACtC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE;QACZ,SAAS,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAC5B,UAAU,EAAE,KAAK,CAAC;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,iBAAiB,CAAA;SAAE,CAAC,CAAC;QACtE,QAAQ,CAAC,EAAE,gBAAgB,CAAC;QAC5B,uFAAuF;QACvF,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;QAChD;;;;;;;WAOG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,WAAW,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,KAAK,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC;IAC5C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,YAAY,CAAC;AAE3F,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yDAAyD;AACzD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErF,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEzD,+DAA+D;AAC/D,MAAM,MAAM,oBAAoB,GAC5B,YAAY,GACZ,UAAU,GACV,aAAa,GACb,cAAc,GACd,OAAO,GACP,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,GAAG,cAAc,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,cAAc,CAAC;IACpB,kDAAkD;IAClD,QAAQ,EAAE,qBAAqB,CAAC;IAChC,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,oBAAoB,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,sEAAsE;AACtE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC;AAED,kEAAkE;AAClE,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
|
package/package.json
CHANGED
package/src/conversion.test.ts
CHANGED
|
@@ -475,6 +475,23 @@ describe('conversion', () => {
|
|
|
475
475
|
expect(result.delta_payload.tx_summary.data).toBe('base64data');
|
|
476
476
|
expect(result.delta_payload.signatures[0].signer_id).toBe('0xsig');
|
|
477
477
|
expect(result.delta_payload.metadata?.proposal_type).toBe('add_signer');
|
|
478
|
+
expect('base_commitment' in result.delta_payload).toBe(false);
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
it('carries the base a proposal was built on in its payload', () => {
|
|
482
|
+
const base = '0x' + 'c'.repeat(64);
|
|
483
|
+
const result = toServerDeltaProposalRequest({
|
|
484
|
+
accountId: '0xaccount',
|
|
485
|
+
nonce: 6,
|
|
486
|
+
deltaPayload: {
|
|
487
|
+
txSummary: { data: 'base64data' },
|
|
488
|
+
signatures: [],
|
|
489
|
+
baseCommitment: base,
|
|
490
|
+
},
|
|
491
|
+
});
|
|
492
|
+
|
|
493
|
+
expect(result.delta_payload.base_commitment).toBe(base);
|
|
494
|
+
expect(Object.keys(result)).toEqual(['account_id', 'nonce', 'delta_payload']);
|
|
478
495
|
});
|
|
479
496
|
|
|
480
497
|
it('converts SignProposalRequest', () => {
|
package/src/conversion.ts
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
import {
|
|
2
|
+
SESSION_REQUEST_VERSION,
|
|
3
|
+
assertSupportedSessionPolicy,
|
|
4
|
+
} from './session-request.js';
|
|
1
5
|
import type {
|
|
2
6
|
CanonicalNonce,
|
|
3
7
|
CosignerSignature,
|
|
@@ -17,6 +21,7 @@ import type {
|
|
|
17
21
|
ProposalMetadata,
|
|
18
22
|
SignProposalRequest,
|
|
19
23
|
StateObject,
|
|
24
|
+
StateTail,
|
|
20
25
|
} from './types.js';
|
|
21
26
|
import type {
|
|
22
27
|
ServerCanonicalNonceResponse,
|
|
@@ -37,6 +42,7 @@ import type {
|
|
|
37
42
|
ServerProposalMetadata,
|
|
38
43
|
ServerSignProposalRequest,
|
|
39
44
|
ServerStateObject,
|
|
45
|
+
ServerStateTail,
|
|
40
46
|
} from './server-types.js';
|
|
41
47
|
import { decodeTransactionRequestEnvelope, type TransactionRequestEnvelope } from './request-envelope.js';
|
|
42
48
|
|
|
@@ -174,6 +180,28 @@ export function fromServerStateObject(server: ServerStateObject): StateObject {
|
|
|
174
180
|
};
|
|
175
181
|
}
|
|
176
182
|
|
|
183
|
+
export function fromServerStateTail(server: ServerStateTail): StateTail {
|
|
184
|
+
if (typeof server.accepts_submissions !== 'boolean') {
|
|
185
|
+
throw new Error(
|
|
186
|
+
`Invalid accepts_submissions from server: ${String(server.accepts_submissions)}`,
|
|
187
|
+
);
|
|
188
|
+
}
|
|
189
|
+
return {
|
|
190
|
+
state: fromServerStateObject(server.state),
|
|
191
|
+
acceptsSubmissions: server.accepts_submissions,
|
|
192
|
+
queue: server.queue.map((candidate) => {
|
|
193
|
+
if (!Number.isSafeInteger(candidate.nonce) || candidate.nonce < 0) {
|
|
194
|
+
throw new Error(`Invalid queued candidate nonce from server: ${String(candidate.nonce)}`);
|
|
195
|
+
}
|
|
196
|
+
return {
|
|
197
|
+
nonce: candidate.nonce,
|
|
198
|
+
prevCommitment: candidate.prev_commitment,
|
|
199
|
+
newCommitment: candidate.new_commitment,
|
|
200
|
+
};
|
|
201
|
+
}),
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
|
|
177
205
|
export function fromServerCanonicalNonce(server: ServerCanonicalNonceResponse): CanonicalNonce {
|
|
178
206
|
if (!Number.isSafeInteger(server.nonce) || server.nonce < 0) {
|
|
179
207
|
throw new Error(`Invalid canonical nonce from server: ${String(server.nonce)}`);
|
|
@@ -295,10 +323,20 @@ export function toServerCreateSessionRequest(req: CreateSessionRequest): ServerC
|
|
|
295
323
|
};
|
|
296
324
|
}
|
|
297
325
|
|
|
326
|
+
/**
|
|
327
|
+
* Throws `UnsupportedAuthVersionError` unless the server reports the
|
|
328
|
+
* session request version this client signs: such a server would refuse
|
|
329
|
+
* every session request.
|
|
330
|
+
*/
|
|
298
331
|
export function fromServerCreateSessionResponse(
|
|
299
332
|
server: ServerCreateSessionResponse
|
|
300
333
|
): CreateSessionResponse {
|
|
301
|
-
|
|
334
|
+
assertSupportedSessionPolicy({ requestAuthVersion: server.request_auth_version });
|
|
335
|
+
return {
|
|
336
|
+
signerCommitment: server.signer_commitment,
|
|
337
|
+
expiresAt: server.expires_at,
|
|
338
|
+
requestAuthVersion: SESSION_REQUEST_VERSION,
|
|
339
|
+
};
|
|
302
340
|
}
|
|
303
341
|
|
|
304
342
|
export function toServerDeltaProposalRequest(req: DeltaProposalRequest): ServerDeltaProposalRequest {
|
|
@@ -315,6 +353,9 @@ export function toServerDeltaProposalRequest(req: DeltaProposalRequest): ServerD
|
|
|
315
353
|
...(req.deltaPayload.transactionRequest
|
|
316
354
|
? { transaction_request: req.deltaPayload.transactionRequest }
|
|
317
355
|
: {}),
|
|
356
|
+
...(req.deltaPayload.baseCommitment !== undefined
|
|
357
|
+
? { base_commitment: req.deltaPayload.baseCommitment }
|
|
358
|
+
: {}),
|
|
318
359
|
},
|
|
319
360
|
};
|
|
320
361
|
}
|
package/src/error-codes.ts
CHANGED
|
@@ -59,7 +59,9 @@ export const GUARDIAN_ERROR_CODES = [
|
|
|
59
59
|
'state_not_found',
|
|
60
60
|
'state_not_on_chain',
|
|
61
61
|
'storage_error',
|
|
62
|
+
'timestamp_out_of_window',
|
|
62
63
|
'unsupported_evm_chain',
|
|
64
|
+
'unsupported_auth_version',
|
|
63
65
|
'unsupported_for_network',
|
|
64
66
|
'wallet_signature_required',
|
|
65
67
|
] as const;
|