@canton-network/wallet-gateway-remote 1.11.3 → 1.12.0
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/auth/jwt-auth-service.d.ts +5 -4
- package/dist/auth/jwt-auth-service.d.ts.map +1 -1
- package/dist/auth/jwt-auth-service.js +76 -8
- package/dist/auth/jwt-auth-service.test.js +193 -0
- package/dist/config/Config.d.ts +58 -7
- package/dist/config/Config.d.ts.map +1 -1
- package/dist/config/Config.test.js +9 -2
- package/dist/config/ConfigUtils.d.ts +1 -1
- package/dist/config/ConfigUtils.d.ts.map +1 -1
- package/dist/config/ConfigUtils.js +43 -8
- package/dist/dapp-api/controller.d.ts +5 -7
- package/dist/dapp-api/controller.d.ts.map +1 -1
- package/dist/dapp-api/controller.js +31 -21
- package/dist/dapp-api/controller.test.js +12 -16
- package/dist/dapp-api/rpc-gen/index.d.ts.map +1 -1
- package/dist/dapp-api/rpc-gen/schemas.d.ts +3 -0
- package/dist/dapp-api/rpc-gen/schemas.d.ts.map +1 -0
- package/dist/dapp-api/rpc-gen/schemas.js +201 -0
- package/dist/dapp-api/rpc-gen/typings.d.ts +8 -1
- package/dist/dapp-api/rpc-gen/typings.d.ts.map +1 -1
- package/dist/dapp-api/server.d.ts +8 -9
- package/dist/dapp-api/server.d.ts.map +1 -1
- package/dist/dapp-api/server.js +7 -43
- package/dist/dapp-api/server.test.js +41 -2
- package/dist/dapp-api/sse-sink.d.ts +18 -0
- package/dist/dapp-api/sse-sink.d.ts.map +1 -0
- package/dist/dapp-api/sse-sink.js +27 -0
- package/dist/dapp-api/sse-sink.test.d.ts +2 -0
- package/dist/dapp-api/sse-sink.test.d.ts.map +1 -0
- package/dist/dapp-api/sse-sink.test.js +30 -0
- package/dist/env.d.ts +0 -1
- package/dist/env.d.ts.map +1 -1
- package/dist/init.d.ts +2 -2
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +13 -4
- package/dist/ledger/party-allocation-service.d.ts +3 -3
- package/dist/ledger/party-allocation-service.d.ts.map +1 -1
- package/dist/ledger/self-issued-auth-service.d.ts +50 -0
- package/dist/ledger/self-issued-auth-service.d.ts.map +1 -0
- package/dist/ledger/self-issued-auth-service.js +263 -0
- package/dist/ledger/self-issued-auth-service.test.d.ts +2 -0
- package/dist/ledger/self-issued-auth-service.test.d.ts.map +1 -0
- package/dist/ledger/self-issued-auth-service.test.js +454 -0
- package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/blockdaemon-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/blockdaemon-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/blockdaemon-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/dfns-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/dfns-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/dfns-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/fireblocks-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/fireblocks-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/fireblocks-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/kernel-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/kernel-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/kernel-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/participant-wallet-allocator.d.ts +6 -6
- package/dist/ledger/wallet-allocation/signing-providers/participant-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/securosys-wallet-allocator.d.ts +7 -7
- package/dist/ledger/wallet-allocation/signing-providers/securosys-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/securosys-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts +6 -6
- package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts.map +1 -1
- package/dist/ledger/wallet-sync-service.d.ts +12 -9
- package/dist/ledger/wallet-sync-service.d.ts.map +1 -1
- package/dist/ledger/wallet-sync-service.js +49 -15
- package/dist/ledger/wallet-sync-service.test.js +171 -11
- package/dist/middleware/apiKeyAuth.d.ts +3 -3
- package/dist/middleware/apiKeyAuth.d.ts.map +1 -1
- package/dist/middleware/apiKeyAuth.js +2 -2
- package/dist/middleware/errorHandler.d.ts +7 -1
- package/dist/middleware/errorHandler.d.ts.map +1 -1
- package/dist/middleware/errorHandler.js +85 -1
- package/dist/middleware/errorHandler.test.js +39 -1
- package/dist/middleware/jsonRpcHandler.d.ts +6 -4
- package/dist/middleware/jsonRpcHandler.d.ts.map +1 -1
- package/dist/middleware/jsonRpcHandler.js +46 -7
- package/dist/middleware/jsonRpcHandler.test.js +101 -1
- package/dist/middleware/jwtAuth.d.ts +2 -2
- package/dist/middleware/jwtAuth.d.ts.map +1 -1
- package/dist/middleware/sessionHandler.d.ts +6 -4
- package/dist/middleware/sessionHandler.d.ts.map +1 -1
- package/dist/middleware/sessionHandler.js +25 -1
- package/dist/middleware/sessionHandler.test.js +61 -1
- package/dist/signing/service-account-session.d.ts +3 -3
- package/dist/signing/service-account-session.d.ts.map +1 -1
- package/dist/signing/service-account-session.js +2 -2
- package/dist/signing/service-account-session.test.js +1 -2
- package/dist/signing/signing-worker.d.ts +18 -16
- package/dist/signing/signing-worker.d.ts.map +1 -1
- package/dist/signing/signing-worker.js +18 -12
- package/dist/signing/signing-worker.test.js +10 -7
- package/dist/user-api/controller.d.ts +11 -7
- package/dist/user-api/controller.d.ts.map +1 -1
- package/dist/user-api/controller.js +249 -86
- package/dist/user-api/controller.test.js +145 -17
- package/dist/user-api/rpc-gen/index.d.ts +18 -0
- package/dist/user-api/rpc-gen/index.d.ts.map +1 -1
- package/dist/user-api/rpc-gen/index.js +6 -0
- package/dist/user-api/rpc-gen/schemas.d.ts +3 -0
- package/dist/user-api/rpc-gen/schemas.d.ts.map +1 -0
- package/dist/user-api/rpc-gen/schemas.js +1035 -0
- package/dist/user-api/rpc-gen/typings.d.ts +202 -28
- package/dist/user-api/rpc-gen/typings.d.ts.map +1 -1
- package/dist/user-api/server.d.ts +7 -8
- package/dist/user-api/server.d.ts.map +1 -1
- package/dist/user-api/server.js +2 -0
- package/dist/user-api/server.test.js +3 -2
- package/dist/user-api/token-network-matching.d.ts +2 -2
- package/dist/user-api/token-network-matching.d.ts.map +1 -1
- package/dist/user-api/token-network-matching.js +9 -7
- package/dist/utils.d.ts +0 -29
- package/dist/utils.d.ts.map +1 -1
- package/dist/utils.js +0 -57
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +2 -5
- package/dist/web/frontend/404/index.html +2 -2
- package/dist/web/frontend/activities/index.html +3 -3
- package/dist/web/frontend/api-keys/add/index.html +2 -2
- package/dist/web/frontend/api-keys/index.html +2 -2
- package/dist/web/frontend/approve/index.html +3 -3
- package/dist/web/frontend/assets/404-B1XXXMXN.js +5 -0
- package/dist/web/frontend/assets/{activities-DSP_NZCE.js → activities-HZnPjlMp.js} +2 -2
- package/dist/web/frontend/assets/{addApiKey-Zv2CS3ub.js → addApiKey-BvkCtUF3.js} +3 -3
- package/dist/web/frontend/assets/addIdentityProvider-Dvjma837.js +28 -0
- package/dist/web/frontend/assets/{addNetwork-B620CvC-.js → addNetwork-Cahac0uo.js} +2 -2
- package/dist/web/frontend/assets/addParty-Cdoed_Yx.js +13 -0
- package/dist/web/frontend/assets/{apiKeys-ohQpjexi.js → apiKeys-BwV6ylWL.js} +3 -3
- package/dist/web/frontend/assets/approve-B0nIfe2y.js +26 -0
- package/dist/web/frontend/assets/callback-BieW5Ux2.js +7 -0
- package/dist/web/frontend/assets/{common-BCDg7K0r.js → common-Bv9twGrA.js} +2 -2
- package/dist/web/frontend/assets/editParty-OOjTHFay.js +14 -0
- package/dist/web/frontend/assets/{identityProviders-C26I4FyE.js → identityProviders-BxJAq1Ne.js} +2 -2
- package/dist/web/frontend/assets/index-Bo6MnlYI.js +2 -0
- package/dist/web/frontend/assets/index-CG_aFABR.js +1 -0
- package/dist/web/frontend/assets/index-D1Brmwbg.js +93 -0
- package/dist/web/frontend/assets/index-pMOoiNFq.js +4887 -0
- package/dist/web/frontend/assets/login-BHxgJEz_.js +11 -0
- package/dist/web/frontend/assets/{networks-CtFnklqS.js → networks-CBprjUF5.js} +3 -3
- package/dist/web/frontend/assets/onboarding-ChmWs-TC.js +84 -0
- package/dist/web/frontend/assets/reviewIdentityProvider-CCmKgN8N.js +43 -0
- package/dist/web/frontend/assets/reviewNetwork-CX8Bmuf3.js +43 -0
- package/dist/web/frontend/assets/signMessage-BN_6S5FV.js +79 -0
- package/dist/web/frontend/callback/index.html +2 -2
- package/dist/web/frontend/identity-providers/add/index.html +2 -2
- package/dist/web/frontend/identity-providers/index.html +2 -2
- package/dist/web/frontend/identity-providers/review/index.html +2 -2
- package/dist/web/frontend/index.html +1 -1
- package/dist/web/frontend/login/index.html +2 -2
- package/dist/web/frontend/networks/add/index.html +2 -2
- package/dist/web/frontend/networks/index.html +2 -2
- package/dist/web/frontend/networks/review/index.html +2 -2
- package/dist/web/frontend/onboarding/index.html +23 -0
- package/dist/web/frontend/parties/add/index.html +5 -4
- package/dist/web/frontend/parties/edit/index.html +5 -4
- package/dist/web/frontend/parties/index.html +3 -2
- package/dist/web/frontend/sign-message/index.html +2 -2
- package/dist/web/route-inputs.js +1 -1
- package/dist/web/server.d.ts +1 -1
- package/dist/web/server.d.ts.map +1 -1
- package/package.json +36 -30
- package/dist/ledger/transaction-service.d.ts +0 -27
- package/dist/ledger/transaction-service.d.ts.map +0 -1
- package/dist/ledger/transaction-service.js +0 -297
- package/dist/ledger/transaction-service.test.d.ts +0 -2
- package/dist/ledger/transaction-service.test.d.ts.map +0 -1
- package/dist/ledger/transaction-service.test.js +0 -551
- package/dist/notification/NotificationService.d.ts +0 -18
- package/dist/notification/NotificationService.d.ts.map +0 -1
- package/dist/notification/NotificationService.js +0 -26
- package/dist/notification/NotificationService.test.d.ts +0 -2
- package/dist/notification/NotificationService.test.d.ts.map +0 -1
- package/dist/notification/NotificationService.test.js +0 -110
- package/dist/signing/signing-drivers.d.ts +0 -7
- package/dist/signing/signing-drivers.d.ts.map +0 -1
- package/dist/signing/signing-drivers.js +0 -3
- package/dist/web/frontend/assets/404-Ds_FbOi_.js +0 -5
- package/dist/web/frontend/assets/addIdentityProvider-BqiC9u9A.js +0 -28
- package/dist/web/frontend/assets/addParty-CSMZt930.js +0 -13
- package/dist/web/frontend/assets/approve-D5YmfGHz.js +0 -21
- package/dist/web/frontend/assets/callback-Dk9tIdBj.js +0 -7
- package/dist/web/frontend/assets/editParty-DX9X91dp.js +0 -14
- package/dist/web/frontend/assets/index-BCECRB_Y.js +0 -4943
- package/dist/web/frontend/assets/index-Cvcr2Fng.js +0 -2
- package/dist/web/frontend/assets/index-DrEQVBtC.js +0 -93
- package/dist/web/frontend/assets/login-dmjNaK2x.js +0 -11
- package/dist/web/frontend/assets/reviewIdentityProvider-GBlomu4-.js +0 -43
- package/dist/web/frontend/assets/reviewNetwork-CWEgNcCg.js +0 -43
- package/dist/web/frontend/assets/settings-DSh9rqaO.js +0 -37
- package/dist/web/frontend/assets/signMessage-CT2_Y1LA.js +0 -79
- package/dist/web/frontend/settings/index.html +0 -15
|
@@ -1,7 +1,91 @@
|
|
|
1
1
|
// Copyright (c) 2025-2026 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
-
import { JsonRpcError, rpcErrors, toHttpErrorCode, } from '@canton-network/core-rpc-errors';
|
|
3
|
+
import { JsonRpcError, rpcErrors, errorCodes, toHttpErrorCode, } from '@canton-network/core-rpc-errors';
|
|
4
4
|
import { jsonRpcResponse } from '@canton-network/core-rpc-transport';
|
|
5
|
+
import { isJsCantonError } from '@canton-network/core-ledger-client';
|
|
6
|
+
// Mirrors ErrorCategory.asInt from com.digitalasset.base.error (Canton's
|
|
7
|
+
// error category taxonomy). Kept in sync with that source rather than
|
|
8
|
+
// re-derived, since the numeric values are part of Canton's wire contract.
|
|
9
|
+
//
|
|
10
|
+
// view source at: https://github.com/digital-asset/canton/blob/2fcea1a4826fd63b6a9ea554c13cb685ae8f2ee2/base/errors/src/main/scala/com/digitalasset/base/error/ErrorCategory.scala#L1
|
|
11
|
+
var CantonErrorCategory;
|
|
12
|
+
(function (CantonErrorCategory) {
|
|
13
|
+
CantonErrorCategory[CantonErrorCategory["TransientServerFailure"] = 1] = "TransientServerFailure";
|
|
14
|
+
CantonErrorCategory[CantonErrorCategory["ContentionOnSharedResources"] = 2] = "ContentionOnSharedResources";
|
|
15
|
+
CantonErrorCategory[CantonErrorCategory["DeadlineExceededRequestStateUnknown"] = 3] = "DeadlineExceededRequestStateUnknown";
|
|
16
|
+
CantonErrorCategory[CantonErrorCategory["SystemInternalAssumptionViolated"] = 4] = "SystemInternalAssumptionViolated";
|
|
17
|
+
CantonErrorCategory[CantonErrorCategory["SecurityAlert"] = 5] = "SecurityAlert";
|
|
18
|
+
CantonErrorCategory[CantonErrorCategory["AuthInterceptorInvalidAuthenticationCredentials"] = 6] = "AuthInterceptorInvalidAuthenticationCredentials";
|
|
19
|
+
CantonErrorCategory[CantonErrorCategory["InsufficientPermission"] = 7] = "InsufficientPermission";
|
|
20
|
+
CantonErrorCategory[CantonErrorCategory["InvalidIndependentOfSystemState"] = 8] = "InvalidIndependentOfSystemState";
|
|
21
|
+
CantonErrorCategory[CantonErrorCategory["InvalidGivenCurrentSystemStateOther"] = 9] = "InvalidGivenCurrentSystemStateOther";
|
|
22
|
+
CantonErrorCategory[CantonErrorCategory["InvalidGivenCurrentSystemStateResourceExists"] = 10] = "InvalidGivenCurrentSystemStateResourceExists";
|
|
23
|
+
CantonErrorCategory[CantonErrorCategory["InvalidGivenCurrentSystemStateResourceMissing"] = 11] = "InvalidGivenCurrentSystemStateResourceMissing";
|
|
24
|
+
CantonErrorCategory[CantonErrorCategory["InvalidGivenCurrentSystemStateSeekAfterEnd"] = 12] = "InvalidGivenCurrentSystemStateSeekAfterEnd";
|
|
25
|
+
CantonErrorCategory[CantonErrorCategory["BackgroundProcessDegradationWarning"] = 13] = "BackgroundProcessDegradationWarning";
|
|
26
|
+
CantonErrorCategory[CantonErrorCategory["InternalUnsupportedOperation"] = 14] = "InternalUnsupportedOperation";
|
|
27
|
+
})(CantonErrorCategory || (CantonErrorCategory = {}));
|
|
28
|
+
// Canton error categories that Canton itself does not log at ERROR (see
|
|
29
|
+
// ErrorCategory.logLevel in com.digitalasset.base.error). Of the 14 defined
|
|
30
|
+
// categories, only SystemInternalAssumptionViolated and
|
|
31
|
+
// InternalUnsupportedOperation represent genuine system faults; the rest are
|
|
32
|
+
// expected client-, contention-, or state-dependent outcomes that Canton
|
|
33
|
+
// logs at INFO or WARN. We collapse Canton's INFO/WARN into our own `info`
|
|
34
|
+
// here, and treat anything outside this set (including category numbers we
|
|
35
|
+
// don't yet know about) as `error`.
|
|
36
|
+
const NON_CRITICAL_CANTON_ERROR_CATEGORIES = new Set([
|
|
37
|
+
CantonErrorCategory.TransientServerFailure,
|
|
38
|
+
CantonErrorCategory.ContentionOnSharedResources,
|
|
39
|
+
CantonErrorCategory.DeadlineExceededRequestStateUnknown,
|
|
40
|
+
CantonErrorCategory.SecurityAlert,
|
|
41
|
+
CantonErrorCategory.AuthInterceptorInvalidAuthenticationCredentials,
|
|
42
|
+
CantonErrorCategory.InsufficientPermission,
|
|
43
|
+
CantonErrorCategory.InvalidIndependentOfSystemState,
|
|
44
|
+
CantonErrorCategory.InvalidGivenCurrentSystemStateOther,
|
|
45
|
+
CantonErrorCategory.InvalidGivenCurrentSystemStateResourceExists,
|
|
46
|
+
CantonErrorCategory.InvalidGivenCurrentSystemStateResourceMissing,
|
|
47
|
+
CantonErrorCategory.InvalidGivenCurrentSystemStateSeekAfterEnd,
|
|
48
|
+
CantonErrorCategory.BackgroundProcessDegradationWarning,
|
|
49
|
+
// SystemInternalAssumptionViolated and InternalUnsupportedOperation are
|
|
50
|
+
// excluded - Canton logs both at ERROR as genuine system faults.
|
|
51
|
+
]);
|
|
52
|
+
/**
|
|
53
|
+
* Determines the level an error thrown from an RPC method should be logged
|
|
54
|
+
* at: `info` for an expected, client/business-caused rejection, `error` for
|
|
55
|
+
* an unexpected system fault (including anything we can't classify).
|
|
56
|
+
*/
|
|
57
|
+
export const errorLogLevel = (error) => {
|
|
58
|
+
if (error instanceof JsonRpcError) {
|
|
59
|
+
switch (error.code) {
|
|
60
|
+
case errorCodes.rpc.invalidInput:
|
|
61
|
+
case errorCodes.rpc.invalidParams:
|
|
62
|
+
case errorCodes.rpc.invalidRequest:
|
|
63
|
+
case errorCodes.rpc.methodNotFound:
|
|
64
|
+
case errorCodes.rpc.methodNotSupported:
|
|
65
|
+
case errorCodes.rpc.parse:
|
|
66
|
+
case errorCodes.provider.unauthorized:
|
|
67
|
+
case errorCodes.provider.unsupportedMethod:
|
|
68
|
+
case errorCodes.provider.userRejectedRequest:
|
|
69
|
+
return 'info';
|
|
70
|
+
case errorCodes.rpc.internal:
|
|
71
|
+
case errorCodes.rpc.limitExceeded:
|
|
72
|
+
case errorCodes.rpc.resourceNotFound:
|
|
73
|
+
case errorCodes.rpc.resourceUnavailable:
|
|
74
|
+
case errorCodes.rpc.transactionRejected:
|
|
75
|
+
case errorCodes.provider.chainDisconnected:
|
|
76
|
+
case errorCodes.provider.disconnected:
|
|
77
|
+
return 'error';
|
|
78
|
+
default:
|
|
79
|
+
return 'error';
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (isJsCantonError(error)) {
|
|
83
|
+
return NON_CRITICAL_CANTON_ERROR_CATEGORIES.has(error.errorCategory)
|
|
84
|
+
? 'info'
|
|
85
|
+
: 'error';
|
|
86
|
+
}
|
|
87
|
+
return 'error';
|
|
88
|
+
};
|
|
5
89
|
const isPayloadTooLargeError = (err) => {
|
|
6
90
|
if (typeof err !== 'object' || err === null) {
|
|
7
91
|
return false;
|
|
@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
|
4
4
|
import { pino } from 'pino';
|
|
5
5
|
import { sink } from 'pino-test';
|
|
6
6
|
import { providerErrors, rpcErrors } from '@canton-network/core-rpc-errors';
|
|
7
|
-
import { errorHandler } from './errorHandler.js';
|
|
7
|
+
import { errorHandler, errorLogLevel } from './errorHandler.js';
|
|
8
8
|
describe('errorHandler', () => {
|
|
9
9
|
const logger = pino({ level: 'silent' }, sink());
|
|
10
10
|
const isApiPath = (path) => path.startsWith('/api/');
|
|
@@ -98,3 +98,41 @@ describe('errorHandler', () => {
|
|
|
98
98
|
expect(json).not.toHaveBeenCalled();
|
|
99
99
|
});
|
|
100
100
|
});
|
|
101
|
+
describe('errorLogLevel', () => {
|
|
102
|
+
function makeJsCantonError(errorCategory) {
|
|
103
|
+
return {
|
|
104
|
+
code: 'DAML_FAILURE',
|
|
105
|
+
cause: 'some ledger rejection',
|
|
106
|
+
errorCategory,
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
it('logs client-caused JsonRpcErrors (HTTP < 500) at info', () => {
|
|
110
|
+
const err = rpcErrors.invalidParams({ message: 'bad params' });
|
|
111
|
+
expect(errorLogLevel(err)).toBe('info');
|
|
112
|
+
});
|
|
113
|
+
it('logs server-caused JsonRpcErrors (HTTP 500) at error', () => {
|
|
114
|
+
const err = rpcErrors.internal({ message: 'boom' });
|
|
115
|
+
expect(errorLogLevel(err)).toBe('error');
|
|
116
|
+
});
|
|
117
|
+
it('logs a JsCantonError in a non-alerting Canton category at info', () => {
|
|
118
|
+
// 9 = InvalidGivenCurrentSystemStateOther, e.g. a failed Daml
|
|
119
|
+
// `requirement`/assertion - an expected business rejection.
|
|
120
|
+
const err = makeJsCantonError(9);
|
|
121
|
+
expect(errorLogLevel(err)).toBe('info');
|
|
122
|
+
});
|
|
123
|
+
it('logs a JsCantonError in a system-fault Canton category at error', () => {
|
|
124
|
+
// 4 = SystemInternalAssumptionViolated - a genuine internal bug.
|
|
125
|
+
const err = makeJsCantonError(4);
|
|
126
|
+
expect(errorLogLevel(err)).toBe('error');
|
|
127
|
+
});
|
|
128
|
+
it('logs a JsCantonError with an unrecognized category at error', () => {
|
|
129
|
+
const err = makeJsCantonError(999);
|
|
130
|
+
expect(errorLogLevel(err)).toBe('error');
|
|
131
|
+
});
|
|
132
|
+
it('logs a plain Error at error', () => {
|
|
133
|
+
expect(errorLogLevel(new Error('boom'))).toBe('error');
|
|
134
|
+
});
|
|
135
|
+
it('logs an unrecognized error shape at error', () => {
|
|
136
|
+
expect(errorLogLevel({ foo: 'bar' })).toBe('error');
|
|
137
|
+
});
|
|
138
|
+
});
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
-
import { NextFunction, Request, Response } from 'express';
|
|
2
|
-
import { Logger } from 'pino';
|
|
3
|
-
import { JsonRpcResponse } from '@canton-network/core-types';
|
|
1
|
+
import type { NextFunction, Request, Response } from 'express';
|
|
2
|
+
import type { Logger } from 'pino';
|
|
3
|
+
import { type JsonRpcResponse } from '@canton-network/core-types';
|
|
4
|
+
import { z } from 'zod';
|
|
4
5
|
interface JsonRpcHttpOptions<T> {
|
|
5
6
|
logger: Logger;
|
|
6
7
|
controller: T;
|
|
8
|
+
paramSchemas: Record<string, z.ZodType>;
|
|
7
9
|
}
|
|
8
10
|
/**
|
|
9
11
|
* Handles JSON-RPC errors and maps them to HTTP responses.
|
|
@@ -13,6 +15,6 @@ interface JsonRpcHttpOptions<T> {
|
|
|
13
15
|
* @returns A tuple containing the HTTP status code and the JSON-RPC response.
|
|
14
16
|
*/
|
|
15
17
|
export declare const handleRpcError: (error: unknown, id: string | number | null, method?: string) => [number, JsonRpcResponse];
|
|
16
|
-
export declare const jsonRpcHandler: <T extends Record<string, (...args: any[]) => any>>({ controller, logger: _logger, }: JsonRpcHttpOptions<T>) => (req: Request, res: Response, next: NextFunction) => void | Response<any, Record<string, any>>;
|
|
18
|
+
export declare const jsonRpcHandler: <T extends Record<string, (...args: any[]) => any>>({ controller, logger: _logger, paramSchemas, }: JsonRpcHttpOptions<T>) => (req: Request, res: Response, next: NextFunction) => void | Response<any, Record<string, any>>;
|
|
17
19
|
export {};
|
|
18
20
|
//# sourceMappingURL=jsonRpcHandler.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jsonRpcHandler.d.ts","sourceRoot":"","sources":["../../src/middleware/jsonRpcHandler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"jsonRpcHandler.d.ts","sourceRoot":"","sources":["../../src/middleware/jsonRpcHandler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAMlC,OAAO,EAGH,KAAK,eAAe,EACvB,MAAM,4BAA4B,CAAA;AAInC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,UAAU,kBAAkB,CAAC,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,CAAC,CAAA;IACb,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;CAC1C;AAkCD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GACvB,OAAO,OAAO,EACd,IAAI,MAAM,GAAG,MAAM,GAAG,IAAI,EAC1B,SAAS,MAAM,KAChB,CAAC,MAAM,EAAE,eAAe,CAiD1B,CAAA;AAED,eAAO,MAAM,cAAc,GAEtB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,EAAE,gDAIjD,kBAAkB,CAAC,CAAC,CAAC,MAMZ,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,8CAgG1D,CAAA"}
|
|
@@ -4,6 +4,33 @@ import { JsonRpcError, rpcErrors, toHttpErrorCode, } from '@canton-network/core-
|
|
|
4
4
|
import { ErrorResponse, JsonRpcRequest, } from '@canton-network/core-types';
|
|
5
5
|
import { jsonRpcResponse } from '@canton-network/core-rpc-transport';
|
|
6
6
|
import { isJsCantonError } from '@canton-network/core-ledger-client';
|
|
7
|
+
import { errorLogLevel } from './errorHandler.js';
|
|
8
|
+
import { z } from 'zod';
|
|
9
|
+
// Bounds the error payload, as issue count, messages (e.g. unrecognized keys)
|
|
10
|
+
// and field names (issue paths, which flattenError turns into fieldErrors keys)
|
|
11
|
+
// all scale with the input.
|
|
12
|
+
const MAX_ISSUES = 10;
|
|
13
|
+
const MAX_ISSUE_MESSAGE_LENGTH = 200;
|
|
14
|
+
const MAX_FIELD_NAME_LENGTH = 100;
|
|
15
|
+
function validateParams(schema, params) {
|
|
16
|
+
const result = schema.safeParse(params);
|
|
17
|
+
if (result.success)
|
|
18
|
+
return { data: result.data };
|
|
19
|
+
const issues = result.error.issues.slice(0, MAX_ISSUES).map((issue) => ({
|
|
20
|
+
...issue,
|
|
21
|
+
path: issue.path.map((segment) => typeof segment === 'string'
|
|
22
|
+
? segment.slice(0, MAX_FIELD_NAME_LENGTH)
|
|
23
|
+
: segment),
|
|
24
|
+
message: issue.message.slice(0, MAX_ISSUE_MESSAGE_LENGTH),
|
|
25
|
+
}));
|
|
26
|
+
const { formErrors, fieldErrors } = z.flattenError(new z.ZodError(issues));
|
|
27
|
+
return {
|
|
28
|
+
error: rpcErrors.invalidParams({
|
|
29
|
+
message: 'Invalid params',
|
|
30
|
+
data: { formErrors, fieldErrors },
|
|
31
|
+
}),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
7
34
|
/**
|
|
8
35
|
* Handles JSON-RPC errors and maps them to HTTP responses.
|
|
9
36
|
* @param error The error that occurred.
|
|
@@ -60,7 +87,7 @@ export const handleRpcError = (error, id, method) => {
|
|
|
60
87
|
};
|
|
61
88
|
export const jsonRpcHandler =
|
|
62
89
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
63
|
-
({ controller, logger: _logger, }) => {
|
|
90
|
+
({ controller, logger: _logger, paramSchemas, }) => {
|
|
64
91
|
const logger = _logger.child({ component: 'json-rpc-http' });
|
|
65
92
|
return (req, res, next) => {
|
|
66
93
|
if (req.method !== 'POST') {
|
|
@@ -87,15 +114,27 @@ export const jsonRpcHandler =
|
|
|
87
114
|
authContext: req.authContext,
|
|
88
115
|
},
|
|
89
116
|
}, `RPC request: Method called ${method}`);
|
|
90
|
-
const methodFn = controller
|
|
91
|
-
|
|
117
|
+
const methodFn = Object.hasOwn(controller, method)
|
|
118
|
+
? controller[method]
|
|
119
|
+
: undefined;
|
|
120
|
+
const schema = Object.hasOwn(paramSchemas, method)
|
|
121
|
+
? paramSchemas[method]
|
|
122
|
+
: undefined;
|
|
123
|
+
if (!methodFn || !schema) {
|
|
92
124
|
const [status, response] = handleRpcError(rpcErrors.methodNotFound({
|
|
93
125
|
message: `Method ${method} not found`,
|
|
94
|
-
}),
|
|
126
|
+
}), id, method);
|
|
127
|
+
return res.status(status).json(response);
|
|
128
|
+
}
|
|
129
|
+
// The controller only sees the parsed params, so anything the
|
|
130
|
+
// schema does not describe never reaches it.
|
|
131
|
+
const validated = validateParams(schema, params);
|
|
132
|
+
if ('error' in validated) {
|
|
133
|
+
const [status, response] = handleRpcError(validated.error, id, method);
|
|
134
|
+
logger.warn({ response }, 'RPC request: Invalid params');
|
|
95
135
|
return res.status(status).json(response);
|
|
96
136
|
}
|
|
97
|
-
|
|
98
|
-
methodFn(params)
|
|
137
|
+
methodFn(validated.data)
|
|
99
138
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
100
139
|
.then((result) => {
|
|
101
140
|
const response = jsonRpcResponse(id, { result });
|
|
@@ -105,7 +144,7 @@ export const jsonRpcHandler =
|
|
|
105
144
|
.catch((error) => {
|
|
106
145
|
const [status, response] = handleRpcError(error, id, method);
|
|
107
146
|
// Full error with callstack in logs, sanitized version in response
|
|
108
|
-
logger
|
|
147
|
+
logger[errorLogLevel(error)]({ err: error, response }, 'RPC response: error with response');
|
|
109
148
|
res.status(status).json(response);
|
|
110
149
|
});
|
|
111
150
|
}
|
|
@@ -5,6 +5,8 @@ import { pino } from 'pino';
|
|
|
5
5
|
import { sink } from 'pino-test';
|
|
6
6
|
import { rpcErrors, toHttpErrorCode } from '@canton-network/core-rpc-errors';
|
|
7
7
|
import { handleRpcError, jsonRpcHandler } from './jsonRpcHandler.js';
|
|
8
|
+
import { paramSchemas as dappParamSchemas } from '../dapp-api/rpc-gen/schemas.js';
|
|
9
|
+
import { z } from 'zod';
|
|
8
10
|
function errorPayload(body) {
|
|
9
11
|
if (!('error' in body)) {
|
|
10
12
|
throw new Error('expected JSON-RPC error response');
|
|
@@ -33,6 +35,11 @@ describe('jsonRpcHandler', () => {
|
|
|
33
35
|
return jsonRpcHandler({
|
|
34
36
|
controller: { resolve, reject, rpcError },
|
|
35
37
|
logger,
|
|
38
|
+
paramSchemas: {
|
|
39
|
+
resolve: z.unknown(),
|
|
40
|
+
reject: z.unknown(),
|
|
41
|
+
rpcError: z.unknown(),
|
|
42
|
+
},
|
|
36
43
|
});
|
|
37
44
|
}
|
|
38
45
|
function makeRes() {
|
|
@@ -45,6 +52,99 @@ describe('jsonRpcHandler', () => {
|
|
|
45
52
|
res.status.mockReturnValue(res);
|
|
46
53
|
return res;
|
|
47
54
|
}
|
|
55
|
+
describe('param validation', () => {
|
|
56
|
+
it.each([
|
|
57
|
+
[undefined, true],
|
|
58
|
+
[[], true],
|
|
59
|
+
[{}, true],
|
|
60
|
+
[[1], false],
|
|
61
|
+
[{ extra: true }, false],
|
|
62
|
+
])('generated schema for a method without params accepts %j: %s', (params, valid) => {
|
|
63
|
+
expect(dappParamSchemas.status.safeParse(params).success).toBe(valid);
|
|
64
|
+
});
|
|
65
|
+
const paramSchemas = {
|
|
66
|
+
resolve: z.strictObject({ message: z.string() }),
|
|
67
|
+
};
|
|
68
|
+
async function call(params, schemas = paramSchemas) {
|
|
69
|
+
const res = makeRes();
|
|
70
|
+
jsonRpcHandler({
|
|
71
|
+
controller: { resolve, reject, rpcError },
|
|
72
|
+
logger,
|
|
73
|
+
paramSchemas: schemas,
|
|
74
|
+
})({
|
|
75
|
+
method: 'POST',
|
|
76
|
+
body: { jsonrpc: '2.0', id: 1, method: 'resolve', params },
|
|
77
|
+
}, res, vi.fn());
|
|
78
|
+
await waitForRpcResponse(res);
|
|
79
|
+
return res;
|
|
80
|
+
}
|
|
81
|
+
it.each([
|
|
82
|
+
['missing params', undefined],
|
|
83
|
+
['a missing required property', {}],
|
|
84
|
+
['a wrongly typed property', { message: 42 }],
|
|
85
|
+
['an unknown property', { message: 'hi', extra: true }],
|
|
86
|
+
])('rejects %s with InvalidParams', async (_, params) => {
|
|
87
|
+
const res = await call(params);
|
|
88
|
+
expect(resolve).not.toHaveBeenCalled();
|
|
89
|
+
expect(res.status).toHaveBeenCalledWith(toHttpErrorCode(rpcErrors.invalidParams().code));
|
|
90
|
+
expect(errorPayload(res.json.mock
|
|
91
|
+
.calls[0][0]).code).toBe(rpcErrors.invalidParams().code);
|
|
92
|
+
});
|
|
93
|
+
it('passes valid params to the controller', async () => {
|
|
94
|
+
await call({ message: 'hi' });
|
|
95
|
+
expect(resolve).toHaveBeenCalledWith({ message: 'hi' });
|
|
96
|
+
});
|
|
97
|
+
it('passes the parsed params, without properties the schema does not describe', async () => {
|
|
98
|
+
await call({ message: 'hi', extra: true }, { resolve: z.object({ message: z.string() }) });
|
|
99
|
+
expect(resolve).toHaveBeenCalledWith({ message: 'hi' });
|
|
100
|
+
});
|
|
101
|
+
it('reports flattened field and form errors', async () => {
|
|
102
|
+
const res = await call({ message: 42, extra: true });
|
|
103
|
+
const error = errorPayload(res.json.mock
|
|
104
|
+
.calls[0][0]);
|
|
105
|
+
expect(error.message).toBe('Invalid params');
|
|
106
|
+
expect(error.data).toEqual({
|
|
107
|
+
formErrors: [expect.stringContaining('"extra"')],
|
|
108
|
+
fieldErrors: { message: [expect.any(String)] },
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
it('bounds the error payload for large invalid inputs', async () => {
|
|
112
|
+
const res = await call(Object.fromEntries(Array.from({ length: 1000 }, (_, i) => [`key${i}`, i])), {
|
|
113
|
+
resolve: z.record(z.string(), z.string()),
|
|
114
|
+
});
|
|
115
|
+
const { data } = errorPayload(res.json.mock
|
|
116
|
+
.calls[0][0]);
|
|
117
|
+
expect(Object.keys(data.fieldErrors)).toHaveLength(10);
|
|
118
|
+
});
|
|
119
|
+
it('truncates long issue messages', async () => {
|
|
120
|
+
const res = await call({
|
|
121
|
+
message: 'hi',
|
|
122
|
+
['x'.repeat(10_000)]: true,
|
|
123
|
+
});
|
|
124
|
+
const { data } = errorPayload(res.json.mock
|
|
125
|
+
.calls[0][0]);
|
|
126
|
+
const [formError] = data.formErrors;
|
|
127
|
+
expect(formError.length).toBe(200);
|
|
128
|
+
});
|
|
129
|
+
it('truncates long field names of the generated schema, which rejects unknown properties that are not null', async () => {
|
|
130
|
+
const res = await call({ message: 'hi', ['x'.repeat(10_000)]: true }, { resolve: dappParamSchemas.signMessage });
|
|
131
|
+
const { data } = errorPayload(res.json.mock
|
|
132
|
+
.calls[0][0]);
|
|
133
|
+
expect(Object.keys(data.fieldErrors)).toEqual(['x'.repeat(100)]);
|
|
134
|
+
});
|
|
135
|
+
it('passes missing params through when the param is optional', async () => {
|
|
136
|
+
await call(undefined, {
|
|
137
|
+
resolve: paramSchemas.resolve.optional(),
|
|
138
|
+
});
|
|
139
|
+
expect(resolve).toHaveBeenCalledWith(undefined);
|
|
140
|
+
});
|
|
141
|
+
it('rejects a controller method without a schema as not found', async () => {
|
|
142
|
+
const res = await call({ message: 'hi' }, {});
|
|
143
|
+
expect(resolve).not.toHaveBeenCalled();
|
|
144
|
+
expect(errorPayload(res.json.mock
|
|
145
|
+
.calls[0][0]).code).toBe(rpcErrors.methodNotFound().code);
|
|
146
|
+
});
|
|
147
|
+
});
|
|
48
148
|
it('delegates to next() if method is not POST', () => {
|
|
49
149
|
const handler = makeHandler();
|
|
50
150
|
const next = vi.fn();
|
|
@@ -94,7 +194,7 @@ describe('jsonRpcHandler', () => {
|
|
|
94
194
|
await waitForRpcResponse(res);
|
|
95
195
|
expect(res.status).toHaveBeenCalled();
|
|
96
196
|
const payload = res.json.mock.calls[0][0];
|
|
97
|
-
expect(payload.id).
|
|
197
|
+
expect(payload.id).toBe(42);
|
|
98
198
|
expect(payload.error.message).toContain('missing');
|
|
99
199
|
});
|
|
100
200
|
it('returns JSON-RPC success when the method resolves', async () => {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Request, Response, NextFunction } from 'express';
|
|
2
|
-
import { AuthService } from '@canton-network/core-wallet-auth';
|
|
3
|
-
import { Logger } from 'pino';
|
|
2
|
+
import type { AuthService } from '@canton-network/core-wallet-auth';
|
|
3
|
+
import type { Logger } from 'pino';
|
|
4
4
|
export declare function jwtAuth(authService: AuthService, logger: Logger): (req: Request, res: Response, next: NextFunction) => Promise<void>;
|
|
5
5
|
//# sourceMappingURL=jwtAuth.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jwtAuth.d.ts","sourceRoot":"","sources":["../../src/middleware/jwtAuth.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;
|
|
1
|
+
{"version":3,"file":"jwtAuth.d.ts","sourceRoot":"","sources":["../../src/middleware/jwtAuth.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAGnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAElC,wBAAgB,OAAO,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,IAC9C,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,mBA4BhE"}
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
import type { Request, Response, NextFunction } from 'express';
|
|
2
|
-
import { AuthAware } from '@canton-network/core-wallet-auth';
|
|
3
|
-
import { Logger } from 'pino';
|
|
4
|
-
import { Store } from '@canton-network/core-wallet-store';
|
|
2
|
+
import type { AuthAware } from '@canton-network/core-wallet-auth';
|
|
3
|
+
import type { Logger } from 'pino';
|
|
4
|
+
import type { Store } from '@canton-network/core-wallet-store';
|
|
5
5
|
/**
|
|
6
6
|
* Middleware to handle session validation based on user sessions.
|
|
7
7
|
* @param store needs to be AuthAware
|
|
8
8
|
* @param allowedPaths a record of path -> list of methods which do not require authentication
|
|
9
9
|
* @param logger
|
|
10
|
+
* @param onboardingPaths a record of path -> list of methods authenticated by a tokenless
|
|
11
|
+
* onboarding session, passed as `params.sessionId`
|
|
10
12
|
* @returns
|
|
11
13
|
*/
|
|
12
|
-
export declare function sessionHandler(store: Store & AuthAware<Store>, allowedPaths: Record<string, string[]>, logger: Logger): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
|
|
14
|
+
export declare function sessionHandler(store: Store & AuthAware<Store>, allowedPaths: Record<string, string[]>, logger: Logger, onboardingPaths?: Record<string, string[]>): (req: Request, res: Response, next: NextFunction) => Promise<void | Response<any, Record<string, any>>>;
|
|
13
15
|
//# sourceMappingURL=sessionHandler.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessionHandler.d.ts","sourceRoot":"","sources":["../../src/middleware/sessionHandler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;
|
|
1
|
+
{"version":3,"file":"sessionHandler.d.ts","sourceRoot":"","sources":["../../src/middleware/sessionHandler.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAA;AAGjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAClC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AAE9D;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,EAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EACtC,MAAM,EAAE,MAAM,EACd,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAM,IAEhC,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,wDAiFhE"}
|
|
@@ -7,12 +7,15 @@ import { jsonRpcResponse } from '@canton-network/core-rpc-transport';
|
|
|
7
7
|
* @param store needs to be AuthAware
|
|
8
8
|
* @param allowedPaths a record of path -> list of methods which do not require authentication
|
|
9
9
|
* @param logger
|
|
10
|
+
* @param onboardingPaths a record of path -> list of methods authenticated by a tokenless
|
|
11
|
+
* onboarding session, passed as `params.sessionId`
|
|
10
12
|
* @returns
|
|
11
13
|
*/
|
|
12
|
-
export function sessionHandler(store, allowedPaths, logger) {
|
|
14
|
+
export function sessionHandler(store, allowedPaths, logger, onboardingPaths = {}) {
|
|
13
15
|
return async (req, res, next) => {
|
|
14
16
|
const context = req.authContext;
|
|
15
17
|
const allowedMethods = allowedPaths[req.baseUrl];
|
|
18
|
+
const onboardingMethods = onboardingPaths[req.baseUrl];
|
|
16
19
|
if (req.method !== 'POST') {
|
|
17
20
|
logger.debug(`Skipping authentication for ${req.method} request to ${req.baseUrl}`);
|
|
18
21
|
return next();
|
|
@@ -24,6 +27,27 @@ export function sessionHandler(store, allowedPaths, logger) {
|
|
|
24
27
|
return next();
|
|
25
28
|
}
|
|
26
29
|
const reqId = req.body?.id ?? null;
|
|
30
|
+
if (onboardingMethods?.includes(req.body.method)) {
|
|
31
|
+
const sessionId = req.body.params?.sessionId;
|
|
32
|
+
const session = typeof sessionId === 'string' && sessionId
|
|
33
|
+
? await store.getOnboardingSession(sessionId)
|
|
34
|
+
: undefined;
|
|
35
|
+
if (!session?.userId) {
|
|
36
|
+
logger.debug('No onboarding session found');
|
|
37
|
+
return res.status(401).json(jsonRpcResponse(reqId, {
|
|
38
|
+
error: {
|
|
39
|
+
code: providerErrors.unauthorized().code,
|
|
40
|
+
message: 'No onboarding session found',
|
|
41
|
+
},
|
|
42
|
+
}));
|
|
43
|
+
}
|
|
44
|
+
req.authContext = {
|
|
45
|
+
userId: session.userId,
|
|
46
|
+
accessToken: '',
|
|
47
|
+
sessionId: session.id,
|
|
48
|
+
};
|
|
49
|
+
return next();
|
|
50
|
+
}
|
|
27
51
|
if (!context?.accessToken) {
|
|
28
52
|
logger.debug('No access token provided for protected method');
|
|
29
53
|
return res.status(401).json(jsonRpcResponse(reqId, {
|
|
@@ -7,8 +7,12 @@ import { sessionHandler } from './sessionHandler.js';
|
|
|
7
7
|
import { providerErrors } from '@canton-network/core-rpc-errors';
|
|
8
8
|
describe('sessionHandler', () => {
|
|
9
9
|
const getSession = vi.fn();
|
|
10
|
+
const getOnboardingSession = vi.fn();
|
|
10
11
|
const withAuthContext = vi.fn(() => ({ getSession }));
|
|
11
|
-
const store = {
|
|
12
|
+
const store = {
|
|
13
|
+
withAuthContext,
|
|
14
|
+
getOnboardingSession,
|
|
15
|
+
};
|
|
12
16
|
const logger = pino({ level: 'silent' }, sink());
|
|
13
17
|
const allowedPaths = {
|
|
14
18
|
'/api/v0/user': ['addSession', 'listNetworks', 'getUser'],
|
|
@@ -23,6 +27,7 @@ describe('sessionHandler', () => {
|
|
|
23
27
|
};
|
|
24
28
|
beforeEach(() => {
|
|
25
29
|
getSession.mockReset();
|
|
30
|
+
getOnboardingSession.mockReset();
|
|
26
31
|
withAuthContext.mockClear();
|
|
27
32
|
withAuthContext.mockReturnValue({ getSession });
|
|
28
33
|
next = vi.fn();
|
|
@@ -143,6 +148,61 @@ describe('sessionHandler', () => {
|
|
|
143
148
|
expect(withAuthContext).toHaveBeenCalledWith(authContext);
|
|
144
149
|
expect(status).toHaveBeenCalledWith(401);
|
|
145
150
|
});
|
|
151
|
+
describe('onboarding methods', () => {
|
|
152
|
+
const onboardingPaths = {
|
|
153
|
+
'/api/v0/user': ['createSelfIssuedWallet'],
|
|
154
|
+
};
|
|
155
|
+
it('sets a tokenless auth context from the onboarding session', async () => {
|
|
156
|
+
getOnboardingSession.mockResolvedValue({
|
|
157
|
+
id: 'onboarding-1',
|
|
158
|
+
network: 'network1',
|
|
159
|
+
origin: 'https://app.example',
|
|
160
|
+
userId: 'alice',
|
|
161
|
+
});
|
|
162
|
+
const req = makeReq({
|
|
163
|
+
authContext: undefined,
|
|
164
|
+
body: {
|
|
165
|
+
method: 'createSelfIssuedWallet',
|
|
166
|
+
params: { sessionId: 'onboarding-1' },
|
|
167
|
+
},
|
|
168
|
+
});
|
|
169
|
+
const middleware = sessionHandler(store, allowedPaths, logger, onboardingPaths);
|
|
170
|
+
await middleware(req, makeRes(), next);
|
|
171
|
+
expect(getOnboardingSession).toHaveBeenCalledWith('onboarding-1');
|
|
172
|
+
expect(req.authContext).toEqual({
|
|
173
|
+
userId: 'alice',
|
|
174
|
+
accessToken: '',
|
|
175
|
+
sessionId: 'onboarding-1',
|
|
176
|
+
});
|
|
177
|
+
expect(next).toHaveBeenCalledOnce();
|
|
178
|
+
expect(status).not.toHaveBeenCalled();
|
|
179
|
+
});
|
|
180
|
+
it.each([
|
|
181
|
+
['is missing', undefined],
|
|
182
|
+
['is unknown or already has a token', 'onboarding-1'],
|
|
183
|
+
])('returns 401 when the session id %s', async (_, sessionId) => {
|
|
184
|
+
getOnboardingSession.mockResolvedValue(undefined);
|
|
185
|
+
const req = makeReq({
|
|
186
|
+
authContext: undefined,
|
|
187
|
+
body: {
|
|
188
|
+
method: 'createSelfIssuedWallet',
|
|
189
|
+
params: sessionId ? { sessionId } : {},
|
|
190
|
+
},
|
|
191
|
+
});
|
|
192
|
+
const middleware = sessionHandler(store, allowedPaths, logger, onboardingPaths);
|
|
193
|
+
await middleware(req, makeRes(), next);
|
|
194
|
+
expect(next).not.toHaveBeenCalled();
|
|
195
|
+
expect(status).toHaveBeenCalledWith(401);
|
|
196
|
+
expect(json).toHaveBeenCalledWith({
|
|
197
|
+
jsonrpc: '2.0',
|
|
198
|
+
id: null,
|
|
199
|
+
error: {
|
|
200
|
+
code: providerErrors.unauthorized().code,
|
|
201
|
+
message: 'No onboarding session found',
|
|
202
|
+
},
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
});
|
|
146
206
|
it('requires a session when the RPC method is not on the path allow list', async () => {
|
|
147
207
|
getSession.mockResolvedValue(undefined);
|
|
148
208
|
const req = makeReq({ body: { method: 'removeSession' } });
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Logger } from 'pino';
|
|
2
|
-
import { AuthAware, AuthContext, AuthTokenProvider } from '@canton-network/core-wallet-auth';
|
|
3
|
-
import { Network, Store } from '@canton-network/core-wallet-store';
|
|
1
|
+
import type { Logger } from 'pino';
|
|
2
|
+
import { type AuthAware, type AuthContext, AuthTokenProvider } from '@canton-network/core-wallet-auth';
|
|
3
|
+
import type { Network, Store } from '@canton-network/core-wallet-store';
|
|
4
4
|
export type AccessTokenProviderFactory = (network: Network) => Promise<AuthTokenProvider>;
|
|
5
5
|
export interface AutomationRunContext {
|
|
6
6
|
authContext: AuthContext;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service-account-session.d.ts","sourceRoot":"","sources":["../../src/signing/service-account-session.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"service-account-session.d.ts","sourceRoot":"","sources":["../../src/signing/service-account-session.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAClC,OAAO,EACH,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,iBAAiB,EAEpB,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AAEvE,MAAM,MAAM,0BAA0B,GAAG,CACrC,OAAO,EAAE,OAAO,KACf,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE/B,MAAM,WAAW,oBAAoB;IACjC,WAAW,EAAE,WAAW,CAAA;IACxB,WAAW,EAAE,KAAK,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACnB;AAED;;;;GAIG;AACH,wBAAsB,2BAA2B,CAC7C,cAAc,EAAE,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,EACxC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAuC3C"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Copyright (c) 2025-2026 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
-
import { AuthTokenProvider, } from '@canton-network/core-wallet-auth';
|
|
3
|
+
import { AuthTokenProvider, resolveAuthIdentityProviderId, } from '@canton-network/core-wallet-auth';
|
|
4
4
|
/**
|
|
5
5
|
* Resolves auth for background completion of pending external transactions.
|
|
6
6
|
* Service-account networks can run without a pre-existing session by minting
|
|
@@ -16,7 +16,7 @@ export async function resolveAutomationRunContext(bootstrapStore, userId, networ
|
|
|
16
16
|
logger.debug({ userId, networkId }, 'Skipping signing worker tick: network is not service-account');
|
|
17
17
|
return undefined;
|
|
18
18
|
}
|
|
19
|
-
const idp = await bootstrapStore.getIdp(network.identityProviderId);
|
|
19
|
+
const idp = await bootstrapStore.getIdp(resolveAuthIdentityProviderId(network.serviceAccountAuth, network.identityProviderId));
|
|
20
20
|
const provider = AuthTokenProvider.fromGatewayConfig(idp, network.serviceAccountAuth, logger);
|
|
21
21
|
const authContext = await provider.getAuthContext();
|
|
22
22
|
const scopedStore = bootstrapStore.withAuthContext(authContext);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Copyright (c) 2025-2026 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
-
import {
|
|
3
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
4
4
|
vi.mock('uuid', () => ({ v4: vi.fn(() => 'session-new') }));
|
|
5
5
|
import { pino } from 'pino';
|
|
6
6
|
import { sink } from 'pino-test';
|
|
@@ -48,7 +48,6 @@ const m2mNetwork = {
|
|
|
48
48
|
};
|
|
49
49
|
const logger = pino({ level: 'silent' }, sink());
|
|
50
50
|
describe('resolveAutomationRunContext', () => {
|
|
51
|
-
afterEach(() => vi.clearAllMocks());
|
|
52
51
|
it('reuses a valid client-credentials session', async () => {
|
|
53
52
|
const session = {
|
|
54
53
|
id: 'session-1',
|