Skip to content

Conversation

@khadni
Copy link
Collaborator

@khadni khadni commented Jan 20, 2026

This pull request primarily updates code samples and snippets across the documentation to use direct imports of individual SDK capabilities (such as CronCapability, HTTPClient, EVMClient, and handler) from @chainlink/cre-sdk, rather than accessing them via the cre.capabilities namespace. Additionally, it clarifies code comments for determinism, updates some metadata fields, and improves documentation notes for SDK usage.

SDK Import and Usage Updates:

  • All code snippets now import CronCapability, HTTPClient, EVMClient, and handler directly from @chainlink/cre-sdk instead of using cre.capabilities. This change affects multiple files in the getting-started and guides/workflow sections, making the code more idiomatic and easier to read. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]

Code Example and Comment Improvements:

  • Clarified comments in TypeScript code examples to better explain deterministic and non-deterministic behaviors, especially around object iteration and key ordering. [1] [2] [3] [4] [5] [6]
  • Updated an example in index-trigger-callback-example.ts to use the direct handler import.

Documentation and Metadata Enhancements:

  • Added an explanatory <Aside> note in the getting started guide, clarifying that users do not need to call main() manually, as the SDK handles execution and error reporting.
  • Updated lastModified metadata fields in several documentation files to reflect the latest changes. [1] [2] [3]
  • Updated import statements in code blocks and guides to match new SDK usage patterns.

Other Minor Changes:

  • Minor formatting improvements in Solidity constructor parameters for readability.

@vercel
Copy link

vercel bot commented Jan 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
documentation Ready Ready Preview Jan 20, 2026 8:08pm

Request Review

@khadni khadni marked this pull request as ready for review January 20, 2026 21:39
@khadni khadni requested a review from a team as a code owner January 20, 2026 21:39
@khadni khadni merged commit dd3826f into main Jan 20, 2026
22 checks passed
@khadni khadni deleted the cre-ts-imports branch January 20, 2026 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants