@imtbl/sdk 0.8.0-alpha → 0.11.0-alpha

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="global.d.ts" />
 /// <reference types="node" />
 import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1, ProviderConfiguration as ProviderConfiguration$1, ExchangeContracts } from 'config';
-import { OrderbookOverrides } from 'config/config';
+import { OrderbookOverrides, OrderbookModuleConfiguration } from 'config/config';
 import { ListingResult, ListListingsResult, OrdersService } from 'openapi/sdk';
 import { ListListingsParams as ListListingsParams$1, PrepareListingParams as PrepareListingParams$1, PrepareListingResponse as PrepareListingResponse$1, CreateListingParams as CreateListingParams$1, FulfillOrderResponse as FulfillOrderResponse$1, CancelOrderResponse as CancelOrderResponse$2 } from 'types';
 
@@ -13051,6 +13051,11 @@ declare class Orderbook {
     private seaport;
     private orderbookConfig;
     constructor(config: ModuleConfiguration<OrderbookOverrides>);
+    /**
+     * Return the configuration for the orderbook module.
+     * @return {OrderbookModuleConfiguration} The configuration for the orderbook module.
+     */
+    config(): OrderbookModuleConfiguration;
     /**
      * Get an order by ID
      * @param {string} listingId - The listingId to find.
@@ -13098,13 +13103,17 @@ declare class Orderbook {
     cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse$2>;
 }
 
+declare const constants: {
+    estimatedFulfillmentGasGwei: number;
+};
+
 declare enum OrderType {
     FULL_OPEN = 0,
     PARTIAL_OPEN = 1,
     FULL_RESTRICTED = 2,
     PARTIAL_RESTRICTED = 3
 }
-declare enum ItemType {
+declare enum ItemType$1 {
     NATIVE = 0,
     ERC20 = 1,
     ERC721 = 2,
@@ -13114,14 +13123,14 @@ declare enum ItemType {
 }
 
 type OfferItem = {
-    itemType: ItemType;
+    itemType: ItemType$1;
     token: string;
     identifierOrCriteria: string;
     startAmount: string;
     endAmount: string;
 };
 type ConsiderationItem = {
-    itemType: ItemType;
+    itemType: ItemType$1;
     token: string;
     identifierOrCriteria: string;
     startAmount: string;
@@ -13145,17 +13154,17 @@ type OrderComponents = OrderParameters & {
     counter: BigNumberish;
 };
 
-interface ERC721Item {
+interface ERC721Item$1 {
     type: 'ERC721';
     contractAddress: string;
     tokenId: string;
 }
-interface ERC20Item {
+interface ERC20Item$1 {
     type: 'ERC20';
     contractAddress: string;
     amount: string;
 }
-interface NativeItem {
+interface NativeItem$1 {
     type: 'NATIVE';
     amount: string;
 }
@@ -13165,8 +13174,8 @@ interface RoyaltyInfo {
 }
 interface PrepareListingParams {
     makerAddress: string;
-    sell: ERC721Item;
-    buy: ERC20Item | NativeItem;
+    sell: ERC721Item$1;
+    buy: ERC20Item$1 | NativeItem$1;
     orderExpiry?: Date;
 }
 interface PrepareListingResponse {
@@ -13219,11 +13228,8 @@ type orderbook_d_ActionType = ActionType;
 declare const orderbook_d_ActionType: typeof ActionType;
 type orderbook_d_CancelOrderResponse = CancelOrderResponse;
 type orderbook_d_CreateListingParams = CreateListingParams;
-type orderbook_d_ERC20Item = ERC20Item;
-type orderbook_d_ERC721Item = ERC721Item;
 type orderbook_d_FulfillOrderResponse = FulfillOrderResponse;
 type orderbook_d_ListListingsParams = ListListingsParams;
-type orderbook_d_NativeItem = NativeItem;
 type orderbook_d_Orderbook = Orderbook;
 declare const orderbook_d_Orderbook: typeof Orderbook;
 type orderbook_d_PrepareListingParams = PrepareListingParams;
@@ -13236,17 +13242,18 @@ type orderbook_d_TransactionAction = TransactionAction;
 type orderbook_d_TransactionBuilder = TransactionBuilder;
 type orderbook_d_TransactionPurpose = TransactionPurpose;
 declare const orderbook_d_TransactionPurpose: typeof TransactionPurpose;
+declare const orderbook_d_constants: typeof constants;
 declare namespace orderbook_d {
   export {
     orderbook_d_Action as Action,
     orderbook_d_ActionType as ActionType,
     orderbook_d_CancelOrderResponse as CancelOrderResponse,
     orderbook_d_CreateListingParams as CreateListingParams,
-    orderbook_d_ERC20Item as ERC20Item,
-    orderbook_d_ERC721Item as ERC721Item,
+    ERC20Item$1 as ERC20Item,
+    ERC721Item$1 as ERC721Item,
     orderbook_d_FulfillOrderResponse as FulfillOrderResponse,
     orderbook_d_ListListingsParams as ListListingsParams,
-    orderbook_d_NativeItem as NativeItem,
+    NativeItem$1 as NativeItem,
     orderbook_d_Orderbook as Orderbook,
     orderbook_d_PrepareListingParams as PrepareListingParams,
     orderbook_d_PrepareListingResponse as PrepareListingResponse,
@@ -13256,6 +13263,7 @@ declare namespace orderbook_d {
     orderbook_d_TransactionAction as TransactionAction,
     orderbook_d_TransactionBuilder as TransactionBuilder,
     orderbook_d_TransactionPurpose as TransactionPurpose,
+    orderbook_d_constants as constants,
   };
 }
 
@@ -13394,6 +13402,131 @@ interface GetAllBalancesParams {
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+/**
+ * Interface representing the parameters for {@link Checkout.smartCheckout}
+ * @property {Web3Provider} provider - The provider to use for smart checkout.
+ * @property {ItemRequirement[]} itemRequirements - The item requirements for the transaction.
+ * @property {FulfilmentTransaction | GasAmount} transactionOrGasAmount - The transaction or gas amount.
+ */
+interface SmartCheckoutParams {
+    provider: Web3Provider;
+    itemRequirements: ItemRequirement[];
+    transactionOrGasAmount: FulfilmentTransaction | GasAmount;
+}
+/**
+ * Represents the item requirements for a transaction.
+ * NativeItem, ERC20Item or ERC721Item {@link Checkout.smartCheckout}.
+ */
+type ItemRequirement = NativeItem | ERC20Item | ERC721Item;
+/**
+ * An enum representing the item types
+ * @enum {string}
+ * @property {string} NATIVE - If the item is a native token.
+ * @property {string} ERC20 - If the item is an ERC20 token.
+ * @property {string} ERC721 - If the item is an ERC721 token.
+ */
+declare enum ItemType {
+    NATIVE = "NATIVE",
+    ERC20 = "ERC20",
+    ERC721 = "ERC721"
+}
+/**
+ * Represents a native item.
+ * @property {ItemType} type - The type indicate this is a native item.
+ * @property {BigNumber} amount - The amount of the item.
+ */
+type NativeItem = {
+    type: ItemType.NATIVE;
+    amount: BigNumber;
+};
+/**
+ * Represents an ERC20 item.
+ * @property {ItemType} type - The type to indicate this is an ERC20 item.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ * @property {BigNumber} amount - The amount of the item.
+ * @property {string} spenderAddress - The contract address of the approver.
+ */
+type ERC20Item = {
+    type: ItemType.ERC20;
+    contractAddress: string;
+    amount: BigNumber;
+    spenderAddress: string;
+};
+/**
+ * Represents an ERC721 item.
+ * @property {ItemType} type - The type to indicate this is an ERC721 item.
+ * @property {string} contractAddress - The contract address of the ERC721.
+ * @property {string} id - The ID of this ERC721 in the collection.
+ * @property {string} spenderAddress - The contract address of the approver.
+ */
+type ERC721Item = {
+    type: ItemType.ERC721;
+    contractAddress: string;
+    id: string;
+    spenderAddress: string;
+};
+/**
+ * An enum representing transaction or gas types
+ * @enum {string}
+ * @property {string} TRANSACTION - If the type is a transaction
+ * @property {string} GAS - If the type is the gas amount
+ */
+declare enum TransactionOrGasType {
+    TRANSACTION = "TRANSACTION",
+    GAS = "GAS"
+}
+/**
+ * The fulfilment transaction which contains the transaction to send.
+ * @property {TransactionOrGasType} type - The type to indicate this is a fulfilment transaction.
+ * @property {TransactionRequest} transaction - The transaction to send.
+ */
+type FulfilmentTransaction = {
+    type: TransactionOrGasType.TRANSACTION;
+    transaction: TransactionRequest;
+};
+/**
+ * The gas amount which contains the gas token and the gas limit.
+ * @property {TransactionOrGasType} type - The type to indicate this is a gas amount.
+ * @property {GasToken} gasToken - The gas token.
+ */
+type GasAmount = {
+    type: TransactionOrGasType.GAS;
+    gasToken: GasToken;
+};
+/**
+ * Represents the gas token which is either a native token or an ERC20 token.
+ */
+type GasToken = NativeGas | ERC20Gas;
+/**
+ * An enum representing the gas token types
+ * @enum {string}
+ * @property {string} NATIVE - If the gas token is a native token.
+ * @property {string} ERC20 - If the gas token is an ERC20 token.
+ */
+declare enum GasTokenType {
+    NATIVE = "NATIVE",
+    ERC20 = "ERC20"
+}
+/**
+ * Represents a native gas token.
+ * @property {GasTokenType} type - The type to indicate this is a native gas token.
+ * @property {BigNumber} limit - The gas limit.
+ */
+type NativeGas = {
+    type: GasTokenType.NATIVE;
+    limit: BigNumber;
+};
+/**
+ * Represents an ERC20 gas token.
+ * @property {GasTokenType} type - The type to indicate this is an ERC20 gas token.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ * @property {BigNumber} limit - The gas limit.
+ */
+type ERC20Gas = {
+    type: GasTokenType.ERC20;
+    contractAddress: string;
+    limit: BigNumber;
+};
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -13684,16 +13817,18 @@ interface SendTransactionResult {
  * Enum representing the names of different wallet providers.
  */
 declare enum WalletProviderName {
-    METAMASK = "metamask",
-    PASSPORT = "passport"
+    PASSPORT = "passport",
+    METAMASK = "metamask"
 }
 /**
  * Interface for the parameters required to create a wallet provider {@link Checkout.createProvider}.
  * @interface CreateProviderParams
  * @property {WalletProviderName} walletProvider - The name of the wallet provider.
+ * @property {Passport} passport - The Passport instance to create a Web3Provider.
  */
 interface CreateProviderParams {
     walletProvider: WalletProviderName;
+    passport?: Passport;
 }
 /**
  * Represents the result of creating a Web3 provider {@link Checkout.createProvider}.
@@ -13898,6 +14033,11 @@ declare class Checkout {
      * @param {BuyParams} params - The parameters for the buy.
     */
     buy(params: BuyParams): Promise<void>;
+    /**
+     * Determines the transaction requirements to complete a purchase.
+     * @params {SmartCheckoutParams} params - The parameters for smart checkout.
+     */
+    smartCheckout(params: SmartCheckoutParams): Promise<void>;
     /**
      * Checks if the given object is a Web3 provider.
      * @param {Web3Provider} web3Provider - The object to check.
@@ -13954,6 +14094,7 @@ type checkout_sdk_d_NetworkInfo = NetworkInfo;
 type checkout_sdk_d_RemoteConfiguration = RemoteConfiguration;
 type checkout_sdk_d_SendTransactionParams = SendTransactionParams;
 type checkout_sdk_d_SendTransactionResult = SendTransactionResult;
+type checkout_sdk_d_SmartCheckoutParams = SmartCheckoutParams;
 type checkout_sdk_d_SwitchNetworkParams = SwitchNetworkParams;
 type checkout_sdk_d_SwitchNetworkResult = SwitchNetworkResult;
 type checkout_sdk_d_TokenFilter = TokenFilter;
@@ -14004,6 +14145,7 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_RemoteConfiguration as RemoteConfiguration,
     checkout_sdk_d_SendTransactionParams as SendTransactionParams,
     checkout_sdk_d_SendTransactionResult as SendTransactionResult,
+    checkout_sdk_d_SmartCheckoutParams as SmartCheckoutParams,
     checkout_sdk_d_SwitchNetworkParams as SwitchNetworkParams,
     checkout_sdk_d_SwitchNetworkResult as SwitchNetworkResult,
     checkout_sdk_d_TokenFilter as TokenFilter,