@uniswap/universal-router-sdk 1.4.2 → 1.5.0-beta.0

package/dist/entities/Command.d.ts

@@ -1,13 +1,13 @@
-import { RoutePlanner } from '../utils/routerCommands'
-export declare type TradeConfig = {
-  allowRevert: boolean
-}
-export declare enum RouterTradeType {
-  UniswapTrade = 'UniswapTrade',
-  NFTTrade = 'NFTTrade',
-  UnwrapWETH = 'UnwrapWETH',
-}
-export interface Command {
-  tradeType: RouterTradeType
-  encode(planner: RoutePlanner, config: TradeConfig): void
-}
+import { RoutePlanner } from '../utils/routerCommands';
+export declare type TradeConfig = {
+    allowRevert: boolean;
+};
+export declare enum RouterTradeType {
+    UniswapTrade = "UniswapTrade",
+    NFTTrade = "NFTTrade",
+    UnwrapWETH = "UnwrapWETH"
+}
+export interface Command {
+    tradeType: RouterTradeType;
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+}

package/dist/entities/NFTTrade.d.ts

@@ -1,50 +1,44 @@
-import { BigNumber, BigNumberish } from 'ethers'
-import { SeaportData } from './protocols/seaport'
-import { FoundationData } from './protocols/foundation'
-import { NFTXData } from './protocols/nftx'
-import { NFT20Data } from './protocols/nft20'
-import { RoutePlanner } from '../utils/routerCommands'
-import { Command, RouterTradeType, TradeConfig } from './Command'
-import { LooksRareData } from './protocols/looksRare'
-import { SudoswapData } from './protocols/sudoswap'
-import { CryptopunkData } from './protocols/cryptopunk'
-import { X2Y2Data } from './protocols/x2y2'
-export declare type SupportedProtocolsData =
-  | SeaportData
-  | FoundationData
-  | NFTXData
-  | LooksRareData
-  | X2Y2Data
-  | CryptopunkData
-  | NFT20Data
-  | SudoswapData
-export declare abstract class NFTTrade<T> implements Command {
-  readonly tradeType: RouterTradeType
-  readonly orders: T[]
-  readonly market: Market
-  constructor(market: Market, orders: T[])
-  abstract encode(planner: RoutePlanner, config: TradeConfig): void
-  abstract getBuyItems(): BuyItem[]
-  abstract getTotalPrice(): BigNumber
-}
-export declare type BuyItem = {
-  tokenAddress: string
-  tokenId: BigNumberish
-  tokenType: TokenType
-  amount?: BigNumberish
-}
-export declare enum Market {
-  Foundation = 'foundation',
-  LooksRare = 'looksrare',
-  NFT20 = 'nft20',
-  NFTX = 'nftx',
-  Seaport = 'seaport',
-  Sudoswap = 'Sudoswap',
-  Cryptopunks = 'cryptopunks',
-  X2Y2 = 'x2y2',
-}
-export declare enum TokenType {
-  ERC721 = 'ERC721',
-  ERC1155 = 'ERC1155',
-  Cryptopunk = 'Cryptopunk',
-}
+import { BigNumber, BigNumberish } from 'ethers';
+import { SeaportData } from './protocols/seaport';
+import { FoundationData } from './protocols/foundation';
+import { NFTXData } from './protocols/nftx';
+import { NFT20Data } from './protocols/nft20';
+import { RoutePlanner } from '../utils/routerCommands';
+import { Command, RouterTradeType, TradeConfig } from './Command';
+import { LooksRareData } from './protocols/looksRare';
+import { SudoswapData } from './protocols/sudoswap';
+import { CryptopunkData } from './protocols/cryptopunk';
+import { X2Y2Data } from './protocols/x2y2';
+import { ElementData } from './protocols/element-market';
+export declare type SupportedProtocolsData = SeaportData | FoundationData | NFTXData | LooksRareData | X2Y2Data | CryptopunkData | NFT20Data | SudoswapData | ElementData;
+export declare abstract class NFTTrade<T> implements Command {
+    readonly tradeType: RouterTradeType;
+    readonly orders: T[];
+    readonly market: Market;
+    constructor(market: Market, orders: T[]);
+    abstract encode(planner: RoutePlanner, config: TradeConfig): void;
+    abstract getBuyItems(): BuyItem[];
+    abstract getTotalPrice(token?: string): BigNumber;
+}
+export declare type BuyItem = {
+    tokenAddress: string;
+    tokenId: BigNumberish;
+    tokenType: TokenType;
+    amount?: BigNumberish;
+};
+export declare enum Market {
+    Foundation = "foundation",
+    LooksRare = "looksrare",
+    NFT20 = "nft20",
+    NFTX = "nftx",
+    Seaport = "seaport",
+    Sudoswap = "Sudoswap",
+    Cryptopunks = "cryptopunks",
+    X2Y2 = "x2y2",
+    Element = "element"
+}
+export declare enum TokenType {
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155",
+    Cryptopunk = "Cryptopunk"
+}

package/dist/entities/index.d.ts

@@ -1,3 +1,3 @@
-export * from './protocols'
-export * from './NFTTrade'
-export * from './Command'
+export * from './protocols';
+export * from './NFTTrade';
+export * from './Command';

package/dist/entities/protocols/cryptopunk.d.ts

@@ -1,16 +1,16 @@
-import { TradeConfig } from '../Command'
-import { NFTTrade, BuyItem } from '../NFTTrade'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-export declare type CryptopunkData = {
-  tokenId: BigNumberish
-  recipient: string
-  value: BigNumberish
-}
-export declare class CryptopunkTrade extends NFTTrade<CryptopunkData> {
-  static CRYPTOPUNK_ADDRESS: string
-  constructor(orders: CryptopunkData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
+import { TradeConfig } from '../Command';
+import { NFTTrade, BuyItem } from '../NFTTrade';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+export declare type CryptopunkData = {
+    tokenId: BigNumberish;
+    recipient: string;
+    value: BigNumberish;
+};
+export declare class CryptopunkTrade extends NFTTrade<CryptopunkData> {
+    static CRYPTOPUNK_ADDRESS: string;
+    constructor(orders: CryptopunkData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}

package/dist/entities/protocols/element-market.d.ts

@@ -0,0 +1,44 @@
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber } from 'ethers';
+export interface Fee {
+    recipient: string;
+    amount: string;
+    feeData: string;
+}
+declare type ElementPartialData = {
+    maker: string;
+    taker: string;
+    expiry: string;
+    nonce: string;
+    erc20Token: string;
+    erc20TokenAmount: string;
+    fees: Fee[];
+};
+export declare type ERC721SellOrder = ElementPartialData & {
+    nft: string;
+    nftId: string;
+};
+export declare type OrderSignature = {
+    signatureType: number;
+    v: number;
+    r: string;
+    s: string;
+};
+export declare type ElementData = {
+    order: ERC721SellOrder;
+    signature: OrderSignature;
+    recipient: string;
+};
+export declare class ElementTrade extends NFTTrade<ElementData> {
+    private static ETH_ADDRESS;
+    static INTERFACE: Interface;
+    constructor(orders: ElementData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+    getOrderPriceIncludingFees(order: ERC721SellOrder): BigNumber;
+}
+export {};

package/dist/entities/protocols/foundation.d.ts

@@ -1,19 +1,19 @@
-import { Interface } from '@ethersproject/abi'
-import { BuyItem, NFTTrade } from '../NFTTrade'
-import { TradeConfig } from '../Command'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-export declare type FoundationData = {
-  recipient: string
-  tokenAddress: string
-  tokenId: BigNumberish
-  price: BigNumberish
-  referrer: string
-}
-export declare class FoundationTrade extends NFTTrade<FoundationData> {
-  static INTERFACE: Interface
-  constructor(orders: FoundationData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+export declare type FoundationData = {
+    recipient: string;
+    tokenAddress: string;
+    tokenId: BigNumberish;
+    price: BigNumberish;
+    referrer: string;
+};
+export declare class FoundationTrade extends NFTTrade<FoundationData> {
+    static INTERFACE: Interface;
+    constructor(orders: FoundationData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}

package/dist/entities/protocols/index.d.ts

@@ -1,10 +1,10 @@
-export * from './cryptopunk'
-export * from './foundation'
-export * from './looksRare'
-export * from './nft20'
-export * from './nftx'
-export * from './seaport'
-export * from './uniswap'
-export * from './sudoswap'
-export * from './x2y2'
-export * from './unwrapWETH'
+export * from './cryptopunk';
+export * from './foundation';
+export * from './looksRare';
+export * from './nft20';
+export * from './nftx';
+export * from './seaport';
+export * from './uniswap';
+export * from './sudoswap';
+export * from './x2y2';
+export * from './unwrapWETH';

package/dist/entities/protocols/looksRare.d.ts

@@ -1,44 +1,44 @@
-import { Interface } from '@ethersproject/abi'
-import { BuyItem, NFTTrade, TokenType } from '../NFTTrade'
-import { TradeConfig } from '../Command'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-export declare type MakerOrder = {
-  collection: string
-  tokenId: BigNumberish
-  isOrderAsk: true
-  signer: string
-  strategy: string
-  currency: string
-  amount: BigNumberish
-  price: BigNumberish
-  minPercentageToAsk: BigNumberish
-  nonce: BigNumberish
-  startTime: BigNumberish
-  endTime: BigNumberish
-  v: BigNumberish
-  r: string
-  s: string
-  params: string
-}
-export declare type TakerOrder = {
-  minPercentageToAsk: BigNumberish
-  price: BigNumberish
-  taker: string
-  tokenId: BigNumberish
-  isOrderAsk: boolean
-  params: string
-}
-export declare type LooksRareData = {
-  makerOrder: MakerOrder
-  takerOrder: TakerOrder
-  recipient: string
-  tokenType: TokenType
-}
-export declare class LooksRareTrade extends NFTTrade<LooksRareData> {
-  static INTERFACE: Interface
-  constructor(orders: LooksRareData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade, TokenType } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+export declare type MakerOrder = {
+    collection: string;
+    tokenId: BigNumberish;
+    isOrderAsk: true;
+    signer: string;
+    strategy: string;
+    currency: string;
+    amount: BigNumberish;
+    price: BigNumberish;
+    minPercentageToAsk: BigNumberish;
+    nonce: BigNumberish;
+    startTime: BigNumberish;
+    endTime: BigNumberish;
+    v: BigNumberish;
+    r: string;
+    s: string;
+    params: string;
+};
+export declare type TakerOrder = {
+    minPercentageToAsk: BigNumberish;
+    price: BigNumberish;
+    taker: string;
+    tokenId: BigNumberish;
+    isOrderAsk: boolean;
+    params: string;
+};
+export declare type LooksRareData = {
+    makerOrder: MakerOrder;
+    takerOrder: TakerOrder;
+    recipient: string;
+    tokenType: TokenType;
+};
+export declare class LooksRareTrade extends NFTTrade<LooksRareData> {
+    static INTERFACE: Interface;
+    constructor(orders: LooksRareData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}

package/dist/entities/protocols/nft20.d.ts

@@ -1,21 +1,21 @@
-import { Interface } from '@ethersproject/abi'
-import { TradeConfig } from '../Command'
-import { NFTTrade, BuyItem } from '../NFTTrade'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-export declare type NFT20Data = {
-  tokenAddress: string
-  tokenIds: BigNumberish[]
-  tokenAmounts: BigNumberish[]
-  recipient: string
-  fee: BigNumberish
-  isV3: boolean
-  value: BigNumberish
-}
-export declare class NFT20Trade extends NFTTrade<NFT20Data> {
-  static INTERFACE: Interface
-  constructor(orders: NFT20Data[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
+import { Interface } from '@ethersproject/abi';
+import { TradeConfig } from '../Command';
+import { NFTTrade, BuyItem } from '../NFTTrade';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+export declare type NFT20Data = {
+    tokenAddress: string;
+    tokenIds: BigNumberish[];
+    tokenAmounts: BigNumberish[];
+    recipient: string;
+    fee: BigNumberish;
+    isV3: boolean;
+    value: BigNumberish;
+};
+export declare class NFT20Trade extends NFTTrade<NFT20Data> {
+    static INTERFACE: Interface;
+    constructor(orders: NFT20Data[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}

package/dist/entities/protocols/nftx.d.ts

@@ -1,20 +1,20 @@
-import { Interface } from '@ethersproject/abi'
-import { BuyItem, NFTTrade } from '../NFTTrade'
-import { TradeConfig } from '../Command'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-export declare type NFTXData = {
-  recipient: string
-  vaultAddress: string
-  vaultId: BigNumberish
-  tokenAddress: string
-  tokenIds: BigNumberish[]
-  value: BigNumber
-}
-export declare class NFTXTrade extends NFTTrade<NFTXData> {
-  static INTERFACE: Interface
-  constructor(orders: NFTXData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+export declare type NFTXData = {
+    recipient: string;
+    vaultAddress: string;
+    vaultId: BigNumberish;
+    tokenAddress: string;
+    tokenIds: BigNumberish[];
+    value: BigNumber;
+};
+export declare class NFTXTrade extends NFTTrade<NFTXData> {
+    static INTERFACE: Interface;
+    constructor(orders: NFTXData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}

package/dist/entities/protocols/seaport.d.ts

@@ -1,63 +1,68 @@
-import { BigNumber, BigNumberish } from 'ethers'
-import { Interface } from '@ethersproject/abi'
-import { BuyItem, NFTTrade } from '../NFTTrade'
-import { TradeConfig } from '../Command'
-import { RoutePlanner } from '../../utils/routerCommands'
-export declare enum SeaportVersion {
-  V1_1 = 0,
-  V1_4 = 1,
-}
-export declare type SeaportData = {
-  items: Order[]
-  recipient: string
-  version: SeaportVersion
-}
-export declare type FulfillmentComponent = {
-  orderIndex: BigNumberish
-  itemIndex: BigNumberish
-}
-export declare type OfferItem = {
-  itemType: BigNumberish
-  token: string
-  identifierOrCriteria: BigNumberish
-  startAmount: BigNumberish
-  endAmount: BigNumberish
-}
-export declare type ConsiderationItem = OfferItem & {
-  recipient: string
-}
-export declare type Order = {
-  parameters: OrderParameters
-  signature: string
-}
-declare type OrderParameters = {
-  offerer: string
-  offer: OfferItem[]
-  consideration: ConsiderationItem[]
-  orderType: BigNumberish
-  startTime: BigNumberish
-  endTime: BigNumberish
-  zoneHash: string
-  zone: string
-  salt: BigNumberish
-  conduitKey: string
-  totalOriginalConsiderationItems: BigNumberish
-}
-export declare type AdvancedOrder = Order & {
-  numerator: BigNumber
-  denominator: BigNumber
-  extraData: string
-}
-export declare class SeaportTrade extends NFTTrade<SeaportData> {
-  static INTERFACE: Interface
-  static OPENSEA_CONDUIT_KEY: string
-  constructor(orders: SeaportData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-  private commandMap
-  private getConsiderationFulfillments
-  private getAdvancedOrderParams
-  private calculateValue
-}
-export {}
+import { BigNumber, BigNumberish } from 'ethers';
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { Permit2Permit } from '../../utils/inputTokens';
+export declare type SeaportData = {
+    items: Order[];
+    recipient: string;
+    protocolAddress: string;
+    inputTokenProcessing?: InputTokenProcessing[];
+};
+export declare type InputTokenProcessing = {
+    token: string;
+    permit2Permit?: Permit2Permit;
+    protocolApproval: boolean;
+    permit2TransferFrom: boolean;
+};
+export declare type FulfillmentComponent = {
+    orderIndex: BigNumberish;
+    itemIndex: BigNumberish;
+};
+export declare type OfferItem = {
+    itemType: BigNumberish;
+    token: string;
+    identifierOrCriteria: BigNumberish;
+    startAmount: BigNumberish;
+    endAmount: BigNumberish;
+};
+export declare type ConsiderationItem = OfferItem & {
+    recipient: string;
+};
+export declare type Order = {
+    parameters: OrderParameters;
+    signature: string;
+};
+declare type OrderParameters = {
+    offerer: string;
+    offer: OfferItem[];
+    consideration: ConsiderationItem[];
+    orderType: BigNumberish;
+    startTime: BigNumberish;
+    endTime: BigNumberish;
+    zoneHash: string;
+    zone: string;
+    salt: BigNumberish;
+    conduitKey: string;
+    totalOriginalConsiderationItems: BigNumberish;
+};
+export declare type AdvancedOrder = Order & {
+    numerator: BigNumber;
+    denominator: BigNumber;
+    extraData: string;
+};
+export declare class SeaportTrade extends NFTTrade<SeaportData> {
+    static INTERFACE: Interface;
+    static OPENSEA_CONDUIT_KEY: string;
+    constructor(orders: SeaportData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalOrderPrice(order: SeaportData, token?: string): BigNumber;
+    getTotalPrice(token?: string): BigNumber;
+    private commandMap;
+    private getConsiderationFulfillments;
+    private getAdvancedOrderParams;
+    private calculateValue;
+}
+export {};

package/dist/entities/protocols/sudoswap.d.ts

@@ -1,27 +1,27 @@
-import { Interface } from '@ethersproject/abi'
-import { BuyItem, NFTTrade } from '../NFTTrade'
-import { TradeConfig } from '../Command'
-import { RoutePlanner } from '../../utils/routerCommands'
-import { BigNumber, BigNumberish } from 'ethers'
-declare type PairSwap = {
-  swapInfo: {
-    pair: string
-    nftIds: BigNumberish[]
-  }
-  tokenAddress: string
-  maxCost: BigNumberish
-}
-export declare type SudoswapData = {
-  swaps: PairSwap[]
-  nftRecipient: string
-  ethRecipient: string
-  deadline: BigNumberish
-}
-export declare class SudoswapTrade extends NFTTrade<SudoswapData> {
-  static INTERFACE: Interface
-  constructor(orders: SudoswapData[])
-  encode(planner: RoutePlanner, config: TradeConfig): void
-  getBuyItems(): BuyItem[]
-  getTotalPrice(): BigNumber
-}
-export {}
+import { Interface } from '@ethersproject/abi';
+import { BuyItem, NFTTrade } from '../NFTTrade';
+import { TradeConfig } from '../Command';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { BigNumber, BigNumberish } from 'ethers';
+declare type PairSwap = {
+    swapInfo: {
+        pair: string;
+        nftIds: BigNumberish[];
+    };
+    tokenAddress: string;
+    maxCost: BigNumberish;
+};
+export declare type SudoswapData = {
+    swaps: PairSwap[];
+    nftRecipient: string;
+    ethRecipient: string;
+    deadline: BigNumberish;
+};
+export declare class SudoswapTrade extends NFTTrade<SudoswapData> {
+    static INTERFACE: Interface;
+    constructor(orders: SudoswapData[]);
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+    getBuyItems(): BuyItem[];
+    getTotalPrice(): BigNumber;
+}
+export {};