Skip to content

Commit 8240178

Browse files
Make sure we generate only what we decide we want to generate (#237)
1 parent b6b7ea2 commit 8240178

6 files changed

Lines changed: 29 additions & 1814 deletions

File tree

packages/cre-sdk/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,15 @@ This SDK uses [@bufbuild/protobuf](https://www.npmjs.com/package/@bufbuild/proto
516516
- `buf.gen.yaml` - Code generation configuration using ts-proto
517517
- Generated files are placed in `src/generated/`
518518

519+
**Opt-in proto allowlist:**
520+
521+
[`buf.gen.yaml`](./buf.gen.yaml) uses an explicit `paths:` allowlist under its `inputs`. Protos added to the `chainlink-protos` submodule are **not** picked up automatically — a new capability must be added to both:
522+
523+
1. [`packages/cre-sdk/buf.gen.yaml`](./buf.gen.yaml) — to generate the raw `*_pb.ts` types.
524+
2. [`packages/cre-sdk/scripts/src/generate-sdks.ts`](./scripts/src/generate-sdks.ts) — to generate the SDK wrapper classes and mocks.
525+
526+
This prevents leaking in-progress or internal capabilities into the public SDK surface before they are ready.
527+
519528
### Chain Selectors Generation
520529

521530
Auto-generated TypeScript files for 200+ blockchain networks from the official [Chainlink chain-selectors repository](https://github.com/smartcontractkit/chain-selectors).

packages/cre-sdk/buf.gen.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@ managed:
1010

1111
inputs:
1212
- directory: ../../submodules/chainlink-protos/cre
13+
# Allowlist: only generate for protos we explicitly opt into.
14+
# New protos added to chainlink-protos/cre will NOT be picked up
15+
# until listed here. Keep in sync with generate-sdks.ts.
16+
paths:
17+
- ../../submodules/chainlink-protos/cre/capabilities/blockchain/aptos/v1alpha
18+
- ../../submodules/chainlink-protos/cre/capabilities/blockchain/evm/v1alpha
19+
- ../../submodules/chainlink-protos/cre/capabilities/internal/actionandtrigger/v1
20+
- ../../submodules/chainlink-protos/cre/capabilities/internal/basicaction/v1
21+
- ../../submodules/chainlink-protos/cre/capabilities/internal/basictrigger/v1
22+
- ../../submodules/chainlink-protos/cre/capabilities/internal/consensus/v1alpha
23+
- ../../submodules/chainlink-protos/cre/capabilities/internal/importclash/p1/v1
24+
- ../../submodules/chainlink-protos/cre/capabilities/internal/importclash/p2/v1
25+
- ../../submodules/chainlink-protos/cre/capabilities/internal/importclash/v1
26+
- ../../submodules/chainlink-protos/cre/capabilities/internal/nodeaction/v1
27+
- ../../submodules/chainlink-protos/cre/capabilities/networking/confidentialhttp/v1alpha
28+
- ../../submodules/chainlink-protos/cre/capabilities/networking/http/v1alpha
29+
- ../../submodules/chainlink-protos/cre/capabilities/scheduler/cron/v1
30+
- ../../submodules/chainlink-protos/cre/sdk/v1alpha
31+
- ../../submodules/chainlink-protos/cre/tools/generator/v1alpha
32+
- ../../submodules/chainlink-protos/cre/values/v1
1333

1434
plugins:
1535
# Modern @bufbuild/protoc-gen-es plugin

packages/cre-sdk/src/generated/capabilities/compute/confidentialworkflow/v1alpha/client_pb.ts

Lines changed: 0 additions & 276 deletions
This file was deleted.

packages/cre-sdk/src/generated/capabilities/internal/consensus/v1beta/consensus_pb.ts

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)