Skip to content

docs(tangle): supply explicit sandbox URLs in examples #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drewstone merged 1 commit into from
Sep 10, 2026
Merged

docs(tangle): supply explicit sandbox URLs in examples #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions packages/agent-provider-tangle/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@ import { Sandbox } from "@tangle-network/sandbox";
import { createTangleProvider } from "@tangle-network/agent-provider-tangle";

const provider = createTangleProvider({
client: new Sandbox({ apiKey: process.env.TANGLE_API_KEY }),
client: new Sandbox({
apiKey: process.env.TANGLE_API_KEY,
baseUrl: process.env.TANGLE_SANDBOX_URL || "https://sandbox.tangle.tools",
}),
});
```

`Sandbox` requires an explicit `baseUrl`.
Set `TANGLE_SANDBOX_URL` to use another deployment.

## `create()` returns a ready environment

`provider.create()` does not return until the sandbox reports `running`.
Expand All @@ -32,7 +38,10 @@ Composing an environment also reads the sandbox's deployment capability document

```ts
const provider = createTangleProvider({
client: new Sandbox({ apiKey: process.env.TANGLE_API_KEY }),
client: new Sandbox({
apiKey: process.env.TANGLE_API_KEY,
baseUrl: process.env.TANGLE_SANDBOX_URL || "https://sandbox.tangle.tools",
}),
readyTimeoutMs: 180_000,
});

Expand Down Expand Up @@ -280,7 +289,10 @@ The adapter does not trust the requested nonce, child metadata, or any legacy

```ts
const provider = createTangleProvider({
client: new Sandbox({ apiKey: process.env.TANGLE_API_KEY }),
client: new Sandbox({
apiKey: process.env.TANGLE_API_KEY,
baseUrl: process.env.TANGLE_SANDBOX_URL || "https://sandbox.tangle.tools",
}),
confidentialAttestationVerifier: async ({ report, attestation }) =>
(await verifyTangleQuote({ report, attestation })) ?? null,
});
Expand Down Expand Up @@ -360,7 +372,10 @@ Set `teamId` inside `exactProcess` to scope create, lookup, and recovery to one

```ts
const provider = createTangleProvider({
client: new Sandbox({ apiKey: process.env.TANGLE_API_KEY }),
client: new Sandbox({
apiKey: process.env.TANGLE_API_KEY,
baseUrl: process.env.TANGLE_SANDBOX_URL || "https://sandbox.tangle.tools",
}),
exactProcess: {},
});

Expand Down