@chainlink/cre-sdk 0.0.0 → 0.0.2-alpha

package/LICENSE.md

@@ -0,0 +1,54 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor: SmartContract Chainlink Limited SEZC
+
+Licensed Work: CRE SDK (Typescript) The Licensed Work is (c) 2024 SmartContract Chainlink Limited SEZC
+
+Additional Use Grant: Any uses listed and defined in this repository
+
+Change Date: May 20, 2029
+
+Change License: MIT
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license your works, and to refer to it using the trademark "Business Source License", as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/README.md

@@ -0,0 +1,493 @@
+# @chainlink/cre-sdk
+
+The Chainlink Runtime Environment (CRE) SDK for TypeScript enables developers to build decentralized workflows that combine off-chain computation with on-chain execution. Create workflows that fetch data from APIs, interact with smart contracts, and coordinate complex multi-step operations across blockchain networks.
+
+## Examples
+
+Ready to clone repo with example workflows and cre-sdk set up: [cre-sdk-examples](https://github.com/smartcontractkit/cre-sdk-typescript/tree/main/packages/cre-sdk-examples).
+
+## Installation
+
+```bash
+bun add @chainlink/cre-sdk
+```
+
+## Quick Start
+
+```typescript
+import { cre, Value, withErrorBoundary } from "@chainlink/cre-sdk";
+
+const onCronTrigger = async (config: { schedule: string }) => {
+  // Your workflow logic here
+  cre.sendResponseValue(Value.from("Hello, CRE!"));
+};
+
+const initWorkflow = (config: { schedule: string }) => {
+  const cron = new cre.capabilities.CronCapability();
+  return [
+    cre.handler(cron.trigger({ schedule: config.schedule }), onCronTrigger),
+  ];
+};
+
+export async function main() {
+  const runner = await cre.newRunner<{ schedule: string }>();
+  await runner.run(initWorkflow);
+}
+
+withErrorBoundary(main);
+```
+
+## Core Concepts
+
+### Workflows
+
+Workflows are the fundamental building blocks of CRE applications. They define how your application responds to triggers and what actions to take. Each workflow consists of:
+
+- **Triggers**: Events that initiate workflow execution (cron schedules, HTTP requests, etc.)
+- **Handlers**: Functions that process trigger events and execute your business logic
+- **Capabilities**: Built-in services for interacting with external systems
+
+### Runtime Modes
+
+CRE supports two execution modes:
+
+- **DON Mode**: Distributed execution across multiple nodes for consensus and reliability
+- **Node Mode**: Individual node execution for specific tasks requiring node-level operations
+
+Use `cre.runInNodeMode()` to execute functions that require individual node processing, such as fetching data from different sources for consensus aggregation.
+
+### Error Handling
+
+Always wrap your main function with `withErrorBoundary()` to ensure proper error handling and workflow termination:
+
+```typescript
+withErrorBoundary(main);
+```
+
+## Available Capabilities
+
+### Scheduling
+
+Execute workflows on a schedule using cron expressions:
+
+```typescript
+import { cre } from "@chainlink/cre-sdk";
+
+const cron = new cre.capabilities.CronCapability();
+const trigger = cron.trigger({ schedule: "0 */5 * * * *" }); // Every 5 minutes
+```
+
+### HTTP Operations
+
+Fetch data from external APIs with built-in consensus mechanisms:
+
+```typescript
+import { cre, consensusMedianAggregation } from "@chainlink/cre-sdk";
+
+const fetchData = async (config: { apiUrl: string }) => {
+  const response = await cre.utils.fetch({ url: config.apiUrl });
+  return Number.parseFloat(response.body.trim());
+};
+
+// Execute with consensus across multiple nodes
+const result = await cre.runInNodeMode(
+  fetchData,
+  consensusMedianAggregation()
+)(config);
+```
+
+### Blockchain Interactions
+
+Read from and write to EVM-compatible blockchains:
+
+```typescript
+import { cre, hexToBase64 } from "@chainlink/cre-sdk";
+import { encodeFunctionData, decodeFunctionResult } from "viem";
+
+// Initialize EVM client with chain selector
+const evmClient = new cre.capabilities.EVMClient(
+  undefined, // default mode
+  BigInt("5009297550715157269") // Ethereum Sepolia
+);
+
+// Read from contract
+const callData = encodeFunctionData({
+  abi: CONTRACT_ABI,
+  functionName: "getValue",
+});
+
+const result = await evmClient.callContract({
+  call: {
+    from: hexToBase64("0x0000000000000000000000000000000000000000"),
+    to: hexToBase64(contractAddress),
+    data: hexToBase64(callData),
+  },
+  blockNumber: {
+    absVal: Buffer.from([3]).toString("base64"), // finalized block
+    sign: "-1",
+  },
+});
+
+// Write to contract
+await evmClient.writeReport({
+  receiver: contractAddress,
+  report: {
+    rawReport: callData,
+  },
+});
+```
+
+## Configuration & Type Safety
+
+Use Zod schemas for type-safe configuration:
+
+```typescript
+import { z } from "zod";
+
+const configSchema = z.object({
+  schedule: z.string(),
+  apiUrl: z.string(),
+  evms: z.array(
+    z.object({
+      chainSelector: z.string(),
+      contractAddress: z.string(),
+    })
+  ),
+});
+
+type Config = z.infer<typeof configSchema>;
+
+export async function main() {
+  const runner = await cre.newRunner<Config>({ configSchema });
+  await runner.run(initWorkflow);
+}
+```
+
+## Consensus & Aggregation
+
+CRE provides built-in consensus mechanisms for aggregating data from multiple nodes:
+
+```typescript
+import { consensusMedianAggregation } from "@chainlink/cre-sdk";
+
+// Execute function across multiple nodes and aggregate results
+const aggregatedValue = await cre.runInNodeMode(
+  fetchDataFunction,
+  consensusMedianAggregation()
+)(config);
+```
+
+## Utility Functions
+
+### Value Serialization
+
+```typescript
+import { Value } from "@chainlink/cre-sdk";
+
+// Send structured response data
+cre.sendResponseValue(
+  Value.from({
+    price: 1234.56,
+    timestamp: Date.now(),
+    source: "api.example.com",
+  })
+);
+```
+
+### Hex Utilities
+
+```typescript
+import { hexToBase64, bytesToHex } from "@chainlink/cre-sdk";
+
+const base64Data = hexToBase64("0x1234567890abcdef");
+const hexData = bytesToHex(buffer);
+```
+
+### Chain Selectors
+
+```typescript
+import { getAllNetworks, getNetwork } from "@chainlink/cre-sdk";
+
+const networks = getAllNetworks();
+const ethereum = getNetwork("ethereum-mainnet");
+```
+
+## Example Workflows
+
+### 1. Simple Scheduled Task
+
+```typescript
+import { cre, Value, withErrorBoundary } from "@chainlink/cre-sdk";
+
+const onCronTrigger = () => {
+  console.log("Workflow executed!");
+  cre.sendResponseValue(Value.from("Task completed"));
+};
+
+const initWorkflow = (config: { schedule: string }) => {
+  const cron = new cre.capabilities.CronCapability();
+  return [
+    cre.handler(cron.trigger({ schedule: config.schedule }), onCronTrigger),
+  ];
+};
+
+export async function main() {
+  const runner = await cre.newRunner<{ schedule: string }>();
+  await runner.run(initWorkflow);
+}
+
+withErrorBoundary(main);
+```
+
+### 2. API Data Aggregation
+
+```typescript
+import {
+  cre,
+  consensusMedianAggregation,
+  Value,
+  withErrorBoundary,
+} from "@chainlink/cre-sdk";
+import { z } from "zod";
+
+const configSchema = z.object({
+  schedule: z.string(),
+  apiUrl: z.string(),
+});
+
+type Config = z.infer<typeof configSchema>;
+
+const fetchPrice = async (config: Config) => {
+  const response = await cre.utils.fetch({ url: config.apiUrl });
+  return Number.parseFloat(response.body.trim());
+};
+
+const onCronTrigger = async (config: Config) => {
+  const price = await cre.runInNodeMode(
+    fetchPrice,
+    consensusMedianAggregation()
+  )(config);
+
+  cre.sendResponseValue(Value.from({ price }));
+};
+
+const initWorkflow = (config: Config) => {
+  const cron = new cre.capabilities.CronCapability();
+  return [
+    cre.handler(cron.trigger({ schedule: config.schedule }), onCronTrigger),
+  ];
+};
+
+export async function main() {
+  const runner = await cre.newRunner<Config>({ configSchema });
+  await runner.run(initWorkflow);
+}
+
+withErrorBoundary(main);
+```
+
+### 3. On-Chain Data Integration
+
+```typescript
+import {
+  cre,
+  consensusMedianAggregation,
+  Value,
+  withErrorBoundary,
+  hexToBase64,
+  bytesToHex,
+} from "@chainlink/cre-sdk";
+import { encodeFunctionData, decodeFunctionResult, zeroAddress } from "viem";
+import { z } from "zod";
+
+const configSchema = z.object({
+  schedule: z.string(),
+  apiUrl: z.string(),
+  evms: z.array(
+    z.object({
+      chainSelector: z.string(),
+      contractAddress: z.string(),
+    })
+  ),
+});
+
+type Config = z.infer<typeof configSchema>;
+
+const fetchOffchainData = async (config: Config) => {
+  const response = await cre.utils.fetch({ url: config.apiUrl });
+  return Number.parseFloat(response.body.trim());
+};
+
+const onCronTrigger = async (config: Config) => {
+  // Get off-chain data with consensus
+  const offchainValue = await cre.runInNodeMode(
+    fetchOffchainData,
+    consensusMedianAggregation()
+  )(config);
+
+  // Read on-chain data
+  const evmConfig = config.evms[0];
+  const evmClient = new cre.capabilities.EVMClient(
+    undefined,
+    BigInt(evmConfig.chainSelector)
+  );
+
+  const callData = encodeFunctionData({
+    abi: [
+      {
+        name: "getValue",
+        type: "function",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+      },
+    ],
+    functionName: "getValue",
+  });
+
+  const contractCall = await evmClient.callContract({
+    call: {
+      from: hexToBase64(zeroAddress),
+      to: hexToBase64(evmConfig.contractAddress),
+      data: hexToBase64(callData),
+    },
+    blockNumber: {
+      absVal: Buffer.from([3]).toString("base64"),
+      sign: "-1",
+    },
+  });
+
+  const onchainValue = decodeFunctionResult({
+    abi: [
+      {
+        name: "getValue",
+        type: "function",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+      },
+    ],
+    functionName: "getValue",
+    data: bytesToHex(contractCall.data),
+  });
+
+  // Combine and return results
+  const finalResult = Number(onchainValue) + offchainValue;
+
+  cre.sendResponseValue(
+    Value.from({
+      offchainValue,
+      onchainValue: Number(onchainValue),
+      finalResult,
+    })
+  );
+};
+
+const initWorkflow = (config: Config) => {
+  const cron = new cre.capabilities.CronCapability();
+  return [
+    cre.handler(cron.trigger({ schedule: config.schedule }), onCronTrigger),
+  ];
+};
+
+export async function main() {
+  const runner = await cre.newRunner<Config>({ configSchema });
+  await runner.run(initWorkflow);
+}
+
+withErrorBoundary(main);
+```
+
+## API Reference
+
+### Core Functions
+
+- `cre.newRunner<T>(options?)`: Create a new workflow runner
+- `cre.handler(trigger, handler)`: Create a trigger-handler pair
+- `cre.sendResponseValue(value)`: Send workflow response
+- `cre.runInNodeMode(fn, aggregator)`: Execute function in node mode with consensus
+- `withErrorBoundary(fn)`: Wrap function with error handling
+
+### Capabilities
+
+- `cre.capabilities.CronCapability`: Schedule-based triggers
+- `cre.capabilities.HTTPCapability`: HTTP request handling
+- `cre.capabilities.HTTPClient`: HTTP client for requests
+- `cre.capabilities.EVMClient`: EVM blockchain interactions
+
+### Utilities
+
+- `cre.utils.fetch()`: HTTP requests with consensus support
+- `Value.from()`: Serialize response values
+- `consensusMedianAggregation()`: Median consensus aggregator
+- `hexToBase64()`, `bytesToHex()`: Data format conversions
+
+## Building from Source
+
+To build the SDK locally:
+
+```bash
+# Install dependencies (from monorepo root)
+bun install
+
+# Generate protocol buffers and SDK types
+bun generate:sdk
+
+# Build the package
+bun run build
+
+# Run tests
+bun test
+
+# Run set of standard tests
+bun test:standard
+```
+
+### Protobuf Generation
+
+This SDK uses [ts-proto](https://github.com/stephenh/ts-proto) for generating TypeScript types from Protocol Buffers.
+
+**Available Commands:**
+
+- `bun generate:proto` - Generate TypeScript types from .proto files
+- `bun proto:lint` - Lint .proto files
+- `bun proto:format` - Format .proto files
+
+**Configuration:**
+
+- `buf.yaml` - Main buf configuration
+- `buf.gen.yaml` - Code generation configuration using ts-proto
+- Generated files are placed in `src/generated/`
+
+### Chain Selectors Generation
+
+Auto-generated TypeScript files for 200+ blockchain networks from the official [Chainlink chain-selectors repository](https://github.com/smartcontractkit/chain-selectors).
+
+**Regenerate chain selectors:**
+
+```bash
+bun generate:chain-selectors
+```
+
+**Usage:**
+
+```typescript
+import { getAllNetworks, getNetwork } from "@chainlink/cre-sdk";
+
+const ethereum = getNetwork("ethereum-mainnet");
+const allNetworks = getAllNetworks();
+```
+
+**Supported Networks:**
+
+- **EVM**: 231 networks (Ethereum, Polygon, Arbitrum, etc.)
+- **Solana**: 3 networks (Mainnet, Testnet, Devnet)
+- **Aptos, Sui, TON, Tron**: 3-4 networks each
+
+## Requirements
+
+- **Runtime**: Bun >= 1.2.21
+- **Dependencies**: Viem, Zod, Protocol Buffers
+- **TypeScript**: 5.9+
+
+## License
+
+See LICENSE in LICENSE.md

package/bin/cre-compile.ts

@@ -0,0 +1,31 @@
+#!/usr/bin/env bun
+
+import { main as compileWorkflow } from "../scripts/src/compile-workflow";
+
+const main = async () => {
+  const cliArgs = process.argv.slice(2);
+
+  const inputPath = cliArgs[0];
+  const outputPathArg = cliArgs[1];
+
+  if (!inputPath) {
+    console.error(
+      "Usage: cre-compile <path/to/workflow.ts> [path/to/output.wasm]"
+    );
+    console.error("Examples:");
+    console.error("  cre-compile src/standard_tests/secrets/test.ts");
+    console.error(
+      "  cre-compile src/standard_tests/secrets/test.ts .temp/standard_tests/secrets/test.wasm"
+    );
+    process.exit(1);
+  }
+
+  // Delegate to the compile-workflow script
+  await compileWorkflow(inputPath, outputPathArg);
+};
+
+// CLI entry point
+main().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});