CRE - Building a Reusable Library Guide (TS & GO) - #4059
Open
ejacquier wants to merge 2 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
👋 ejacquier, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new "Building a Reusable Library" guide (TS + Go) covering how to package integration logic as a standalone dependency that other developers can import into their own CRE workflows — filling a gap where no doc previously covered publishing/consuming shared code across workflows.
cre/guides/operations/building-a-library-ts.mdx— npm package guide: QuickJS/WASM restrictions, why standard HTTP/crypto/Node libs don't work, required use of CRE SDK capabilities (HTTPClient,.result()pattern, consensus aggregation), determinism pitfalls, packaging (peerDependencyon@chainlink/cre-sdk), and publishing.cre/guides/operations/building-a-library-go.mdx— Go module guide: same shape, adapted for WASI/wasip1(no filesystem/raw sockets instead of QuickJS's stricter import ban),Promise/Awaitinstead of goroutines/channels, Go-specific determinism rules (map iteration,encoding/jsonv1,proto.Marshal), and why library files should skip the//go:build wasip1tag to stay unit-testable.src/config/sidebar.tsunder Workflow Operations as a paired TS/Go entry (matchingpageId/sdkLang), sitting alongside "Custom Rust Plugins."Why
There was no guidance for the "author once, reuse across workflows" pattern — every integration (Slack, PagerDuty, etc.) was being hand-rolled per workflow. This gives library authors a single source of truth for the constraints that are easy to get wrong (e.g. accidentally depending on
axiosornet/http, or writing anasyncpublic API that can't actually be awaited in a handler).