@portal-hq/web 3.6.2-alpha → 3.7.0

package/zero-x.d.ts

@@ -0,0 +1,204 @@
+export interface ZeroExQuoteRequest {
+  chainId: string
+  buyToken: string
+  sellToken: string
+  sellAmount: string
+  txOrigin?: string
+  swapFeeRecipient?: string
+  swapFeeBps?: number
+  swapFeeToken?: string
+  tradeSurplusRecipient?: string
+  gasPrice?: string
+  slippageBps?: number
+  excludedSources?: string
+  sellEntireBalance?: 'true' | 'false'
+}
+
+export interface ZeroExQuoteResponse {
+  data: {
+    rawResponse: {
+      message?: string
+      blockNumber: string
+      buyAmount: string
+      buyToken: string
+      fees: {
+        integratorFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+        zeroExFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+        gasFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+      }
+      issues: {
+        allowance: {
+          actual: string
+          spender: string
+        }
+        balance: {
+          token: string
+          actual: string
+          expected: string
+        }
+        simulationIncomplete: boolean
+        invalidSourcesPassed: any[]
+      }
+      liquidityAvailable: boolean
+      minBuyAmount: string
+      route: {
+        fills: {
+          from: string
+          to: string
+          source: string
+          proportionBps: string
+        }[]
+        tokens: { address: string; symbol: string }[]
+      }
+      sellAmount: string
+      sellToken: string
+      tokenMetadata: {
+        buyToken: {
+          buyTaxBps: string
+          sellTaxBps: string
+        }
+        sellToken: {
+          buyTaxBps: string
+          sellTaxBps: string
+        }
+      }
+      totalNetworkFee: string
+      transaction: {
+        to: string
+        data: string
+        gas: string
+        gasPrice: string
+        value: string
+      }
+    }
+  }
+  metadata: {
+    buyToken: string
+    sellToken: string
+    sellAmount: string
+    chainId: string
+    clientId: string
+    clientEip155Address: string
+  }
+}
+
+export interface ZeroExSourcesRequest {
+  chainId: string
+}
+
+export interface ZeroExSourcesResponse {
+  metadata: {
+    chainId: string
+    clientId: string
+  }
+  data: {
+    rawResponse: { sources: string[]; zid: string }
+  }
+}
+
+export interface ZeroExPriceRequest {
+  chainId: string
+  buyToken: string
+  sellToken: string
+  sellAmount: string
+  txOrigin?: string
+  swapFeeRecipient?: string
+  swapFeeBps?: number
+  swapFeeToken?: string
+  tradeSurplusRecipient?: string
+  gasPrice?: string
+  slippageBps?: number
+  excludedSources?: string
+  sellEntireBalance?: 'true' | 'false'
+}
+
+export interface ZeroExPriceResponse {
+  data: {
+    rawResponse: {
+      message?: string
+      blockNumber: string
+      buyAmount: string
+      buyToken: string
+      fees: {
+        integratorFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+        zeroExFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+        gasFee: {
+          amount: string
+          token: string
+          type: string
+        } | null
+      }
+      gas: string
+      gasPrice: string
+      issues: {
+        allowance: {
+          actual: string
+          spender: string
+        }
+        balance: {
+          token: string
+          actual: string
+          expected: string
+        }
+        simulationIncomplete: boolean
+        invalidSourcesPassed: any[]
+      }
+      liquidityAvailable: boolean
+      minBuyAmount: string
+      route: {
+        fills: {
+          from: string
+          to: string
+          source: string
+          proportionBps: string
+        }[]
+        tokens: { address: string; symbol: string }[]
+      }
+      sellAmount: string
+      sellToken: string
+      tokenMetadata: {
+        buyToken: {
+          buyTaxBps: string
+          sellTaxBps: string
+        }
+        sellToken: {
+          buyTaxBps: string
+          sellTaxBps: string
+        }
+      }
+      totalNetworkFee: string
+    }
+  }
+  metadata: {
+    buyToken: string
+    sellToken: string
+    sellAmount: string
+    chainId: string
+    clientId: string
+    clientEip155Address: string
+  }
+}
+
+export interface ZeroExOptions {
+  zeroXApiKey?: string
+}