docs/trustless-agent: Add ROFL TS client #1543
Conversation
✅ Deploy Preview for oasisprotocol-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
matevz
left a comment
matevz
left a comment
There was a problem hiding this comment.
Can you please add the new chapter to the sidebar too and the Build landing page https://github.com/oasisprotocol/docs/blob/main/docs/build/README.mdx
| ## Update on-chain app config | ||
|
|
There was a problem hiding this comment.
| ## Update on-chain app config | |
| Then publish the enclave identities and config: |
| oasis rofl update | ||
| ``` | ||
|
|
||
| ## Deploy to a ROFL provider |
There was a problem hiding this comment.
| ## Deploy to a ROFL provider | |
| ## Deploy |
| Your agent can call Sapphire contracts to log decisions or perform actions. | ||
| Gate privileged paths in your contracts by verifying ROFL origin. | ||
|
|
||
| ## Build the ROFL bundle |
There was a problem hiding this comment.
| ## Build the ROFL bundle | |
| ## Build ROFL bundle |
| ## Troubleshooting | ||
|
|
||
| - Ensure the ROFL machine can resolve your model endpoint (OpenAI/Ollama) | ||
| - Check `oasis rofl machine logs` for enclave startup issues |
There was a problem hiding this comment.
| - Check `oasis rofl machine logs` for enclave startup issues | |
| - Check `oasis rofl machine logs` for enclave startup issues |
I would combine the Troubleshooting, Resources and Conclusion in something like "Testing it out" section where you'd show how to use oasis rofl machine logs and what to expect in the output.
|
|
||
|
|
||
| ```shell | ||
| # 1) Install bun and ElizaOS CLI |
| bun --version || curl -fsSL https://bun.sh/install | bash | ||
| bun install -g @elizaos/cli | ||
|
|
||
| # 3) Configure model credentials locally |
There was a problem hiding this comment.
| # 3) Configure model credentials locally | |
| # Configure model credentials locally |
| # or for local models: | ||
| # OLLAMA_HOST=http://host.docker.internal:11434 | ||
|
|
||
| # 4) Start the agent locally |
There was a problem hiding this comment.
| # 4) Start the agent locally | |
| # Start the agent locally |
| ## ROFL overview | ||
|
|
There was a problem hiding this comment.
Leftover?
| ## ROFL overview |
| # 4) Start the agent locally | ||
| elizaos start | ||
| ``` | ||
| </details> |
There was a problem hiding this comment.
Leftover.
| </details> |
| # or for local models: | ||
| # OLLAMA_HOST=http://host.docker.internal:11434 |
There was a problem hiding this comment.
Let's ditch ollama for now and rely on OpenAI only.
| # or for local models: | |
| # OLLAMA_HOST=http://host.docker.internal:11434 |
| set -e | ||
|
|
||
| # Expected env in ROFL: | ||
| # OPENAI_API_KEY (or OLLAMA_HOST) for the model provider |
There was a problem hiding this comment.
| # OPENAI_API_KEY (or OLLAMA_HOST) for the model provider | |
| # OPENAI_API_KEY for the model provider |
| <summary>docker/Dockerfile</summary> | ||
|
|
||
| ```dockerfile | ||
| FROM oven/bun:1.1-alpine |
There was a problem hiding this comment.
| FROM oven/bun:1.1-alpine | |
| FROM node:24-alpine |
| ADD . /app | ||
|
|
||
| # Install ElizaOS CLI and project dependencies. | ||
| RUN bun install -g @elizaos/cli && bun install |
There was a problem hiding this comment.
| RUN bun install -g @elizaos/cli && bun install | |
| RUN npm install -g @elizaos/cli && npm install |
There was a problem hiding this comment.
npm install doesn't recognize the elizaos/cli package. The official docs list bun as package manager, I think we have to keep it.
| - OPENAI_API_KEY=${OPENAI_API_KEY} | ||
| volumes: | ||
| # Mount only if your agent needs to interact with Sapphire via appd. | ||
| # - /run/rofl-appd.sock:/run/rofl-appd.sock |
There was a problem hiding this comment.
How do you communicate with appd? Does ElizaOS now support it out of the box? If not, then just ditch the volumes section.
| bun install -g @elizaos/cli | ||
|
|
||
| # 3) Configure model credentials locally | ||
| elizaos env edit-local |
There was a problem hiding this comment.
This doesn't work out of the box. Did you forget to run elizaos create? In this case the eliza-app folder is created there and the secrets configured.
| </details> | ||
|
|
||
| <details> | ||
| <summary>docker/Dockerfile</summary> |
There was a problem hiding this comment.
The Dockerfile and docker/entry.sh are already generated, if using elizaos create wizzard. I would remove this.
| ## Contract interaction (high level) | ||
|
|
||
| Your agent can call Sapphire contracts to log decisions or perform actions. | ||
| Gate privileged paths in your contracts by verifying ROFL origin. | ||
|
|
There was a problem hiding this comment.
Leftover?
| ## Contract interaction (high level) | |
| Your agent can call Sapphire contracts to log decisions or perform actions. | |
| Gate privileged paths in your contracts by verifying ROFL origin. |
|
|
||
| ## How the agent interacts on Sapphire | ||
|
|
||
| - Encode calldata for your contract method and call `submitEthTx(...)` via |
There was a problem hiding this comment.
| - Encode calldata for your contract method and call `submitEthTx(...)` via | |
| - Encode calldata for your contract method and call [`signSubmit()`] via |
[`signSubmit()`]: https://github.com/oasisprotocol/oasis-sdk/blob/main/docs/rofl/features/appd.md
matevz
force-pushed
the
ZigaMr/feat/trustless-agent-doc
branch
from
b62b78a to
f7b85ca
Compare
matevz
force-pushed
the
ZigaMr/feat/trustless-agent-doc
branch
from
f7b85ca to
a00ef8a
Compare
|
Most of the proposed changes were merged in #1560 (without ROFL TS client). I renamed this PR to add ROFL TS client. |
matevz
changed the title
This PR adds docs/build/use-cases/trustless-agent.mdx, a practical guide for launching a trustless Eliza AI agent with ROFL
Issue: #1527