Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V3-sdk guides sdk publisher disclaimer #19

Merged
merged 1 commit into from
Jan 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/advanced/03-price-oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/advanced/04-range-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/liquidity/02-minting-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/liquidity/03-fetching-positions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/liquidity/04-modifying-position.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/liquidity/05-collecting-fees.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/liquidity/06-swap-and-add-liquidity.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 7 additions & 1 deletion docs/sdk/v3/guides/swaps/01-quoting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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,
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/swaps/02-trading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/swaps/03-simulate-offchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/sdk/v3/guides/swaps/04-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down