Skip to content

Commit b992d83

Browse files
authored
Feat/update ledger language (#1636)
* updated ledger language * chore: regenerate docs/agents.md (post-commit of 44bbcdf)
1 parent b3dd80c commit b992d83

10 files changed

Lines changed: 63 additions & 46 deletions

File tree

docs/agents.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ description: Look up Base documentation with a compact directory-grouped index b
1313
- [Base Account](./base-account/llms.txt)
1414
- [Base Chain](./base-chain/llms.txt) — Bridge tokens and messages between Base and Solana Mainnet
1515
- [Get Started](./get-started/llms.txt)
16-
- [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.
16+
- [Ledgers](./ledgers/llms.txt) — An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base.
17+
- [Static](./static/llms.txt)
1718

1819
## Tools available for AI assistants
1920

@@ -101,5 +102,5 @@ npx skills add base/base-skills
101102
|base-chain/specs/upgrades/isthmus:derivation,exec-engine,l1-attributes,overview,predeploys,system-config
102103
|base-chain/specs/upgrades/jovian:derivation,exec-engine,l1-attributes,overview,system-config
103104
|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
104-
|ledger:deposit-flow,how-it-works,overview,withdraw-flow
105+
|ledgers:deposit-flow,how-it-works,overview,withdraw-flow
105106
|root:agents,changes,cookie-policy,privacy-policy,terms-of-service,tone_of_voice

docs/docs.json

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -636,18 +636,18 @@
636636
}
637637
},
638638
{
639-
"tab": "Ledger",
639+
"tab": "Ledgers",
640640
"groups": [
641641
{
642642
"group": "Overview",
643-
"pages": ["ledger/overview"]
643+
"pages": ["ledgers/overview"]
644644
},
645645
{
646-
"group": "Ledger",
646+
"group": "Ledgers",
647647
"pages": [
648-
"ledger/how-it-works",
649-
"ledger/deposit-flow",
650-
"ledger/withdraw-flow"
648+
"ledgers/how-it-works",
649+
"ledgers/deposit-flow",
650+
"ledgers/withdraw-flow"
651651
]
652652
}
653653
]
@@ -789,6 +789,22 @@
789789
]
790790
},
791791
"redirects": [
792+
{
793+
"source": "/ledger/overview",
794+
"destination": "/ledgers/overview"
795+
},
796+
{
797+
"source": "/ledger/how-it-works",
798+
"destination": "/ledgers/how-it-works"
799+
},
800+
{
801+
"source": "/ledger/deposit-flow",
802+
"destination": "/ledgers/deposit-flow"
803+
},
804+
{
805+
"source": "/ledger/withdraw-flow",
806+
"destination": "/ledgers/withdraw-flow"
807+
},
792808
{
793809
"source": "/base-chain/node-operators/base-v1-upgrade",
794810
"destination": "/base-chain/specs/upgrades/azul/node-upgrade"

docs/ledger/llms.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Deposit flow"
3-
keywords: ["Base Ledger deposit", "encrypted recipient deposit", "Portal contract deposit", "private deposit Base", "confidential deposit onchain"]
3+
keywords: ["Base ledger deposit", "encrypted recipient deposit", "Portal contract deposit", "private deposit Base", "confidential deposit onchain"]
44
description: "What happens when funds enter a ledger, and which deposit details stay hidden onchain."
55
---
66

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "How it works"
3-
keywords: ["Base Ledger lifecycle", "Portal contract Base", "private payment flow", "Base Ledger deposit withdraw", "onchain private transactions"]
4-
description: "A walkthrough of the three stages every Base Ledger payment passes through."
3+
keywords: ["Base ledger lifecycle", "Portal contract Base", "private payment flow", "Base ledger deposit withdraw", "onchain private transactions"]
4+
description: "A walkthrough of the three stages every Base ledger payment passes through."
55
---
66

7-
The lifecycle of a payment is the same on every Base Ledger: funds enter through the Portal contract,
7+
The lifecycle of a payment is the same on every Base ledger: funds enter through the Portal contract,
88
move privately within the ledger, and exit back to Base. The operator runs the services that process
99
each step and decides how to authorize withdrawals.
1010

@@ -17,10 +17,10 @@ each step and decides how to authorize withdrawals.
1717
A payment moves through three stages:
1818

1919
1. **Deposit.** A user moves funds from Base into the ledger through the Portal contract. The recipient
20-
remains encrypted, so deposits to one user remain unlinked. See [Deposit flow](/ledger/deposit-flow).
20+
remains encrypted, so deposits to one user remain unlinked. See [Deposit flow](/ledgers/deposit-flow).
2121
2. **Hold and transact in private.** Inside the ledger, users can transfer, swap, and earn yield while balances and activity remain private.
2222
3. **Withdraw.** A user moves funds back to Base through the operator. Onchain, a withdrawal reveals
2323
the asset and amount but not the account behind it, so deposits and withdrawals stay unlinkable.
24-
See [Withdraw flow](/ledger/withdraw-flow).
24+
See [Withdraw flow](/ledgers/withdraw-flow).
2525

2626

docs/ledgers/llms.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# https://docs.base.org/ledgers/llms.txt
2+
3+
## Base Ledgers Documentation
4+
5+
> 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.
6+
7+
## Introduction
8+
- [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
9+
10+
## Guides
11+
- [How it works](https://docs.base.org/ledgers/how-it-works.md) - Follow the payment lifecycle from deposit, to private ledger activity, to withdrawal
12+
- [Deposit flow](https://docs.base.org/ledgers/deposit-flow.md) - Understand how funds enter a ledger and which deposit details remain hidden onchain
13+
- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow.md) - Understand how funds exit a ledger and how withdrawal authorization works
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Ledger overview"
3-
keywords: ["Base Ledger", "private payments Base", "enterprise stablecoin payments", "private payment ledger", "confidential transactions Base", "onchain B2B payments"]
2+
title: "Ledgers overview"
3+
keywords: ["Base Ledgers", "private payments Base", "enterprise stablecoin payments", "private payment ledger", "confidential transactions Base", "onchain B2B payments"]
44
description: "An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base."
55
---
66

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

11-
## What is a Base Ledger
11+
## What are Base Ledgers
1212

1313
Base Ledgers let enterprises launch their own private payments products on Base. It allows you to build a
1414
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:
4545
## Capabilities
4646

4747
### Private by default
48-
A Base Ledger keeps balances, transactions, and transfers off public block explorers. Deposits hide
48+
A ledger keeps balances, transactions, and transfers off public block explorers. Deposits hide
4949
the recipient and withdrawals hide the sender, so the two stay unlinkable on the public chain.
5050

5151
### Compliant
@@ -58,13 +58,13 @@ actions in one transaction, such as deposit-and-act or withdraw-and-swap. The ac
5858
together or not at all, so funds never sit in an intermediate state.
5959

6060
### Configurable
61-
Operators run a Base Ledger on their own terms, with their own KYC and compliance controls and
61+
Operators run a ledger on their own terms, with their own KYC and compliance controls and
6262
funds self-custodied in a dedicated contract. A ledger can also run custom logic for how it
6363
processes transactions.
6464

6565
## Who operates a ledger
6666

67-
An operator runs its own Base Ledger and is responsible for its custody and compliance. Teams that
67+
An operator runs its own ledger and is responsible for its custody and compliance. Teams that
6868
prefer not to operate one can use [Coinbase Managed](https://docs.cdp.coinbase.com/payments/overview), a managed service built on Base Ledgers.
6969

7070
## Request a demo
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: "Withdraw flow"
3-
keywords: ["Base Ledger withdrawal", "Portal contract withdraw", "private withdrawal Base", "withdrawal authorization onchain", "operator-signed withdrawal"]
3+
keywords: ["Base ledger withdrawal", "Portal contract withdraw", "private withdrawal Base", "withdrawal authorization onchain", "operator-signed withdrawal"]
44
description: "What happens when funds exit a ledger, and how you control withdrawal authorization."
55
---
66

7-
Funds leave a Base Ledger through the Portal contract on Base. The ledger keeps recipients and balances private.
7+
Funds leave a ledger through the Portal contract on Base. The ledger keeps recipients and balances private.
88

99
<Frame>
10-
![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)
10+
![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)
1111
</Frame>
1212

1313
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.

docs/llms-full.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -407,11 +407,11 @@ const client = createPublicClient({ chain: base, transport: http() })
407407
- [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.
408408
- [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.
409409

410-
## Ledger
411-
- [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.
412-
- [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.
413-
- [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.
414-
- [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.
410+
## Ledgers
411+
- [Ledgers overview](https://docs.base.org/ledgers/overview): An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base.
412+
- [Deposit flow](https://docs.base.org/ledgers/deposit-flow): What happens when funds enter a ledger, and which deposit details stay hidden onchain.
413+
- [How it works](https://docs.base.org/ledgers/how-it-works): A walkthrough of the three stages every Base ledger payment passes through.
414+
- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow): What happens when funds exit a ledger, and how you control withdrawal authorization.
415415

416416
## Optional
417417
- [Base MCP server](https://docs.base.org/mcp): Direct AI access to Base documentation

docs/llms.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,11 @@
319319
- [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.
320320
- [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.
321321

322-
## Ledger
323-
- [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.
324-
- [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.
325-
- [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.
326-
- [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.
322+
## Ledgers
323+
- [Ledgers overview](https://docs.base.org/ledgers/overview): An introduction to Base Ledgers, the enterprise way to run confidential payments that settle on Base.
324+
- [Deposit flow](https://docs.base.org/ledgers/deposit-flow): What happens when funds enter a ledger, and which deposit details stay hidden onchain.
325+
- [How it works](https://docs.base.org/ledgers/how-it-works): A walkthrough of the three stages every Base ledger payment passes through.
326+
- [Withdraw flow](https://docs.base.org/ledgers/withdraw-flow): What happens when funds exit a ledger, and how you control withdrawal authorization.
327327

328328
## Optional
329329
- [Base MCP server](https://docs.base.org/mcp): Direct AI access to Base documentation

0 commit comments

Comments
 (0)