@t-0/provider-sdk 1.1.27 → 1.1.29
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 +33 -3
- package/lib/cjs/crypto/hash.d.ts +2 -0
- package/lib/cjs/crypto/hash.js +17 -0
- package/lib/cjs/crypto/index.d.ts +5 -0
- package/lib/cjs/crypto/index.js +14 -0
- package/lib/cjs/crypto/keys.d.ts +2 -0
- package/lib/cjs/crypto/keys.js +19 -0
- package/lib/cjs/crypto/request.d.ts +20 -0
- package/lib/cjs/crypto/request.js +49 -0
- package/lib/cjs/crypto/verify.d.ts +1 -0
- package/lib/cjs/crypto/verify.js +19 -0
- package/lib/cjs/index.d.ts +3 -0
- package/lib/cjs/index.js +8 -1
- package/lib/cjs/service/health.d.ts +1 -1
- package/lib/cjs/service/health.js +1 -5
- package/lib/cjs/service/health_pb.d.ts +157 -0
- package/lib/cjs/service/health_pb.js +90 -0
- package/lib/cjs/service/service.d.ts +12 -1
- package/lib/cjs/service/service.js +7 -17
- package/lib/cjs/service/validate.d.ts +25 -0
- package/lib/cjs/service/validate.js +42 -0
- package/lib/cjs/service/validate_response.d.ts +15 -1
- package/lib/cjs/service/validate_response.js +29 -2
- package/lib/cjs/version.d.ts +1 -1
- package/lib/cjs/version.js +1 -1
- package/lib/esm/crypto/hash.d.ts +2 -0
- package/lib/esm/crypto/hash.js +13 -0
- package/lib/esm/crypto/index.d.ts +5 -0
- package/lib/esm/crypto/index.js +4 -0
- package/lib/esm/crypto/keys.d.ts +2 -0
- package/lib/esm/crypto/keys.js +15 -0
- package/lib/esm/crypto/request.d.ts +20 -0
- package/lib/esm/crypto/request.js +45 -0
- package/lib/esm/crypto/verify.d.ts +1 -0
- package/lib/esm/crypto/verify.js +16 -0
- package/lib/esm/index.d.ts +3 -0
- package/lib/esm/index.js +3 -0
- package/lib/esm/service/health.d.ts +1 -1
- package/lib/esm/service/health.js +1 -5
- package/lib/esm/service/health_pb.d.ts +157 -0
- package/lib/esm/service/health_pb.js +87 -0
- package/lib/esm/service/service.d.ts +12 -1
- package/lib/esm/service/service.js +7 -17
- package/lib/esm/service/validate.d.ts +25 -0
- package/lib/esm/service/validate.js +38 -0
- package/lib/esm/service/validate_response.d.ts +15 -1
- package/lib/esm/service/validate_response.js +29 -2
- package/lib/esm/version.d.ts +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/tsconfig.cjs.tsbuildinfo +1 -1
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +15 -6
package/README.md
CHANGED
|
@@ -14,10 +14,7 @@ See [starter README](../starter/README.md) for details on the generated project.
|
|
|
14
14
|
|
|
15
15
|
## Installation
|
|
16
16
|
|
|
17
|
-
The SDK depends on `@buf/grpc_grpc.bufbuild_es`, which is published on the Buf Schema Registry, not npmjs. Point the `@buf` scope at BSR before installing (the starter template already ships this `.npmrc`):
|
|
18
|
-
|
|
19
17
|
```bash
|
|
20
|
-
echo '@buf:registry=https://buf.build/gen/npm/v1/' >> .npmrc
|
|
21
18
|
npm install @t-0/provider-sdk
|
|
22
19
|
```
|
|
23
20
|
|
|
@@ -67,6 +64,39 @@ server.listen(3000);
|
|
|
67
64
|
|
|
68
65
|
The middleware chain: `signatureValidation` captures raw request bytes for hashing, `nodeAdapter` bridges ConnectRPC to Node.js HTTP, and `createService` registers your handlers with signature verification.
|
|
69
66
|
|
|
67
|
+
### Standalone Signature Verification
|
|
68
|
+
|
|
69
|
+
For frameworks that don't use Node's `http.createServer` (Effect, Koa, Fastify, etc.), use `createRequestVerifier` to verify inbound requests with just the raw body bytes and headers:
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
import { createRequestVerifier, parsePublicKey } from "@t-0/provider-sdk";
|
|
73
|
+
|
|
74
|
+
const verify = createRequestVerifier({
|
|
75
|
+
networkPublicKey: process.env.NETWORK_PUBLIC_KEY!,
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
// In your framework's request handler:
|
|
79
|
+
function handleRequest(rawBody: Uint8Array, headers: Record<string, string>) {
|
|
80
|
+
const result = verify({
|
|
81
|
+
body: rawBody,
|
|
82
|
+
signatureHeader: headers["x-signature"],
|
|
83
|
+
publicKeyHeader: headers["x-public-key"],
|
|
84
|
+
timestampHeader: headers["x-signature-timestamp"],
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
if (!result.valid) {
|
|
88
|
+
// result.reason is one of: 'invalid_timestamp', 'timestamp_out_of_range',
|
|
89
|
+
// 'invalid_public_key', 'unknown_public_key', 'invalid_signature_format',
|
|
90
|
+
// 'signature_failed'
|
|
91
|
+
return errorResponse(result.reason);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Request is authenticated — parse the protobuf body and handle it
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
The lower-level primitives are also exported individually: `verifySignature`, `computeDigest`, `keccak256`, `parsePublicKey`, `publicKeysEqual`.
|
|
99
|
+
|
|
70
100
|
### Network Client
|
|
71
101
|
|
|
72
102
|
Use `createClient` to call T-0 Network APIs. The client handles request signing automatically:
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.keccak256 = keccak256;
|
|
4
|
+
exports.computeDigest = computeDigest;
|
|
5
|
+
const sha3_js_1 = require("@noble/hashes/sha3.js");
|
|
6
|
+
function keccak256(...inputs) {
|
|
7
|
+
const h = sha3_js_1.keccak_256.create();
|
|
8
|
+
for (const input of inputs) {
|
|
9
|
+
h.update(input);
|
|
10
|
+
}
|
|
11
|
+
return Buffer.from(h.digest());
|
|
12
|
+
}
|
|
13
|
+
function computeDigest(body, timestampMs) {
|
|
14
|
+
const tsBuf = Buffer.alloc(8);
|
|
15
|
+
tsBuf.writeBigUInt64LE(BigInt(timestampMs));
|
|
16
|
+
return keccak256(body, tsBuf);
|
|
17
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { verifySignature } from './verify.js';
|
|
2
|
+
export { keccak256, computeDigest } from './hash.js';
|
|
3
|
+
export { parsePublicKey, publicKeysEqual } from './keys.js';
|
|
4
|
+
export { createRequestVerifier, DEFAULT_TOLERANCE_MS } from './request.js';
|
|
5
|
+
export type { CreateVerifierOptions, VerifyRequest, VerifyRequestResult, VerifyRequestFailure, RequestVerifier } from './request.js';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEFAULT_TOLERANCE_MS = exports.createRequestVerifier = exports.publicKeysEqual = exports.parsePublicKey = exports.computeDigest = exports.keccak256 = exports.verifySignature = void 0;
|
|
4
|
+
var verify_js_1 = require("./verify.js");
|
|
5
|
+
Object.defineProperty(exports, "verifySignature", { enumerable: true, get: function () { return verify_js_1.verifySignature; } });
|
|
6
|
+
var hash_js_1 = require("./hash.js");
|
|
7
|
+
Object.defineProperty(exports, "keccak256", { enumerable: true, get: function () { return hash_js_1.keccak256; } });
|
|
8
|
+
Object.defineProperty(exports, "computeDigest", { enumerable: true, get: function () { return hash_js_1.computeDigest; } });
|
|
9
|
+
var keys_js_1 = require("./keys.js");
|
|
10
|
+
Object.defineProperty(exports, "parsePublicKey", { enumerable: true, get: function () { return keys_js_1.parsePublicKey; } });
|
|
11
|
+
Object.defineProperty(exports, "publicKeysEqual", { enumerable: true, get: function () { return keys_js_1.publicKeysEqual; } });
|
|
12
|
+
var request_js_1 = require("./request.js");
|
|
13
|
+
Object.defineProperty(exports, "createRequestVerifier", { enumerable: true, get: function () { return request_js_1.createRequestVerifier; } });
|
|
14
|
+
Object.defineProperty(exports, "DEFAULT_TOLERANCE_MS", { enumerable: true, get: function () { return request_js_1.DEFAULT_TOLERANCE_MS; } });
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.parsePublicKey = parsePublicKey;
|
|
4
|
+
exports.publicKeysEqual = publicKeysEqual;
|
|
5
|
+
function parsePublicKey(key) {
|
|
6
|
+
if (typeof key === 'string') {
|
|
7
|
+
key = Buffer.from(key.startsWith('0x') ? key.slice(2) : key, 'hex');
|
|
8
|
+
}
|
|
9
|
+
if (key.length !== 65 || key[0] !== 0x04) {
|
|
10
|
+
throw new Error('Public key must be 65 bytes in uncompressed format (0x04 prefix)');
|
|
11
|
+
}
|
|
12
|
+
return Buffer.from(key);
|
|
13
|
+
}
|
|
14
|
+
function publicKeysEqual(a, b) {
|
|
15
|
+
if (a.length !== b.length) {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
return Buffer.from(a).compare(Buffer.from(b)) === 0;
|
|
19
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export declare const DEFAULT_TOLERANCE_MS = 60000;
|
|
2
|
+
export interface CreateVerifierOptions {
|
|
3
|
+
networkPublicKey: string | Buffer;
|
|
4
|
+
toleranceMs?: number;
|
|
5
|
+
}
|
|
6
|
+
export interface VerifyRequest {
|
|
7
|
+
body: Uint8Array;
|
|
8
|
+
signatureHeader: string;
|
|
9
|
+
publicKeyHeader: string;
|
|
10
|
+
timestampHeader: string;
|
|
11
|
+
}
|
|
12
|
+
export type VerifyRequestFailure = 'invalid_timestamp' | 'timestamp_out_of_range' | 'invalid_public_key' | 'unknown_public_key' | 'invalid_signature_format' | 'signature_failed';
|
|
13
|
+
export type VerifyRequestResult = {
|
|
14
|
+
valid: true;
|
|
15
|
+
} | {
|
|
16
|
+
valid: false;
|
|
17
|
+
reason: VerifyRequestFailure;
|
|
18
|
+
};
|
|
19
|
+
export type RequestVerifier = (req: VerifyRequest) => VerifyRequestResult;
|
|
20
|
+
export declare function createRequestVerifier(opts: CreateVerifierOptions): RequestVerifier;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEFAULT_TOLERANCE_MS = void 0;
|
|
4
|
+
exports.createRequestVerifier = createRequestVerifier;
|
|
5
|
+
const verify_js_1 = require("./verify.js");
|
|
6
|
+
const hash_js_1 = require("./hash.js");
|
|
7
|
+
const keys_js_1 = require("./keys.js");
|
|
8
|
+
exports.DEFAULT_TOLERANCE_MS = 60000;
|
|
9
|
+
function createRequestVerifier(opts) {
|
|
10
|
+
const networkKey = (0, keys_js_1.parsePublicKey)(opts.networkPublicKey);
|
|
11
|
+
const tolerance = opts.toleranceMs ?? exports.DEFAULT_TOLERANCE_MS;
|
|
12
|
+
return (req) => {
|
|
13
|
+
const ts = parseInt(req.timestampHeader, 10);
|
|
14
|
+
if (!Number.isFinite(ts) || ts < 0) {
|
|
15
|
+
return { valid: false, reason: 'invalid_timestamp' };
|
|
16
|
+
}
|
|
17
|
+
if (Math.abs(Date.now() - ts) > tolerance) {
|
|
18
|
+
return { valid: false, reason: 'timestamp_out_of_range' };
|
|
19
|
+
}
|
|
20
|
+
let publicKey;
|
|
21
|
+
try {
|
|
22
|
+
publicKey = (0, keys_js_1.parsePublicKey)(req.publicKeyHeader);
|
|
23
|
+
}
|
|
24
|
+
catch {
|
|
25
|
+
return { valid: false, reason: 'invalid_public_key' };
|
|
26
|
+
}
|
|
27
|
+
if (!(0, keys_js_1.publicKeysEqual)(publicKey, networkKey)) {
|
|
28
|
+
return { valid: false, reason: 'unknown_public_key' };
|
|
29
|
+
}
|
|
30
|
+
let signature;
|
|
31
|
+
try {
|
|
32
|
+
const hex = req.signatureHeader.startsWith('0x')
|
|
33
|
+
? req.signatureHeader.slice(2)
|
|
34
|
+
: req.signatureHeader;
|
|
35
|
+
signature = Buffer.from(hex, 'hex');
|
|
36
|
+
}
|
|
37
|
+
catch {
|
|
38
|
+
return { valid: false, reason: 'invalid_signature_format' };
|
|
39
|
+
}
|
|
40
|
+
if (signature.length !== 64 && signature.length !== 65) {
|
|
41
|
+
return { valid: false, reason: 'invalid_signature_format' };
|
|
42
|
+
}
|
|
43
|
+
const digest = (0, hash_js_1.computeDigest)(req.body, ts);
|
|
44
|
+
if (!(0, verify_js_1.verifySignature)(publicKey, digest, signature)) {
|
|
45
|
+
return { valid: false, reason: 'signature_failed' };
|
|
46
|
+
}
|
|
47
|
+
return { valid: true };
|
|
48
|
+
};
|
|
49
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function verifySignature(publicKey: Uint8Array, digest: Uint8Array, signature: Uint8Array): boolean;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.verifySignature = verifySignature;
|
|
4
|
+
const secp256k1_js_1 = require("@noble/curves/secp256k1.js");
|
|
5
|
+
function verifySignature(publicKey, digest, signature) {
|
|
6
|
+
if (digest.length !== 32) {
|
|
7
|
+
return false;
|
|
8
|
+
}
|
|
9
|
+
if (signature.length !== 64 && signature.length !== 65) {
|
|
10
|
+
return false;
|
|
11
|
+
}
|
|
12
|
+
const sig64 = signature.length === 65 ? signature.subarray(0, 64) : signature;
|
|
13
|
+
try {
|
|
14
|
+
return secp256k1_js_1.secp256k1.verify(sig64, digest, publicKey, { prehash: false });
|
|
15
|
+
}
|
|
16
|
+
catch {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
}
|
package/lib/cjs/index.d.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
export * from "./crypto/index.js";
|
|
1
2
|
export * from "./client/client.js";
|
|
2
3
|
export * from "./service/service.js";
|
|
3
4
|
export * from "./service/validate_response.js";
|
|
5
|
+
export * from "./service/validate.js";
|
|
4
6
|
export * from "./service/node.js";
|
|
7
|
+
export { default as NetworkHeaders } from "./common/headers.js";
|
|
5
8
|
export { connectNodeAdapter as nodeAdapter } from "@connectrpc/connect-node";
|
|
6
9
|
export type { Client, HandlerContext } from "@connectrpc/connect";
|
|
7
10
|
export * from './common/gen/tzero/v1/common/common_pb.js';
|
package/lib/cjs/index.js
CHANGED
|
@@ -35,12 +35,19 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
35
35
|
return result;
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
39
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
|
+
};
|
|
38
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.PaymentIntentRecipient = exports.PaymentIntentProvider = exports.PaymentIntentBeneficiary = exports.PaymentIntentPayInProvider = exports.PaymentIntentNetwork = exports.nodeAdapter = void 0;
|
|
42
|
+
exports.PaymentIntentRecipient = exports.PaymentIntentProvider = exports.PaymentIntentBeneficiary = exports.PaymentIntentPayInProvider = exports.PaymentIntentNetwork = exports.nodeAdapter = exports.NetworkHeaders = void 0;
|
|
43
|
+
__exportStar(require("./crypto/index.js"), exports);
|
|
40
44
|
__exportStar(require("./client/client.js"), exports);
|
|
41
45
|
__exportStar(require("./service/service.js"), exports);
|
|
42
46
|
__exportStar(require("./service/validate_response.js"), exports);
|
|
47
|
+
__exportStar(require("./service/validate.js"), exports);
|
|
43
48
|
__exportStar(require("./service/node.js"), exports);
|
|
49
|
+
var headers_js_1 = require("./common/headers.js");
|
|
50
|
+
Object.defineProperty(exports, "NetworkHeaders", { enumerable: true, get: function () { return __importDefault(headers_js_1).default; } });
|
|
44
51
|
var connect_node_1 = require("@connectrpc/connect-node");
|
|
45
52
|
Object.defineProperty(exports, "nodeAdapter", { enumerable: true, get: function () { return connect_node_1.connectNodeAdapter; } });
|
|
46
53
|
__exportStar(require("./common/gen/tzero/v1/common/common_pb.js"), exports);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type ServiceImpl } from "@connectrpc/connect";
|
|
2
|
-
import { Health } from "
|
|
2
|
+
import { Health } from "./health_pb.js";
|
|
3
3
|
/**
|
|
4
4
|
* Headers carrying the identity of the SDK answering the probe. They ride on
|
|
5
5
|
* the health response and nowhere else: `HealthCheckResponse` has a single
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.createHealthServiceImpl = exports.SDK_VERSION_HEADER = exports.SDK_ECOSYSTEM_HEADER = void 0;
|
|
4
4
|
const protobuf_1 = require("@bufbuild/protobuf");
|
|
5
5
|
const connect_1 = require("@connectrpc/connect");
|
|
6
|
-
const health_pb_js_1 = require("
|
|
6
|
+
const health_pb_js_1 = require("./health_pb.js");
|
|
7
7
|
const version_js_1 = require("../version.js");
|
|
8
8
|
/**
|
|
9
9
|
* Headers carrying the identity of the SDK answering the probe. They ride on
|
|
@@ -33,10 +33,6 @@ const createHealthServiceImpl = (services) => {
|
|
|
33
33
|
check(req, ctx) {
|
|
34
34
|
ctx.responseHeader.set(exports.SDK_ECOSYSTEM_HEADER, SDK_ECOSYSTEM);
|
|
35
35
|
ctx.responseHeader.set(exports.SDK_VERSION_HEADER, version_js_1.SDK_VERSION);
|
|
36
|
-
// The schema comes from a published .d.ts, whose type brands do not
|
|
37
|
-
// survive ServiceImpl's generics — connect-es widens the request to
|
|
38
|
-
// Message<string>. The descriptor is still the real one at runtime, so
|
|
39
|
-
// this narrows back to what the wire actually carries.
|
|
40
36
|
const { service } = req;
|
|
41
37
|
// An empty service name asks about the process as a whole, which is up if
|
|
42
38
|
// this handler is running at all.
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
3
|
+
/**
|
|
4
|
+
* Describes the file grpc/health/v1/health.proto.
|
|
5
|
+
*/
|
|
6
|
+
export declare const file_grpc_health_v1_health: GenFile;
|
|
7
|
+
/**
|
|
8
|
+
* @generated from message grpc.health.v1.HealthCheckRequest
|
|
9
|
+
*/
|
|
10
|
+
export type HealthCheckRequest = Message<"grpc.health.v1.HealthCheckRequest"> & {
|
|
11
|
+
/**
|
|
12
|
+
* @generated from field: string service = 1;
|
|
13
|
+
*/
|
|
14
|
+
service: string;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Describes the message grpc.health.v1.HealthCheckRequest.
|
|
18
|
+
* Use `create(HealthCheckRequestSchema)` to create a new message.
|
|
19
|
+
*/
|
|
20
|
+
export declare const HealthCheckRequestSchema: GenMessage<HealthCheckRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* @generated from message grpc.health.v1.HealthCheckResponse
|
|
23
|
+
*/
|
|
24
|
+
export type HealthCheckResponse = Message<"grpc.health.v1.HealthCheckResponse"> & {
|
|
25
|
+
/**
|
|
26
|
+
* @generated from field: grpc.health.v1.HealthCheckResponse.ServingStatus status = 1;
|
|
27
|
+
*/
|
|
28
|
+
status: HealthCheckResponse_ServingStatus;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Describes the message grpc.health.v1.HealthCheckResponse.
|
|
32
|
+
* Use `create(HealthCheckResponseSchema)` to create a new message.
|
|
33
|
+
*/
|
|
34
|
+
export declare const HealthCheckResponseSchema: GenMessage<HealthCheckResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* @generated from enum grpc.health.v1.HealthCheckResponse.ServingStatus
|
|
37
|
+
*/
|
|
38
|
+
export declare enum HealthCheckResponse_ServingStatus {
|
|
39
|
+
/**
|
|
40
|
+
* @generated from enum value: UNKNOWN = 0;
|
|
41
|
+
*/
|
|
42
|
+
UNKNOWN = 0,
|
|
43
|
+
/**
|
|
44
|
+
* @generated from enum value: SERVING = 1;
|
|
45
|
+
*/
|
|
46
|
+
SERVING = 1,
|
|
47
|
+
/**
|
|
48
|
+
* @generated from enum value: NOT_SERVING = 2;
|
|
49
|
+
*/
|
|
50
|
+
NOT_SERVING = 2,
|
|
51
|
+
/**
|
|
52
|
+
* Used only by the Watch method.
|
|
53
|
+
*
|
|
54
|
+
* @generated from enum value: SERVICE_UNKNOWN = 3;
|
|
55
|
+
*/
|
|
56
|
+
SERVICE_UNKNOWN = 3
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Describes the enum grpc.health.v1.HealthCheckResponse.ServingStatus.
|
|
60
|
+
*/
|
|
61
|
+
export declare const HealthCheckResponse_ServingStatusSchema: GenEnum<HealthCheckResponse_ServingStatus>;
|
|
62
|
+
/**
|
|
63
|
+
* @generated from message grpc.health.v1.HealthListRequest
|
|
64
|
+
*/
|
|
65
|
+
export type HealthListRequest = Message<"grpc.health.v1.HealthListRequest"> & {};
|
|
66
|
+
/**
|
|
67
|
+
* Describes the message grpc.health.v1.HealthListRequest.
|
|
68
|
+
* Use `create(HealthListRequestSchema)` to create a new message.
|
|
69
|
+
*/
|
|
70
|
+
export declare const HealthListRequestSchema: GenMessage<HealthListRequest>;
|
|
71
|
+
/**
|
|
72
|
+
* @generated from message grpc.health.v1.HealthListResponse
|
|
73
|
+
*/
|
|
74
|
+
export type HealthListResponse = Message<"grpc.health.v1.HealthListResponse"> & {
|
|
75
|
+
/**
|
|
76
|
+
* statuses contains all the services and their respective status.
|
|
77
|
+
*
|
|
78
|
+
* @generated from field: map<string, grpc.health.v1.HealthCheckResponse> statuses = 1;
|
|
79
|
+
*/
|
|
80
|
+
statuses: {
|
|
81
|
+
[key: string]: HealthCheckResponse;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* Describes the message grpc.health.v1.HealthListResponse.
|
|
86
|
+
* Use `create(HealthListResponseSchema)` to create a new message.
|
|
87
|
+
*/
|
|
88
|
+
export declare const HealthListResponseSchema: GenMessage<HealthListResponse>;
|
|
89
|
+
/**
|
|
90
|
+
* Health is gRPC's mechanism for checking whether a server is able to handle
|
|
91
|
+
* RPCs. Its semantics are documented in
|
|
92
|
+
* https://github.com/grpc/grpc/blob/master/doc/health-checking.md.
|
|
93
|
+
*
|
|
94
|
+
* @generated from service grpc.health.v1.Health
|
|
95
|
+
*/
|
|
96
|
+
export declare const Health: GenService<{
|
|
97
|
+
/**
|
|
98
|
+
* Check gets the health of the specified service. If the requested service
|
|
99
|
+
* is unknown, the call will fail with status NOT_FOUND. If the caller does
|
|
100
|
+
* not specify a service name, the server should respond with its overall
|
|
101
|
+
* health status.
|
|
102
|
+
*
|
|
103
|
+
* Clients should set a deadline when calling Check, and can declare the
|
|
104
|
+
* server unhealthy if they do not receive a timely response.
|
|
105
|
+
*
|
|
106
|
+
* @generated from rpc grpc.health.v1.Health.Check
|
|
107
|
+
*/
|
|
108
|
+
check: {
|
|
109
|
+
methodKind: "unary";
|
|
110
|
+
input: typeof HealthCheckRequestSchema;
|
|
111
|
+
output: typeof HealthCheckResponseSchema;
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* List provides a non-atomic snapshot of the health of all the available
|
|
115
|
+
* services.
|
|
116
|
+
*
|
|
117
|
+
* The server may respond with a RESOURCE_EXHAUSTED error if too many services
|
|
118
|
+
* exist.
|
|
119
|
+
*
|
|
120
|
+
* Clients should set a deadline when calling List, and can declare the server
|
|
121
|
+
* unhealthy if they do not receive a timely response.
|
|
122
|
+
*
|
|
123
|
+
* Clients should keep in mind that the list of health services exposed by an
|
|
124
|
+
* application can change over the lifetime of the process.
|
|
125
|
+
*
|
|
126
|
+
* @generated from rpc grpc.health.v1.Health.List
|
|
127
|
+
*/
|
|
128
|
+
list: {
|
|
129
|
+
methodKind: "unary";
|
|
130
|
+
input: typeof HealthListRequestSchema;
|
|
131
|
+
output: typeof HealthListResponseSchema;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Performs a watch for the serving status of the requested service.
|
|
135
|
+
* The server will immediately send back a message indicating the current
|
|
136
|
+
* serving status. It will then subsequently send a new message whenever
|
|
137
|
+
* the service's serving status changes.
|
|
138
|
+
*
|
|
139
|
+
* If the requested service is unknown when the call is received, the
|
|
140
|
+
* server will send a message setting the serving status to
|
|
141
|
+
* SERVICE_UNKNOWN but will *not* terminate the call. If at some
|
|
142
|
+
* future point, the serving status of the service becomes known, the
|
|
143
|
+
* server will send a new message with the service's serving status.
|
|
144
|
+
*
|
|
145
|
+
* If the call terminates with status UNIMPLEMENTED, then clients
|
|
146
|
+
* should assume this method is not supported and should not retry the
|
|
147
|
+
* call. If the call terminates with any other status (including OK),
|
|
148
|
+
* clients should retry the call with appropriate exponential backoff.
|
|
149
|
+
*
|
|
150
|
+
* @generated from rpc grpc.health.v1.Health.Watch
|
|
151
|
+
*/
|
|
152
|
+
watch: {
|
|
153
|
+
methodKind: "server_streaming";
|
|
154
|
+
input: typeof HealthCheckRequestSchema;
|
|
155
|
+
output: typeof HealthCheckResponseSchema;
|
|
156
|
+
};
|
|
157
|
+
}>;
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Vendored generated stubs for grpc.health.v1 -- do not edit by hand.
|
|
3
|
+
//
|
|
4
|
+
// Source: buf.build/grpc/grpc, grpc/health/v1/health.proto
|
|
5
|
+
// Plugin: buf.build/bufbuild/es:v2.12.0 (kept in step with the root
|
|
6
|
+
// buf.gen.yaml pin -- plugin and @bufbuild/protobuf runtime must
|
|
7
|
+
// agree on major).
|
|
8
|
+
//
|
|
9
|
+
// Regenerate with the following, which keeps this header and replaces
|
|
10
|
+
// everything from the gRPC copyright line down. Do not just `mv` the generated
|
|
11
|
+
// file over this one -- that would delete these instructions along with it.
|
|
12
|
+
//
|
|
13
|
+
// cd node/sdk
|
|
14
|
+
// buf generate buf.build/grpc/grpc --path grpc/health/v1/health.proto \
|
|
15
|
+
// --template '{"version":"v2","plugins":[{"remote":"buf.build/bufbuild/es:v2.12.0","out":"gen-health","opt":["target=ts","import_extension=js"]}]}'
|
|
16
|
+
// sed '/^\/\/ Copyright 2015 The gRPC Authors/,$d' src/service/health_pb.ts > gen-health/header
|
|
17
|
+
// cat gen-health/header gen-health/grpc/health/v1/health_pb.ts > src/service/health_pb.ts
|
|
18
|
+
// rm -rf gen-health
|
|
19
|
+
//
|
|
20
|
+
// Vendored rather than depended on: the equivalent package
|
|
21
|
+
// `@buf/grpc_grpc.bufbuild_es` is published only on the Buf Schema Registry, and
|
|
22
|
+
// reaching it needs registry config that a published npm package cannot hand its
|
|
23
|
+
// consumers -- so depending on it 404'd every downstream install. Rationale in
|
|
24
|
+
// docs/HEALTH_SERVICE.md.
|
|
25
|
+
//
|
|
26
|
+
// Lives under src/service/ rather than src/common/gen/ so the transport keeps
|
|
27
|
+
// importing nothing from common/gen.
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.Health = exports.HealthListResponseSchema = exports.HealthListRequestSchema = exports.HealthCheckResponse_ServingStatusSchema = exports.HealthCheckResponse_ServingStatus = exports.HealthCheckResponseSchema = exports.HealthCheckRequestSchema = exports.file_grpc_health_v1_health = void 0;
|
|
30
|
+
const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
|
|
31
|
+
/**
|
|
32
|
+
* Describes the file grpc/health/v1/health.proto.
|
|
33
|
+
*/
|
|
34
|
+
exports.file_grpc_health_v1_health = (0, codegenv2_1.fileDesc)("ChtncnBjL2hlYWx0aC92MS9oZWFsdGgucHJvdG8SDmdycGMuaGVhbHRoLnYxIiUKEkhlYWx0aENoZWNrUmVxdWVzdBIPCgdzZXJ2aWNlGAEgASgJIqkBChNIZWFsdGhDaGVja1Jlc3BvbnNlEkEKBnN0YXR1cxgBIAEoDjIxLmdycGMuaGVhbHRoLnYxLkhlYWx0aENoZWNrUmVzcG9uc2UuU2VydmluZ1N0YXR1cyJPCg1TZXJ2aW5nU3RhdHVzEgsKB1VOS05PV04QABILCgdTRVJWSU5HEAESDwoLTk9UX1NFUlZJTkcQAhITCg9TRVJWSUNFX1VOS05PV04QAyITChFIZWFsdGhMaXN0UmVxdWVzdCKuAQoSSGVhbHRoTGlzdFJlc3BvbnNlEkIKCHN0YXR1c2VzGAEgAygLMjAuZ3JwYy5oZWFsdGgudjEuSGVhbHRoTGlzdFJlc3BvbnNlLlN0YXR1c2VzRW50cnkaVAoNU3RhdHVzZXNFbnRyeRILCgNrZXkYASABKAkSMgoFdmFsdWUYAiABKAsyIy5ncnBjLmhlYWx0aC52MS5IZWFsdGhDaGVja1Jlc3BvbnNlOgI4ATL9AQoGSGVhbHRoElAKBUNoZWNrEiIuZ3JwYy5oZWFsdGgudjEuSGVhbHRoQ2hlY2tSZXF1ZXN0GiMuZ3JwYy5oZWFsdGgudjEuSGVhbHRoQ2hlY2tSZXNwb25zZRJNCgRMaXN0EiEuZ3JwYy5oZWFsdGgudjEuSGVhbHRoTGlzdFJlcXVlc3QaIi5ncnBjLmhlYWx0aC52MS5IZWFsdGhMaXN0UmVzcG9uc2USUgoFV2F0Y2gSIi5ncnBjLmhlYWx0aC52MS5IZWFsdGhDaGVja1JlcXVlc3QaIy5ncnBjLmhlYWx0aC52MS5IZWFsdGhDaGVja1Jlc3BvbnNlMAFCcAoRaW8uZ3JwYy5oZWFsdGgudjFCC0hlYWx0aFByb3RvUAFaLGdvb2dsZS5nb2xhbmcub3JnL2dycGMvaGVhbHRoL2dycGNfaGVhbHRoX3YxogIMR3JwY0hlYWx0aFYxqgIOR3JwYy5IZWFsdGguVjFiBnByb3RvMw");
|
|
35
|
+
/**
|
|
36
|
+
* Describes the message grpc.health.v1.HealthCheckRequest.
|
|
37
|
+
* Use `create(HealthCheckRequestSchema)` to create a new message.
|
|
38
|
+
*/
|
|
39
|
+
exports.HealthCheckRequestSchema = (0, codegenv2_1.messageDesc)(exports.file_grpc_health_v1_health, 0);
|
|
40
|
+
/**
|
|
41
|
+
* Describes the message grpc.health.v1.HealthCheckResponse.
|
|
42
|
+
* Use `create(HealthCheckResponseSchema)` to create a new message.
|
|
43
|
+
*/
|
|
44
|
+
exports.HealthCheckResponseSchema = (0, codegenv2_1.messageDesc)(exports.file_grpc_health_v1_health, 1);
|
|
45
|
+
/**
|
|
46
|
+
* @generated from enum grpc.health.v1.HealthCheckResponse.ServingStatus
|
|
47
|
+
*/
|
|
48
|
+
var HealthCheckResponse_ServingStatus;
|
|
49
|
+
(function (HealthCheckResponse_ServingStatus) {
|
|
50
|
+
/**
|
|
51
|
+
* @generated from enum value: UNKNOWN = 0;
|
|
52
|
+
*/
|
|
53
|
+
HealthCheckResponse_ServingStatus[HealthCheckResponse_ServingStatus["UNKNOWN"] = 0] = "UNKNOWN";
|
|
54
|
+
/**
|
|
55
|
+
* @generated from enum value: SERVING = 1;
|
|
56
|
+
*/
|
|
57
|
+
HealthCheckResponse_ServingStatus[HealthCheckResponse_ServingStatus["SERVING"] = 1] = "SERVING";
|
|
58
|
+
/**
|
|
59
|
+
* @generated from enum value: NOT_SERVING = 2;
|
|
60
|
+
*/
|
|
61
|
+
HealthCheckResponse_ServingStatus[HealthCheckResponse_ServingStatus["NOT_SERVING"] = 2] = "NOT_SERVING";
|
|
62
|
+
/**
|
|
63
|
+
* Used only by the Watch method.
|
|
64
|
+
*
|
|
65
|
+
* @generated from enum value: SERVICE_UNKNOWN = 3;
|
|
66
|
+
*/
|
|
67
|
+
HealthCheckResponse_ServingStatus[HealthCheckResponse_ServingStatus["SERVICE_UNKNOWN"] = 3] = "SERVICE_UNKNOWN";
|
|
68
|
+
})(HealthCheckResponse_ServingStatus || (exports.HealthCheckResponse_ServingStatus = HealthCheckResponse_ServingStatus = {}));
|
|
69
|
+
/**
|
|
70
|
+
* Describes the enum grpc.health.v1.HealthCheckResponse.ServingStatus.
|
|
71
|
+
*/
|
|
72
|
+
exports.HealthCheckResponse_ServingStatusSchema = (0, codegenv2_1.enumDesc)(exports.file_grpc_health_v1_health, 1, 0);
|
|
73
|
+
/**
|
|
74
|
+
* Describes the message grpc.health.v1.HealthListRequest.
|
|
75
|
+
* Use `create(HealthListRequestSchema)` to create a new message.
|
|
76
|
+
*/
|
|
77
|
+
exports.HealthListRequestSchema = (0, codegenv2_1.messageDesc)(exports.file_grpc_health_v1_health, 2);
|
|
78
|
+
/**
|
|
79
|
+
* Describes the message grpc.health.v1.HealthListResponse.
|
|
80
|
+
* Use `create(HealthListResponseSchema)` to create a new message.
|
|
81
|
+
*/
|
|
82
|
+
exports.HealthListResponseSchema = (0, codegenv2_1.messageDesc)(exports.file_grpc_health_v1_health, 3);
|
|
83
|
+
/**
|
|
84
|
+
* Health is gRPC's mechanism for checking whether a server is able to handle
|
|
85
|
+
* RPCs. Its semantics are documented in
|
|
86
|
+
* https://github.com/grpc/grpc/blob/master/doc/health-checking.md.
|
|
87
|
+
*
|
|
88
|
+
* @generated from service grpc.health.v1.Health
|
|
89
|
+
*/
|
|
90
|
+
exports.Health = (0, codegenv2_1.serviceDesc)(exports.file_grpc_health_v1_health, 0);
|
|
@@ -2,11 +2,22 @@ import { ConnectRouter } from "@connectrpc/connect";
|
|
|
2
2
|
import type { Interceptor } from "@connectrpc/connect";
|
|
3
3
|
import type { DescService } from "@bufbuild/protobuf";
|
|
4
4
|
import type { ServiceImpl } from "@connectrpc/connect";
|
|
5
|
+
import { type Logger } from "./validate_response.js";
|
|
6
|
+
export interface CreateServiceOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Logger used by the SDK for error-level events (currently:
|
|
9
|
+
* response-validation failures from the interceptor safety net). The same
|
|
10
|
+
* logger will be used for any future server-wide SDK log sites.
|
|
11
|
+
*
|
|
12
|
+
* If omitted, the SDK logs to `console.error` with a JSON-encoded payload.
|
|
13
|
+
*/
|
|
14
|
+
logger?: Logger;
|
|
15
|
+
}
|
|
5
16
|
export declare const REQUEST_VALIDITY_MILLIS = 60000;
|
|
6
17
|
interface Router {
|
|
7
18
|
service: <T extends DescService, I extends ServiceImpl<T>>(service: T, implementation: I) => void;
|
|
8
19
|
}
|
|
9
|
-
export declare const createService: (networkPublicKey: string | Buffer, registerRoutes: (router: Router) => void) => {
|
|
20
|
+
export declare const createService: (networkPublicKey: string | Buffer, registerRoutes: (router: Router) => void, options?: CreateServiceOptions) => {
|
|
10
21
|
routes: (router: ConnectRouter) => void;
|
|
11
22
|
interceptors: Interceptor[];
|
|
12
23
|
grpcWeb: boolean;
|
|
@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
exports.createService = exports.REQUEST_VALIDITY_MILLIS = void 0;
|
|
7
7
|
const connect_1 = require("@connectrpc/connect");
|
|
8
8
|
const headers_js_1 = __importDefault(require("../common/headers.js"));
|
|
9
|
-
const
|
|
9
|
+
const verify_js_1 = require("../crypto/verify.js");
|
|
10
10
|
const validate_response_js_1 = require("./validate_response.js");
|
|
11
|
-
const health_pb_js_1 = require("
|
|
11
|
+
const health_pb_js_1 = require("./health_pb.js");
|
|
12
12
|
const health_js_1 = require("./health.js");
|
|
13
13
|
exports.REQUEST_VALIDITY_MILLIS = 60000;
|
|
14
14
|
const createSignatureVerification = (networkPublicKey) => (next) => async (req) => {
|
|
@@ -20,29 +20,19 @@ const createSignatureVerification = (networkPublicKey) => (next) => async (req)
|
|
|
20
20
|
if (networkPublicKey.compare(publicKey) !== 0) {
|
|
21
21
|
throw new connect_1.ConnectError(`${headers_js_1.default.PublicKey} value is not network public key`, connect_1.Code.Unauthenticated);
|
|
22
22
|
}
|
|
23
|
-
|
|
24
|
-
if (signature.length === 65) {
|
|
25
|
-
signature = signature.subarray(0, 64);
|
|
26
|
-
}
|
|
23
|
+
const signature = decodeHex(getHeader(req, headers_js_1.default.Signature));
|
|
27
24
|
const hasher = req.contextValues.get(kHash);
|
|
28
25
|
const tsBuf = Buffer.alloc(8);
|
|
29
26
|
tsBuf.writeBigUInt64LE(BigInt(ts)); // 64‑bit little‑endian timestamp
|
|
30
|
-
const
|
|
27
|
+
const digest = hasher
|
|
31
28
|
.update(tsBuf)
|
|
32
29
|
.digest();
|
|
33
|
-
|
|
34
|
-
try {
|
|
35
|
-
signatureValid = secp256k1_js_1.secp256k1.verify(signature, hash, publicKey, { prehash: false });
|
|
36
|
-
}
|
|
37
|
-
catch (e) {
|
|
38
|
-
throw new connect_1.ConnectError(`${headers_js_1.default.Signature} has invalid signature or public key format: ${e}`, connect_1.Code.Unauthenticated);
|
|
39
|
-
}
|
|
40
|
-
if (!signatureValid) {
|
|
30
|
+
if (!(0, verify_js_1.verifySignature)(publicKey, digest, signature)) {
|
|
41
31
|
throw new connect_1.ConnectError(`${headers_js_1.default.Signature} has invalid signature`, connect_1.Code.Unauthenticated);
|
|
42
32
|
}
|
|
43
33
|
return await next(req);
|
|
44
34
|
};
|
|
45
|
-
const createService = (networkPublicKey, registerRoutes) => {
|
|
35
|
+
const createService = (networkPublicKey, registerRoutes, options) => {
|
|
46
36
|
if (typeof networkPublicKey == "string") {
|
|
47
37
|
networkPublicKey = decodeHex(networkPublicKey);
|
|
48
38
|
}
|
|
@@ -63,7 +53,7 @@ const createService = (networkPublicKey, registerRoutes) => {
|
|
|
63
53
|
collected.push(health_pb_js_1.Health.typeName);
|
|
64
54
|
origService(health_pb_js_1.Health, (0, health_js_1.createHealthServiceImpl)(collected));
|
|
65
55
|
},
|
|
66
|
-
interceptors: [createSignatureVerification(networkPublicKey), (0, validate_response_js_1.createValidationInterceptor)()],
|
|
56
|
+
interceptors: [createSignatureVerification(networkPublicKey), (0, validate_response_js_1.createValidationInterceptor)(options?.logger)],
|
|
67
57
|
grpcWeb: false,
|
|
68
58
|
contextValues: (req) => {
|
|
69
59
|
return (0, connect_1.createContextValues)().set(kHash, req.hasher);
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { DescMessage, MessageShape } from "@bufbuild/protobuf";
|
|
2
|
+
/**
|
|
3
|
+
* Shared protovalidate validator instance for the public {@link validate} helper.
|
|
4
|
+
* Construction is cheap, but reusing one instance avoids repeated compilation
|
|
5
|
+
* of the same rules.
|
|
6
|
+
*/
|
|
7
|
+
export declare const validator: import("@bufbuild/protovalidate").Validator;
|
|
8
|
+
/**
|
|
9
|
+
* Validates a response message against its buf.validate proto annotations.
|
|
10
|
+
*
|
|
11
|
+
* On success, returns the message unchanged (typed). On failure, throws a
|
|
12
|
+
* {@link ConnectError} with {@link Code.Internal} and a message matching the
|
|
13
|
+
* shape emitted by the SDK's response-validation interceptor — so propagating
|
|
14
|
+
* the error from a handler produces the same wire response as not calling
|
|
15
|
+
* `validate` at all.
|
|
16
|
+
*
|
|
17
|
+
* Intended use:
|
|
18
|
+
* ```ts
|
|
19
|
+
* return validate(PayOutResponseSchema, { result: { case: "accepted", value: {} } });
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* Catch the error to convert it into a domain-level failure (e.g. the `Failed`
|
|
23
|
+
* arm of a `oneof result`) instead of an opaque `Code.Internal`.
|
|
24
|
+
*/
|
|
25
|
+
export declare function validate<Desc extends DescMessage>(schema: Desc, msg: MessageShape<Desc>): MessageShape<Desc>;
|