@zero-tech/zauction-sdk 0.2.9 → 0.2.11

package/src/subgraph/client.ts

@@ -0,0 +1,62 @@
+import * as apollo from "@apollo/client/core";
+import fetch from "cross-fetch";
+import {
+  TokenBuy,
+  TokenBuyNowListingCollection,
+  TokenSale,
+  TokenSaleCollection,
+} from "../types";
+import * as actions from "./actions";
+import { getLogger } from "../utilities";
+
+export interface SubgraphClient {
+  listSales: (contract: string, tokenId: string) => Promise<TokenSale[]>;
+  listBuyNowSales: (contract: string, tokenId: string) => Promise<TokenBuy[]>;
+  listAllSales: () => Promise<TokenSaleCollection>;
+  listAllBuyNowListings: () => Promise<TokenBuyNowListingCollection>;
+}
+
+const createApolloClient = (
+  subgraphUri: string
+): apollo.ApolloClient<apollo.NormalizedCacheObject> => {
+  const client = new apollo.ApolloClient({
+    link: new apollo.HttpLink({ uri: subgraphUri, fetch }),
+    cache: new apollo.InMemoryCache(),
+  });
+
+  return client;
+};
+
+export const createClient = (
+  subgraphUri: string,
+  wildToken: string
+): SubgraphClient => {
+  const apolloClient = createApolloClient(subgraphUri);
+
+  const logger = getLogger("subgraph:client");
+  const subgraphClient: SubgraphClient = {
+    listSales: (contract: string, tokenId: string) => {
+      logger.debug(`Get sales for domain: ${tokenId}`);
+      return actions.listSales(apolloClient, contract, tokenId, wildToken);
+    },
+    listBuyNowSales: (contract: string, tokenId: string) => {
+      logger.debug(`Get "buy now" sales for domain: ${tokenId}`);
+      return actions.listBuyNowSales(
+        apolloClient,
+        contract,
+        tokenId,
+        wildToken
+      );
+    },
+    listAllSales: () => {
+      logger.debug(`Get all sales`);
+      return actions.listAllSales(apolloClient, wildToken);
+    },
+    listAllBuyNowListings: () => {
+      logger.debug(`Get all buy now listings`);
+      return actions.listAllBuyNowListings(apolloClient, wildToken);
+    },
+  };
+
+  return subgraphClient;
+};

package/src/subgraph/helpers/index.ts

@@ -0,0 +1,39 @@
+import { ApolloClient, DocumentNode } from "@apollo/client/core";
+import {
+  ListAllSalesQueryOptions,
+  ListSalesQueryOptions,
+  TokenSalesDto,
+} from "../types";
+import { TokenSale } from "../../types";
+
+export const listSales = async <T>(
+  apolloClient: ApolloClient<T>,
+  query: DocumentNode,
+  variables: ListSalesQueryOptions | ListAllSalesQueryOptions,
+  wildToken: string
+): Promise<TokenSale[]> => {
+  const queryResult = await apolloClient.query<TokenSalesDto>({
+    query: query,
+    variables: variables,
+  });
+
+  if (queryResult.error) {
+    throw queryResult.error;
+  }
+
+  const sales: TokenSale[] = queryResult.data.tokenSales.map((e) => {
+    const sale: TokenSale = {
+      bidNonce: e.bidNonce,
+      timestamp: e.timestamp,
+      tokenId: e.tokenId,
+      contract: e.contractAddress,
+      saleAmount: e.amount,
+      seller: e.seller.id,
+      buyer: e.buyer.id,
+      paymentToken: e.paymentToken ?? wildToken,
+      topLevelDomainId: e.topLevelDomainId,
+    };
+    return sale;
+  });
+  return sales;
+};

package/src/subgraph/index.ts

@@ -0,0 +1 @@
+export * from "./client";

package/src/subgraph/queries.ts

@@ -0,0 +1,75 @@
+import { gql } from "@apollo/client/core";
+
+export const getTokenSalesForNftQuery = gql`
+  query TokenSales($contract: Bytes!, $tokenId: ID!) {
+    tokenSales(where: { tokenId: $tokenId, contractAddress: $contract }) {
+      id
+      bidNonce
+      tokenId
+      contractAddress
+      amount
+      buyer {
+        id
+      }
+      seller {
+        id
+      }
+      timestamp
+      paymentToken
+      topLevelDomainId
+    }
+  }
+`;
+
+export const getBuyNowTokenSales = gql`
+  query DomainTokenSolds($tokenId: String!, $contractAddress: Bytes!) {
+    domainTokenSolds(
+      where: { tokenId: $tokenId, contractAddress: $contractAddress }
+    ) {
+      id
+      buyer {
+        id
+      }
+      seller {
+        id
+      }
+      amount
+      tokenId
+      contractAddress
+      timestamp
+      paymentToken
+      topLevelDomainId
+    }
+  }
+`;
+
+export const getBuyNowTokenListings = gql`
+  query BuyNowListings($count: Int!, $skipCount: Int!) {
+    buyNowListings(first: $count, skip: $skipCount) {
+      id
+      amount
+      paymentToken
+    }
+  }
+`;
+
+export const getAllTokenSales = gql`
+  query TokenSales($count: Int!, $skipCount: Int!) {
+    tokenSales(first: $count, skip: $skipCount) {
+      id
+      bidNonce
+      tokenId
+      contractAddress
+      amount
+      buyer {
+        id
+      }
+      seller {
+        id
+      }
+      timestamp
+      paymentToken
+      topLevelDomainId
+    }
+  }
+`;

package/src/subgraph/types.ts

@@ -0,0 +1,58 @@
+export interface AccountDto {
+  id: string;
+}
+
+export interface BuyNowListingDto {
+  id: string; // Will be the tokenId
+  amount: string;
+  paymentToken: string;
+}
+
+export interface TokenBuyNowListingsDto {
+  buyNowListings: BuyNowListingDto[];
+}
+
+export interface TokenSaleDto {
+  id: string;
+  bidNonce: string;
+  tokenId: string;
+  contractAddress: string;
+  amount: string;
+  buyer: AccountDto;
+  seller: AccountDto;
+  timestamp: string;
+  paymentToken?: string;
+  topLevelDomainId: string;
+}
+
+export interface TokenSalesDto {
+  tokenSales: TokenSaleDto[];
+}
+
+export interface TokenBuyNowSaleDto {
+  id: string;
+  buyer: AccountDto;
+  seller: AccountDto;
+  amount: string;
+  tokenId: string;
+  contractAddress: string;
+  timestamp: string;
+  paymentToken?: string;
+  topLevelDomainId: string;
+}
+
+export interface TokenBuyNowSalesDto {
+  domainTokenSolds: TokenBuyNowSaleDto[];
+}
+
+export interface ListAllSalesQueryOptions {
+  count: number;
+  skipCount: number;
+}
+
+export type ListAllBuyNowListingsQueryOptions = ListAllSalesQueryOptions;
+
+export interface ListSalesQueryOptions {
+  contract: string;
+  tokenId: string;
+}

package/src/types.ts

@@ -0,0 +1,181 @@
+import { ethers } from "ethers";
+import { Bid } from "./api/types";
+import { Maybe } from "./utilities";
+export { Bid };
+
+export interface Config {
+  apiUri: string;
+  subgraphUri: string;
+  zAuctionAddress: string;
+  zAuctionLegacyAddress: string;
+  wildTokenAddress: string;
+  znsHubAddress: string;
+  web3Provider: ethers.providers.Web3Provider;
+}
+
+export interface Instance {
+  listSales: (tokenId: string) => Promise<TokenSale[]>;
+  listAllSales: () => Promise<TokenSaleCollection>;
+  listAllBuyNowListings: () => Promise<TokenBuyNowListingCollection>;
+  listBuyNowSales: (tokenId: string) => Promise<TokenBuy[]>;
+  listBids: (
+    tokenIds: string[],
+    filter?: TokenBidFilter
+  ) => Promise<TokenBidCollection>;
+  listBidsByAccount: (account: string) => Promise<Bid[]>;
+  placeBid: (
+    params: NewBidParameters,
+    signer: ethers.Signer,
+    statusCallback?: PlaceBidStatusCallback
+  ) => Promise<void>;
+  isZAuctionApprovedToTransferNftByBid: (
+    account: string,
+    bid: Bid
+  ) => Promise<boolean>;
+  isZAuctionApprovedToTransferNftByDomain: (
+    account: string,
+    tokenId: string
+  ) => Promise<boolean>;
+  isZAuctionLegacyApprovedToTransferNft: (
+    account: string,
+    tokenId: string
+  ) => Promise<boolean>;
+  getZAuctionSpendAllowanceByBid: (
+    account: string,
+    bid: Bid
+  ) => Promise<ethers.BigNumber>;
+  getZAuctionSpendAllowanceByDomain: (
+    account: string,
+    tokenId: string
+  ) => Promise<ethers.BigNumber>;
+  getZAuctionSpendAllowance: (
+    account: string,
+    paymentTokenAddress: string
+  ) => Promise<ethers.BigNumber>;
+  getZAuctionLegacySpendAllowance: (
+    account: string
+  ) => Promise<ethers.BigNumber>;
+  setNetworkPaymentToken: (
+    networkId: string,
+    domainNetworkToken: string,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  getPaymentTokenForDomain: (domainTokenId: string) => Promise<string>;
+  approveZAuctionSpendPaymentTokenByBid: (
+    bid: Bid,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  approveZAuctionSpendPaymentTokenByDomain: (
+    tokenId: string,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  approveZAuctionSpendPaymentToken: (
+    paymentTokenAddress: string,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  approveZAuctionTransferNftByBid: (
+    bid: Bid,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  approveZAuctionTransferNftByDomain: (
+    tokenId: string,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  acceptBid: (
+    bid: Bid,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  cancelBid: (
+    bid: Bid,
+    cancelOnChain: boolean,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction | void>;
+  buyNow: (
+    params: BuyNowParams,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  getBuyNowListing: (tokenId: string) => Promise<Maybe<BuyNowListing>>;
+  setBuyNowPrice: (
+    params: BuyNowParams,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+  cancelBuyNow: (
+    tokenId: string,
+    signer: ethers.Signer
+  ) => Promise<ethers.ContractTransaction>;
+}
+
+export interface TokenSale {
+  contract: string;
+  bidNonce: string;
+  tokenId: string;
+  saleAmount: string;
+  buyer: string;
+  seller: string;
+  timestamp: string;
+  paymentToken: string;
+  topLevelDomainId: string;
+}
+
+export interface TokenBuy {
+  buyer: string;
+  seller: string;
+  amount: string;
+  contract: string;
+  tokenId: string;
+  timestamp: string;
+  paymentToken: string;
+  topLevelDomainId: string;
+}
+
+export interface TokenBuyNowListing {
+  tokenId: string;
+  amount: string;
+  paymentToken: string;
+}
+
+export interface TokenBuyNowListingCollection {
+  [tokenId: string]: TokenBuyNowListing[];
+}
+
+export interface TokenSaleCollection {
+  [tokenId: string]: TokenSale[];
+}
+
+export interface TokenBidCollection {
+  [tokenId: string]: Bid[];
+}
+
+export enum TokenBidFilter {
+  All,
+  Active,
+  Cancelled,
+}
+
+export type PlaceBidStatusCallback = (status: PlaceBidStatus) => void;
+
+export enum PlaceBidStatus {
+  Encoding,
+  Signing,
+  Submitting,
+  Completed,
+}
+
+export interface NewBidParameters {
+  tokenId: string;
+  bidAmount: string; // in wei
+  startBlock?: string;
+  expireBlock?: string;
+}
+
+export interface BuyNowParams {
+  amount: string;
+  tokenId: string;
+  paymentToken: string;
+}
+
+export interface BuyNowListing {
+  price: ethers.BigNumber;
+  holder: string;
+  paymentToken: string;
+}

package/src/utilities/index.ts

@@ -0,0 +1,2 @@
+export type Maybe<T> = T | undefined;
+export * from "./logging";

package/src/utilities/logging.ts

@@ -0,0 +1,27 @@
+import { Consola, LogLevel } from "consola";
+
+// For details on logging levels
+// https://github.com/unjs/consola/blob/master/types/consola.d.ts
+const logger = new Consola({ level: LogLevel.Info });
+
+export const getLogger = (tag?: string): Consola => {
+  if (tag) {
+    return logger.withTag(tag);
+  }
+  return logger;
+};
+
+export const setLogLevel = (level?: LogLevel): void => {
+  if (!level || typeof level != "number") {
+    console.log("Provide a number");
+    Object.entries(LogLevel).forEach(([key, value]) => {
+      console.log(`${key}=${value}`);
+    });
+    return;
+  }
+
+  logger.level = level;
+};
+
+/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+(global as any).setZAuctionSDKLogLevel = setLogLevel;