@covalenthq/client-sdk 2.2.3 → 2.2.5

package/dist/cjs/src/utils/types/TransactionService.types.d.ts

@@ -56,79 +56,16 @@ export type Transaction = Nullable<{
     gas_quote_rate: number;
     /** * The explorer links for this transaction. */
     explorers: Explorer[];
-    /** * The details for the dex transaction. */
-    dex_details: DexReport[];
     /** * The details for the NFT sale transaction. */
     nft_sale_details: NftSalesReport[];
-    /** * The details for the lending protocol transaction. */
-    lending_details: LendingReport[];
     /** * The log events. */
     log_events: LogEvent[];
-    /** * The details related to the safe transaction. */
-    safe_details: SafeDetails[];
-}>;
-export type DexReport = Nullable<{
-    /** * The offset is the position of the log entry within an event log. */
-    log_offset: number;
-    /** * Stores the name of the protocol that facilitated the event. */
-    protocol_name: string;
-    /** * Stores the contract address of the protocol that facilitated the event. */
-    protocol_address: string;
-    /** * The protocol logo URL. */
-    protocol_logo_url: string;
-    /** * Stores the aggregator responsible for the event. */
-    aggregator_name: string;
-    /** * Stores the contract address of the aggregator responsible for the event. */
-    aggregator_address: string;
-    /** * DEXs often have multiple version - e.g Uniswap V1, V2 and V3. The `version` field allows you to look at a specific version of the DEX. */
-    version: number;
-    /** * Similarly to the `version` field, `fork_version` gives you the version of the forked DEX. For example, most DEXs are a fork of Uniswap V2; therefore, `fork` = `aave` & `fork_version` = `2` */
-    fork_version: number;
-    /** * Many DEXs are a fork of an already established DEX. The fork field allows you to see which DEX has been forked. */
-    fork: string;
-    /** * Stores the event taking place - e.g `swap`, `add_liquidity` and `remove_liquidity`. */
-    event: string;
-    /** * Stores the address of the pair that the user interacts with. */
-    pair_address: string;
-    pair_lp_fee_bps: number;
-    lp_token_address: string;
-    lp_token_ticker: string;
-    lp_token_num_decimals: number;
-    lp_token_name: string;
-    lp_token_value: string;
-    exchange_rate_usd: number;
-    /** * Stores the address of token 0 in the specific pair. */
-    token_0_address: string;
-    /** * Stores the ticker symbol of token 0 in the specific pair. */
-    token_0_ticker: string;
-    /** * Stores the number of contract decimals of token 0 in the specific pair. */
-    token_0_num_decimals: number;
-    /** * Stores the contract name of token 0 in the specific pair. */
-    token_0_name: string;
-    /** * Stores the address of token 1 in the specific pair. */
-    token_1_address: string;
-    /** * Stores the ticker symbol of token 1 in the specific pair. */
-    token_1_ticker: string;
-    /** * Stores the number of contract decimals of token 1 in the specific pair. */
-    token_1_num_decimals: number;
-    /** * Stores the contract name of token 1 in the specific pair. */
-    token_1_name: string;
-    /** * Stores the amount of token 0 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
-    token_0_amount: string;
-    token_0_quote_rate: number;
-    token_0_usd_quote: number;
-    pretty_token_0_usd_quote: string;
-    token_0_logo_url: string;
-    /** * Stores the amount of token 1 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
-    token_1_amount: string;
-    token_1_quote_rate: number;
-    token_1_usd_quote: number;
-    pretty_token_1_usd_quote: string;
-    token_1_logo_url: string;
-    /** * Stores the wallet address that initiated the transaction (i.e the wallet paying the gas fee). */
-    sender: string;
-    /** * Stores the recipient of the transaction - recipients can be other wallets or smart contracts. For example, if you want to Swap tokens on Uniswap, the Uniswap router would typically be the recipient of the transaction. */
-    recipient: string;
+    /** * List of internal transfers/transactions associated with the wallet address. */
+    internal_transfers: InternalTransfer[];
+    /** * List of state changes with before and after values and balances for involved contract and wallet addresses. */
+    state_changes: StateChange[];
+    /** * Object with a transaction's input data such as the Method ID. */
+    input_data: InputData;
 }>;
 export type NftSalesReport = Nullable<{
     /** * The offset is the position of the log entry within an event log. */
@@ -181,87 +118,6 @@ export type NftSalesReport = Nullable<{
     trade_type: string;
     trade_group_type: string;
 }>;
-export type LendingReport = Nullable<{
-    /** * The offset is the position of the log entry within an event log. */
-    log_offset: number;
-    /** * Stores the name of the lending protocol that facilitated the event. */
-    protocol_name: string;
-    /** * Stores the contract address of the lending protocol that facilitated the event. */
-    protocol_address: string;
-    /** * The protocol logo URL. */
-    protocol_logo_url: string;
-    /** * Lending protocols often have multiple version (e.g. Aave V1, V2 and V3). The `version` field allows you to look at a specific version of the Lending protocol. */
-    version: string;
-    /** * Many lending protocols are a fork of an already established protocol. The fork column allows you to see which lending protocol has been forked. */
-    fork: string;
-    /** * Similarly to the `version` column, `fork_version` gives you the version of the forked lending protocol. For example, most lending protocols in the space are a fork of Aave V2; therefore, `fork` = `aave` & `fork_version` = `2` */
-    fork_version: string;
-    /** * Stores the event taking place - e.g `borrow`, `deposit`, `liquidation`, 'repay' and 'withdraw'. */
-    event: string;
-    /** * Stores the name of the LP token issued by the lending protocol. LP tokens can be debt or interest bearing tokens. */
-    lp_token_name: string;
-    /** * Stores the number decimal of the LP token. */
-    lp_decimals: number;
-    /** * Stores the ticker symbol of the LP token. */
-    lp_ticker_symbol: string;
-    /** * Stores the token address of the LP token. */
-    lp_token_address: string;
-    /** * Stores the amount of LP token used in the event (e.g. 1 aETH, 100 cUSDC, etc). */
-    lp_token_amount: number;
-    /** * Stores the total USD amount of all the LP Token used in the event. */
-    lp_token_price: number;
-    /** * Stores the exchange rate between the LP and underlying token. */
-    exchange_rate: number;
-    /** * Stores the USD price of the LP Token used in the event. */
-    exchange_rate_usd: number;
-    /** * Stores the name of the token going into the lending protocol (e.g the token getting deposited). */
-    token_name_in: string;
-    /** * Stores the number decimal of the token going into the lending protocol. */
-    token_decimal_in: number;
-    /** * Stores the address of the token going into the lending protocol. */
-    token_address_in: string;
-    /** * Stores the ticker symbol of the token going into the lending protocol. */
-    token_ticker_in: string;
-    /** * Stores the logo URL of the token going into the lending protocol. */
-    token_logo_in: string;
-    /** * Stores the amount of tokens going into the lending protocol (e.g 1 ETH, 100 USDC, etc). */
-    token_amount_in: number;
-    /** * Stores the total USD amount of all tokens going into the lending protocol. */
-    amount_in_usd: number;
-    pretty_amount_in_usd: string;
-    /** * Stores the name of the token going out of the lending protocol (e.g the token getting deposited). */
-    token_name_out: string;
-    /** * Stores the number decimal of the token going out of the lending protocol. */
-    token_decimals_out: number;
-    /** * Stores the address of the token going out of the lending protocol. */
-    token_address_out: string;
-    /** * Stores the ticker symbol of the token going out of the lending protocol. */
-    token_ticker_out: string;
-    /** * Stores the logo URL of the token going out of the lending protocol. */
-    token_logo_out: string;
-    /** * Stores the amount of tokens going out of the lending protocol (e.g 1 ETH, 100 USDC, etc). */
-    token_amount_out: number;
-    /** * Stores the total USD amount of all tokens going out of the lending protocol. */
-    amount_out_usd: number;
-    pretty_amount_out_usd: string;
-    /** * Stores the type of loan the user is taking out. Lending protocols enable you to take out a stable or variable loan. Only relevant to borrow events. */
-    borrow_rate_mode: number;
-    /** * Stores the interest rate of the loan. Only relevant to borrow events. */
-    borrow_rate: number;
-    on_behalf_of: string;
-    /** * Stores the wallet address liquidating the loan. Only relevant to liquidation events. */
-    liquidator: string;
-    /** * Stores the wallet address of the user initiating the event. */
-    user: string;
-}>;
-export type SafeDetails = Nullable<{
-    /** * The address that signed the safe transaction. */
-    owner_address: string;
-    /** * The signature of the owner for the safe transaction. */
-    signature: string;
-    /** * The type of safe signature used. */
-    signature_type: string;
-}>;
 export type RecentTransactionsResponse = Nullable<{
     /** * The requested address. */
     address: string;
@@ -316,6 +172,12 @@ export type TransactionsBlockResponse = Nullable<{
     chain_name: ChainName;
     /** * List of response items. */
     items: Transaction[];
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<TransactionsBlockResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<TransactionsBlockResponse>>) | null;
 }>;
 export type TransactionsSummaryResponse = Nullable<{
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -406,8 +268,12 @@ export type GetTransactionQueryParamOpts = Nullable<{
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
+    /** * Whether to include internal transfers/transactions. */
+    withInternal?: boolean;
+    /** * Whether to include all transaction state changes with before and after values. */
+    withState?: boolean;
+    /** * Whether to include the transaction's input data such as the Method ID. */
+    withInputData?: boolean;
 }>;
 export type GetAllTransactionsForAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
@@ -416,54 +282,111 @@ export type GetAllTransactionsForAddressQueryParamOpts = Nullable<{
     noLogs?: boolean;
     /** * Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order. */
     blockSignedAtAsc?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
+    /** * Whether to include internal transfers/transactions. */
+    withInternal?: boolean;
+    /** * Whether to include all transaction state changes with before and after values. */
+    withState?: boolean;
+    /** * Whether to include the transaction's input data such as the Method ID. */
+    withInputData?: boolean;
 }>;
-export type GetTransactionsForBlockQueryParamOpts = Nullable<{
+export type getTransactionsForBlockByPageQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
 }>;
-export type GetTransactionsForAddressV3QueryParamOpts = Nullable<{
+export type getPaginatedTransactionsForAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
     /** * Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order. */
     blockSignedAtAsc?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
 }>;
 export type GetTimeBucketTransactionsForAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
 }>;
-export type GetTransactionsForBlockHashByPageQueryParamOpts = Nullable<{
+export type GetTransactionSummaryQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
-    /** * Omit log events. */
-    noLogs?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
+    /** * Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions. */
+    withGas?: boolean;
 }>;
-export type GetTransactionsForBlockHashQueryParamOpts = Nullable<{
+export type InternalTransfer = Nullable<{
+    /** * The contract address sending the native token. */
+    from_address: string;
+    /** * The internal transfer recipient wallet address. */
+    to_address: string;
+    /** * The value of the internal transfer in wei. */
+    value: string;
+    /** * The gas available from the parent transaction or contract call. */
+    gas_limit: number;
+}>;
+export type StateChange = Nullable<{
+    /** * The address associated with the state change. */
+    address: string;
+    /** * The balance of the native token before the transaction in wei. */
+    balance_before: string;
+    /** * The balance of the native token after the transaction in wei. */
+    balance_after: string;
+    /** * List of before and after values in the storage address. */
+    storage_changes: StorageChange[];
+    /** * The transaction count for this address before the transaction. */
+    nonce_before: number;
+    /** * The transaction count for this address after the transaction. */
+    nonce_after: number;
+}>;
+export type StorageChange = Nullable<{
+    /** * The specific storage slot in the contract's storage space. */
+    storage_address: string;
+    /** * The hex value stored in the slot before the transaction. */
+    value_before: string;
+    /** * The hex value stored in the slot after the transaction. */
+    value_after: string;
+}>;
+export type InputData = Nullable<{
+    /** * The first 4 bytes of the invoked smart contract function signature. Used to identify the function being called in the contract. */
+    method_id: string;
+}>;
+export type GetEarliestTransactionsForAddressQueryParamOpts = Nullable<{
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
     quoteCurrency?: Quote;
     /** * Omit log events. */
     noLogs?: boolean;
-    /** * Include safe details. */
-    withSafe?: boolean;
 }>;
-export type GetTransactionSummaryQueryParamOpts = Nullable<{
-    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
-    quoteCurrency?: Quote;
-    /** * Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions. */
-    withGas?: boolean;
+export type EarliestTransactionsForAddressResponse = Nullable<{
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: Quote;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    complete: boolean;
+    /** * The current bucket of the response. */
+    current_bucket: number;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * List of response items. */
+    items: Transaction[];
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<EarliestTransactionsForAddressResponse>>) | null;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<EarliestTransactionsForAddressResponse>>) | null;
+}>;
+export type TransactionsForBlockResponse = Nullable<{
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * List of response items. */
+    items: Transaction[];
 }>;