diff --git a/docs/agents.md b/docs/agents.md index 68bf0ba94..819611e3c 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -13,7 +13,8 @@ description: Look up Base documentation with a compact directory-grouped index b - [Base Account](./base-account/llms.txt) - [Base Chain](./base-chain/llms.txt) — Bridge tokens and messages between Base and Solana Mainnet - [Get Started](./get-started/llms.txt) -- [Ledger](./ledger/llms.txt) — Base Ledgers let enterprises launch their own private payments products on Base. It allows you to build a private payments environment connected to Base. Balances, transactions, and transfers stay off public block explorers, while funds settle on Base. +- [Ledgers](./ledgers/llms.txt) — An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base. +- [Static](./static/llms.txt) ## Tools available for AI assistants @@ -101,5 +102,5 @@ npx skills add base/base-skills |base-chain/specs/upgrades/isthmus:derivation,exec-engine,l1-attributes,overview,predeploys,system-config |base-chain/specs/upgrades/jovian:derivation,exec-engine,l1-attributes,overview,system-config |get-started:base-mentorship-program,base-services-hub,base,block-explorers,concepts,country-leads-and-ambassadors,data-indexers,deploy-smart-contracts,docs-llms,docs-mcp,get-funded,launch-token,learning-resources,prompt-library,resources-for-ai-agents -|ledger:deposit-flow,how-it-works,overview,withdraw-flow +|ledgers:deposit-flow,how-it-works,overview,withdraw-flow |root:agents,changes,cookie-policy,privacy-policy,terms-of-service,tone_of_voice diff --git a/docs/docs.json b/docs/docs.json index f5d56f00d..bc19b3cf8 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -636,18 +636,18 @@ } }, { - "tab": "Ledger", + "tab": "Ledgers", "groups": [ { "group": "Overview", - "pages": ["ledger/overview"] + "pages": ["ledgers/overview"] }, { - "group": "Ledger", + "group": "Ledgers", "pages": [ - "ledger/how-it-works", - "ledger/deposit-flow", - "ledger/withdraw-flow" + "ledgers/how-it-works", + "ledgers/deposit-flow", + "ledgers/withdraw-flow" ] } ] @@ -789,6 +789,22 @@ ] }, "redirects": [ + { + "source": "/ledger/overview", + "destination": "/ledgers/overview" + }, + { + "source": "/ledger/how-it-works", + "destination": "/ledgers/how-it-works" + }, + { + "source": "/ledger/deposit-flow", + "destination": "/ledgers/deposit-flow" + }, + { + "source": "/ledger/withdraw-flow", + "destination": "/ledgers/withdraw-flow" + }, { "source": "/base-chain/node-operators/base-v1-upgrade", "destination": "/base-chain/specs/upgrades/azul/node-upgrade" diff --git a/docs/ledger/llms.txt b/docs/ledger/llms.txt deleted file mode 100644 index ab07ecd34..000000000 --- a/docs/ledger/llms.txt +++ /dev/null @@ -1,13 +0,0 @@ -# https://docs.base.org/ledger/llms.txt - -## Base Ledgers Documentation - -> Base Ledgers let enterprises launch private payments products connected to Base. Balances, transactions, and transfers stay off public block explorers while funds settle on Base. - -## Introduction -- [Ledger overview](https://docs.base.org/ledger/overview.md) - Learn what Base Ledgers are, when to use them, and how private payments settle on Base - -## Guides -- [How it works](https://docs.base.org/ledger/how-it-works.md) - Follow the payment lifecycle from deposit, to private ledger activity, to withdrawal -- [Deposit flow](https://docs.base.org/ledger/deposit-flow.md) - Understand how funds enter a ledger and which deposit details remain hidden onchain -- [Withdraw flow](https://docs.base.org/ledger/withdraw-flow.md) - Understand how funds exit a ledger and how withdrawal authorization works diff --git a/docs/ledger/deposit-flow.mdx b/docs/ledgers/deposit-flow.mdx similarity index 96% rename from docs/ledger/deposit-flow.mdx rename to docs/ledgers/deposit-flow.mdx index 1697bf0d1..448f67b7e 100644 --- a/docs/ledger/deposit-flow.mdx +++ b/docs/ledgers/deposit-flow.mdx @@ -1,6 +1,6 @@ --- title: "Deposit flow" -keywords: ["Base Ledger deposit", "encrypted recipient deposit", "Portal contract deposit", "private deposit Base", "confidential deposit onchain"] +keywords: ["Base ledger deposit", "encrypted recipient deposit", "Portal contract deposit", "private deposit Base", "confidential deposit onchain"] description: "What happens when funds enter a ledger, and which deposit details stay hidden onchain." --- diff --git a/docs/ledger/how-it-works.mdx b/docs/ledgers/how-it-works.mdx similarity index 75% rename from docs/ledger/how-it-works.mdx rename to docs/ledgers/how-it-works.mdx index 9dc0c0a3c..ab6b0c856 100644 --- a/docs/ledger/how-it-works.mdx +++ b/docs/ledgers/how-it-works.mdx @@ -1,10 +1,10 @@ --- title: "How it works" -keywords: ["Base Ledger lifecycle", "Portal contract Base", "private payment flow", "Base Ledger deposit withdraw", "onchain private transactions"] -description: "A walkthrough of the three stages every Base Ledger payment passes through." +keywords: ["Base ledger lifecycle", "Portal contract Base", "private payment flow", "Base ledger deposit withdraw", "onchain private transactions"] +description: "A walkthrough of the three stages every Base ledger payment passes through." --- -The lifecycle of a payment is the same on every Base Ledger: funds enter through the Portal contract, +The lifecycle of a payment is the same on every Base ledger: funds enter through the Portal contract, move privately within the ledger, and exit back to Base. The operator runs the services that process each step and decides how to authorize withdrawals. @@ -17,10 +17,10 @@ each step and decides how to authorize withdrawals. A payment moves through three stages: 1. **Deposit.** A user moves funds from Base into the ledger through the Portal contract. The recipient - remains encrypted, so deposits to one user remain unlinked. See [Deposit flow](/ledger/deposit-flow). + remains encrypted, so deposits to one user remain unlinked. See [Deposit flow](/ledgers/deposit-flow). 2. **Hold and transact in private.** Inside the ledger, users can transfer, swap, and earn yield while balances and activity remain private. 3. **Withdraw.** A user moves funds back to Base through the operator. Onchain, a withdrawal reveals the asset and amount but not the account behind it, so deposits and withdrawals stay unlinkable. - See [Withdraw flow](/ledger/withdraw-flow). + See [Withdraw flow](/ledgers/withdraw-flow). diff --git a/docs/ledgers/llms.txt b/docs/ledgers/llms.txt new file mode 100644 index 000000000..1d549f622 --- /dev/null +++ b/docs/ledgers/llms.txt @@ -0,0 +1,13 @@ +# https://docs.base.org/ledgers/llms.txt + +## Base Ledgers Documentation + +> Base Ledgers let enterprises launch private payments products connected to Base. Balances, transactions, and transfers stay off public block explorers while funds settle on Base. + +## Introduction +- [Ledgers overview](https://docs.base.org/ledgers/overview.md) - Learn what Base Ledgers are, when to use them, and how private payments settle on Base + +## Guides +- [How it works](https://docs.base.org/ledgers/how-it-works.md) - Follow the payment lifecycle from deposit, to private ledger activity, to withdrawal +- [Deposit flow](https://docs.base.org/ledgers/deposit-flow.md) - Understand how funds enter a ledger and which deposit details remain hidden onchain +- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow.md) - Understand how funds exit a ledger and how withdrawal authorization works diff --git a/docs/ledger/overview.mdx b/docs/ledgers/overview.mdx similarity index 87% rename from docs/ledger/overview.mdx rename to docs/ledgers/overview.mdx index 8cdd24f1a..ac3f5231d 100644 --- a/docs/ledger/overview.mdx +++ b/docs/ledgers/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Ledger overview" -keywords: ["Base Ledger", "private payments Base", "enterprise stablecoin payments", "private payment ledger", "confidential transactions Base", "onchain B2B payments"] +title: "Ledgers overview" +keywords: ["Base Ledgers", "private payments Base", "enterprise stablecoin payments", "private payment ledger", "confidential transactions Base", "onchain B2B payments"] description: "An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base." --- @@ -8,7 +8,7 @@ description: "An introduction to Base Ledgers, the enterprise way to run confide Base Ledgers is in early access. [Request a demo](https://www.coinbase.com/developer-platform/developer-interest) to learn more. -## What is a Base Ledger +## What are Base Ledgers Base Ledgers let enterprises launch their own private payments products on Base. It allows you to build a private payments environment connected to Base. Balances, transactions, and transfers stay off public @@ -45,7 +45,7 @@ Enterprises build a range of products on Base Ledgers: ## Capabilities ### Private by default -A Base Ledger keeps balances, transactions, and transfers off public block explorers. Deposits hide +A ledger keeps balances, transactions, and transfers off public block explorers. Deposits hide the recipient and withdrawals hide the sender, so the two stay unlinkable on the public chain. ### Compliant @@ -58,13 +58,13 @@ actions in one transaction, such as deposit-and-act or withdraw-and-swap. The ac together or not at all, so funds never sit in an intermediate state. ### Configurable -Operators run a Base Ledger on their own terms, with their own KYC and compliance controls and +Operators run a ledger on their own terms, with their own KYC and compliance controls and funds self-custodied in a dedicated contract. A ledger can also run custom logic for how it processes transactions. ## Who operates a ledger -An operator runs its own Base Ledger and is responsible for its custody and compliance. Teams that +An operator runs its own ledger and is responsible for its custody and compliance. Teams that prefer not to operate one can use [Coinbase Managed](https://docs.cdp.coinbase.com/payments/overview), a managed service built on Base Ledgers. ## Request a demo diff --git a/docs/ledger/withdraw-flow.mdx b/docs/ledgers/withdraw-flow.mdx similarity index 85% rename from docs/ledger/withdraw-flow.mdx rename to docs/ledgers/withdraw-flow.mdx index f25834ca7..2e891f5af 100644 --- a/docs/ledger/withdraw-flow.mdx +++ b/docs/ledgers/withdraw-flow.mdx @@ -1,13 +1,13 @@ --- title: "Withdraw flow" -keywords: ["Base Ledger withdrawal", "Portal contract withdraw", "private withdrawal Base", "withdrawal authorization onchain", "operator-signed withdrawal"] +keywords: ["Base ledger withdrawal", "Portal contract withdraw", "private withdrawal Base", "withdrawal authorization onchain", "operator-signed withdrawal"] description: "What happens when funds exit a ledger, and how you control withdrawal authorization." --- -Funds leave a Base Ledger through the Portal contract on Base. The ledger keeps recipients and balances private. +Funds leave a ledger through the Portal contract on Base. The ledger keeps recipients and balances private. -![Withdrawal flow: request an operator-signed withdrawal authorization from the Ledger API, submit the withdrawal to the Portal contract on Base, which releases funds and debits the ledger.](/images/ledger/withdraw-flow.png) +![Withdrawal flow: request an operator-signed withdrawal authorization from the ledger API, submit the withdrawal to the Portal contract on Base, which releases funds and debits the ledger.](/images/ledger/withdraw-flow.png) Withdrawals move funds from the ledger back to a recipient on Base. You choose how the Portal validates a withdrawal onchain, from a simple signature check to full state-transition proofs. The ledger debits the account when you commit the withdrawal; you then submit the authorization onchain and the Portal releases the funds. diff --git a/docs/llms-full.txt b/docs/llms-full.txt index c9098924c..7258a832b 100644 --- a/docs/llms-full.txt +++ b/docs/llms-full.txt @@ -407,11 +407,11 @@ const client = createPublicClient({ chain: base, transport: http() }) - [Build an app on Base](https://docs.base.org/apps/quickstart/build-app): A step-by-step guide to building a Next.js tally app on Base using wagmi and viem, with wallet connection, contract reads and writes, and batch transaction support. - [Add notifications](https://docs.base.org/apps/technical-guides/base-notifications): Send in-app notifications to your app's users through the Base Dashboard REST API. -## Ledger -- [Ledger overview](https://docs.base.org/ledger/overview): Base Ledgers let enterprises launch their own private payments products on Base. It allows you to build a private payments environment connected to Base. Balances, transactions, and transfers stay off public block explorers, while funds settle on Base. -- [Deposit flow](https://docs.base.org/ledger/deposit-flow): How deposits move funds from Base into a Base Ledger through the Portal contract, encrypting the recipient so deposits stay unlinkable while the asset, amount, and sender settle publicly onchain. -- [How it works](https://docs.base.org/ledger/how-it-works): The lifecycle of a payment on a Base Ledger: funds enter through the Portal contract, move privately within the ledger, and exit back to Base, with the operator authorizing each step. -- [Withdraw flow](https://docs.base.org/ledger/withdraw-flow): How withdrawals move funds from a Base Ledger back to Base through the Portal contract, with operator-signed authorization and validation you choose, while keeping the sender account private. +## Ledgers +- [Ledgers overview](https://docs.base.org/ledgers/overview): An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base. +- [Deposit flow](https://docs.base.org/ledgers/deposit-flow): What happens when funds enter a ledger, and which deposit details stay hidden onchain. +- [How it works](https://docs.base.org/ledgers/how-it-works): A walkthrough of the three stages every Base ledger payment passes through. +- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow): What happens when funds exit a ledger, and how you control withdrawal authorization. ## Optional - [Base MCP server](https://docs.base.org/mcp): Direct AI access to Base documentation diff --git a/docs/llms.txt b/docs/llms.txt index 855ad1f59..175ca7613 100644 --- a/docs/llms.txt +++ b/docs/llms.txt @@ -319,11 +319,11 @@ - [Build an app on Base](https://docs.base.org/apps/quickstart/build-app): A step-by-step guide to building a Next.js tally app on Base using wagmi and viem, with wallet connection, contract reads and writes, and batch transaction support. - [Add notifications](https://docs.base.org/apps/technical-guides/base-notifications): Send in-app notifications to your app's users through the Base Dashboard REST API. -## Ledger -- [Ledger overview](https://docs.base.org/ledger/overview): Base Ledgers let enterprises launch their own private payments products on Base. It allows you to build a private payments environment connected to Base. Balances, transactions, and transfers stay off public block explorers, while funds settle on Base. -- [Deposit flow](https://docs.base.org/ledger/deposit-flow): How deposits move funds from Base into a Base Ledger through the Portal contract, encrypting the recipient so deposits stay unlinkable while the asset, amount, and sender settle publicly onchain. -- [How it works](https://docs.base.org/ledger/how-it-works): The lifecycle of a payment on a Base Ledger: funds enter through the Portal contract, move privately within the ledger, and exit back to Base, with the operator authorizing each step. -- [Withdraw flow](https://docs.base.org/ledger/withdraw-flow): How withdrawals move funds from a Base Ledger back to Base through the Portal contract, with operator-signed authorization and validation you choose, while keeping the sender account private. +## Ledgers +- [Ledgers overview](https://docs.base.org/ledgers/overview): An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base. +- [Deposit flow](https://docs.base.org/ledgers/deposit-flow): What happens when funds enter a ledger, and which deposit details stay hidden onchain. +- [How it works](https://docs.base.org/ledgers/how-it-works): A walkthrough of the three stages every Base ledger payment passes through. +- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow): What happens when funds exit a ledger, and how you control withdrawal authorization. ## Optional - [Base MCP server](https://docs.base.org/mcp): Direct AI access to Base documentation