Add Add/Remove Liquidity

.changeset/large-socks-exist.md

@@ -0,0 +1,9 @@
+---
+"@balancer/sdk": minor
+---
+
+- Add add/remove liquidity pool support (non-nested pools)
+- Weighted pool type
+- ComposableStable pool type
+- Uses balancerHelpers to query amounts in/out rather than relying on specific pool math and associated data
+- Integration tests run against local viem fork

.changeset/neat-glasses-brush.md

@@ -0,0 +1,5 @@
+---
+"@balancer/sdk": minor
+---
+
+Adds Balancer API Provider. A utility module designed to fetch pool data from [API](https://github.com/beethovenxfi/beethovenx-backend/blob/v3-main/README.md#branching-and-deployment-environments).

.github/workflows/checks.yml

@@ -29,7 +29,6 @@ jobs:
         uses: ./.github/actions/setup
       - name: Lint & format code
         run: pnpm format & pnpm lint
-
   test:
     name: Test
     needs: install
@@ -42,13 +41,14 @@ jobs:
       - uses: actions/checkout@v3
       - name: Setup
         uses: ./.github/actions/setup
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
       - name: Test
         run: pnpm test:ci
         env:
           ETHEREUM_RPC_URL: ${{ secrets.ETHEREUM_RPC_URL }}
           POLYGON_RPC_URL: ${{ secrets.POLYGON_RPC_URL }}
           FANTOM_RPC_URL: ${{ secrets.FANTOM_RPC_URL }}
-
   build:
     name: Build
     needs: install

.gitignore

@@ -66,4 +66,19 @@ jspm_packages/
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*
+
+# hardhat
+node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+
+# Hardhat files
+cache
+artifacts
+
+#IDE
+.idea

README.md

@@ -21,3 +21,95 @@ If your platform does not support one of the required features, it is also possi
 Testing requires access to an archive node for onchain quote comparisons. This can be done using Infura.
 
 `pnpm test`
+
+## Balancer Api Provider
+
+The Balancer API Provider is a provider that facilitates 
+data fetching from the Balancer API,
+it can be used for:
+- Fetch Pool State for AddLiquidity;
+- Fetch Pool State for RemoveLiquidity.
+
+### Usage for adding liquidity to a Pool
+
+```ts
+  import { BalancerApi, AddLiquidity } from "@balancer/sdk";
+    ...
+    const addLiquidityInput: AddLiquidityProportionalInput = {
+      bptOut,
+      chainId,
+      rpcUrl,
+      kind: AddLiquidityKind.Proportional,
+    };
+
+    const balancerApi = new BalancerApi('https://backend-v3-canary.beets-ftm-node.com/graphql', 1);
+    const poolState = await balancerApi.pools.fetchPoolState('0x5f1d6874cb1e7156e79a7563d2b61c6cbce03150000200000000000000000586');
+    const addLiquidity = new AddLiquidity();
+    const queryOutput = await addLiquidity.query(addLiquidityInput, poolState);
+    const { call, to, value, maxAmountsIn, minBptOut } =
+        addLiquidity.buildCall({
+            ...queryOutput,
+            slippage,
+            sender: signerAddress,
+            recipient: signerAddress,
+        });
+    const client = createClient({
+      ...
+    })
+
+    await client.sendTransaction({
+      account: signerAddress,
+      chain: client.chain,
+      data: call,
+      to,
+      value,
+    });
+```
+Full working add liquidity example: [examples/addLiquidity.ts](./examples/addLiquidity.ts)
+
+### Usage for removing liquidity from a Pool
+```ts
+import { BalancerApi, RemoveLiquidity } from "@balancer/sdk";
+...
+const removeLiquidityInput: RemoveLiquiditySingleTokenInput = {
+  chainId,
+  rpcUrl,
+  bptIn,
+  tokenOut,
+  kind: RemoveLiquidityKind.SingleToken,
+};
+
+const balancerApi = new BalancerApi('https://backend-v3-canary.beets-ftm-node.com/graphql', 1);
+const poolState = await balancerApi.pools.fetchPoolState('0x5f1d6874cb1e7156e79a7563d2b61c6cbce03150000200000000000000000586');
+const removeLiquidity = new RemoveLiquidity();
+const queryOutput = await removeLiquidity.query(removeLiquidityInput, poolState);
+const { call, to, value, maxAmountsIn, minBptOut } =
+  removeLiquidity.buildCall({
+    ...queryOutput,
+    slippage,
+    sender: signerAddress,
+    recipient: signerAddress,
+  });
+const client = createClient({
+  ...
+})
+
+await client.sendTransaction({
+  account: signerAddress,
+  chain: client.chain,
+  data: call,
+  to,
+  value,
+});
+```
+Full working remove liquidity example: [examples/removeLiquidity.ts](./examples/removeLiquidity.ts)
+
+## Anvil client
+To download and install the anvil client, run the following commands (MacOS):
+- `curl -L https://foundry.paradigm.xyz | bash`
+- `brew install libusb`
+- `source /Users/$(whoami)/.zshenv`
+- `foundryup`
+
+For other SO's check https://book.getfoundry.sh/getting-started/installation
+```

examples/addLiquidity.ts

@@ -0,0 +1,103 @@
+/**
+ * Example showing how to add liquidity to a pool.
+ * (Runs against a local Anvil fork)
+ *
+ * Run with:
+ * pnpm example ./examples/addLiquidity.ts
+ */
+import { config } from 'dotenv';
+config();
+
+import {
+    BalancerApi,
+    ChainId,
+    AddLiquidityInput,
+    AddLiquidityKind,
+    AddLiquidity,
+    Slippage,
+} from '../src';
+import { parseUnits } from 'viem';
+import { ANVIL_NETWORKS, startFork } from '../test/anvil/anvil-global-setup';
+import { makeForkTx } from './utils/makeForkTx';
+
+const addLiquidity = async () => {
+    // User defined
+    const chainId = ChainId.MAINNET;
+    const userAccount = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    const poolId =
+        '0x5c6ee304399dbdb9c8ef030ab642b10820db8f56000200000000000000000014'; // 80BAL-20WETH
+    const slippage = Slippage.fromPercentage('1'); // 1%
+
+    // Start a local anvil fork that will be used to query/tx against
+    const { rpcUrl } = await startFork(ANVIL_NETWORKS.MAINNET);
+
+    // API is used to fetch relevant pool data
+    const balancerApi = new BalancerApi(
+        'https://backend-v3-canary.beets-ftm-node.com/graphql',
+        chainId,
+    );
+    const poolStateInput = await balancerApi.pools.fetchPoolState(poolId);
+
+    // We create arbitrary amounts in but these would usually be set by user
+    const amountsIn = poolStateInput.tokens.map((t) => ({
+        rawAmount: parseUnits('1', t.decimals),
+        decimals: t.decimals,
+        address: t.address,
+    }));
+
+    // Construct the AddLiquidityInput, in this case an AddLiquidityUnbalanced
+    const addLiquidityInput: AddLiquidityInput = {
+        amountsIn,
+        chainId,
+        rpcUrl,
+        kind: AddLiquidityKind.Unbalanced,
+    };
+
+    // Simulate addLiquidity to get the amount of BPT out
+    const addLiquidity = new AddLiquidity();
+    const queryOutput = await addLiquidity.query(
+        addLiquidityInput,
+        poolStateInput,
+    );
+
+    console.log('Add Liquidity Query Output:');
+    console.log('Tokens In:');
+    queryOutput.amountsIn.map((a) =>
+        console.log(a.token.address, a.amount.toString()),
+    );
+    console.log(`BPT Out: ${queryOutput.bptOut.amount.toString()}`);
+
+    // Apply slippage to the BPT amount received from the query and construct the call
+    const call = addLiquidity.buildCall({
+        ...queryOutput,
+        slippage,
+        sender: userAccount,
+        recipient: userAccount,
+    });
+
+    console.log('\nWith slippage applied:');
+    console.log('Max tokens in:');
+    call.maxAmountsIn.forEach((a) =>
+        console.log(a.token.address, a.amount.toString()),
+    );
+    console.log(`Min BPT Out: ${call.minBptOut.amount.toString()}`);
+
+    // Make the tx against the local fork and print the result
+    const slots = [1, 3, 0];
+    await makeForkTx(
+        call,
+        {
+            rpcUrl,
+            chainId,
+            impersonateAccount: userAccount,
+            forkTokens: amountsIn.map((a, i) => ({
+                address: a.address,
+                slot: slots[i],
+                rawBalance: a.rawAmount,
+            })),
+        },
+        poolStateInput,
+    );
+};
+
+addLiquidity().then(() => {});

examples/removeLiquidity.ts

@@ -0,0 +1,106 @@
+/**
+ * Example showing how to remove liquidity from a pool.
+ * (Runs against a local Anvil fork)
+ *
+ * Run with:
+ * pnpm example ./examples/removeLiquidity.ts
+ */
+import dotenv from 'dotenv';
+dotenv.config();
+
+import {
+    ChainId,
+    RemoveLiquidityKind,
+    RemoveLiquidity,
+    PoolStateInput,
+    Slippage,
+    InputAmount,
+    RemoveLiquidityInput,
+    BalancerApi,
+} from '../src';
+import { parseEther } from 'viem';
+import { ANVIL_NETWORKS, startFork } from '../test/anvil/anvil-global-setup';
+import { makeForkTx } from './utils/makeForkTx';
+
+const removeLiquidity = async () => {
+    // User defined:
+    const chainId = ChainId.MAINNET;
+    const userAccount = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    const poolId =
+        '0x5c6ee304399dbdb9c8ef030ab642b10820db8f56000200000000000000000014'; // 80BAL-20WETH
+    const tokenOut = '0xba100000625a3754423978a60c9317c58a424e3D'; // BAL
+    const slippage = Slippage.fromPercentage('1'); // 1%
+
+    // Start a local anvil fork that will be used to query/tx against
+    const { rpcUrl } = await startFork(ANVIL_NETWORKS[ChainId[chainId]]);
+
+    // API is used to fetch relevant pool data
+    const balancerApi = new BalancerApi(
+        'https://backend-v3-canary.beets-ftm-node.com/graphql',
+        chainId,
+    );
+    const poolStateInput: PoolStateInput =
+        await balancerApi.pools.fetchPoolState(poolId);
+
+    // Construct the RemoveLiquidityInput, in this case a RemoveLiquiditySingleToken
+    const bptIn: InputAmount = {
+        rawAmount: parseEther('1'),
+        decimals: 18,
+        address: poolStateInput.address,
+    };
+    const removeLiquidityInput: RemoveLiquidityInput = {
+        chainId,
+        rpcUrl,
+        bptIn,
+        tokenOut,
+        kind: RemoveLiquidityKind.SingleToken,
+    };
+
+    // Simulate removing liquidity to get the tokens out
+    const removeLiquidity = new RemoveLiquidity();
+    const queryOutput = await removeLiquidity.query(
+        removeLiquidityInput,
+        poolStateInput,
+    );
+
+    console.log('Remove Liquidity Query Output:');
+    console.log(`BPT In: ${queryOutput.bptIn.amount.toString()}\nTokens Out:`);
+    queryOutput.amountsOut.map((a) =>
+        console.log(a.token.address, a.amount.toString()),
+    );
+
+    // Apply slippage to the tokens out received from the query and construct the call
+    const call = removeLiquidity.buildCall({
+        ...queryOutput,
+        slippage,
+        sender: userAccount,
+        recipient: userAccount,
+    });
+
+    console.log('\nWith slippage applied:');
+    console.log(`Max BPT In: ${call.maxBptIn.amount}`);
+    console.log('Min amounts out: ');
+    call.minAmountsOut.forEach((a) =>
+        console.log(a.token.address, a.amount.toString()),
+    );
+
+    // Make the tx against the local fork and print the result
+    await makeForkTx(
+        call,
+        {
+            rpcUrl,
+            chainId,
+            impersonateAccount: userAccount,
+            forkTokens: [
+                {
+                    address: bptIn.address,
+                    slot: 0,
+                    rawBalance: bptIn.rawAmount,
+                },
+            ],
+        },
+        poolStateInput,
+    );
+};
+
+removeLiquidity();