diff --git a/packages/cre-sdk/README.md b/packages/cre-sdk/README.md index f14c7a6b..6db9c868 100644 --- a/packages/cre-sdk/README.md +++ b/packages/cre-sdk/README.md @@ -123,6 +123,12 @@ Use `runtime.runInNodeMode()` to execute functions that require individual node The SDK wires runtime safety internally; you can call `main()` directly as shown in the examples. +### Confidential Workflows + +A Confidential Workflow is a CRE workflow that designates part of its logic to run inside a secure [enclave](https://docs.chain.link/cre/key-terms#enclave)—a running instance of a [Trusted Execution Environment (TEE)](https://docs.chain.link/cre/key-terms#tee-trusted-execution-environment), a hardware-isolated environment designed to keep the indicated data it processes confidential from the machine's own operator during execution and node operators. + +Secrets fetched inside the enclave such as Vault DON secrets, HTTP response payloads, and intermediate computation data remain confidential throughout workflow execution. They also provide DON consensus-based verification of enclave attestations, helping ensure the integrity of confidential workflow execution. You decide what stays inside the enclave and what crosses back out to the Workflow DON for consensus-verified execution, such as generating a report to submit onchain. + ## Available Capabilities ### Scheduling @@ -470,6 +476,7 @@ See the [star-wars example](https://github.com/smartcontractkit/cre-sdk-typescri - `Runner.newRunner(options?)`: Create a new workflow runner - `cre.handler(trigger, handler)`: Create a trigger-handler pair +- `cre.handlerInTee(trigger, handler, tees)`: Registers a handler whose callback runs inside a TEE. - `runtime.runInNodeMode(fn, aggregator)`: Execute function in node mode with consensus ### Capabilities