docs: re-gen typedoc + README updates (#244)

Author: dohaki

README.md

@@ -50,22 +50,22 @@ const client = createAcrossClient({
   chains: [mainnet, optimism, arbitrum],
 });
 
-// 2. Retrieve quote for USDC from Arbitrum -> Optimism
+// 2. Retrieve quote for USDC from Arbitrum -> ETH on Optimism
 const route = {
   originChainId: arbitrum.id,
   destinationChainId: optimism.id,
-  inputToken: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
-  outputToken: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
+  inputToken: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", // USDC
+  outputToken: "0x0000000000000000000000000000000000000000", // Native ETH
 };
-const quote = await client.getQuote({
+const swapQuote = await client.getSwapQuote({
   route,
-  inputAmount: parseUnit("1000", 6) // USDC decimals
-})
+  amount: parseUnit("10", 6), // USDC decimals
+});
 
 // 3. Execute quote
-await client.executeQuote({
+await client.executeSwapQuote({
   walletClient: wallet,
-  deposit: quote.deposit,
+  swapQuote,
   onProgress: (progress) => {
     // handle progress
   },

packages/sdk/README.md

@@ -62,22 +62,22 @@ const client = createAcrossClient({
 
 ### 2. Retrieve a quote
 
-Now, you can retrieve a quote for a given route.
+Now, you can retrieve a quote for a given route with an arbitrary token pair.
 
 ```ts
 import { parseEther } from "viem";
 
-// WETH from Arbitrum -> Optimism
+// USDC from Arbitrum -> ETH on Optimism
 const route = {
   originChainId: arbitrum.id,
   destinationChainId: optimism.id,
-  inputToken: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1", // WETH arb
-  outputToken: "0x4200000000000000000000000000000000000006", // WETH opt
+  inputToken: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", // USDC
+  outputToken: "0x0000000000000000000000000000000000000000", // Native ETH
 };
 
-const quote = await client.getQuote({
+const swapQuote = await client.getSwapQuote({
   route,
-  inputAmount: parseEther("1"),
+  amount: parseUnit("10", 6), // USDC decimals
 });
 ```
 
@@ -93,9 +93,9 @@ import { useWalletClient } from "wagmi";
 
 const wallet = useWalletClient();
 
-await client.executeQuote({
+await client.executeSwapQuote({
   walletClient: wallet,
-  deposit: quote.deposit, // returned by `getQuote`
+  swapQuote, // returned by `client.getSwapQuote`
   onProgress: (progress) => {
     if (progress.step === "approve" && progress.status === "txSuccess") {
       // if approving an ERC20, you have access to the approval receipt
@@ -116,8 +116,8 @@ await client.executeQuote({
 
 The method will execute a quote by:
 
-1. Approving the SpokePool contract if necessary
-2. Depositing the input token on the origin chain
+1. Approving the `SpokePool` or `SpokePoolPeriphery` contract if necessary
+2. Depositing the input token on the origin chain (also facilitating an origin swap if necessary)
 3. Waiting for the deposit to be filled on the destination chain
 
 You can use the `onProgress` callback to act on different stages of the execution.
@@ -129,123 +129,53 @@ Across enables users to seamlessly interact with your dApp or chain using assets
 
 ### Example: Stake Native ETH on Destination Chain
 
-To stake native ETH in one step:
-
-1. Bridge WETH to the destination chain, sending the output tokens (WETH) to Across's MulticallHandler contract (since contracts receive WETH).
-2. Unwrap WETH to obtain native ETH.
-3. Stake the ETH on your staking contract.
-
-**Note**: If your calldata depends on the output amount, you must use the `update()` function.
-
-### 1. Craft a cross-chain message
+This example shows you how to use the app-sdk to swap, bridge and stake native ETH across chains.
+You only need to specify the destination chain actions.
 
 ```ts
-import { type Amount } from "@across-protocol/app-sdk";
-import { encodeFunctionData } from "viem";
-import { optimism } from "viem/chains";
-
-// constants
-const userAddress = "0xFoo";
-const multicallHandlerOptimism = "0x924a9f036260DdD5808007E1AA95f08eD08aA569";
-
-export const WETH_OPTIMISM = {
-  chain: optimism,
-  abi: WethAbi,
-  address: "0x4200000000000000000000000000000000000006",
-  decimals: 18,
-  logoUrl:
-    "https://raw.githubusercontent.com/across-protocol/frontend/master/src/assets/token-logos/weth.svg",
-  name: "Wrapped Ether",
-  symbol: "WETH",
-} as const;
-
-export const STAKE_CONTRACT = {
-  address: "0x733Debf51574c70CfCdb7918F032E16F686bd9f8",
-  chain: optimism,
-  abi: StakerContractABI,
-} as const;
-
-// WETH unwrap action
-function generateUnwrapCallData(wethAmount: Amount) {
-  return encodeFunctionData({
-    abi: WETH_OPTIMISM.abi,
-    functionName: "withdraw",
-    args: [BigInt(wethAmount)],
-  });
-}
-
-// STAKE action
-function generateStakeCallData(userAddress: Address) {
-  return encodeFunctionData({
-    abi: STAKE_CONTRACT.abi,
-    functionName: "stake",
-    args: [userAddress],
-  });
-}
-
-const unwrapAndStakeMessage = {
-  actions: [
-    {
-      target: WETH_OPTIMISM.address,
-      callData: generateUnwrapCallData(inputAmount),
-      value: 0n,
-      // we only update the calldata since the unwrap call is non-payable, but we DO care about the output amount.
-      update: (updatedOutputAmount) => {
-        return {
-          callData: generateUnwrapCallData(updatedOutputAmount),
-        };
-      },
-    },
-    {
-      target: STAKE_CONTRACT.address,
-      callData: generateStakeCallData(userAddress),
-      // 🔔 the initial value may be set equal to the output amount. This MUST be updated via the `update()` function below oir this call will fail!
-      value: inputAmount,
-      // now we MUST update msg.value since this last call is calling a payable function.
-      update: (updatedOutputAmount) => {
-        return {
-          value: updatedOutputAmount,
-        };
-      },
-    },
-  ],
-  fallbackRecipient: userAddress,
-};
-```
+import { createAcrossClient } from "@across-protocol/app-sdk";
+import { mainnet, optimism, arbitrum } from "viem/chains";
+import { useWalletClient } from "wagmi";
 
-### 2. Retrieve a quote
+const wallet = useWalletClient();
 
-After specifying a cross-chain message, you simply can fetch a quote the same way as a normal bridge
+// Example Staking contract on OP
+const stakingAddress = "0x733Debf51574c70CfCdb7918F032E16F686bd9f8";
 
-```ts
+// 1. Create client
+const client = createAcrossClient({
+  integratorId: "0xdead", // 2-byte hex string
+  chains: [mainnet, optimism, arbitrum],
+});
+
+// 2. Retrieve quote for USDC from Arbitrum -> ETH on Optimism
 const route = {
   originChainId: arbitrum.id,
   destinationChainId: optimism.id,
-  inputToken: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1", // WETH arbitrum
-  outputToken: "0x4200000000000000000000000000000000000006", // WETH optimism
+  inputToken: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", // USDC
+  outputToken: "0x0000000000000000000000000000000000000000", // Native ETH
 };
-
-const quote = await client.getQuote({
+const swapQuote = await client.getSwapQuote({
   route,
-  inputAmount: parseEther("1"),
-  // 🔔 Notice the recipient is not the staking contract itself or even the user, but the contract that will execute our cross chain messages
-  recipient: multicallHandlerOptimism,
-  crossChainMessage: unwrapAndStakeMessage,
+  amount: parseUnit("10", 6), // USDC decimals
+  actions: [
+    {
+      // Target contract of destination chain actions
+      target: stakingAddress,
+      // Human-readable ABI format of method to call
+      functionSignature: "function stake(address stakerAddress)",
+      // Args to above
+      args: [{ value: wallet.address }],
+      // Allows to set call value to available balance AFTER bridge
+      populateCallValueDynamically: true,
+    },
+  ],
 });
-```
-
-### 3. Execute a quote
-
-If the quote is available, you can execute like so
-
-```ts
-import { useWalletClient } from "wagmi";
-
-const wallet = useWalletClient();
 
-await client.executeQuote({
+// 3. Execute quote
+await client.executeSwapQuote({
   walletClient: wallet,
-  deposit: quote.deposit, // returned by `getQuote`
+  swapQuote,
   onProgress: (progress) => {
     // handle progress
   },
@@ -277,17 +207,16 @@ For the full detailed reference see [here](./docs/README.md).
 
 ### Chains and Routes
 
-- [`getSupportedChains`](./docs/classes/AcrossClient.md#getsupportedchains)
-- [`getAvailableRoutes`](./docs/classes/AcrossClient.md#getavailableroutes)
+- [`getSwapChains`](./docs/classes/AcrossClient.md#getswapchains)
+- [`getSwapTokens`](./docs/classes/AcrossClient.md#getswaptokens)
 
 ### Quotes, Fees and Limits
 
-- [`getQuote`](./docs/classes/AcrossClient.md#getquote)
+- [`getSwapQuote`](./docs/classes/AcrossClient.md#getswapquote)
 
 ### Transaction Simulations and Executions
 
-- [`executeQuote`](./docs/classes/AcrossClient.md#executequote)
-- [`simulateDepositTx`](./docs/classes/AcrossClient.md#simulatedeposittx)
+- [`executeSwapQuote`](./docs/classes/AcrossClient.md#executeswapquote)
 
 ### Deposit and Fill Status
 

packages/sdk/docs/README.md

@@ -19,6 +19,8 @@
 - [AcrossChain](type-aliases/AcrossChain.md)
 - [AcrossClientOptions](type-aliases/AcrossClientOptions.md)
 - [AcrossErrorCodeType](type-aliases/AcrossErrorCodeType.md)
+- [Action](type-aliases/Action.md)
+- [ActionArg](type-aliases/ActionArg.md)
 - [Amount](type-aliases/Amount.md)
 - [BuildMessageParams](type-aliases/BuildMessageParams.md)
 - [ChainInfoMap](type-aliases/ChainInfoMap.md)
@@ -32,6 +34,9 @@
 - [DepositLog](type-aliases/DepositLog.md)
 - [DepositStatus](type-aliases/DepositStatus.md)
 - [ExecuteQuoteParams](type-aliases/ExecuteQuoteParams.md)
+- [ExecuteQuoteResponseParams](type-aliases/ExecuteQuoteResponseParams.md)
+- [ExecuteSwapQuoteParams](type-aliases/ExecuteSwapQuoteParams.md)
+- [ExecuteSwapQuoteResponseParams](type-aliases/ExecuteSwapQuoteResponseParams.md)
 - [ExecutionProgress](type-aliases/ExecutionProgress.md)
 - [FilledV3RelayEvent](type-aliases/FilledV3RelayEvent.md)
 - [FillEventLog](type-aliases/FillEventLog.md)
@@ -49,12 +54,18 @@
 - [GetSuggestedFeesParams](type-aliases/GetSuggestedFeesParams.md)
 - [GetSuggestedFeesReturnType](type-aliases/GetSuggestedFeesReturnType.md)
 - [GetSupportedChainsParams](type-aliases/GetSupportedChainsParams.md)
+- [GetSwapChainsParams](type-aliases/GetSwapChainsParams.md)
+- [GetSwapChainsReturnType](type-aliases/GetSwapChainsReturnType.md)
+- [GetSwapQuoteParams](type-aliases/GetSwapQuoteParams.md)
+- [GetSwapTokensParams](type-aliases/GetSwapTokensParams.md)
+- [GetSwapTokensReturnType](type-aliases/GetSwapTokensReturnType.md)
 - [IndexerStatusResponse](type-aliases/IndexerStatusResponse.md)
 - [LoggerT](type-aliases/LoggerT.md)
 - [LogLevel](type-aliases/LogLevel.md)
 - [MakeOptional](type-aliases/MakeOptional.md)
 - [NoNullValuesOfObject](type-aliases/NoNullValuesOfObject.md)
 - [Quote](type-aliases/Quote.md)
+- [RecursiveActionArg](type-aliases/RecursiveActionArg.md)
 - [Route](type-aliases/Route.md)
 - [RoutesQueryParams](type-aliases/RoutesQueryParams.md)
 - [SignUpdateDepositTypedDataParams](type-aliases/SignUpdateDepositTypedDataParams.md)
@@ -63,7 +74,10 @@
 - [SimulateUpdateDepositTxParams](type-aliases/SimulateUpdateDepositTxParams.md)
 - [Status](type-aliases/Status.md)
 - [SuggestedFeesQueryParams](type-aliases/SuggestedFeesQueryParams.md)
-- [SuggestedFeesResponse](type-aliases/SuggestedFeesResponse.md)
+- [SwapApiToken](type-aliases/SwapApiToken.md)
+- [SwapChain](type-aliases/SwapChain.md)
+- [SwapChainsQueryParams](type-aliases/SwapChainsQueryParams.md)
+- [SwapExecutionProgress](type-aliases/SwapExecutionProgress.md)
 - [TenderlySimulateTxParams](type-aliases/TenderlySimulateTxParams.md)
 - [TokenInfo](type-aliases/TokenInfo.md)
 - [TransactionProgress](type-aliases/TransactionProgress.md)
@@ -76,9 +90,13 @@
 ## Variables
 
 - [DOMAIN\_CALLDATA\_DELIMITER](variables/DOMAIN_CALLDATA_DELIMITER.md)
+- [fetchAcrossApi](variables/fetchAcrossApi.md)
+- [fetchAcrossApiPost](variables/fetchAcrossApiPost.md)
+- [fetchIndexerApi](variables/fetchIndexerApi.md)
 - [FillType](variables/FillType.md)
 - [LogLevels](variables/LogLevels.md)
 - [MulticallHandlerAbi](variables/MulticallHandlerAbi.md)
+- [ZERO\_BYTES\_32](variables/ZERO_BYTES_32.md)
 
 ## Functions
 
@@ -90,8 +108,7 @@
 - [configurePublicClients](functions/configurePublicClients.md)
 - [createAcrossClient](functions/createAcrossClient.md)
 - [executeQuote](functions/executeQuote.md)
-- [fetchAcrossApi](functions/fetchAcrossApi.md)
-- [fetchIndexerApi](functions/fetchIndexerApi.md)
+- [executeSwapQuote](functions/executeSwapQuote.md)
 - [getAcrossClient](functions/getAcrossClient.md)
 - [getAvailableRoutes](functions/getAvailableRoutes.md)
 - [getCurrentTimeSeconds](functions/getCurrentTimeSeconds.md)
@@ -105,21 +122,27 @@
 - [getQuote](functions/getQuote.md)
 - [getSuggestedFees](functions/getSuggestedFees.md)
 - [getSupportedChains](functions/getSupportedChains.md)
+- [getSwapChains](functions/getSwapChains.md)
+- [getSwapQuote](functions/getSwapQuote.md)
+- [getSwapTokens](functions/getSwapTokens.md)
 - [getUpdateDepositTypedData](functions/getUpdateDepositTypedData.md)
 - [getUpdateDepositTypedDataV3\_5](functions/getUpdateDepositTypedDataV3_5.md)
+- [hasMessage](functions/hasMessage.md)
+- [isDefined](functions/isDefined.md)
 - [isOk](functions/isOk.md)
 - [isValidIntegratorId](functions/isValidIntegratorId.md)
 - [parseDepositLogs](functions/parseDepositLogs.md)
 - [parseFillLogs](functions/parseFillLogs.md)
+- [parseSuggestedFees](functions/parseSuggestedFees.md)
 - [signUpdateDepositTypedData](functions/signUpdateDepositTypedData.md)
+- [signUpdateDepositTypedDataV3\_5](functions/signUpdateDepositTypedDataV3_5.md)
 - [simulateApproveTx](functions/simulateApproveTx.md)
 - [simulateDepositTx](functions/simulateDepositTx.md)
 - [simulateTxOnTenderly](functions/simulateTxOnTenderly.md)
 - [simulateUpdateDepositTx](functions/simulateUpdateDepositTx.md)
 - [tagIntegratorId](functions/tagIntegratorId.md)
 - [waitForDepositTx](functions/waitForDepositTx.md)
 - [waitForFillByDepositTx](functions/waitForFillByDepositTx.md)
+- [waitForFillEvent](functions/waitForFillEvent.md)
 - [waitForFillTx](functions/waitForFillTx.md)
 - [waitForFillTxEvent](functions/waitForFillTxEvent.md)
-- [waitForV3\_5FillEvent](functions/waitForV3_5FillEvent.md)
-- [waitForV3FillEvent](functions/waitForV3FillEvent.md)