From e90b624caf861f6839f8f01a31c5057971b1e1e0 Mon Sep 17 00:00:00 2001 From: Florian Winkler Date: Sat, 6 Jan 2024 19:00:26 +0100 Subject: [PATCH] V3-sdk guides sdk publisher disclaimer --- docs/sdk/v3/guides/advanced/03-price-oracle.md | 6 ++++++ docs/sdk/v3/guides/advanced/04-range-orders.md | 6 ++++++ docs/sdk/v3/guides/liquidity/02-minting-position.md | 6 ++++++ docs/sdk/v3/guides/liquidity/03-fetching-positions.md | 6 ++++++ docs/sdk/v3/guides/liquidity/04-modifying-position.md | 6 ++++++ docs/sdk/v3/guides/liquidity/05-collecting-fees.md | 6 ++++++ docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md | 6 ++++++ docs/sdk/v3/guides/swaps/01-quoting.md | 8 +++++++- docs/sdk/v3/guides/swaps/02-trading.md | 6 ++++++ docs/sdk/v3/guides/swaps/03-simulate-offchain.md | 6 ++++++ docs/sdk/v3/guides/swaps/04-routing.md | 6 ++++++ 11 files changed, 67 insertions(+), 1 deletion(-) diff --git a/docs/sdk/v3/guides/advanced/03-price-oracle.md b/docs/sdk/v3/guides/advanced/03-price-oracle.md index fe839eb36..b2957f743 100644 --- a/docs/sdk/v3/guides/advanced/03-price-oracle.md +++ b/docs/sdk/v3/guides/advanced/03-price-oracle.md @@ -24,6 +24,12 @@ This guide will **cover**: Before diving into this guide, consider reading the theory behind using Uniswap V3 as an [Onchain Oracle](../../../../concepts/protocol/oracle.md). +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/advanced/04-range-orders.md b/docs/sdk/v3/guides/advanced/04-range-orders.md index c12ce4fb7..1d010f83e 100644 --- a/docs/sdk/v3/guides/advanced/04-range-orders.md +++ b/docs/sdk/v3/guides/advanced/04-range-orders.md @@ -27,6 +27,12 @@ This guide will **cover**: Before working through this guide, consider checking out the Range Orders [concept page](../../../../concepts/protocol/range-orders.md) to understand how Limit orders can be executed with Uniswap V3. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/liquidity/02-minting-position.md b/docs/sdk/v3/guides/liquidity/02-minting-position.md index fc5d50be1..0672d1f8d 100644 --- a/docs/sdk/v3/guides/liquidity/02-minting-position.md +++ b/docs/sdk/v3/guides/liquidity/02-minting-position.md @@ -23,6 +23,12 @@ The guide will **cover**: At the end of the guide, given the inputs above, we should be able to mint a liquidity position with the press of a button and view the position on the UI of the web application. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/liquidity/03-fetching-positions.md b/docs/sdk/v3/guides/liquidity/03-fetching-positions.md index c1da8334f..4b1242375 100644 --- a/docs/sdk/v3/guides/liquidity/03-fetching-positions.md +++ b/docs/sdk/v3/guides/liquidity/03-fetching-positions.md @@ -20,6 +20,12 @@ The guide will **cover**: 1. Fetching all positions for an address. 2. Fetching the position info for the positions. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/liquidity/04-modifying-position.md b/docs/sdk/v3/guides/liquidity/04-modifying-position.md index 235c983ff..2e980cffe 100644 --- a/docs/sdk/v3/guides/liquidity/04-modifying-position.md +++ b/docs/sdk/v3/guides/liquidity/04-modifying-position.md @@ -20,6 +20,12 @@ The guide will **cover**: At the end of the guide, given the inputs above, we should be able to add or remove liquidity from a minted position with the press of a button and see the change reflected in our position and the balance of our tokens. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/liquidity/05-collecting-fees.md b/docs/sdk/v3/guides/liquidity/05-collecting-fees.md index a217165d2..a070af76c 100644 --- a/docs/sdk/v3/guides/liquidity/05-collecting-fees.md +++ b/docs/sdk/v3/guides/liquidity/05-collecting-fees.md @@ -19,6 +19,12 @@ The guide will **cover**: At the end of the guide, given the inputs above, we should be able to collect the accrued fees (if any) of a minted position with the press of a button and see the change reflected in our position and the balance of our tokens. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md b/docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md index 15daa6c5a..d47e25c11 100644 --- a/docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md +++ b/docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md @@ -24,6 +24,12 @@ The guide will **cover**: At the end of the guide, given the inputs above, we should be able swap-and-add liquidity using 100% of the input assets with the press of a button and see the change reflected in our position and the balance of our tokens. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/swaps/01-quoting.md b/docs/sdk/v3/guides/swaps/01-quoting.md index 7aa8f6df1..10778b33e 100644 --- a/docs/sdk/v3/guides/swaps/01-quoting.md +++ b/docs/sdk/v3/guides/swaps/01-quoting.md @@ -22,6 +22,12 @@ The guide will **cover**: At the end of the guide, we should be able to fetch a quote for the given input token pair and the input token amount with the press of a button on the web application. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) @@ -98,7 +104,7 @@ The function expects a `CurrencyAmount` object. We use ethers to parse the input ```typescript import { ethers } from 'ethers' -import { CurrencyAmount } from 'sdk-core' +import { CurrencyAmount } from '@uniswapfoundation/sdk-core' const rawInputAmount = ethers.utils.parseUnits( CurrentConfig.tokens.amountIn, diff --git a/docs/sdk/v3/guides/swaps/02-trading.md b/docs/sdk/v3/guides/swaps/02-trading.md index 47b0868ec..1fa6699dc 100644 --- a/docs/sdk/v3/guides/swaps/02-trading.md +++ b/docs/sdk/v3/guides/swaps/02-trading.md @@ -27,6 +27,12 @@ At the end of the guide, we should be able to create and execute a trade between Included in the example application is functionality to wrap/unwrap ETH as needed to fund the example `WETH` to `USDC` swap directly from an `ETH` balance. ::: +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/swaps/03-simulate-offchain.md b/docs/sdk/v3/guides/swaps/03-simulate-offchain.md index 003bbcf38..738dee715 100644 --- a/docs/sdk/v3/guides/swaps/03-simulate-offchain.md +++ b/docs/sdk/v3/guides/swaps/03-simulate-offchain.md @@ -23,6 +23,12 @@ The guide will **cover**: At the end of the guide, we should be able to initialize Pools with full tickdata and simulate trades offchain. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk) diff --git a/docs/sdk/v3/guides/swaps/04-routing.md b/docs/sdk/v3/guides/swaps/04-routing.md index 3c3c77508..b130ee3ce 100644 --- a/docs/sdk/v3/guides/swaps/04-routing.md +++ b/docs/sdk/v3/guides/swaps/04-routing.md @@ -21,6 +21,12 @@ The guide will **cover**: At the end of the guide, we should be able to create a route and and execute a swap between any two currencies tokens using the example's included UI. +:::info +The SDKs that are used in the guide are now published by the [Uniswap Foundation](https://github.com/uniswapfoundation) instead of Uniswap Labs. +You can find a list of supported SDKs [here](https://www.npmjs.com/org/uniswapfoundation). +Make sure you don't mix SDKs published by Uniswap Labs and the Uniswap Foundation to avoid unpredictable behavior. +::: + For this guide, the following Uniswap packages are used: - [`@uniswapfoundation/v3-sdk`](https://www.npmjs.com/package/@uniswapfoundation/v3-sdk)