@zoralabs/protocol-sdk 0.10.0 → 0.11.0

package/src/secondary/uniswap/uniswapQuoteExact.ts

@@ -0,0 +1,114 @@
+import { Address } from "viem";
+import {
+  mainnet,
+  sepolia,
+  zora,
+  zoraSepolia,
+  base,
+  baseSepolia,
+  optimism,
+  arbitrum,
+  blast,
+} from "viem/chains";
+import { uniswapQuoterABI } from "./abis";
+import { PublicClient } from "../../utils";
+
+const UniswapQuoterAddress: Record<number, Address> = {
+  [mainnet.id]: "0x61fFE014bA17989E743c5F6cB21bF9697530B21e",
+  [sepolia.id]: "0xEd1f6473345F45b75F8179591dd5bA1888cf2FB3",
+  [zora.id]: "0x11867e1b3348F3ce4FcC170BC5af3d23E07E64Df",
+  [zoraSepolia.id]: "0xC195976fEF0985886E37036E2DF62bF371E12Df0",
+  [base.id]: "0x3d4e44Eb1374240CE5F1B871ab261CD16335B76a",
+  [baseSepolia.id]: "0xC5290058841028F1614F3A6F0F5816cAd0df5E27",
+  [optimism.id]: "0x61fFE014bA17989E743c5F6cB21bF9697530B21e",
+  [arbitrum.id]: "0x61fFE014bA17989E743c5F6cB21bF9697530B21e",
+  [blast.id]: "0x6Cdcd65e03c1CEc3730AeeCd45bc140D57A25C77",
+};
+
+/**
+ * Fetches a quote for buying an exact amount of erc20z from the uniswap pool
+ *
+ * @param tokenIn - the token to sell (will be weth)
+ * @param tokenOut - the token to purchase (will be an erc20z)
+ * @param amount - the exact amount of erc20z to purchase
+ * @param fee - the fee of the pool
+ * @param chainId - the chain id
+ */
+export async function quoteExactOutputSingle({
+  tokenIn,
+  tokenOut,
+  amountOut,
+  fee,
+  chainId,
+  client,
+}: {
+  tokenIn: Address;
+  tokenOut: Address;
+  amountOut: bigint;
+  fee: number;
+  chainId: number;
+  client: PublicClient;
+}): Promise<bigint> {
+  const quote = await client.simulateContract({
+    abi: uniswapQuoterABI,
+    address: UniswapQuoterAddress[
+      chainId as keyof typeof UniswapQuoterAddress
+    ] as Address,
+    functionName: "quoteExactOutputSingle",
+    args: [
+      {
+        tokenIn,
+        tokenOut,
+        amount: amountOut,
+        fee,
+        sqrtPriceLimitX96: 0n,
+      },
+    ],
+  });
+
+  return quote.result[0];
+}
+
+/**
+ * Fetches a quote for selling an exact amount of erc20z to the uniswap pool
+ *
+ * @param tokenIn - the token to sell (will be erc20z)
+ * @param tokenOut - the token to purchase (will be weth)
+ * @param amount - the exact amount of erc20z to sell
+ * @param fee - the fee of the pool
+ * @param chainId - the chain id
+ */
+export async function quoteExactInputSingle({
+  tokenIn,
+  tokenOut,
+  amountIn,
+  fee,
+  chainId,
+  client,
+}: {
+  tokenIn: Address;
+  tokenOut: Address;
+  amountIn: bigint;
+  fee: number;
+  chainId: number;
+  client: PublicClient;
+}): Promise<bigint> {
+  const quote = await client.simulateContract({
+    abi: uniswapQuoterABI,
+    address: UniswapQuoterAddress[
+      chainId as keyof typeof UniswapQuoterAddress
+    ] as Address,
+    functionName: "quoteExactInputSingle",
+    args: [
+      {
+        tokenIn,
+        tokenOut,
+        amountIn,
+        fee,
+        sqrtPriceLimitX96: 0n,
+      },
+    ],
+  });
+
+  return quote.result[0];
+}

package/src/secondary/uniswap/uniswapReserves.ts

@@ -0,0 +1,34 @@
+import { createPublicClient, http } from "viem";
+import { mainnet } from "viem/chains";
+import { uniswapV2USDCAbi } from "./abis";
+
+const uniswapV2USDCMainnetAddress =
+  "0xb4e16d0168e52d35cacd2c6185b44281ec28c9dc";
+
+export function getUniswapV2USDCReserves() {
+  const mainnetClient = createPublicClient({
+    chain: mainnet,
+    transport: http(),
+  });
+  return mainnetClient.readContract({
+    address: uniswapV2USDCMainnetAddress,
+    abi: uniswapV2USDCAbi,
+    functionName: "getReserves",
+  });
+}
+
+function toEthPriceInUSDC({
+  reserve0,
+  reserve1,
+}: {
+  reserve0: bigint;
+  reserve1: bigint;
+}) {
+  return Number((reserve0 * BigInt(1e14)) / reserve1) / 1e2;
+}
+
+// returns the ETH price in USDC
+export async function getEthPriceInUSDC() {
+  const reserves = await getUniswapV2USDCReserves();
+  return toEthPriceInUSDC({ reserve0: reserves[0], reserve1: reserves[1] });
+}

package/src/secondary/utils.ts

@@ -0,0 +1,40 @@
+import { Address } from "viem";
+import { PublicClient } from "src/utils";
+import {
+  zoraTimedSaleStrategyABI,
+  zoraTimedSaleStrategyAddress,
+} from "@zoralabs/protocol-deployments";
+import { SecondaryInfo } from "./types";
+export async function getSecondaryInfo({
+  contract,
+  tokenId,
+  publicClient,
+  chainId,
+}: {
+  contract: Address;
+  tokenId: bigint;
+  publicClient: PublicClient;
+  chainId: number;
+}): Promise<SecondaryInfo | undefined> {
+  const result = await publicClient.readContract({
+    abi: zoraTimedSaleStrategyABI,
+    address:
+      zoraTimedSaleStrategyAddress[
+        chainId as keyof typeof zoraTimedSaleStrategyAddress
+      ],
+    functionName: "sale",
+    args: [contract, tokenId],
+  });
+
+  // if there is no erc20zAddress, we can assume that secondary market has not been configured for this contract and token.
+  if (!result.erc20zAddress) {
+    return undefined;
+  }
+
+  return {
+    erc20z: result.erc20zAddress,
+    pool: result.poolAddress,
+    secondaryActivated: result.secondaryActivated,
+    saleEnd: result.saleEnd === 0n ? undefined : result.saleEnd,
+  };
+}

package/src/sparks/sparks-contracts.ts

@@ -27,9 +27,7 @@ import {
   encodeFunctionData,
   zeroAddress,
 } from "viem";
-
-const addressOrAccountAddress = (address: Address | Account) =>
-  typeof address === "string" ? address : address.address;
+import { addressOrAccountAddress } from "src/utils";
 
 /**
  * Constructs the parameters to mint a MINT with ETH on the ZoraMintsManager based on the price of the currently mintable ETH token.

package/src/types.ts

@@ -1,13 +1,12 @@
-import {
-  Account,
-  Address,
-  PublicClient,
-  SimulateContractParameters,
-} from "viem";
+import { Account, Address, SimulateContractParameters } from "viem";
+import { PublicClient } from "src/utils";
 
 export type GenericTokenIdTypes = number | bigint | string;
 
-export type IPublicClient = Pick<PublicClient, "readContract" | "getBlock">;
+export type IPublicClient = Pick<
+  PublicClient,
+  "readContract" | "getBlock" | "simulateContract" | "getBalance"
+>;
 
 export type SimulateContractParametersWithAccount = SimulateContractParameters<
   any,

package/src/utils.ts

@@ -5,7 +5,10 @@ export const makeContractParameters = (
   args: SimulateContractParametersWithAccount,
 ) => args;
 
-export type PublicClient = Pick<BasePublicClient, "readContract" | "getBlock">;
+export type PublicClient = Pick<
+  BasePublicClient,
+  "readContract" | "getBlock" | "simulateContract" | "getBalance"
+>;
 
 export type ClientConfig = {
   /** The chain that the client is to run on. */
@@ -37,3 +40,6 @@ export function mintRecipientOrAccount({
 export type Concrete<Type> = {
   [Property in keyof Type]-?: Type[Property];
 };
+
+export const addressOrAccountAddress = (address: Address | Account) =>
+  typeof address === "string" ? address : address.address;