From aea3805e0de0dd15f478e71702e3153e9d2741a4 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 22 Jan 2025 18:19:09 +0200 Subject: [PATCH 1/4] Update DatabaseAdapter.md --- docs/api/classes/DatabaseAdapter.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md index 46cf221d279..4e8a988ad6c 100644 --- a/docs/api/classes/DatabaseAdapter.md +++ b/docs/api/classes/DatabaseAdapter.md @@ -19,7 +19,7 @@ like accounts, memories, actors, goals, and rooms. > **new DatabaseAdapter**\<`DB`\>(`circuitBreakerConfig`?): [`DatabaseAdapter`](DatabaseAdapter.md)\<`DB`\> -Creates a new DatabaseAdapter instance with optional circuit breaker configuration. +Creates a new DatabaseAdapter instance with an optional circuit breaker configuration. #### Parameters @@ -69,7 +69,7 @@ The database instance. > `protected` **circuitBreaker**: `CircuitBreaker` -Circuit breaker instance used to handle fault tolerance and prevent cascading failures. +Circuit breaker instance are used to handle fault tolerance and prevent cascading failures. Implements the Circuit Breaker pattern to temporarily disable operations when a failure threshold is reached. The circuit breaker has three states: From 833ea710cb815f27405105edbbf0b06e442a9c8a Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 22 Jan 2025 18:20:25 +0200 Subject: [PATCH 2/4] Update composeContext.md --- docs/api/functions/composeContext.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/functions/composeContext.md b/docs/api/functions/composeContext.md index 055bdb28c07..ce5064aa794 100644 --- a/docs/api/functions/composeContext.md +++ b/docs/api/functions/composeContext.md @@ -24,7 +24,7 @@ The state object contains values to replace the placeholders in the template. • **params.template**: `string` | `Function` -The template string or function returning a string containing placeholders to be replaced with state values. +The template string or function returns a string containing placeholders to be replaced with state values. • **params.templatingEngine?**: `"handlebars"` @@ -34,7 +34,7 @@ The templating engine to use for compiling and evaluating the template (optional `string` -The composed context string with placeholders replaced by corresponding state values. +The composed context string with placeholders is replaced by corresponding state values. ## Example From 8c29f72e02cd0f59b9461cda9f89da4b590913f2 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 22 Jan 2025 18:23:31 +0200 Subject: [PATCH 3/4] Update verified-inference.md --- docs/docs/advanced/verified-inference.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/advanced/verified-inference.md b/docs/docs/advanced/verified-inference.md index 2b8692bebbc..6d004f5b763 100644 --- a/docs/docs/advanced/verified-inference.md +++ b/docs/docs/advanced/verified-inference.md @@ -6,7 +6,7 @@ sidebar_position: 18 ## Overview -With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent. +With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI-compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent. Compared to [fully deploying the agent in a TEE](https://elizaos.github.io/eliza/docs/advanced/eliza-in-tee/), this is a more light-weight solution which only verifies the inference calls and only needs a single line of code change. @@ -14,7 +14,7 @@ The API supports all OpenAI models out of the box, including your fine-tuned mod ## Background -The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users. +The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies the agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users. Here’s how it works: ![](https://i.imgur.com/SNwSHam.png) @@ -23,7 +23,7 @@ Here’s how it works: 2. The TEE securely processes the request by calling the LLM API. 3. The TEE sends back the `{Message, Proof}` to the agent. 4. The TEE submits the attestation with `{Message, Proof}` to Solana. -5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent website/app. +5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent's website/app. To verify the code running inside the TEE, use instructions [from here](https://github.com/galadriel-ai/sentience/tree/main/verified-inference/verify). @@ -48,7 +48,7 @@ To verify the code running inside the TEE, use instructions [from here](https:// ``` 4. **Run your agent.** - Reminder how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent). + Reminder of how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent). ```bash pnpm start --character="characters/.json" pnpm start:client From 8937dc3fd782c5e642c748e5fc038ecc2efe7b09 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 22 Jan 2025 18:24:16 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6553de7d452..819ce359478 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ pnpm clean Once the agent is running, you should see the message to run "pnpm start:client" at the end. -Open another terminal, move to same directory, run the command below, then follow the URL to chat with your agent. +Open another terminal, move to the same directory, run the command below, then follow the URL to chat with your agent. ```bash pnpm start:client