@peac/transport-grpc 0.12.6

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.
@@ -0,0 +1,25 @@
1
+
2
+ > @peac/transport-grpc@0.12.6 build /Users/raj/code/peac/packages/transport/grpc
3
+ > pnpm run build:js && pnpm run build:types
4
+
5
+
6
+ > @peac/transport-grpc@0.12.6 build:js /Users/raj/code/peac/packages/transport/grpc
7
+ > tsup
8
+
9
+ CLI Building entry: src/index.ts
10
+ CLI Using tsconfig: tsconfig.json
11
+ CLI tsup v8.5.1
12
+ CLI Using tsup config: /Users/raj/code/peac/packages/transport/grpc/tsup.config.ts
13
+ CLI Target: es2022
14
+ CJS Build start
15
+ ESM Build start
16
+ CJS dist/index.cjs 9.50 KB
17
+ CJS dist/index.cjs.map 23.79 KB
18
+ CJS ⚡️ Build success in 132ms
19
+ ESM dist/index.mjs 8.96 KB
20
+ ESM dist/index.mjs.map 23.73 KB
21
+ ESM ⚡️ Build success in 132ms
22
+
23
+ > @peac/transport-grpc@0.12.6 build:types /Users/raj/code/peac/packages/transport/grpc
24
+ > rm -f dist/.tsbuildinfo && tsc && rm -f dist/.tsbuildinfo
25
+
@@ -0,0 +1,15 @@
1
+
2
+ > @peac/transport-grpc@0.12.6 test /Users/raj/code/peac/packages/transport/grpc
3
+ > vitest run
4
+
5
+
6
+  RUN  v4.0.18 /Users/raj/code/peac/packages/transport/grpc
7
+
8
+ ✓ tests/a2a-carrier.test.ts (24 tests) 10ms
9
+ ✓ tests/status-parity.test.ts (60 tests) 6ms
10
+
11
+  Test Files  2 passed (2)
12
+  Tests  84 passed (84)
13
+  Start at  16:24:11
14
+  Duration  439ms (transform 371ms, setup 0ms, import 613ms, tests 16ms, environment 0ms)
15
+
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2025-2026 PEAC Protocol Contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,110 @@
1
+ # @peac/transport-grpc
2
+
3
+ PEAC gRPC transport layer: carrier adapter, HTTP/gRPC status code parity, and metadata key conventions for signed interaction receipts over gRPC.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pnpm add @peac/transport-grpc
9
+ ```
10
+
11
+ ## What It Does
12
+
13
+ `@peac/transport-grpc` provides gRPC transport bindings for PEAC evidence carriers using embedded metadata. It maps receipts to gRPC metadata keys, translates between HTTP and gRPC status codes, and implements the `CarrierAdapter` interface for gRPC-based A2A deployments. This package handles embedded metadata carriers only; for larger receipts that exceed the metadata budget, use reference-based patterns (`receipt_url`) handled by `@peac/net-node`. Pure TypeScript with no `@grpc/grpc-js` dependency; consumers bring their own gRPC runtime.
14
+
15
+ ## How Do I Use It?
16
+
17
+ ### Attach a receipt to gRPC metadata
18
+
19
+ ```typescript
20
+ import { addReceiptToMetadata } from '@peac/transport-grpc';
21
+
22
+ const metadata: Record<string, string> = {};
23
+ addReceiptToMetadata(metadata, receiptJws);
24
+ // metadata['peac-receipt'] = receiptJws
25
+ // metadata['peac-receipt-type'] = 'interaction-record+jwt'
26
+ ```
27
+
28
+ ### Extract a receipt from gRPC metadata
29
+
30
+ ```typescript
31
+ import { extractReceiptFromMetadata } from '@peac/transport-grpc';
32
+
33
+ const jws = extractReceiptFromMetadata(incomingMetadata);
34
+ if (jws) {
35
+ // verify with @peac/protocol verifyLocal()
36
+ }
37
+ ```
38
+
39
+ ### Use the CarrierAdapter
40
+
41
+ ```typescript
42
+ import { A2AGrpcCarrierAdapter } from '@peac/transport-grpc';
43
+
44
+ const adapter = new A2AGrpcCarrierAdapter();
45
+
46
+ // Attach carrier to metadata
47
+ const metadata = adapter.attach({}, [carrier]);
48
+
49
+ // Extract carrier (computes real SHA-256 receipt_ref)
50
+ const result = adapter.extract(metadata);
51
+ if (result) {
52
+ console.log(result.receipts[0].receipt_ref); // sha256:<real digest>
53
+ }
54
+ ```
55
+
56
+ ### Map HTTP status codes to gRPC
57
+
58
+ ```typescript
59
+ import { httpStatusToGrpc, grpcStatusToHttp, GrpcStatus } from '@peac/transport-grpc';
60
+
61
+ httpStatusToGrpc(402); // GrpcStatus.FAILED_PRECONDITION (9)
62
+ grpcStatusToHttp(GrpcStatus.UNAUTHENTICATED); // 401
63
+ ```
64
+
65
+ ### Use Wire 0.1 receipt type
66
+
67
+ ```typescript
68
+ import { addReceiptToMetadata } from '@peac/transport-grpc';
69
+
70
+ addReceiptToMetadata(metadata, receiptJws, 'peac-receipt/0.1');
71
+ ```
72
+
73
+ ## Header Size Constraints
74
+
75
+ gRPC metadata is carried in HTTP/2 headers. Official gRPC guidance warns that servers may limit request headers, with a common default of 8 KiB. The default `GRPC_MAX_CARRIER_SIZE` is set to 8,192 bytes as the conservative interoperability-safe default. Larger limits are deployment-specific and require explicit server configuration.
76
+
77
+ For environments with known larger server limits, override via:
78
+
79
+ ```typescript
80
+ import { createGrpcCarrierMeta } from '@peac/transport-grpc';
81
+
82
+ const meta = createGrpcCarrierMeta({ max_size: 65_536 }); // 64 KiB
83
+ ```
84
+
85
+ For receipts exceeding the header budget, prefer reference mode (`receipt_url`) instead of embedding the full JWS in metadata.
86
+
87
+ ## Integrates With
88
+
89
+ - `@peac/kernel` (Layer 0): Types, constants, error codes
90
+ - `@peac/schema` (Layer 1): Carrier constraint validation
91
+ - `@peac/mappings-a2a` (Layer 4): A2A metadata carrier operations
92
+ - `@peac/protocol` (Layer 3): Receipt issuance and verification
93
+
94
+ ## For Agent Developers
95
+
96
+ If you are building an AI agent or MCP server that needs evidence receipts:
97
+
98
+ - Start with [`@peac/mcp-server`](https://www.npmjs.com/package/@peac/mcp-server) for a ready-to-use MCP tool server
99
+ - Use `@peac/protocol` for programmatic receipt issuance and verification
100
+ - See the [llms.txt](https://github.com/peacprotocol/peac/blob/main/llms.txt) for a concise overview
101
+
102
+ ## License
103
+
104
+ Apache-2.0
105
+
106
+ ---
107
+
108
+ PEAC Protocol is an open source project stewarded by Originary and community contributors.
109
+
110
+ [Docs](https://www.peacprotocol.org) | [GitHub](https://github.com/peacprotocol/peac) | [Originary](https://www.originary.xyz)
@@ -0,0 +1,71 @@
1
+ /**
2
+ * gRPC CarrierAdapter for A2A transport.
3
+ *
4
+ * Implements the PEAC CarrierAdapter interface for gRPC metadata,
5
+ * enabling receipt attach/extract via gRPC metadata keys. Pure TS
6
+ * with no @grpc/grpc-js dependency; consumers bring their own gRPC.
7
+ *
8
+ * Size default: 8 KiB. gRPC metadata rides in HTTP/2 headers where
9
+ * servers commonly enforce an 8 KiB limit. For larger receipts, use
10
+ * reference mode (receipt_url) or negotiate a higher limit with the
11
+ * gRPC server configuration.
12
+ */
13
+ import type { CarrierAdapter, PeacEvidenceCarrier, CarrierMeta, CarrierValidationResult } from '@peac/kernel';
14
+ import type { GrpcMetadataLike } from './metadata.js';
15
+ /**
16
+ * Default maximum carrier size for gRPC metadata (8 KiB).
17
+ *
18
+ * gRPC metadata is carried in HTTP/2 headers. Official gRPC guidance
19
+ * warns that servers may limit request headers, with a common default
20
+ * of 8 KiB. This is a conservative interoperability-safe default.
21
+ * Consumers with known larger server limits can override via
22
+ * `createGrpcCarrierMeta({ max_size: ... })`.
23
+ */
24
+ export declare const GRPC_MAX_CARRIER_SIZE = 8192;
25
+ /**
26
+ * CarrierAdapter for gRPC metadata transport.
27
+ *
28
+ * Reads and writes PEAC evidence carriers via `GrpcMetadataKeys.RECEIPT`
29
+ * and `GrpcMetadataKeys.RECEIPT_TYPE` metadata entries.
30
+ *
31
+ * `extract()` computes the real SHA-256 receipt_ref synchronously
32
+ * using Node's `crypto.createHash` (server-first package).
33
+ */
34
+ export declare class A2AGrpcCarrierAdapter implements CarrierAdapter<GrpcMetadataLike, GrpcMetadataLike> {
35
+ /**
36
+ * Extract PEAC evidence carrier from gRPC metadata.
37
+ *
38
+ * Computes the real SHA-256 receipt_ref from the JWS bytes using
39
+ * Node's synchronous crypto.createHash (server-first package).
40
+ * Rejects binary metadata keys (gRPC `-bin` suffix convention).
41
+ *
42
+ * @returns Extracted carrier with computed receipt_ref, or null if absent
43
+ */
44
+ extract(input: GrpcMetadataLike): {
45
+ receipts: PeacEvidenceCarrier[];
46
+ meta: CarrierMeta;
47
+ } | null;
48
+ attach(output: GrpcMetadataLike, carriers: PeacEvidenceCarrier[], meta?: CarrierMeta): GrpcMetadataLike;
49
+ validateConstraints(carrier: PeacEvidenceCarrier, meta: CarrierMeta): CarrierValidationResult;
50
+ }
51
+ /**
52
+ * Create default CarrierMeta for gRPC transport.
53
+ *
54
+ * Default max_size is 8 KiB (HTTP/2 header budget). Override for
55
+ * environments with known larger server limits.
56
+ */
57
+ export declare function createGrpcCarrierMeta(overrides?: Partial<CarrierMeta>): CarrierMeta;
58
+ /**
59
+ * Validate that the package's own PEAC metadata key constants are ASCII-safe
60
+ * and do not use the reserved `grpc-` prefix.
61
+ *
62
+ * This is a repo-level invariant check, not an inbound metadata validator.
63
+ * It verifies that all keys defined in `GrpcMetadataKeys` use only
64
+ * lowercase ASCII letters, digits, hyphens, and underscores per
65
+ * gRPC metadata key requirements, and that none start with the
66
+ * reserved `grpc-` prefix.
67
+ *
68
+ * @returns Array of invalid keys (empty if all valid)
69
+ */
70
+ export declare function validateOwnMetadataKeys(): string[];
71
+ //# sourceMappingURL=a2a-carrier.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"a2a-carrier.d.ts","sourceRoot":"","sources":["../src/a2a-carrier.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,WAAW,EACX,uBAAuB,EAExB,MAAM,cAAc,CAAC;AAItB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAMtD;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,OAAQ,CAAC;AAS3C;;;;;;;;GAQG;AACH,qBAAa,qBAAsB,YAAW,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAC9F;;;;;;;;OAQG;IACH,OAAO,CAAC,KAAK,EAAE,gBAAgB,GAAG;QAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC;QAAC,IAAI,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI;IAwB/F,MAAM,CACJ,MAAM,EAAE,gBAAgB,EACxB,QAAQ,EAAE,mBAAmB,EAAE,EAC/B,IAAI,CAAC,EAAE,WAAW,GACjB,gBAAgB;IAiBnB,mBAAmB,CAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,WAAW,GAAG,uBAAuB;CAG9F;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAOnF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,EAAE,CAYlD"}