Skip to content

Commit 248ece1

Browse files
committed
chore: update docs to reflect quote changes
1 parent e6a3d12 commit 248ece1

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/src/sdk-reference/ethers/withdrawals.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ const { status, receipt: l1Receipt } = await sdk.withdrawals.finalize(handle.l2T
5656

5757
| Route | Meaning |
5858
| --------------- | ---------------------------------------------------- |
59-
| `eth-base` | Base token is **ETH** on L2 |
60-
| `eth-nonbase` | Base token is **not ETH** on L2 |
59+
| `base` | Withdrawing the **base token** (ETH or otherwise) |
6160
| `erc20-nonbase` | Withdrawing an ERC-20 that is **not** the base token |
6261

6362
You **don’t** pass a route manually; it’s derived from network metadata and the token.
@@ -84,7 +83,7 @@ Estimate the operation (route, approvals, gas hints). Does **not** send transact
8483
const q = await sdk.withdrawals.quote({ token, amount, to });
8584
/*
8685
{
87-
route: "eth-base" | "eth-nonbase" | "erc20-nonbase",
86+
route: "base" | "erc20-nonbase",
8887
summary: {
8988
route,
9089
approvalsNeeded: [{ token, spender, amount }],
@@ -257,9 +256,9 @@ export interface Eip1559GasOverrides {
257256
}
258257

259258
export interface WithdrawQuote {
260-
route: 'eth-base' | 'eth-nonbase' | 'erc20-nonbase';
259+
route: 'base' | 'erc20-nonbase';
261260
summary: {
262-
route: 'eth-base' | 'eth-nonbase' | 'erc20-nonbase';
261+
route: 'base' | 'erc20-nonbase';
263262
approvalsNeeded: Array<{ token: Address; spender: Address; amount: bigint }>;
264263
amounts: {
265264
transfer: {

docs/src/sdk-reference/viem/withdrawals.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ const { status, receipt: l1Receipt } = await sdk.withdrawals.finalize(handle.l2T
7171

7272
| Route | Meaning |
7373
| --------------- | ---------------------------------------------------- |
74-
| `eth-base` | Base token is **ETH** on L2 |
75-
| `eth-nonbase` | Base token is **not ETH** on L2 |
74+
| `base` | Withdrawing the **base token** (ETH or otherwise) |
7675
| `erc20-nonbase` | Withdrawing an ERC-20 that is **not** the base token |
7776

7877
Routes are derived automatically from network metadata and the supplied `token`.
@@ -99,7 +98,7 @@ Estimate the operation (route, approvals, gas hints). Does **not** send transact
9998
const q = await sdk.withdrawals.quote({ token, amount, to });
10099
/*
101100
{
102-
route: "eth-base" | "eth-nonbase" | "erc20-nonbase",
101+
route: "base" | "erc20-nonbase",
103102
summary: {
104103
route,
105104
approvalsNeeded: [{ token, spender, amount }],
@@ -266,9 +265,9 @@ export interface Eip1559GasOverrides {
266265
}
267266

268267
export interface WithdrawQuote {
269-
route: 'eth-base' | 'eth-nonbase' | 'erc20-nonbase';
268+
route: 'base' | 'erc20-nonbase';
270269
summary: {
271-
route: 'eth-base' | 'eth-nonbase' | 'erc20-nonbase';
270+
route: 'base' | 'erc20-nonbase';
272271
approvalsNeeded: Array<{ token: Address; spender: Address; amount: bigint }>;
273272
amounts: {
274273
transfer: {

0 commit comments

Comments
 (0)