@imtbl/sdk 1.40.0-alpha.1 → 1.40.0-alpha.2

package/dist/index.d.ts

@@ -13318,7 +13318,7 @@ interface BlockchainMetadata$1 {
  * @export
  * @interface Chain
  */
-interface Chain$2 {
+interface Chain$3 {
     /**
      * The id of chain
      * @type {string}
@@ -13362,7 +13362,7 @@ interface Activity$1 {
      * @type {Chain}
      * @memberof Activity
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      *
      * @type {ActivityType}
@@ -13460,7 +13460,7 @@ interface ChainWithDetailsAllOf$1 {
  * @type ChainWithDetails
  * @export
  */
-type ChainWithDetails$1 = Chain$2 & ChainWithDetailsAllOf$1;
+type ChainWithDetails$1 = Chain$3 & ChainWithDetailsAllOf$1;
 
 /**
  * Immutable zkEVM API
@@ -13507,7 +13507,7 @@ interface Collection$1 {
      * @type {Chain}
      * @memberof Collection
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * The name of the collection
      * @type {string}
@@ -13961,7 +13961,7 @@ interface Metadata$1 {
      * @type {Chain}
      * @memberof Metadata
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * The contract address of the metadata
      * @type {string}
@@ -14121,7 +14121,7 @@ interface GetMintRequestResult$1 {
      * @type {Chain}
      * @memberof GetMintRequestResult
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * The address of the contract
      * @type {string}
@@ -14213,7 +14213,7 @@ interface NFT$1 {
      * @type {Chain}
      * @memberof NFT
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * An `uint256` token id as string
      * @type {string}
@@ -14355,7 +14355,7 @@ interface Token$1 {
      * @type {Chain}
      * @memberof Token
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * The address of token contract
      * @type {string}
@@ -14646,7 +14646,7 @@ interface NFTOwner$1 {
      * @type {Chain}
      * @memberof NFTOwner
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      * The address of NFT contract
      * @type {string}
@@ -14880,7 +14880,7 @@ interface RefreshCollectionMetadataResult$1 {
      * @type {Chain}
      * @memberof RefreshCollectionMetadataResult
      */
-    'chain': Chain$2;
+    'chain': Chain$3;
     /**
      *
      * @type {CollectionMetadata}
@@ -16950,7 +16950,7 @@ interface BlockchainMetadata {
  * @export
  * @interface Chain
  */
-interface Chain$1 {
+interface Chain$2 {
     /**
      * The id of chain
      * @type {string}
@@ -16994,7 +16994,7 @@ interface Activity {
      * @type {Chain}
      * @memberof Activity
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      *
      * @type {ActivityType}
@@ -17092,7 +17092,7 @@ interface ChainWithDetailsAllOf {
  * @type ChainWithDetails
  * @export
  */
-type ChainWithDetails = Chain$1 & ChainWithDetailsAllOf;
+type ChainWithDetails = Chain$2 & ChainWithDetailsAllOf;
 
 /**
  * Immutable zkEVM API
@@ -17138,7 +17138,7 @@ interface Collection {
      * @type {Chain}
      * @memberof Collection
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The name of the collection
      * @type {string}
@@ -17724,7 +17724,7 @@ interface Metadata {
      * @type {Chain}
      * @memberof Metadata
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The contract address of the metadata
      * @type {string}
@@ -17883,7 +17883,7 @@ interface GetMintRequestResult {
      * @type {Chain}
      * @memberof GetMintRequestResult
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The address of the contract
      * @type {string}
@@ -17969,7 +17969,7 @@ interface NFT {
      * @type {Chain}
      * @memberof NFT
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * An `uint256` token id as string
      * @type {string}
@@ -18111,7 +18111,7 @@ interface Token {
      * @type {Chain}
      * @memberof Token
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The address of token contract
      * @type {string}
@@ -18373,7 +18373,7 @@ interface NFTWithOwner {
      * @type {Chain}
      * @memberof NFTWithOwner
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The address of NFT contract
      * @type {string}
@@ -18564,7 +18564,7 @@ interface NFTOwner {
      * @type {Chain}
      * @memberof NFTOwner
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * The address of NFT contract
      * @type {string}
@@ -18659,7 +18659,7 @@ interface NFTWithBalance {
      * @type {Chain}
      * @memberof NFTWithBalance
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      * An `uint256` token id as string
      * @type {string}
@@ -18946,7 +18946,7 @@ interface RefreshCollectionMetadataResult {
      * @type {Chain}
      * @memberof RefreshCollectionMetadataResult
      */
-    'chain': Chain$1;
+    'chain': Chain$2;
     /**
      *
      * @type {CollectionMetadata}
@@ -20178,7 +20178,7 @@ declare namespace index_d {
     index_d_BasicAPIError as BasicAPIError,
     index_d_BlockchainMetadata as BlockchainMetadata,
     index_d_Burn as Burn,
-    Chain$1 as Chain,
+    Chain$2 as Chain,
     index_d_ChainWithDetails as ChainWithDetails,
     index_d_ChainWithDetailsAllOf as ChainWithDetailsAllOf,
     index_d_Collection as Collection,
@@ -27495,7 +27495,7 @@ type CreateListingRequestBody = {
 /**
  * The chain details
  */
-type Chain = {
+type Chain$1 = {
     /**
      * The id of chain
      */
@@ -27604,7 +27604,7 @@ type Order$1 = {
     account_address: string;
     buy: Array<Item>;
     fees: Array<Fee$2>;
-    chain: Chain;
+    chain: Chain$1;
     /**
      * Time the Order is created
      */
@@ -27715,7 +27715,7 @@ type Trade$1 = {
     buy: Array<Item>;
     buyer_address: string;
     buyer_fees: Array<Fee$2>;
-    chain: Chain;
+    chain: Chain$1;
     order_id: string;
     blockchain_metadata: TradeBlockchainMetadata;
     /**
@@ -32063,6 +32063,359 @@ declare namespace x_d {
   };
 }
 
+interface BlockChainMetadata {
+    log_index: string;
+    block_number: string;
+    transaction_hash: string;
+    transaction_index: string;
+}
+interface Chain {
+    id: string;
+    name: string;
+}
+interface ZkevmActivityMint {
+    event_name: 'imtbl_zkevm_activity_mint';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            to: string;
+            asset: {
+                token_id: string;
+                contract_type: string;
+                contract_address: string;
+            };
+            amount: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmActivityBurn {
+    event_name: 'imtbl_zkevm_activity_burn';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            from: string;
+            asset: {
+                token_id: string;
+                contract_type: string;
+                contract_address: string;
+            };
+            amount: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmActivityTransfer {
+    event_name: 'imtbl_zkevm_activity_transfer';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            to: string;
+            from: string;
+            asset: {
+                token_id: string;
+                contract_type: string;
+                contract_address: string;
+            };
+            amount: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmActivitySale {
+    event_name: 'imtbl_zkevm_activity_sale';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            to: string;
+            from: string;
+            asset: {
+                amount: string;
+                token_id: string;
+                contract_type: string;
+                contract_address: string;
+            }[];
+            payment: {
+                fees: {
+                    amount: string;
+                    fee_type: string;
+                    recipient: string;
+                }[];
+                token: {
+                    symbol: string;
+                    contract_type: string;
+                    contract_address: string;
+                };
+                price_excluding_fees: string;
+                price_including_fees: string;
+            };
+            order_id: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmActivityDeposit {
+    event_name: 'imtbl_zkevm_activity_deposit';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            amount: string;
+            asset: {
+                contract_type: string;
+                contract_address: string;
+            };
+            to: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmActivityWithdrawal {
+    event_name: 'imtbl_zkevm_activity_withdrawal';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        details: {
+            amount: string;
+            asset: {
+                contract_type: string;
+                contract_address: string;
+            };
+            from: string;
+        };
+        indexed_at: string;
+        activity_type: string;
+        blockchain_metadata: BlockChainMetadata;
+    };
+}
+interface ZkevmCollectionUpdated {
+    event_name: 'imtbl_zkevm_collection_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        chain: Chain;
+        contract_address: string;
+        indexed_at: string;
+        updated_at: string;
+        contract_type: string;
+        symbol: string | null;
+        name: string | null;
+        image: string | null;
+        contract_uri: string | null;
+        description: string | null;
+        external_link: string | null;
+        metadata_synced_at: string | null;
+        decimals: string | null;
+        root_contract_address: string | null;
+    };
+}
+interface ZkevmNftUpdated {
+    event_name: 'imtbl_zkevm_nft_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        chain: Chain;
+        contract_address: string;
+        indexed_at: string;
+        metadata_synced_at: string | null;
+        token_id: string;
+        metadata_id: string | null;
+    };
+}
+interface ZkevmMintRequestUpdated {
+    event_name: 'imtbl_zkevm_mint_request_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        chain: Chain;
+        contract_address: string;
+        owner_address: string;
+        reference_id: string;
+        metadata_id: string;
+        token_id: string | null;
+        status: string;
+        transaction_hash: string | null;
+        activity_id: string | null;
+        error: {
+            code: string;
+            message: string;
+        } | null;
+        created_at: string;
+        updated_at: string;
+        amount?: number;
+    };
+}
+interface ZkevmMetadataUpdated {
+    event_name: 'imtbl_zkevm_metadata_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        chain: Chain;
+        contract_address: string;
+        image: string | null;
+        external_url: string | null;
+        description: string | null;
+        name: string | null;
+        attributes: {
+            trait_type: string;
+            value: string;
+        }[];
+        animation_url: string | null;
+        youtube_url: string | null;
+        created_at: string;
+        updated_at: string;
+    };
+}
+interface ZkevmTokenUpdated {
+    event_name: 'imtbl_zkevm_token_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        chain: Chain;
+        contract_address: string;
+        indexed_at: string;
+        updated_at: string;
+        contract_type: string;
+        symbol: string;
+        name: string;
+        image: string | null;
+        contract_uri: string | null;
+        description: string | null;
+        external_link: string | null;
+        metadata_synced_at: string | null;
+        decimals: number;
+        root_contract_address: string | null;
+    };
+}
+interface ZkevmOrderUpdated {
+    event_name: 'imtbl_zkevm_order_updated';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        buy: {
+            item_type: string;
+            end_amount: string;
+            start_amount: string;
+            contract_address: string;
+        }[];
+        hash: string;
+        salt: string;
+        sell: {
+            token_id: string;
+            item_type: string;
+            end_amount: string;
+            start_amount: string;
+            contract_address: string;
+        }[];
+        status: string;
+        fill_status: {
+            denominator: string;
+            numerator: string;
+        };
+        chain_id: string;
+        end_time: number;
+        signature: string;
+        buyer_fees: {
+            amount: string;
+            fee_type: string;
+            recipient: string;
+        }[];
+        created_at: number;
+        start_time: number;
+        updated_at: number;
+        protocol_data: {
+            counter: string;
+            order_type: string;
+            zone_address: string;
+            seaport_address: string;
+            seaport_version: string;
+        };
+        account_address: string;
+    };
+}
+interface ZkevmTradeCreated {
+    event_name: 'imtbl_zkevm_trade_created';
+    event_id: string;
+    chain: string;
+    data: {
+        id: string;
+        tx_hash: string;
+        chain_id: string;
+        order_id: string;
+        buy_items: {
+            amount: string;
+            item_type: string;
+            contract_address: string;
+        }[];
+        buyer_fees: {
+            amount: string;
+            fee_type: string;
+            recipient: string;
+        }[];
+        sell_items: {
+            amount: string;
+            token_id: string;
+            item_type: string;
+            contract_address: string;
+        }[];
+        block_number: string;
+        buyer_address: string;
+        seller_address: string;
+        tx_index_in_block: string;
+        log_index_in_block: string;
+    };
+}
+
+type WebhookHandlers = {
+    zkevmMintRequestUpdated?: (event: ZkevmMintRequestUpdated) => Promise<void>;
+    zkEvmActivityMint?: (event: ZkevmActivityMint) => Promise<void>;
+    zkEvmActivityBurn?: (event: ZkevmActivityBurn) => Promise<void>;
+    zkEvmActivityTransfer?: (event: ZkevmActivityTransfer) => Promise<void>;
+    zkEvmActivitySale?: (event: ZkevmActivitySale) => Promise<void>;
+    zkEvmActivityDeposit?: (event: ZkevmActivityDeposit) => Promise<void>;
+    zkEvmActivityWithdrawal?: (event: ZkevmActivityWithdrawal) => Promise<void>;
+    zkEvmCollectionUpdated?: (event: ZkevmCollectionUpdated) => Promise<void>;
+    zkEvmNftUpdated?: (event: ZkevmNftUpdated) => Promise<void>;
+    zkEvmMetadataUpdated?: (event: ZkevmMetadataUpdated) => Promise<void>;
+    zkEvmTokenUpdated?: (event: ZkevmTokenUpdated) => Promise<void>;
+    zkEvmOrderUpdated?: (event: ZkevmOrderUpdated) => Promise<void>;
+    zkEvmTradeCreated?: (event: ZkevmTradeCreated) => Promise<void>;
+    xNftCreated?: (event: Asset) => Promise<void>;
+    xNftUpdated?: (event: Asset) => Promise<void>;
+    xOrderAccepted?: (event: OrderV3) => Promise<void>;
+    xOrderFilled?: (event: OrderV3) => Promise<void>;
+    xOrderCancelled?: (event: OrderV3) => Promise<void>;
+    xTransferCreated?: (event: Transfer$2) => Promise<void>;
+    all?: (event: any) => Promise<void>;
+};
 /**
  * handle will validate webhook message origin and verify signature of the message and calls corresponding handlers passed in.
  * @param body The request body to a webhook endpoint in json string or js object form.
@@ -32070,14 +32423,43 @@ declare namespace x_d {
  * @param handlers The optional handlers object for different events. The `all` handler will be triggered for all event types.
  * @returns The event object from the webhook message after validation and verification.
  */
-declare const handle: (body: string | Record<string, unknown>, env: Environment, handlers?: {
-    zkevmMintRequestUpdated?: ((event: any) => Promise<void>) | undefined;
-    all?: ((event: any) => Promise<void>) | undefined;
-} | undefined) => Promise<any>;
-
+declare const handle: (body: string | Record<string, unknown>, env: Environment, handlers?: WebhookHandlers) => Promise<any>;
+
+type webhook_d_BlockChainMetadata = BlockChainMetadata;
+type webhook_d_Chain = Chain;
+type webhook_d_WebhookHandlers = WebhookHandlers;
+type webhook_d_ZkevmActivityBurn = ZkevmActivityBurn;
+type webhook_d_ZkevmActivityDeposit = ZkevmActivityDeposit;
+type webhook_d_ZkevmActivityMint = ZkevmActivityMint;
+type webhook_d_ZkevmActivitySale = ZkevmActivitySale;
+type webhook_d_ZkevmActivityTransfer = ZkevmActivityTransfer;
+type webhook_d_ZkevmActivityWithdrawal = ZkevmActivityWithdrawal;
+type webhook_d_ZkevmCollectionUpdated = ZkevmCollectionUpdated;
+type webhook_d_ZkevmMetadataUpdated = ZkevmMetadataUpdated;
+type webhook_d_ZkevmMintRequestUpdated = ZkevmMintRequestUpdated;
+type webhook_d_ZkevmNftUpdated = ZkevmNftUpdated;
+type webhook_d_ZkevmOrderUpdated = ZkevmOrderUpdated;
+type webhook_d_ZkevmTokenUpdated = ZkevmTokenUpdated;
+type webhook_d_ZkevmTradeCreated = ZkevmTradeCreated;
 declare const webhook_d_handle: typeof handle;
 declare namespace webhook_d {
   export {
+    webhook_d_BlockChainMetadata as BlockChainMetadata,
+    webhook_d_Chain as Chain,
+    webhook_d_WebhookHandlers as WebhookHandlers,
+    webhook_d_ZkevmActivityBurn as ZkevmActivityBurn,
+    webhook_d_ZkevmActivityDeposit as ZkevmActivityDeposit,
+    webhook_d_ZkevmActivityMint as ZkevmActivityMint,
+    webhook_d_ZkevmActivitySale as ZkevmActivitySale,
+    webhook_d_ZkevmActivityTransfer as ZkevmActivityTransfer,
+    webhook_d_ZkevmActivityWithdrawal as ZkevmActivityWithdrawal,
+    webhook_d_ZkevmCollectionUpdated as ZkevmCollectionUpdated,
+    webhook_d_ZkevmMetadataUpdated as ZkevmMetadataUpdated,
+    webhook_d_ZkevmMintRequestUpdated as ZkevmMintRequestUpdated,
+    webhook_d_ZkevmNftUpdated as ZkevmNftUpdated,
+    webhook_d_ZkevmOrderUpdated as ZkevmOrderUpdated,
+    webhook_d_ZkevmTokenUpdated as ZkevmTokenUpdated,
+    webhook_d_ZkevmTradeCreated as ZkevmTradeCreated,
     webhook_d_handle as handle,
   };
 }
@@ -32139,33 +32521,7 @@ declare const submitMintingRequests: (mintingPersistence: MintingPersistence, bl
     chainName?: string | undefined;
     maxNumberOfTries?: number | undefined;
 }, logger?: Logger) => Promise<never>;
-type MintRequestEvent = {
-    event_name: string;
-    chain: string;
-    event_id: string;
-    data: {
-        chain: {
-            id: string;
-            name: string;
-        };
-        contract_address: string;
-        owner_address: string;
-        reference_id: string;
-        metadata_id: string;
-        token_id: string | null;
-        status: string;
-        transaction_hash: string | null;
-        activity_id: string | null;
-        error: {
-            code: string;
-            message: string;
-        } | null;
-        created_at: string;
-        updated_at: string;
-        amount?: number;
-    };
-};
-declare const processMint: (mintingPersistence: MintingPersistence, event: MintRequestEvent, logger?: Logger) => Promise<void>;
+declare const processMint: (mintingPersistence: MintingPersistence, event: ZkevmMintRequestUpdated, logger?: Logger) => Promise<void>;
 
 interface MintingBackendModuleConfiguration extends ModuleConfiguration<undefined> {
     persistence: MintingPersistence;
@@ -32184,8 +32540,7 @@ declare class MintingBackendModule {
         maxNumberOfTries?: number;
     }): Promise<void>;
     processMint(body: string | Record<string, unknown>, otherHandlers?: {
-        zkevmMintRequestUpdated: (event: MintRequestEvent) => Promise<void>;
-        all: (..._args: any) => Promise<void>;
+        zkevmMintRequestUpdated: (event: ZkevmMintRequestUpdated) => Promise<void>;
     }): Promise<void>;
 }