Skip to content

Commit d28a076

Browse files
fix(d0cs): apply suggestions from code review
1 parent 4f1649d commit d28a076

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

docs/fcc/guides/01-sign.mdx

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ The TEE framework handles attestation, key management, and message routing — y
2323

2424
The Private Key Manager extension demonstrates the core TEE workflow:
2525

26-
1. A user sends an Elliptic Curve Integrated Encryption Scheme (ECIES) encrypted private key on-chain via the `InstructionSender` contract
27-
2. The TEE extension decrypts and stores the key inside the secure enclave
28-
3. A user sends a `sign` instruction with an arbitrary message
29-
4. The TEE extension signs the message with the stored key and returns the signature on-chain
26+
1. A user sends an Elliptic Curve Integrated Encryption Scheme (ECIES) encrypted private key on-chain via the `InstructionSender` contract.
27+
2. The TEE extension decrypts and stores the key inside the secure enclave.
28+
3. A user sends a `sign` instruction with an arbitrary message.
29+
4. The TEE extension signs the message with the stored key and returns the signature on-chain.
3030

3131
We will build this in three parts: the **on-chain contract** that sends instructions, the **off-chain handler** that processes them, and the **deployment tooling** that ties everything together.
3232

@@ -35,11 +35,10 @@ We will build this in three parts: the **on-chain contract** that sends instruct
3535
The extension stack consists of three components running as Docker services:
3636

3737
- **`extension-tee`:** Your extension code (Go, Python, or TypeScript).
38-
Receives decoded instructions from the proxy and returns results
38+
Receives decoded instructions from the proxy and returns results.
3939
- **`ext-proxy`:** The TEE extension proxy.
40-
Watches the chain for new instructions targeting your extension, forwards them to your handler, and submits results back on-chain
41-
- **`redis`:** In-memory store used by the proxy for internal state
42-
40+
Watches the chain for new instructions targeting your extension, forwards them to your handler, and submits results back on-chain.
41+
- **`redis`:** In-memory store used by the proxy for internal state.
4342

4443
The tunnel ([Cloudflared](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/) or [ngrok](https://ngrok.com/)) exposes the proxy's external port so that other TEE nodes on the network can reach your extension for attestation and availability checks.
4544

@@ -89,7 +88,7 @@ contract InstructionSender {
8988
9089
...
9190
}
92-
````
91+
```
9392

9493
:::note
9594
The constructor takes the addresses of the two Flare system contracts.
@@ -548,7 +547,7 @@ cd typescript/tools
548547
npm run register-tee -- -p http://localhost:6676 -l
549548
```
550549

551-
The `-l` flag enables **local/test mode**, which uses a test attestation token instead of a real GCP JWT.
550+
The `-l` flag enables **local/test mode**, which uses a test attestation token instead of a real [Google Cloud Platform JSON Web Token (JWT)](https://docs.cloud.google.com/api-gateway/docs/authenticating-users-jwt).
552551
This is required when running outside of an actual TEE enclave.
553552

554553
The `-p` flag specifies the proxy URL used for the FDC availability check.
@@ -615,7 +614,7 @@ To create your own TEE extension using this template:
615614
5. **Register handlers** - Wire up your handlers with the framework using `f.Handle(opType, opCommand, myHandler)`.
616615
6. **Deploy and test** - Follow the steps in this guide to deploy your contract, register the extension, and verify it works.
617616

618-
:::tip[What to change vs. what to keep]
617+
:::tip[What to change, what to keep]
619618
Only modify files in `app/` (your business logic) and `contract/InstructionSender.sol` (your on-chain interface).
620619
The files in `base/` are framework infrastructure and should not need changes.
621620
:::
@@ -662,7 +661,7 @@ If your tunnel restarts and the URL changes:
662661

663662
## Cleanup
664663

665-
**1. Stop the Docker stack**
664+
**Stop the Docker stack**
666665

667666
```bash
668667
docker compose down

0 commit comments

Comments
 (0)