Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions docs/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
28 changes: 22 additions & 6 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
]
Expand Down Expand Up @@ -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"
Expand Down
13 changes: 0 additions & 13 deletions docs/ledger/llms.txt

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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."
---

Expand Down
10 changes: 5 additions & 5 deletions docs/ledger/how-it-works.mdx → docs/ledgers/how-it-works.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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).


13 changes: 13 additions & 0 deletions docs/ledgers/llms.txt
Original file line number Diff line number Diff line change
@@ -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
12 changes: 6 additions & 6 deletions docs/ledger/overview.mdx → docs/ledgers/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
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."
---

<Warning>
Base Ledgers is in early access. [Request a demo](https://www.coinbase.com/developer-platform/developer-interest) to learn more.
</Warning>

## 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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

<Frame>
![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)
</Frame>

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.
Expand Down
10 changes: 5 additions & 5 deletions docs/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading