@skip-go/client 1.6.0-alpha.1 → 1.6.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/package.json +1 -1
  2. package/dist/cjs/api/getAssets.cjs +0 -16
  3. package/dist/cjs/api/getAssetsBetweenChains.cjs +0 -12
  4. package/dist/cjs/api/getBridges.cjs +0 -12
  5. package/dist/cjs/api/getChains.cjs +0 -12
  6. package/dist/cjs/api/getVenues.cjs +0 -12
  7. package/dist/cjs/api/postAssetsFromSource.cjs +0 -13
  8. package/dist/cjs/api/postBalances.cjs +0 -12
  9. package/dist/cjs/api/postIbcOriginAssets.cjs +0 -12
  10. package/dist/cjs/api/postMessages.cjs +0 -12
  11. package/dist/cjs/api/postMessagesDirect.cjs +0 -12
  12. package/dist/cjs/api/postRecommendAssets.cjs +0 -12
  13. package/dist/cjs/api/postRoute.cjs +0 -12
  14. package/dist/cjs/api/postSubmitTransaction.cjs +0 -12
  15. package/dist/cjs/api/postTrackTransaction.cjs +0 -12
  16. package/dist/cjs/api/postTransactionStatus.cjs +0 -12
  17. package/dist/cjs/chunk-2QPPD3BB.cjs +0 -210
  18. package/dist/cjs/chunk-2SA3OAIJ.cjs +0 -18
  19. package/dist/cjs/chunk-4BWE7SOV.cjs +0 -68
  20. package/dist/cjs/chunk-4GHUZDDP.cjs +0 -16
  21. package/dist/cjs/chunk-4ZIVDKQN.cjs +0 -387
  22. package/dist/cjs/chunk-A3UNNRKD.cjs +0 -574
  23. package/dist/cjs/chunk-A5S6SIYN.cjs +0 -12
  24. package/dist/cjs/chunk-AQTXZWLA.cjs +0 -55
  25. package/dist/cjs/chunk-ASDMDYTC.cjs +0 -11
  26. package/dist/cjs/chunk-ATW6UNT5.cjs +0 -136
  27. package/dist/cjs/chunk-AUTOIM57.cjs +0 -22
  28. package/dist/cjs/chunk-AVWWCQ5P.cjs +0 -2264
  29. package/dist/cjs/chunk-CIZTNJ3K.cjs +0 -24
  30. package/dist/cjs/chunk-CK6CQWQU.cjs +0 -49
  31. package/dist/cjs/chunk-EAZQ2ECA.cjs +0 -185
  32. package/dist/cjs/chunk-F3EB2AQG.cjs +0 -28
  33. package/dist/cjs/chunk-FCTBCHOT.cjs +0 -12
  34. package/dist/cjs/chunk-GDDD6R2X.cjs +0 -459
  35. package/dist/cjs/chunk-IJIBMN2F.cjs +0 -12
  36. package/dist/cjs/chunk-JRXPJ45U.cjs +0 -12
  37. package/dist/cjs/chunk-LJF74VNZ.cjs +0 -214
  38. package/dist/cjs/chunk-LJV45UGL.cjs +0 -582
  39. package/dist/cjs/chunk-MUJBB64F.cjs +0 -291
  40. package/dist/cjs/chunk-NCFH5MGF.cjs +0 -39
  41. package/dist/cjs/chunk-NM4PISTQ.cjs +0 -3359
  42. package/dist/cjs/chunk-OJISEAMX.cjs +0 -13
  43. package/dist/cjs/chunk-OVKHTOBP.cjs +0 -99
  44. package/dist/cjs/chunk-PDNKS5R2.cjs +0 -13
  45. package/dist/cjs/chunk-TEH6UMUR.cjs +0 -280
  46. package/dist/cjs/chunk-UXW4XVHF.cjs +0 -15
  47. package/dist/cjs/chunk-WVMDZODS.cjs +0 -1495
  48. package/dist/cjs/chunk-YX56UXDX.cjs +0 -189
  49. package/dist/cjs/index.cjs +0 -349
  50. package/dist/cjs/public-functions/executeMultipleRoutes.cjs +0 -27
  51. package/dist/cjs/public-functions/executeRoute.cjs +0 -27
  52. package/dist/cjs/public-functions/getCosmosGasAmountForMessage.cjs +0 -16
  53. package/dist/cjs/public-functions/getEvmGasAmountForMessage.cjs +0 -11
  54. package/dist/cjs/public-functions/getFeeInfoForChain.cjs +0 -14
  55. package/dist/cjs/public-functions/getRecommendedGasPrice.cjs +0 -15
  56. package/dist/cjs/public-functions/getRouteWithGasOnReceive.cjs +0 -41
  57. package/dist/cjs/public-functions/getSigningStargateClient.cjs +0 -15
  58. package/dist/cjs/public-functions/setApiOptions.cjs +0 -12
  59. package/dist/cjs/public-functions/setClientOptions.cjs +0 -16
  60. package/dist/cjs/public-functions/subscribeToRouteStatus.cjs +0 -26
  61. package/dist/cjs/public-functions/validateCosmosGasBalance.cjs +0 -18
  62. package/dist/cjs/public-functions/waitForTransaction.cjs +0 -18
  63. package/dist/esm/api/getAssets.d.ts +0 -19
  64. package/dist/esm/api/getAssets.js +0 -3
  65. package/dist/esm/api/getAssetsBetweenChains.d.ts +0 -56
  66. package/dist/esm/api/getAssetsBetweenChains.js +0 -3
  67. package/dist/esm/api/getBridges.d.ts +0 -55
  68. package/dist/esm/api/getBridges.js +0 -3
  69. package/dist/esm/api/getChains.d.ts +0 -41
  70. package/dist/esm/api/getChains.js +0 -3
  71. package/dist/esm/api/getVenues.d.ts +0 -13
  72. package/dist/esm/api/getVenues.js +0 -3
  73. package/dist/esm/api/postAssetsFromSource.d.ts +0 -22
  74. package/dist/esm/api/postAssetsFromSource.js +0 -4
  75. package/dist/esm/api/postBalances.d.ts +0 -35
  76. package/dist/esm/api/postBalances.js +0 -3
  77. package/dist/esm/api/postIbcOriginAssets.d.ts +0 -32
  78. package/dist/esm/api/postIbcOriginAssets.js +0 -3
  79. package/dist/esm/api/postMessages.d.ts +0 -101
  80. package/dist/esm/api/postMessages.js +0 -3
  81. package/dist/esm/api/postMessagesDirect.d.ts +0 -617
  82. package/dist/esm/api/postMessagesDirect.js +0 -3
  83. package/dist/esm/api/postRecommendAssets.d.ts +0 -40
  84. package/dist/esm/api/postRecommendAssets.js +0 -3
  85. package/dist/esm/api/postRoute.d.ts +0 -507
  86. package/dist/esm/api/postRoute.js +0 -3
  87. package/dist/esm/api/postSubmitTransaction.d.ts +0 -17
  88. package/dist/esm/api/postSubmitTransaction.js +0 -3
  89. package/dist/esm/api/postTrackTransaction.d.ts +0 -12
  90. package/dist/esm/api/postTrackTransaction.js +0 -3
  91. package/dist/esm/api/postTransactionStatus.d.ts +0 -639
  92. package/dist/esm/api/postTransactionStatus.js +0 -3
  93. package/dist/esm/apiState-1VvikVK-.d.ts +0 -8
  94. package/dist/esm/callbacks-1e6BnDot.d.ts +0 -158
  95. package/dist/esm/chunk-3DIX6KRJ.js +0 -566
  96. package/dist/esm/chunk-3JHLVPRG.js +0 -10
  97. package/dist/esm/chunk-5WYMRZIO.js +0 -97
  98. package/dist/esm/chunk-6QW6MRVQ.js +0 -53
  99. package/dist/esm/chunk-A4HQEGYV.js +0 -432
  100. package/dist/esm/chunk-A5NZMSTI.js +0 -10
  101. package/dist/esm/chunk-CGJRRAFS.js +0 -22
  102. package/dist/esm/chunk-DMJMN4J3.js +0 -379
  103. package/dist/esm/chunk-E4NRDAVO.js +0 -65
  104. package/dist/esm/chunk-ETBJVFQP.js +0 -10
  105. package/dist/esm/chunk-F2LQB2DP.js +0 -3323
  106. package/dist/esm/chunk-F66EKL3W.js +0 -203
  107. package/dist/esm/chunk-GV2QOWB4.js +0 -26
  108. package/dist/esm/chunk-GZJLX2CP.js +0 -2258
  109. package/dist/esm/chunk-HNU2Y3JI.js +0 -13
  110. package/dist/esm/chunk-J24LYWJE.js +0 -130
  111. package/dist/esm/chunk-KZKAL5ZN.js +0 -16
  112. package/dist/esm/chunk-N4PTRCNT.js +0 -11
  113. package/dist/esm/chunk-NUHMTWHP.js +0 -180
  114. package/dist/esm/chunk-OMOVHXSC.js +0 -212
  115. package/dist/esm/chunk-P36PE4CR.js +0 -37
  116. package/dist/esm/chunk-PZ2624FK.js +0 -187
  117. package/dist/esm/chunk-QYXGDTUU.js +0 -47
  118. package/dist/esm/chunk-R2GHDOWX.js +0 -272
  119. package/dist/esm/chunk-RTDD7HZ3.js +0 -275
  120. package/dist/esm/chunk-SXBG57J3.js +0 -20
  121. package/dist/esm/chunk-TGTOO2ZQ.js +0 -14
  122. package/dist/esm/chunk-UHCKOKBM.js +0 -9
  123. package/dist/esm/chunk-ULUX2CVU.js +0 -557
  124. package/dist/esm/chunk-UN46DUOV.js +0 -11
  125. package/dist/esm/chunk-XNU3TKKM.js +0 -10
  126. package/dist/esm/chunk-ZVFYCNA5.js +0 -1492
  127. package/dist/esm/client-types-Bz-WqtM3.d.ts +0 -114
  128. package/dist/esm/generateApi-Bi3W_Sti.d.ts +0 -56
  129. package/dist/esm/index.d.ts +0 -1859
  130. package/dist/esm/index.js +0 -32
  131. package/dist/esm/public-functions/executeMultipleRoutes.d.ts +0 -80
  132. package/dist/esm/public-functions/executeMultipleRoutes.js +0 -18
  133. package/dist/esm/public-functions/executeRoute.d.ts +0 -12
  134. package/dist/esm/public-functions/executeRoute.js +0 -18
  135. package/dist/esm/public-functions/getCosmosGasAmountForMessage.d.ts +0 -8
  136. package/dist/esm/public-functions/getCosmosGasAmountForMessage.js +0 -3
  137. package/dist/esm/public-functions/getEvmGasAmountForMessage.d.ts +0 -14
  138. package/dist/esm/public-functions/getEvmGasAmountForMessage.js +0 -2
  139. package/dist/esm/public-functions/getFeeInfoForChain.d.ts +0 -9
  140. package/dist/esm/public-functions/getFeeInfoForChain.js +0 -5
  141. package/dist/esm/public-functions/getRecommendedGasPrice.d.ts +0 -9
  142. package/dist/esm/public-functions/getRecommendedGasPrice.js +0 -6
  143. package/dist/esm/public-functions/getRouteWithGasOnReceive.d.ts +0 -20
  144. package/dist/esm/public-functions/getRouteWithGasOnReceive.js +0 -32
  145. package/dist/esm/public-functions/getSigningStargateClient.d.ts +0 -13
  146. package/dist/esm/public-functions/getSigningStargateClient.js +0 -6
  147. package/dist/esm/public-functions/setApiOptions.d.ts +0 -9
  148. package/dist/esm/public-functions/setApiOptions.js +0 -3
  149. package/dist/esm/public-functions/setClientOptions.d.ts +0 -11
  150. package/dist/esm/public-functions/setClientOptions.js +0 -7
  151. package/dist/esm/public-functions/subscribeToRouteStatus.d.ts +0 -12
  152. package/dist/esm/public-functions/subscribeToRouteStatus.js +0 -5
  153. package/dist/esm/public-functions/validateCosmosGasBalance.d.ts +0 -44
  154. package/dist/esm/public-functions/validateCosmosGasBalance.js +0 -9
  155. package/dist/esm/public-functions/waitForTransaction.d.ts +0 -1279
  156. package/dist/esm/public-functions/waitForTransaction.js +0 -5
  157. package/dist/esm/setClientOptions-QO8p3yRr.d.ts +0 -76
  158. package/dist/esm/swaggerTypes-Cvh0GDv-.d.ts +0 -2050
@@ -1,2050 +0,0 @@
1
- /**
2
- * Indicates whether the fee is deducted from the transfer amount or charged additionally.
3
- * - FEE_BEHAVIOR_DEDUCTED: Fee is subtracted from the transfer amount (default, typical for Cosmos chains)
4
- * - FEE_BEHAVIOR_ADDITIONAL: Fee is charged on top of the transfer amount (typical for EVM chains with native tokens)
5
- */
6
- declare enum FeeBehavior {
7
- FEE_BEHAVIOR_DEDUCTED = "FEE_BEHAVIOR_DEDUCTED",
8
- FEE_BEHAVIOR_ADDITIONAL = "FEE_BEHAVIOR_ADDITIONAL"
9
- }
10
- /**
11
- * Fee type:
12
- * * SMART_RELAY - Fees for Smart relaying services.'
13
- */
14
- declare enum FeeType {
15
- SMART_RELAY = "SMART_RELAY"
16
- }
17
- /**
18
- * Transfer state:
19
- * * `TRANSFER_UNKNOWN` - Transfer state is not known.
20
- * * `TRANSFER_PENDING` - The send packet for the transfer has been committed and the transfer is pending.
21
- * * `TRANSFER_RECEIVED` - The transfer packet has been received by the destination chain. It can still fail and revert if it is part of a multi-hop PFM transfer.
22
- * * `TRANSFER_SUCCESS` - The transfer has been successfully completed and will not revert.
23
- * * `TRANSFER_FAILURE`- The transfer has failed.
24
- */
25
- declare enum TransferState {
26
- TRANSFER_UNKNOWN = "TRANSFER_UNKNOWN",
27
- TRANSFER_PENDING = "TRANSFER_PENDING",
28
- TRANSFER_RECEIVED = "TRANSFER_RECEIVED",
29
- TRANSFER_SUCCESS = "TRANSFER_SUCCESS",
30
- TRANSFER_FAILURE = "TRANSFER_FAILURE"
31
- }
32
- /**
33
- * LayerZero transfer state:
34
- * * `LAYER_ZERO_TRANSFER_UNKNOWN` - Unknown error
35
- * * `LAYER_ZERO_TRANSFER_SENT` - The transaction on the source chain has executed
36
- * * `LAYER_ZERO_TRANSFER_WAITING_FOR_COMPOSE` - The transfer has been delivered to the destination chain but there is an additional lz_compose transaction that still needs to be delivered before marking this transfer as LAYER_ZERO_TRANSFER_RECEIVED
37
- * * `LAYER_ZERO_TRANSFER_RECEIVED` - The transfer has been received at the destination chain
38
- * * `LAYER_ZERO_TRANSFER_FAILED` - The transfer has failed
39
- */
40
- declare enum LayerZeroTransferState {
41
- LAYER_ZERO_TRANSFER_UNKNOWN = "LAYER_ZERO_TRANSFER_UNKNOWN",
42
- LAYER_ZERO_TRANSFER_SENT = "LAYER_ZERO_TRANSFER_SENT",
43
- LAYER_ZERO_TRANSFER_WAITING_FOR_COMPOSE = "LAYER_ZERO_TRANSFER_WAITING_FOR_COMPOSE",
44
- LAYER_ZERO_TRANSFER_RECEIVED = "LAYER_ZERO_TRANSFER_RECEIVED",
45
- LAYER_ZERO_TRANSFER_FAILED = "LAYER_ZERO_TRANSFER_FAILED"
46
- }
47
- /**
48
- * OPInit transfer state:
49
- * * `OPINIT_TRANSFER_UNKNOWN` - Unknown error
50
- * * `OPINIT_TRANSFER_SENT` - The deposit transaction on the source chain has executed
51
- * * `OPINIT_TRANSFER_RECEIVED` - OPInit transfer has been received at the destination chain
52
- */
53
- declare enum OPInitTransferState {
54
- OPINIT_TRANSFER_UNKNOWN = "OPINIT_TRANSFER_UNKNOWN",
55
- OPINIT_TRANSFER_SENT = "OPINIT_TRANSFER_SENT",
56
- OPINIT_TRANSFER_RECEIVED = "OPINIT_TRANSFER_RECEIVED"
57
- }
58
- /**
59
- * Transaction state:
60
- * * `STATE_SUBMITTED` - The initial transaction has been submitted to Skip Go API but not observed on chain yet
61
- * * `STATE_PENDING` - The initial transaction has been observed on chain, and there are still pending actions
62
- * * `STATE_COMPLETED_SUCCESS` - The route has completed successfully and the user has their tokens on the destination. (indicated by `transfer_asset_release`)
63
- * * `STATE_COMPLETED_ERROR` - The route errored somewhere and the user has their tokens unlocked in one of their wallets. Their tokens are either on the source chain, an intermediate chain, or the destination chain but as the wrong asset.
64
- * (Again, `transfer_asset_release` indicates where the tokens are)
65
- * * `STATE_ABANDONED` - Tracking for the transaction has been abandoned. This happens if the cross-chain sequence of actions stalls for more than 10 minutes or if the initial transaction does not get observed in a block for 5 minutes.
66
- * * `STATE_PENDING_ERROR` - The overall transaction will fail, pending error propagation
67
- */
68
- declare enum TransactionState {
69
- STATE_SUBMITTED = "STATE_SUBMITTED",
70
- STATE_PENDING = "STATE_PENDING",
71
- STATE_ABANDONED = "STATE_ABANDONED",
72
- STATE_COMPLETED_SUCCESS = "STATE_COMPLETED_SUCCESS",
73
- STATE_COMPLETED_ERROR = "STATE_COMPLETED_ERROR",
74
- STATE_PENDING_ERROR = "STATE_PENDING_ERROR"
75
- }
76
- /**
77
- * Packet error types:
78
- * * `STATUS_ERROR_UNKNOWN` - Unknown error
79
- * * `STATUS_ERROR_TRANSACTION_EXECUTION` - Error was encountered during transaction execution
80
- * * `STATUS_ERROR_INDEXING` - Error was encountered while indexing the transaction and packet data
81
- * * `STATUS_ERROR_TRANSFER` - The transfer failed to complete successfully
82
- */
83
- declare enum StatusErrorType {
84
- STATUS_ERROR_UNKNOWN = "STATUS_ERROR_UNKNOWN",
85
- STATUS_ERROR_TRANSACTION_EXECUTION = "STATUS_ERROR_TRANSACTION_EXECUTION",
86
- STATUS_ERROR_INDEXING = "STATUS_ERROR_INDEXING",
87
- STATUS_ERROR_TRANSFER = "STATUS_ERROR_TRANSFER"
88
- }
89
- /**
90
- * SendToken error types:
91
- * * `SEND_TOKEN_EXECUTION_ERROR` - Error occurred during the execute transaction
92
- */
93
- declare enum SendTokenErrorType {
94
- SEND_TOKEN_EXECUTION_ERROR = "SEND_TOKEN_EXECUTION_ERROR"
95
- }
96
- /**
97
- * Recommendation reason:
98
- * * `LOW_INFO_WARNING` - Not enough asset pricing information to determine the price safety of the route.
99
- * * `BAD_PRICE_WARNING` - The execution price of the route deviates significantly from the current market price.
100
- */
101
- declare enum RoutePriceWarningType {
102
- LOW_INFO_WARNING = "LOW_INFO_WARNING",
103
- BAD_PRICE_WARNING = "BAD_PRICE_WARNING"
104
- }
105
- /**
106
- * Recommendation reason:
107
- * * `UNKNOWN` - Unknown recommendation reason.
108
- * * `MOST_LIQUID` - Highest liquidity form of the transferred token on the destination chain.
109
- * * `BASE_TOKEN` - The base token if the destination chain is the origin chain of the source token.
110
- * * `DIRECT` - The token resulting from the least amount of transfers to the destination chain.
111
- */
112
- declare enum Reason {
113
- UNKNOWN = "UNKNOWN",
114
- MOST_LIQUID = "MOST_LIQUID",
115
- BASE_TOKEN = "BASE_TOKEN",
116
- DIRECT = "DIRECT"
117
- }
118
- /**
119
- * Packet error type:
120
- * * `PACKET_ERROR_UNKNOWN` - Unknown error
121
- * * `PACKET_ERROR_ACKNOWLEDGEMENT` - Packet acknowledgement error
122
- * * `PACKET_ERROR_TIMEOUT` - Packet timed out
123
- */
124
- declare enum PacketErrorType {
125
- PACKET_ERROR_UNKNOWN = "PACKET_ERROR_UNKNOWN",
126
- PACKET_ERROR_ACKNOWLEDGEMENT = "PACKET_ERROR_ACKNOWLEDGEMENT",
127
- PACKET_ERROR_TIMEOUT = "PACKET_ERROR_TIMEOUT"
128
- }
129
- /**
130
- * Hyperlane transfer state:
131
- * * `HYPERLANE_TRANSFER_UNKNOWN` - Unknown error
132
- * * `HYPERLANE_TRANSFER_SENT` - The Hyperlane transfer transaction on the source chain has executed
133
- * * `HYPERLANE_TRANSFER_FAILED` - The Hyperlane transfer failed
134
- * * `HYPERLANE_TRANSFER_RECEIVED` - The Hyperlane transfer has been received at the destination chain
135
- */
136
- declare enum HyperlaneTransferState {
137
- HYPERLANE_TRANSFER_UNKNOWN = "HYPERLANE_TRANSFER_UNKNOWN",
138
- HYPERLANE_TRANSFER_SENT = "HYPERLANE_TRANSFER_SENT",
139
- HYPERLANE_TRANSFER_FAILED = "HYPERLANE_TRANSFER_FAILED",
140
- HYPERLANE_TRANSFER_RECEIVED = "HYPERLANE_TRANSFER_RECEIVED"
141
- }
142
- /**
143
- * ContractCallWithToken errors:
144
- * * `CONTRACT_CALL_WITH_TOKEN_EXECUTION_ERROR` - Error occurred during the execute transaction
145
- */
146
- declare enum ContractCallWithTokenErrorType {
147
- CONTRACT_CALL_WITH_TOKEN_EXECUTION_ERROR = "CONTRACT_CALL_WITH_TOKEN_EXECUTION_ERROR"
148
- }
149
- declare enum ChainType {
150
- Cosmos = "cosmos",
151
- Evm = "evm",
152
- Svm = "svm"
153
- }
154
- /**
155
- * Bridge Type:
156
- * * `IBC` - IBC Bridge
157
- * * `AXELAR` - Axelar Bridge
158
- * * `CCTP` - CCTP Bridge
159
- * * `HYPERLANE` - Hyperlane Bridge
160
- * * `OPINIT` - Opinit Bridge
161
- * * `GO_FAST` - Go Fast Bridge
162
- * * `STARGATE` - Stargate Bridge
163
- * * `LAYER_ZERO` - Layerzero Bridge
164
- * * `EUREKA` - IBC Eureka Bridge
165
- */
166
- declare enum BridgeType {
167
- IBC = "IBC",
168
- AXELAR = "AXELAR",
169
- CCTP = "CCTP",
170
- HYPERLANE = "HYPERLANE",
171
- OPINIT = "OPINIT",
172
- GO_FAST = "GO_FAST",
173
- STARGATE = "STARGATE",
174
- LAYER_ZERO = "LAYER_ZERO",
175
- EUREKA = "EUREKA",
176
- CCTP_V2 = "CCTP_V2"
177
- }
178
- /**
179
- * GoFast transfer state:
180
- * * `GO_FAST_TRANSFER_UNKNOWN` - Unknown state
181
- * * `GO_FAST_TRANSFER_SENT` - Order submitted on source chain
182
- * * `GO_FAST_POST_ACTION_FAILED` - Order filled, but subsequent action (e.g., swap) failed
183
- * * `GO_FAST_TRANSFER_TIMEOUT` - Order timed out
184
- * * `GO_FAST_TRANSFER_FILLED` - Order filled on destination chain
185
- * * `GO_FAST_TRANSFER_REFUNDED` - Order refunded
186
- */
187
- declare enum GoFastTransferState {
188
- GO_FAST_TRANSFER_UNKNOWN = "GO_FAST_TRANSFER_UNKNOWN",
189
- GO_FAST_TRANSFER_SENT = "GO_FAST_TRANSFER_SENT",
190
- GO_FAST_POST_ACTION_FAILED = "GO_FAST_POST_ACTION_FAILED",
191
- GO_FAST_TRANSFER_TIMEOUT = "GO_FAST_TRANSFER_TIMEOUT",
192
- GO_FAST_TRANSFER_FILLED = "GO_FAST_TRANSFER_FILLED",
193
- GO_FAST_TRANSFER_REFUNDED = "GO_FAST_TRANSFER_REFUNDED"
194
- }
195
- /**
196
- * Stargate transfer state:
197
- * * `STARGATE_TRANSFER_UNKNOWN` - Unknown error
198
- * * `STARGATE_TRANSFER_SENT` - The Stargate transfer transaction on the source chain has executed
199
- * * `STARGATE_TRANSFER_PENDING_CONFIRMATION` - Stargate transfer is pending confirmation
200
- * * `STARGATE_TRANSFER_CONFIRMED` - Stargate transfer has been confirmed
201
- * * `STARGATE_TRANSFER_RECEIVED` - Stargate transfer has been received at the destination chain
202
- * * `STARGATE_TRANSFER_FAILED` - Stargate transfer failed
203
- */
204
- declare enum StargateTransferState {
205
- STARGATE_TRANSFER_UNKNOWN = "STARGATE_TRANSFER_UNKNOWN",
206
- STARGATE_TRANSFER_SENT = "STARGATE_TRANSFER_SENT",
207
- STARGATE_TRANSFER_PENDING_CONFIRMATION = "STARGATE_TRANSFER_PENDING_CONFIRMATION",
208
- STARGATE_TRANSFER_CONFIRMED = "STARGATE_TRANSFER_CONFIRMED",
209
- STARGATE_TRANSFER_RECEIVED = "STARGATE_TRANSFER_RECEIVED",
210
- STARGATE_TRANSFER_FAILED = "STARGATE_TRANSFER_FAILED"
211
- }
212
- /**
213
- * CCTP transfer state:
214
- * * `CCTP_TRANSFER_UNKNOWN` - Unknown error
215
- * * `CCTP_TRANSFER_SENT` - The burn transaction on the source chain has executed
216
- * * `CCTP_TRANSFER_PENDING_CONFIRMATION` - CCTP transfer is pending confirmation by the cctp attestation api
217
- * * `CCTP_TRANSFER_CONFIRMED` - CCTP transfer has been confirmed by the cctp attestation api
218
- * * `CCTP_TRANSFER_RECEIVED` - CCTP transfer has been received at the destination chain
219
- */
220
- declare enum CCTPTransferState {
221
- CCTP_TRANSFER_UNKNOWN = "CCTP_TRANSFER_UNKNOWN",
222
- CCTP_TRANSFER_SENT = "CCTP_TRANSFER_SENT",
223
- CCTP_TRANSFER_PENDING_CONFIRMATION = "CCTP_TRANSFER_PENDING_CONFIRMATION",
224
- CCTP_TRANSFER_CONFIRMED = "CCTP_TRANSFER_CONFIRMED",
225
- CCTP_TRANSFER_RECEIVED = "CCTP_TRANSFER_RECEIVED"
226
- }
227
- /**
228
- * Axelar transfer type:
229
- * * `AXELAR_TRANSFER_CONTRACT_CALL_WITH_TOKEN` - GMP contract call with token transfer type
230
- * * `AXELAR_TRANSFER_SEND_TOKEN` - Send token transfer type
231
- */
232
- declare enum AxelarTransferType {
233
- AXELAR_TRANSFER_CONTRACT_CALL_WITH_TOKEN = "AXELAR_TRANSFER_CONTRACT_CALL_WITH_TOKEN",
234
- AXELAR_TRANSFER_SEND_TOKEN = "AXELAR_TRANSFER_SEND_TOKEN"
235
- }
236
- /**
237
- * Axelar transfer state:
238
- * * `AXELAR_TRANSFER_UNKNOWN` - Unknown error
239
- * * `AXELAR_TRANSFER_PENDING_CONFIRMATION` - Axelar transfer is pending confirmation
240
- * * `AXELAR_TRANSFER_PENDING_RECEIPT` - Axelar transfer is pending receipt at destination
241
- * * `AXELAR_TRANSFER_SUCCESS` - Axelar transfer succeeded and assets have been received
242
- * * `AXELAR_TRANSFER_FAILURE` - Axelar transfer failed
243
- */
244
- declare enum AxelarTransferState {
245
- AXELAR_TRANSFER_UNKNOWN = "AXELAR_TRANSFER_UNKNOWN",
246
- AXELAR_TRANSFER_PENDING_CONFIRMATION = "AXELAR_TRANSFER_PENDING_CONFIRMATION",
247
- AXELAR_TRANSFER_PENDING_RECEIPT = "AXELAR_TRANSFER_PENDING_RECEIPT",
248
- AXELAR_TRANSFER_SUCCESS = "AXELAR_TRANSFER_SUCCESS",
249
- AXELAR_TRANSFER_FAILURE = "AXELAR_TRANSFER_FAILURE"
250
- }
251
- declare enum AutopilotAction {
252
- LIQUID_STAKE = "LIQUID_STAKE",
253
- CLAIM = "CLAIM"
254
- }
255
- interface AcknowledgementErrorDetails {
256
- /** Error code */
257
- code?: number;
258
- /** Error message */
259
- message?: string;
260
- }
261
- /** An affiliate that receives fees from a swap */
262
- interface Affiliate {
263
- /** Address to which to pay the fee */
264
- address?: string;
265
- /** Bps fee to pay to the affiliate */
266
- basisPointsFee?: string;
267
- }
268
- interface ApiError {
269
- /** Error message */
270
- message?: string;
271
- }
272
- interface Asset {
273
- /** Denom of the asset */
274
- denom: string;
275
- /** Chain-id of the asset */
276
- chainId: string;
277
- /** Denom of the origin of the asset. If this is an ibc denom, this is the original denom that the ibc token represents */
278
- originDenom: string;
279
- /** Chain-id of the origin of the asset. If this is an ibc denom, this is the chain-id of the asset that the ibc token represents */
280
- originChainId: string;
281
- /** The forward slash delimited sequence of ibc ports and channels that can be traversed to unwind an ibc token to its origin asset. */
282
- trace: string;
283
- /** Indicates whether asset is a CW20 token */
284
- isCw20: boolean;
285
- /** Indicates whether asset is an EVM token */
286
- isEvm: boolean;
287
- /** Indicates whether asset is an SVM token */
288
- isSvm: boolean;
289
- /** Symbol of the asset, e.g. ATOM for uatom */
290
- symbol?: string;
291
- /** Name of the asset */
292
- name?: string;
293
- /** URI pointing to an image of the logo of the asset */
294
- logoUri?: string;
295
- /** Number of decimals used for amounts of the asset */
296
- decimals?: number;
297
- /** Address of the contract for the asset, e.g. if it is a CW20 or ERC20 token */
298
- tokenContract?: string;
299
- /** Description of the asset */
300
- description?: string;
301
- /** Coingecko id of the asset */
302
- coingeckoId?: string;
303
- /** Recommended symbol of the asset used to differentiate between bridged assets with the same symbol, e.g. USDC.axl for Axelar USDC and USDC.grv for Gravity USDC */
304
- recommendedSymbol?: string;
305
- }
306
- interface AssetBetweenChains {
307
- assetOnSource?: Asset;
308
- assetOnDest?: Asset;
309
- /** Number of transactions required to transfer the asset */
310
- txsRequired: number;
311
- /** Bridges that are used to transfer the asset */
312
- bridges?: BridgeType[];
313
- }
314
- interface AssetRecommendation {
315
- /** Asset that is recommended */
316
- asset?: Asset;
317
- /** Reason for recommending the asset */
318
- reason?: Reason;
319
- }
320
- interface AutopilotMsg {
321
- action?: AutopilotAction;
322
- receiver?: string;
323
- }
324
- interface AutopilotMsgWrapper {
325
- autpilotMsg?: AutopilotMsg;
326
- }
327
- /** A transfer facilitated by the Axelar bridge */
328
- interface AxelarTransfer {
329
- /** Canonical chain-id of the source chain of the bridge transaction */
330
- fromChainId?: string;
331
- /** Canonical chain-id of the destination chain of the bridge transaction */
332
- toChainId?: string;
333
- /** Axelar-name of the asset to bridge */
334
- asset?: string;
335
- /** Whether to unwrap the asset at the destination chain (from ERC-20 to native) */
336
- shouldUnwrap?: boolean;
337
- /** Denom of the input asset */
338
- denomIn?: string;
339
- /** Denom of the output asset */
340
- denomOut?: string;
341
- /** Amount of the fee asset to be paid as the Axelar bridge fee. This is denominated in the fee asset. */
342
- feeAmount?: string;
343
- /** Amount of the fee asset to be paid as the Axelar bridge fee, converted to USD value */
344
- usdFeeAmount?: string;
345
- feeAsset?: Asset;
346
- /** Whether the source and destination chains are both testnets */
347
- isTestnet?: boolean;
348
- /** A cross-chain transfer */
349
- ibcTransferToAxelar?: Transfer;
350
- /**
351
- * Bridge Type:
352
- * * `IBC` - IBC Bridge
353
- * * `AXELAR` - Axelar Bridge
354
- * * `CCTP` - CCTP Bridge
355
- * * `HYPERLANE` - Hyperlane Bridge
356
- * * `OPINIT` - Opinit Bridge
357
- * * `GO_FAST` - Go Fast Bridge
358
- * * `STARGATE` - Stargate Bridge
359
- * * `LAYER_ZERO` - Layerzero Bridge
360
- * * `EUREKA` - IBC Eureka Bridge
361
- */
362
- bridgeId?: BridgeType;
363
- /** Indicates whether this transfer is relayed via Smart Relay */
364
- smartRelay?: boolean;
365
- /**
366
- * Deprecated, use from_chain_id instead. Name for source chain of the bridge transaction used on Axelar
367
- * @deprecated
368
- */
369
- fromChain?: string;
370
- /**
371
- * Deprecated, use to_chain_id instead. Name for destination chain of the bridge transaction used on Axelar
372
- * @deprecated
373
- */
374
- toChain?: string;
375
- }
376
- interface AxelarTransferInfo {
377
- /** Link to the transaction on the Axelar Scan explorer */
378
- axelarScanLink?: string;
379
- /** Chain ID of the destination chain */
380
- toChainId: string;
381
- /** Chain ID of the source chain */
382
- fromChainId: string;
383
- /**
384
- * Axelar transfer state:
385
- * * `AXELAR_TRANSFER_UNKNOWN` - Unknown error
386
- * * `AXELAR_TRANSFER_PENDING_CONFIRMATION` - Axelar transfer is pending confirmation
387
- * * `AXELAR_TRANSFER_PENDING_RECEIPT` - Axelar transfer is pending receipt at destination
388
- * * `AXELAR_TRANSFER_SUCCESS` - Axelar transfer succeeded and assets have been received
389
- * * `AXELAR_TRANSFER_FAILURE` - Axelar transfer failed
390
- */
391
- state: AxelarTransferState;
392
- txs: {
393
- contractCallWithTokenTxs?: ContractCallWithTokenTxs;
394
- } | SendTokenTxs;
395
- /**
396
- * Axelar transfer type:
397
- * * `AXELAR_TRANSFER_CONTRACT_CALL_WITH_TOKEN` - GMP contract call with token transfer type
398
- * * `AXELAR_TRANSFER_SEND_TOKEN` - Send token transfer type
399
- */
400
- type?: AxelarTransferType;
401
- }
402
- interface AxelarTransferWrapper {
403
- /** A transfer facilitated by the Axelar bridge */
404
- axelarTransfer?: AxelarTransfer;
405
- }
406
- /** Details about the fee paid for Smart Relaying */
407
- interface SmartRelayFeeQuote {
408
- /** The USDC fee amount */
409
- feeAmount?: string;
410
- /** Address of the relayer */
411
- relayerAddress?: string;
412
- /** Expiration time of the fee quote */
413
- expiration?: string;
414
- /** The fee asset denomination */
415
- feeDenom?: string;
416
- /** The address the fee should be sent to */
417
- feePaymentAddress?: string;
418
- }
419
- /** A transfer facilitated by the CCTP bridge */
420
- interface CCTPTransfer {
421
- /** Canonical chain-id of the source chain of the bridge transaction */
422
- fromChainId?: string;
423
- /** Canonical chain-id of the destination chain of the bridge transaction */
424
- toChainId?: string;
425
- /** Name of the asset to bridge. It will be the erc-20 contract address for EVM chains and `uusdc` for Noble. */
426
- burnToken?: string;
427
- /** Denom of the input asset */
428
- denomIn?: string;
429
- /** Denom of the output asset */
430
- denomOut?: string;
431
- /**
432
- * Bridge Type:
433
- * * `IBC` - IBC Bridge
434
- * * `AXELAR` - Axelar Bridge
435
- * * `CCTP` - CCTP Bridge
436
- * * `HYPERLANE` - Hyperlane Bridge
437
- * * `OPINIT` - Opinit Bridge
438
- * * `GO_FAST` - Go Fast Bridge
439
- * * `STARGATE` - Stargate Bridge
440
- * * `LAYER_ZERO` - Layerzero Bridge
441
- * * `EUREKA` - IBC Eureka Bridge
442
- */
443
- bridgeId?: BridgeType;
444
- /** Indicates whether this transfer is relayed via Smart Relay */
445
- smartRelay?: boolean;
446
- smartRelayFeeQuote?: SmartRelayFeeQuote;
447
- }
448
- interface CCTPTransferInfo {
449
- /** Chain ID of the destination chain */
450
- toChainId?: string;
451
- /** Chain ID of the source chain */
452
- fromChainId?: string;
453
- /**
454
- * CCTP transfer state:
455
- * * `CCTP_TRANSFER_UNKNOWN` - Unknown error
456
- * * `CCTP_TRANSFER_SENT` - The burn transaction on the source chain has executed
457
- * * `CCTP_TRANSFER_PENDING_CONFIRMATION` - CCTP transfer is pending confirmation by the cctp attestation api
458
- * * `CCTP_TRANSFER_CONFIRMED` - CCTP transfer has been confirmed by the cctp attestation api
459
- * * `CCTP_TRANSFER_RECEIVED` - CCTP transfer has been received at the destination chain
460
- */
461
- state?: CCTPTransferState;
462
- txs?: CCTPTransferTxs;
463
- }
464
- interface CCTPTransferTxs {
465
- sendTx?: ChainTransaction;
466
- receiveTx?: ChainTransaction;
467
- }
468
- interface CCTPTransferWrapper {
469
- /** A transfer facilitated by the CCTP bridge */
470
- cctpTransfer?: CCTPTransfer;
471
- }
472
- /** A transfer facilitated by the Stargate bridge */
473
- interface StargateTransfer {
474
- /** Canonical chain-id of the source chain of the bridge transaction */
475
- fromChainId?: string;
476
- /** Canonical chain-id of the destination chain of the bridge transaction */
477
- toChainId?: string;
478
- /** Denom of the input asset */
479
- denomIn?: string;
480
- /** Denom of the output asset */
481
- denomOut?: string;
482
- poolAddress?: string;
483
- destinationEndpointId?: number;
484
- oftFeeAsset?: Asset;
485
- oftFeeAmount?: string;
486
- oftFeeAmountUsd?: string;
487
- messagingFeeAsset?: Asset;
488
- messagingFeeAmount?: string;
489
- messagingFeeAmountUsd?: string;
490
- /**
491
- * Bridge Type:
492
- * * `IBC` - IBC Bridge
493
- * * `AXELAR` - Axelar Bridge
494
- * * `CCTP` - CCTP Bridge
495
- * * `HYPERLANE` - Hyperlane Bridge
496
- * * `OPINIT` - Opinit Bridge
497
- * * `GO_FAST` - Go Fast Bridge
498
- * * `STARGATE` - Stargate Bridge
499
- * * `LAYER_ZERO` - Layerzero Bridge
500
- * * `EUREKA` - IBC Eureka Bridge
501
- */
502
- bridgeId?: BridgeType;
503
- }
504
- interface StargateTransferTxs {
505
- sendTx?: ChainTransaction;
506
- receiveTx?: ChainTransaction;
507
- errorTx?: ChainTransaction;
508
- }
509
- interface StargateTransferInfo {
510
- /** Chain ID of the source chain */
511
- fromChainId?: string;
512
- /** Chain ID of the destination chain */
513
- toChainId?: string;
514
- /**
515
- * Stargate transfer state:
516
- * * `STARGATE_TRANSFER_UNKNOWN` - Unknown error
517
- * * `STARGATE_TRANSFER_SENT` - The Stargate transfer transaction on the source chain has executed
518
- * * `STARGATE_TRANSFER_PENDING_CONFIRMATION` - Stargate transfer is pending confirmation
519
- * * `STARGATE_TRANSFER_CONFIRMED` - Stargate transfer has been confirmed
520
- * * `STARGATE_TRANSFER_RECEIVED` - Stargate transfer has been received at the destination chain
521
- * * `STARGATE_TRANSFER_FAILED` - Stargate transfer failed
522
- */
523
- state?: StargateTransferState;
524
- txs?: StargateTransferTxs;
525
- }
526
- interface StargateTransferWrapper {
527
- /** A transfer facilitated by the Stargate bridge */
528
- stargateTransfer?: StargateTransfer;
529
- }
530
- /** A transfer facilitated by GoFast */
531
- interface GoFastTransfer {
532
- /** Canonical chain-id of the source chain of the bridge transaction */
533
- fromChainId?: string;
534
- /** Canonical chain-id of the destination chain of the bridge transaction */
535
- toChainId?: string;
536
- /** Go fast Fee */
537
- fee?: GoFastFee;
538
- /**
539
- * Bridge Type:
540
- * * `IBC` - IBC Bridge
541
- * * `AXELAR` - Axelar Bridge
542
- * * `CCTP` - CCTP Bridge
543
- * * `HYPERLANE` - Hyperlane Bridge
544
- * * `OPINIT` - Opinit Bridge
545
- * * `GO_FAST` - Go Fast Bridge
546
- * * `STARGATE` - Stargate Bridge
547
- * * `LAYER_ZERO` - Layerzero Bridge
548
- * * `EUREKA` - IBC Eureka Bridge
549
- */
550
- bridgeId?: BridgeType;
551
- /** Denom of the input asset */
552
- denomIn?: string;
553
- /** Denom of the output asset */
554
- denomOut?: string;
555
- /** Source domain ID of the transfer */
556
- sourceDomain?: string;
557
- /** Destination domain ID of the transfer */
558
- destinationDomain?: string;
559
- }
560
- interface GoFastTransferTxs {
561
- orderSubmittedTx?: ChainTransaction;
562
- orderFilledTx?: ChainTransaction;
563
- orderRefundedTx?: ChainTransaction;
564
- orderTimeoutTx?: ChainTransaction;
565
- }
566
- interface GoFastTransferInfo {
567
- /** Chain Id of the source chain */
568
- fromChainId: string;
569
- /** Chain Id of the destination chain */
570
- toChainId: string;
571
- /**
572
- * GoFast transfer state:
573
- * * `GO_FAST_TRANSFER_UNKNOWN` - Unknown state
574
- * * `GO_FAST_TRANSFER_SENT` - Order submitted on source chain
575
- * * `GO_FAST_POST_ACTION_FAILED` - Order filled, but subsequent action (e.g., swap) failed
576
- * * `GO_FAST_TRANSFER_TIMEOUT` - Order timed out
577
- * * `GO_FAST_TRANSFER_FILLED` - Order filled on destination chain
578
- * * `GO_FAST_TRANSFER_REFUNDED` - Order refunded
579
- */
580
- state: GoFastTransferState;
581
- txs: GoFastTransferTxs;
582
- /** Error message if the transfer failed post-fill */
583
- errorMessage?: string;
584
- }
585
- interface GoFastTransferWrapper {
586
- /** A transfer facilitated by GoFast */
587
- goFastTransfer?: GoFastTransfer;
588
- }
589
- interface BalanceRequestChainEntry {
590
- /** Address of the wallet that the balance is requested for */
591
- address?: string;
592
- /** Denoms of the assets to get the balance for */
593
- denoms?: string[];
594
- }
595
- interface BalanceResponseDenomEntry {
596
- amount: string;
597
- /** @format int32 */
598
- decimals?: number;
599
- formattedAmount: string;
600
- price?: string;
601
- valueUsd?: string;
602
- error?: ApiError;
603
- }
604
- interface BalanceResponseChainEntry {
605
- denoms?: Record<string, BalanceResponseDenomEntry>;
606
- }
607
- interface BankSend {
608
- /** Chain-id of the chain that the transaction is intended for */
609
- chainId?: string;
610
- /** Denom of the asset to send */
611
- denom?: string;
612
- }
613
- interface BankSendWrapper {
614
- bankSend?: BankSend;
615
- }
616
- interface Bridge {
617
- /**
618
- * Bridge Type:
619
- * * `IBC` - IBC Bridge
620
- * * `AXELAR` - Axelar Bridge
621
- * * `CCTP` - CCTP Bridge
622
- * * `HYPERLANE` - Hyperlane Bridge
623
- * * `OPINIT` - Opinit Bridge
624
- * * `GO_FAST` - Go Fast Bridge
625
- * * `STARGATE` - Stargate Bridge
626
- * * `LAYER_ZERO` - Layerzero Bridge
627
- * * `EUREKA` - IBC Eureka Bridge
628
- */
629
- id?: BridgeType;
630
- /** Name of the bridge */
631
- name?: string;
632
- /** URI pointing to an image of the logo of the bridge */
633
- logoUri?: string;
634
- }
635
- interface Chain {
636
- /** Name of the chain */
637
- chainName: string;
638
- /** Chain-id of the chain */
639
- chainId: string;
640
- /** Whether the PFM module is enabled on the chain */
641
- pfmEnabled: boolean;
642
- /** Supported cosmos modules */
643
- cosmosModuleSupport: CosmosModuleSupport;
644
- /** Whether the chain supports IBC memos */
645
- supportsMemo: boolean;
646
- /** chain logo URI */
647
- logoUri?: string;
648
- /** Bech32 prefix of the chain */
649
- bech32Prefix: string;
650
- /** Fee assets of the chain */
651
- feeAssets: FeeAsset[];
652
- /** Type of chain, e.g. "cosmos" or "evm" */
653
- chainType: ChainType;
654
- /** IBC capabilities of the chain */
655
- ibcCapabilities: IbcCapabilities;
656
- /** Whether the chain is a testnet */
657
- isTestnet: boolean;
658
- /** User friendly name of the chain */
659
- prettyName: string;
660
- }
661
- interface ChainAffiliates {
662
- /** An array of affiliates that receives fees from a swap */
663
- affiliates?: Affiliate[];
664
- }
665
- interface ContractCallWithTokenError {
666
- /** Error message */
667
- message?: string;
668
- /**
669
- * ContractCallWithToken errors:
670
- * * `CONTRACT_CALL_WITH_TOKEN_EXECUTION_ERROR` - Error occurred during the execute transaction
671
- */
672
- type?: ContractCallWithTokenErrorType;
673
- }
674
- interface ContractCallWithTokenTxs {
675
- approveTx?: ChainTransaction;
676
- confirmTx?: ChainTransaction;
677
- error?: ContractCallWithTokenError;
678
- executeTx?: ChainTransaction;
679
- gasPaidTx?: ChainTransaction;
680
- sendTx?: ChainTransaction;
681
- }
682
- interface CosmWasmContractMsg {
683
- /** Address of the contract to execute the message on */
684
- contractAddress?: string;
685
- /** JSON string of the message */
686
- msg?: string;
687
- }
688
- interface CosmWasmContractMsgWrapper {
689
- wasmMsg?: CosmWasmContractMsg;
690
- }
691
- /** An ERC20 token contract approval */
692
- interface Erc20Approval {
693
- /** Amount of the approval */
694
- amount: string;
695
- /** Address of the spender */
696
- spender: string;
697
- /** Address of the ERC20 token contract */
698
- tokenContract: string;
699
- }
700
- interface ErrorDetail {
701
- /**
702
- * Error detail:
703
- * * `LOW_INFO_ERROR` - Not enough asset pricing information to determine the price safety of the route.
704
- * * `BAD_PRICE_ERROR` - The execution price of the route deviates significantly from the current market price.
705
- * * `HIGH_LOSS_ERROR` - The route would result in a USD loss exceeding the configured threshold and has been blocked.
706
- */
707
- reason?: "LOW_INFO_ERROR" | "BAD_PRICE_ERROR" | "HIGH_LOSS_ERROR";
708
- }
709
- interface Error {
710
- /** Error code */
711
- code?: GRPCStatusCode;
712
- /** Additional error details */
713
- details?: ErrorDetail[];
714
- /** Error message */
715
- message?: string;
716
- }
717
- /** A message in a cosmos transaction */
718
- interface CosmosMsg {
719
- /** JSON string of the message */
720
- msg?: string;
721
- /** TypeUrl of the message */
722
- msgTypeUrl?: string;
723
- }
724
- /** A transaction on a Cosmos chain */
725
- interface CosmosTx {
726
- /** Chain-id of the chain that the transaction is intended for */
727
- chainId: string;
728
- /** Path of chain-ids that the message is intended to interact with */
729
- path?: string[];
730
- /** The address of the wallet that will sign this transaction */
731
- signerAddress?: string;
732
- /** The messages that should be included in the transaction. The ordering must be adhered to. */
733
- msgs?: CosmosMsg[];
734
- }
735
- interface CosmosTxWrapper {
736
- /** A transaction on a Cosmos chain */
737
- cosmosTx: CosmosTx;
738
- }
739
- /** A swap on an EVM chain */
740
- interface EvmSwap {
741
- /** Address of the input token. Empty string if native token. */
742
- inputToken?: string;
743
- /** Amount of the input token */
744
- amountIn?: string;
745
- /** Calldata for the swap */
746
- swapCalldata?: string;
747
- /** Amount of the output token */
748
- amountOut?: string;
749
- /** Chain-id for the swap */
750
- fromChainId?: string;
751
- /** Denom of the input asset */
752
- denomIn?: string;
753
- /** Denom of the output asset */
754
- denomOut?: string;
755
- /** Venues used for the swap */
756
- swapVenues?: SwapVenue[];
757
- }
758
- interface EvmSwapWrapper {
759
- /** A swap on an EVM chain */
760
- evmSwap?: EvmSwap;
761
- }
762
- /** A transaction on an EVM chain */
763
- interface EvmTx {
764
- /** Chain-id of the chain that the transaction is intended for */
765
- chainId: string;
766
- /** Data of the transaction */
767
- data?: string;
768
- /** ERC20 approvals required for the transaction */
769
- requiredErc20Approvals?: Erc20Approval[];
770
- /** The address of the wallet that will sign this transaction */
771
- signerAddress?: string;
772
- /** Address of the recipient of the transaction */
773
- to?: string;
774
- /** Amount of the transaction */
775
- value?: string;
776
- }
777
- interface EvmTxWrapper {
778
- /** A transaction on an EVM chain */
779
- evmTx: EvmTx;
780
- }
781
- /** A transaction on an SVM chain */
782
- interface SvmTx {
783
- /** Chain-id of the chain that the transaction is intended for */
784
- chainId: string;
785
- /** The address of the wallet that will sign this transaction */
786
- signerAddress?: string;
787
- /** Base64 encoded unsigned or partially signed transaction */
788
- tx?: string;
789
- }
790
- interface SvmTxWrapper {
791
- /** A transaction on an SVM chain */
792
- svmTx: SvmTx;
793
- }
794
- /** Asset used to pay gas fees and the recommended price tiers. Assets and gas price recommendations are sourced from the [keplr chain registry](https://github.com/chainapsis/keplr-chain-registry) */
795
- interface FeeAsset {
796
- /** Asset denom */
797
- denom: string;
798
- /** Gas price tiers */
799
- gasPrice?: {
800
- /** Average gas price */
801
- average?: string;
802
- /** High gas price */
803
- high?: string;
804
- /** Low gas price */
805
- low?: string;
806
- };
807
- }
808
- /** Go fast Fee */
809
- interface GoFastFee {
810
- feeAsset: Asset;
811
- bpsFee?: string;
812
- bpsFeeAmount?: string;
813
- bpsFeeUsd?: string;
814
- sourceChainFeeAmount?: string;
815
- sourceChainFeeUsd?: string;
816
- destinationChainFeeAmount?: string;
817
- destinationChainFeeUsd?: string;
818
- }
819
- /** grpc status codes as defined [here](https://grpc.github.io/grpc/core/md_doc_statuscodes.html) */
820
- type GRPCStatusCode = number;
821
- /** A transfer facilitated by the Hyperlane bridge */
822
- interface HyperlaneTransfer {
823
- /** Canonical chain-id of the source chain of the bridge transaction */
824
- fromChainId?: string;
825
- /** Canonical chain-id of the destination chain of the bridge transaction */
826
- toChainId?: string;
827
- /** Denom of the input asset */
828
- denomIn?: string;
829
- /** Denom of the output asset */
830
- denomOut?: string;
831
- /** Contract address of the hyperlane warp route contract that initiates the transfer */
832
- hyperlaneContractAddress?: string;
833
- /** Amount of the fee asset to be paid as the Hyperlane bridge fee. This is denominated in the fee asset. */
834
- feeAmount?: string;
835
- /** Amount of the fee asset to be paid as the Hyperlane bridge fee, converted to USD value */
836
- usdFeeAmount?: string;
837
- feeAsset?: Asset;
838
- /**
839
- * Bridge Type:
840
- * * `IBC` - IBC Bridge
841
- * * `AXELAR` - Axelar Bridge
842
- * * `CCTP` - CCTP Bridge
843
- * * `HYPERLANE` - Hyperlane Bridge
844
- * * `OPINIT` - Opinit Bridge
845
- * * `GO_FAST` - Go Fast Bridge
846
- * * `STARGATE` - Stargate Bridge
847
- * * `LAYER_ZERO` - Layerzero Bridge
848
- * * `EUREKA` - IBC Eureka Bridge
849
- */
850
- bridgeId?: BridgeType;
851
- /** Indicates whether this transfer is relayed via Smart Relay */
852
- smartRelay?: boolean;
853
- }
854
- interface HyperlaneTransferInfo {
855
- /** Chain ID of the source chain */
856
- fromChainId: string;
857
- /** Chain ID of the destination chain */
858
- toChainId: string;
859
- /**
860
- * Hyperlane transfer state:
861
- * * `HYPERLANE_TRANSFER_UNKNOWN` - Unknown error
862
- * * `HYPERLANE_TRANSFER_SENT` - The Hyperlane transfer transaction on the source chain has executed
863
- * * `HYPERLANE_TRANSFER_FAILED` - The Hyperlane transfer failed
864
- * * `HYPERLANE_TRANSFER_RECEIVED` - The Hyperlane transfer has been received at the destination chain
865
- */
866
- state: HyperlaneTransferState;
867
- txs: HyperlaneTransferTransactions;
868
- }
869
- interface HyperlaneTransferTransactions {
870
- sendTx?: ChainTransaction;
871
- receiveTx?: ChainTransaction;
872
- }
873
- interface HyperlaneTransferWrapper {
874
- /** A transfer facilitated by the Hyperlane bridge */
875
- hyperlaneTransfer?: HyperlaneTransfer;
876
- }
877
- interface IBCTransferInfo {
878
- /** Chain ID of the destination chain */
879
- toChainId: string;
880
- packetTxs: Packet;
881
- /** Chain ID of the source chain */
882
- fromChainId: string;
883
- /**
884
- * Transfer state:
885
- * * `TRANSFER_UNKNOWN` - Transfer state is not known.
886
- * * `TRANSFER_PENDING` - The send packet for the transfer has been committed and the transfer is pending.
887
- * * `TRANSFER_RECEIVED` - The transfer packet has been received by the destination chain. It can still fail and revert if it is part of a multi-hop PFM transfer.
888
- * * `TRANSFER_SUCCESS` - The transfer has been successfully completed and will not revert.
889
- * * `TRANSFER_FAILURE`- The transfer has failed.
890
- */
891
- state: TransferState;
892
- }
893
- type Msg = MultiChainMsgWrapper | EvmTxWrapper | SvmTxWrapper;
894
- type Tx = (CosmosTxWrapper | EvmTxWrapper | SvmTxWrapper) & {
895
- /** Array of indices of the operations that this transaction executes */
896
- operationsIndices?: number[];
897
- };
898
- /** A message that interacts with multiple chains */
899
- interface MultiChainMsg {
900
- /** Chain-id of the chain that the transaction containing the message is intended for */
901
- chainId?: string;
902
- /** JSON string of the message */
903
- msg?: string;
904
- /** TypeUrl of the message */
905
- msgTypeUrl?: string;
906
- /** Path of chain-ids that the message is intended to interact with */
907
- path?: string[];
908
- }
909
- interface MultiChainMsgWrapper {
910
- /** A message that interacts with multiple chains */
911
- multiChainMsg?: MultiChainMsg;
912
- }
913
- type Operation = (TransferWrapper | SwapWrapper | AxelarTransferWrapper | BankSendWrapper | CCTPTransferWrapper | HyperlaneTransferWrapper | EvmSwapWrapper | OPInitTransferWrapper | GoFastTransferWrapper | StargateTransferWrapper | LayerZeroTransferWrapper | EurekaTransferWrapper) & {
914
- /** Index of the tx returned from Msgs that executes this operation */
915
- txIndex: number;
916
- /** Amount of input asset to this operation */
917
- amountIn: string;
918
- /** Amount of output asset from this operation */
919
- amountOut: string;
920
- };
921
- interface OptionalAsset {
922
- asset?: Asset;
923
- /** Whether the asset was found */
924
- assetFound?: boolean;
925
- }
926
- interface LayerZeroTransferTransactions {
927
- sendTx?: ChainTransaction;
928
- receiveTx?: ChainTransaction;
929
- composeTx?: ChainTransaction;
930
- errorTx?: ChainTransaction;
931
- }
932
- interface Packet {
933
- acknowledgeTx?: ChainTransaction;
934
- error?: PacketError;
935
- receiveTx?: ChainTransaction;
936
- sendTx?: ChainTransaction;
937
- timeoutTx?: ChainTransaction;
938
- }
939
- interface PacketError {
940
- details?: AcknowledgementErrorDetails;
941
- /** Error message */
942
- message?: string;
943
- /**
944
- * Packet error type:
945
- * * `PACKET_ERROR_UNKNOWN` - Unknown error
946
- * * `PACKET_ERROR_ACKNOWLEDGEMENT` - Packet acknowledgement error
947
- * * `PACKET_ERROR_TIMEOUT` - Packet timed out
948
- */
949
- type?: PacketErrorType;
950
- }
951
- interface ChainTransaction {
952
- /** Chain ID the packet event occurs on */
953
- chainId?: string;
954
- /** Link to the transaction on block explorer */
955
- explorerLink: string;
956
- /** Hash of the transaction the packet event occurred in */
957
- txHash?: string;
958
- /** RFC3339 formatted UTC timestamp of when the transaction landed on chain */
959
- onChainAt?: string;
960
- }
961
- type PostHandler = CosmWasmContractMsgWrapper | AutopilotMsgWrapper;
962
- interface Route {
963
- /** Amount of source asset to be transferred or swapped */
964
- amountIn: string;
965
- /** Amount of destination asset out */
966
- amountOut: string;
967
- /** Chain-ids of all chains of the transfer or swap, in order of usage by operations in the route */
968
- chainIds: string[];
969
- /** All chain-ids that require an address to be provided for, in order of usage by operations in the route */
970
- requiredChainAddresses: string[];
971
- /** Chain-id of the destination asset */
972
- destAssetChainId: string;
973
- /** Denom of the destination asset */
974
- destAssetDenom: string;
975
- /** Whether this route performs a swap */
976
- doesSwap?: boolean;
977
- /** Amount of destination asset out, if a swap is performed */
978
- estimatedAmountOut: string;
979
- /** Array of operations required to perform the transfer or swap */
980
- operations: Operation[];
981
- /** Chain-id of the source asset */
982
- sourceAssetChainId: string;
983
- /** Denom of the source asset */
984
- sourceAssetDenom: string;
985
- /** Swap venue on which the swap is performed, if a swap is performed */
986
- swapVenues?: SwapVenue[];
987
- /** Number of transactions required to perform the transfer or swap */
988
- txsRequired: number;
989
- /** Amount of the source denom, converted to USD value */
990
- usdAmountIn?: string;
991
- /** Amount of the destination denom expected to be received, converted to USD value */
992
- usdAmountOut?: string;
993
- /** Price impact of the estimated swap, if present. Measured in percentage e.g. "0.5" is .5% */
994
- swapPriceImpactPercent?: string;
995
- /** Indicates if the route is unsafe due to poor execution price or if safety cannot be determined due to lack of pricing information */
996
- warning?: {
997
- /**
998
- * Recommendation reason:
999
- * * `LOW_INFO_WARNING` - Not enough asset pricing information to determine the price safety of the route.
1000
- * * `BAD_PRICE_WARNING` - The execution price of the route deviates significantly from the current market price.
1001
- */
1002
- type?: RoutePriceWarningType;
1003
- /** Warning message */
1004
- message?: string;
1005
- };
1006
- /** Indicates fees incurred in the execution of the transfer */
1007
- estimatedFees?: Fee[];
1008
- /** The estimated time in seconds for the route to execute */
1009
- estimatedRouteDurationSeconds: number;
1010
- }
1011
- interface SendTokenError {
1012
- /** Error message */
1013
- message?: string;
1014
- /**
1015
- * SendToken error types:
1016
- * * `SEND_TOKEN_EXECUTION_ERROR` - Error occurred during the execute transaction
1017
- */
1018
- type?: SendTokenErrorType;
1019
- }
1020
- interface SendTokenTxs {
1021
- confirmTx?: ChainTransaction;
1022
- error?: SendTokenError;
1023
- executeTx?: ChainTransaction;
1024
- sendTx?: ChainTransaction;
1025
- }
1026
- interface StatusError {
1027
- details?: TransactionExecutionErrorDetails;
1028
- /** Error message */
1029
- message?: string;
1030
- /**
1031
- * Packet error types:
1032
- * * `STATUS_ERROR_UNKNOWN` - Unknown error
1033
- * * `STATUS_ERROR_TRANSACTION_EXECUTION` - Error was encountered during transaction execution
1034
- * * `STATUS_ERROR_INDEXING` - Error was encountered while indexing the transaction and packet data
1035
- * * `STATUS_ERROR_TRANSFER` - The transfer failed to complete successfully
1036
- */
1037
- type?: StatusErrorType;
1038
- }
1039
- type Swap = (SwapInWrapper | SwapOutWrapper | SmartSwapInWrapper) & {
1040
- /** Estimated total affiliate fee generated by the swap */
1041
- estimatedAffiliateFee?: string;
1042
- /** Chain ID that the swap will be executed on (alias for chain_id) */
1043
- fromChainId?: string;
1044
- /** Chain ID that the swap will be executed on */
1045
- chainId?: string;
1046
- /** Input denom of the swap */
1047
- denomIn?: string;
1048
- /** Output denom of the swap */
1049
- denomOut?: string;
1050
- /** Swap venues that the swap will route through */
1051
- swapVenues?: SwapVenue[];
1052
- };
1053
- /** Specification of a swap with an exact amount in */
1054
- interface SwapExactCoinIn {
1055
- /** Swap venue that this swap should execute on */
1056
- swapVenue?: SwapVenue;
1057
- /** Operations required to execute the swap */
1058
- swapOperations?: SwapOperation[];
1059
- /** Amount to swap in */
1060
- swapAmountIn?: string;
1061
- /** Price impact of the estimated swap, if present. Measured in percentage e.g. "0.5" is .5% */
1062
- priceImpactPercent?: string;
1063
- /** The estimated amount out received from the swap */
1064
- estimatedAmountOut?: string;
1065
- }
1066
- /** Specification of a swap with an exact amount out */
1067
- interface SwapExactCoinOut {
1068
- /** Swap venue that this swap should execute on */
1069
- swapVenue?: SwapVenue;
1070
- /** Operations required to execute the swap */
1071
- swapOperations?: SwapOperation[];
1072
- /** Amount to get out of the swap */
1073
- swapAmountOut?: string;
1074
- /** Price impact of the estimated swap, if present. Measured in percentage e.g. "0.5" is .5% */
1075
- priceImpactPercent?: string;
1076
- }
1077
- interface SwapInWrapper {
1078
- /** Specification of a swap with an exact amount in */
1079
- swapIn?: SwapExactCoinIn;
1080
- }
1081
- /** Description of a single swap operation */
1082
- interface SwapOperation {
1083
- /** Input denom of the swap */
1084
- denomIn?: string;
1085
- /** Output denom of the swap */
1086
- denomOut?: string;
1087
- /** Identifier of the pool to use for the swap */
1088
- pool?: string;
1089
- /** Optional dditional metadata a swap adapter may require */
1090
- interface?: string;
1091
- }
1092
- interface SwapOutWrapper {
1093
- /** Specification of a swap with an exact amount out */
1094
- swapOut?: SwapExactCoinOut;
1095
- }
1096
- interface SwapRoute {
1097
- /** Amount to swap in */
1098
- swapAmountIn?: string;
1099
- /** Denom in of the swap */
1100
- denomIn?: string;
1101
- /** Operations required to execute the swap route */
1102
- swapOperations?: SwapOperation[];
1103
- }
1104
- /** Specification of a smart swap in operation */
1105
- interface SmartSwapExactCoinIn {
1106
- /** Swap venue that this swap should execute on */
1107
- swapVenue?: SwapVenue;
1108
- /** Routes to execute the swap */
1109
- swapRoutes?: SwapRoute[];
1110
- /** The estimated amount out received from the swap */
1111
- estimatedAmountOut?: string;
1112
- }
1113
- interface SmartSwapOptions {
1114
- /** Indicates whether the swap can be split into multiple swap routes */
1115
- splitRoutes?: boolean;
1116
- /** Indicates whether to include routes that swap on EVM chains */
1117
- evmSwaps?: boolean;
1118
- }
1119
- interface SmartSwapInWrapper {
1120
- /** Specification of a smart swap in operation */
1121
- smartSwapIn?: SmartSwapExactCoinIn;
1122
- }
1123
- /** A venue on which swaps can be exceuted */
1124
- interface SwapVenue {
1125
- /** Chain ID of the swap venue */
1126
- chainId?: string;
1127
- /** Name of the swap venue */
1128
- name?: string;
1129
- /** URI for the venue's logo */
1130
- logoUri?: string;
1131
- }
1132
- interface SwapWrapper {
1133
- swap?: Swap;
1134
- }
1135
- interface TransactionExecutionErrorDetails {
1136
- /** Error code */
1137
- code?: number;
1138
- /** Error message */
1139
- message?: string;
1140
- }
1141
- /** A transfer facilitated by the OP Init bridge */
1142
- interface OPInitTransfer {
1143
- /** Canonical chain-id of the source chain of the bridge transaction */
1144
- fromChainId?: string;
1145
- /** Canonical chain-id of the destination chain of the bridge transaction */
1146
- toChainId?: string;
1147
- /** Denom of the input asset */
1148
- denomIn?: string;
1149
- /** Denom of the output asset */
1150
- denomOut?: string;
1151
- /** Identifier used by the OPInit bridge to identify the L1-L2 pair the transfer occurs between */
1152
- opInitBridgeId?: any;
1153
- /**
1154
- * Bridge Type:
1155
- * * `IBC` - IBC Bridge
1156
- * * `AXELAR` - Axelar Bridge
1157
- * * `CCTP` - CCTP Bridge
1158
- * * `HYPERLANE` - Hyperlane Bridge
1159
- * * `OPINIT` - Opinit Bridge
1160
- * * `GO_FAST` - Go Fast Bridge
1161
- * * `STARGATE` - Stargate Bridge
1162
- * * `LAYER_ZERO` - Layerzero Bridge
1163
- * * `EUREKA` - IBC Eureka Bridge
1164
- */
1165
- bridgeId?: BridgeType;
1166
- /** Indicates whether this transfer is relayed via Smart Relay */
1167
- smartRelay?: boolean;
1168
- }
1169
- interface OPInitTransferWrapper {
1170
- /** A transfer facilitated by the OP Init bridge */
1171
- opInitTransfer?: OPInitTransfer;
1172
- }
1173
- interface OPInitTransferInfo {
1174
- /** Chain ID of the destination chain */
1175
- toChainId: string;
1176
- /** Chain ID of the source chain */
1177
- fromChainId: string;
1178
- /**
1179
- * OPInit transfer state:
1180
- * * `OPINIT_TRANSFER_UNKNOWN` - Unknown error
1181
- * * `OPINIT_TRANSFER_SENT` - The deposit transaction on the source chain has executed
1182
- * * `OPINIT_TRANSFER_RECEIVED` - OPInit transfer has been received at the destination chain
1183
- */
1184
- state: OPInitTransferState;
1185
- txs: OPInitTransferTxs;
1186
- }
1187
- interface OPInitTransferTxs {
1188
- sendTx?: ChainTransaction;
1189
- receiveTx?: ChainTransaction;
1190
- }
1191
- /** A cross-chain transfer */
1192
- interface Transfer {
1193
- /** Port to use to initiate the transfer */
1194
- port?: string;
1195
- /** Channel to use to initiate the transfer */
1196
- channel?: string;
1197
- /** Chain-id on which the transfer is initiated */
1198
- fromChainId?: string;
1199
- /** Chain-id on which the transfer is received */
1200
- toChainId?: string;
1201
- /** Whether pfm is enabled on the chain where the transfer is initiated */
1202
- pfmEnabled?: boolean;
1203
- /** Whether the transfer chain supports a memo */
1204
- supportsMemo?: boolean;
1205
- /** Denom of the input asset of the transfer */
1206
- denomIn?: string;
1207
- /** Denom of the output asset of the transfer */
1208
- denomOut?: string;
1209
- /** Amount of the fee asset to be paid as the transfer fee if applicable. */
1210
- feeAmount?: string;
1211
- /** Amount of the fee asset to be paid as the transfer fee if applicable, converted to USD value */
1212
- usdFeeAmount?: string;
1213
- /** Asset to be paid as the transfer fee if applicable. */
1214
- feeAsset?: Asset;
1215
- /**
1216
- * Bridge Type:
1217
- * * `IBC` - IBC Bridge
1218
- * * `AXELAR` - Axelar Bridge
1219
- * * `CCTP` - CCTP Bridge
1220
- * * `HYPERLANE` - Hyperlane Bridge
1221
- * * `OPINIT` - Opinit Bridge
1222
- * * `GO_FAST` - Go Fast Bridge
1223
- * * `STARGATE` - Stargate Bridge
1224
- * * `LAYER_ZERO` - Layerzero Bridge
1225
- * * `EUREKA` - IBC Eureka Bridge
1226
- */
1227
- bridgeId?: BridgeType;
1228
- /** Indicates whether this transfer is relayed via Smart Relay */
1229
- smartRelay?: boolean;
1230
- /** Address of the entry contract on the destination chain */
1231
- toChainEntryContractAddress?: string;
1232
- /** Address of the callback contract on the destination chain */
1233
- toChainCallbackContractAddress?: string;
1234
- /**
1235
- * Deprecated, use denom_out instead. Denom of the destination asset of the transfer
1236
- * @deprecated
1237
- */
1238
- destDenom?: string;
1239
- }
1240
- interface TransferEvent {
1241
- ibcTransfer?: IBCTransferInfo;
1242
- axelarTransfer?: AxelarTransferInfo;
1243
- cctpTransfer?: CCTPTransferInfo;
1244
- hyperlaneTransfer?: HyperlaneTransferInfo;
1245
- opInitTransfer?: OPInitTransferInfo;
1246
- stargateTransfer?: StargateTransferInfo;
1247
- goFastTransfer?: GoFastTransferInfo;
1248
- eurekaTransfer?: EurekaTransferInfo;
1249
- layerZeroTransfer?: LayerZeroTransferInfo;
1250
- }
1251
- /** Indicates location and denom of transfer asset release. */
1252
- interface TransferAssetRelease {
1253
- /** The chain ID of the chain that the transfer asset is released on. */
1254
- chainId?: string;
1255
- /** The denom of the asset that is released. */
1256
- denom?: string;
1257
- /** The amount of the asset that is released. */
1258
- amount?: string;
1259
- /** Indicates whether assets have been released and are accessible. The assets may still be in transit. */
1260
- released?: boolean;
1261
- }
1262
- interface TransferStatus {
1263
- /**
1264
- * Transaction state:
1265
- * * `STATE_SUBMITTED` - The initial transaction has been submitted to Skip Go API but not observed on chain yet
1266
- * * `STATE_PENDING` - The initial transaction has been observed on chain, and there are still pending actions
1267
- * * `STATE_COMPLETED_SUCCESS` - The route has completed successfully and the user has their tokens on the destination. (indicated by `transfer_asset_release`)
1268
- * * `STATE_COMPLETED_ERROR` - The route errored somewhere and the user has their tokens unlocked in one of their wallets. Their tokens are either on the source chain, an intermediate chain, or the destination chain but as the wrong asset.
1269
- * (Again, `transfer_asset_release` indicates where the tokens are)
1270
- * * `STATE_ABANDONED` - Tracking for the transaction has been abandoned. This happens if the cross-chain sequence of actions stalls for more than 10 minutes or if the initial transaction does not get observed in a block for 5 minutes.
1271
- * * `STATE_PENDING_ERROR` - The overall transaction will fail, pending error propagation
1272
- */
1273
- state?: TransactionState;
1274
- /** Lists any IBC and Axelar transfers as they are seen. */
1275
- transferSequence?: TransferEvent[];
1276
- /** Indicates which entry in the `transfer_sequence` field that the transfer is blocked on. Will be null if there is no blocked transfer. */
1277
- nextBlockingTransfer?: {
1278
- /** The index of the entry in the `transfer_sequence` field that the transfer is blocked on. */
1279
- transferSequenceIndex?: number;
1280
- };
1281
- /** Indicates location and denom of transfer asset release. */
1282
- transferAssetRelease?: TransferAssetRelease;
1283
- error?: StatusError;
1284
- }
1285
- interface TransferWrapper {
1286
- /** A cross-chain transfer */
1287
- transfer?: Transfer;
1288
- }
1289
- /** An IBC Eureka transfer */
1290
- interface EurekaTransfer {
1291
- /** Port on the destination chain */
1292
- destinationPort?: string;
1293
- /** Client on the source chain */
1294
- sourceClient?: string;
1295
- /** Chain-id on which the transfer is initiated */
1296
- fromChainId?: string;
1297
- /** Chain-id on which the transfer is received */
1298
- toChainId?: string;
1299
- /** Whether pfm is enabled on the chain where the transfer is initiated */
1300
- pfmEnabled?: boolean;
1301
- /** Whether the transfer chain supports a memo */
1302
- supportsMemo?: boolean;
1303
- /** Denom of the input asset of the transfer */
1304
- denomIn?: string;
1305
- /** Denom of the output asset of the transfer */
1306
- denomOut?: string;
1307
- /** Address of the Eureka entry contract on the source chain */
1308
- entryContractAddress?: string;
1309
- /** Optional address of the Eureka callback adapter contract on the source chain */
1310
- callbackAdapterContractAddress?: string;
1311
- /**
1312
- * Bridge Type:
1313
- * * `IBC` - IBC Bridge
1314
- * * `AXELAR` - Axelar Bridge
1315
- * * `CCTP` - CCTP Bridge
1316
- * * `HYPERLANE` - Hyperlane Bridge
1317
- * * `OPINIT` - Opinit Bridge
1318
- * * `GO_FAST` - Go Fast Bridge
1319
- * * `STARGATE` - Stargate Bridge
1320
- * * `LAYER_ZERO` - Layerzero Bridge
1321
- * * `EUREKA` - IBC Eureka Bridge
1322
- */
1323
- bridgeId?: BridgeType;
1324
- /** Indicates whether this transfer is relayed via Smart Relay */
1325
- smartRelay?: boolean;
1326
- smartRelayFeeQuote?: SmartRelayFeeQuote;
1327
- /** Optional address of the Eureka callback contract on the destination chain */
1328
- toChainCallbackContractAddress?: string;
1329
- /** Optional address of the Eureka entry contract on the destination chain */
1330
- toChainEntryContractAddress?: string;
1331
- }
1332
- interface EurekaTransferInfo {
1333
- /** Chain ID of the source chain */
1334
- fromChainId: string;
1335
- /** Chain ID of the destination chain */
1336
- toChainId: string;
1337
- /**
1338
- * Transfer state:
1339
- * * `TRANSFER_UNKNOWN` - Transfer state is not known.
1340
- * * `TRANSFER_PENDING` - The send packet for the transfer has been committed and the transfer is pending.
1341
- * * `TRANSFER_RECEIVED` - The transfer packet has been received by the destination chain. It can still fail and revert if it is part of a multi-hop PFM transfer.
1342
- * * `TRANSFER_SUCCESS` - The transfer has been successfully completed and will not revert.
1343
- * * `TRANSFER_FAILURE`- The transfer has failed.
1344
- */
1345
- state: TransferState;
1346
- packetTxs: Packet;
1347
- }
1348
- interface EurekaTransferWrapper {
1349
- /** An IBC Eureka transfer */
1350
- eurekaTransfer?: EurekaTransfer;
1351
- }
1352
- /** A Layer Zero Transfer */
1353
- interface LayerZeroTransfer {
1354
- /** Chain-id on which the transfer is initiated */
1355
- fromChainId: string;
1356
- /** Chain-id on which the transfer is received */
1357
- toChainId: string;
1358
- /** Denom of the input asset of the transfer */
1359
- denomIn: string;
1360
- /** Denom of the output asset of the transfer */
1361
- denomOut: string;
1362
- sourceOftContractAddress: string;
1363
- destinationEndpointId: number;
1364
- messagingFeeAsset: Asset;
1365
- messagingFeeAmount: string;
1366
- messagingFeeAmountUsd: string;
1367
- /**
1368
- * Bridge Type:
1369
- * * `IBC` - IBC Bridge
1370
- * * `AXELAR` - Axelar Bridge
1371
- * * `CCTP` - CCTP Bridge
1372
- * * `HYPERLANE` - Hyperlane Bridge
1373
- * * `OPINIT` - Opinit Bridge
1374
- * * `GO_FAST` - Go Fast Bridge
1375
- * * `STARGATE` - Stargate Bridge
1376
- * * `LAYER_ZERO` - Layerzero Bridge
1377
- * * `EUREKA` - IBC Eureka Bridge
1378
- */
1379
- bridgeId: BridgeType;
1380
- }
1381
- interface LayerZeroTransferInfo {
1382
- /** Chain ID of the source chain */
1383
- fromChainId: string;
1384
- /** Chain ID of the destination chain */
1385
- toChainId: string;
1386
- /**
1387
- * LayerZero transfer state:
1388
- * * `LAYER_ZERO_TRANSFER_UNKNOWN` - Unknown error
1389
- * * `LAYER_ZERO_TRANSFER_SENT` - The transaction on the source chain has executed
1390
- * * `LAYER_ZERO_TRANSFER_WAITING_FOR_COMPOSE` - The transfer has been delivered to the destination chain but there is an additional lz_compose transaction that still needs to be delivered before marking this transfer as LAYER_ZERO_TRANSFER_RECEIVED
1391
- * * `LAYER_ZERO_TRANSFER_RECEIVED` - The transfer has been received at the destination chain
1392
- * * `LAYER_ZERO_TRANSFER_FAILED` - The transfer has failed
1393
- */
1394
- state: LayerZeroTransferState;
1395
- txs: LayerZeroTransferTransactions;
1396
- }
1397
- interface LayerZeroTransferWrapper {
1398
- /** A Layer Zero Transfer */
1399
- layerZeroTransfer?: LayerZeroTransfer;
1400
- }
1401
- interface RecommendationRequest {
1402
- /** Denom of the source asset */
1403
- sourceAssetDenom?: string;
1404
- /** Chain-id of the source asset */
1405
- sourceAssetChainId?: string;
1406
- /** Chain-id of the recommended destination asset */
1407
- destChainId?: string;
1408
- /** Reason for recommendation (optional) */
1409
- reason?: Reason;
1410
- }
1411
- interface CosmosModuleSupport {
1412
- /** Whether the authz module is supported */
1413
- authz?: boolean;
1414
- /** Whether the feegrant module is supported */
1415
- feegrant?: boolean;
1416
- }
1417
- interface IbcCapabilities {
1418
- /** Whether the packet forwarding middleware module is supported */
1419
- cosmosPfm?: boolean;
1420
- /** Whether the ibc hooks module is supported */
1421
- cosmosIbcHooks?: boolean;
1422
- /** Whether the chain supports IBC memos */
1423
- cosmosMemo?: boolean;
1424
- /** Whether the autopilot module is supported */
1425
- cosmosAutopilot?: boolean;
1426
- }
1427
- interface Fee {
1428
- /**
1429
- * Fee type:
1430
- * * SMART_RELAY - Fees for Smart relaying services.'
1431
- */
1432
- feeType?: FeeType;
1433
- /**
1434
- * Bridge Type:
1435
- * * `IBC` - IBC Bridge
1436
- * * `AXELAR` - Axelar Bridge
1437
- * * `CCTP` - CCTP Bridge
1438
- * * `HYPERLANE` - Hyperlane Bridge
1439
- * * `OPINIT` - Opinit Bridge
1440
- * * `GO_FAST` - Go Fast Bridge
1441
- * * `STARGATE` - Stargate Bridge
1442
- * * `LAYER_ZERO` - Layerzero Bridge
1443
- * * `EUREKA` - IBC Eureka Bridge
1444
- */
1445
- bridgeId?: BridgeType;
1446
- /** Amount of the fee asset to be paid */
1447
- amount?: string;
1448
- /** The value of the fee in USD */
1449
- usdAmount?: string;
1450
- originAsset: Asset;
1451
- /** Chain ID of the chain where fees are collected */
1452
- chainId?: string;
1453
- /** The index of the transaction in the list of transactions required to execute the transfer where fees are paid */
1454
- txIndex?: number;
1455
- /** The index of the operation in the returned operations list which incurs the fee */
1456
- operationIndex?: number;
1457
- /** Indicates whether this fee is deducted from the transfer amount or charged additionally */
1458
- feeBehavior?: FeeBehavior;
1459
- }
1460
- interface BalancesRequest {
1461
- chains?: Record<string, BalanceRequestChainEntry>;
1462
- }
1463
- interface AssetsFromSourceRequest {
1464
- /** Denom of the source asset */
1465
- sourceAssetDenom: string;
1466
- /** Chain-id of the source asset */
1467
- sourceAssetChainId: string;
1468
- /**
1469
- * Whether to include recommendations requiring multiple transactions to reach the destination
1470
- * @default false
1471
- */
1472
- allowMultiTx?: boolean;
1473
- /** Optional reason for recommending assets */
1474
- recommendationReason?: Reason;
1475
- /**
1476
- * Whether to include swap routes
1477
- * @default false
1478
- */
1479
- includeSwaps?: boolean;
1480
- /** Swap venues to consider if including swap routes */
1481
- swapVenues?: SwapVenue[];
1482
- /**
1483
- * Whether to only return native assets
1484
- * @default false
1485
- */
1486
- nativeOnly?: boolean;
1487
- /** Optional grouping key for results */
1488
- groupBy?: string;
1489
- /**
1490
- * Whether to include CW20 tokens
1491
- * @default false
1492
- */
1493
- includeCw20Assets?: boolean;
1494
- }
1495
- interface RouteRequest {
1496
- /** Denom of the source asset */
1497
- sourceAssetDenom?: string;
1498
- /** Chain-id of the source asset */
1499
- sourceAssetChainId?: string;
1500
- /** Denom of the destination asset */
1501
- destAssetDenom?: string;
1502
- /** Chain-id of the destination asset */
1503
- destAssetChainId?: string;
1504
- /** Amount of source asset to be transferred or swapped. Only one of amount_in and amount_out should be provided. */
1505
- amountIn?: string;
1506
- /** Amount of destination asset to receive. Only one of amount_in and amount_out should be provided. If amount_out is provided for a swap, the route will be computed to give exactly amount_out. */
1507
- amountOut?: string;
1508
- /** Cumulative fee to be distributed to affiliates, in bps (optional) */
1509
- cumulativeAffiliateFeeBps?: string;
1510
- /** Swap venues to consider, if provided (optional) */
1511
- swapVenues?: SwapVenue[];
1512
- /** Toggles whether the api should return routes that fail price safety checks. */
1513
- allowUnsafe?: boolean;
1514
- /** Array of experimental features to enable */
1515
- experimentalFeatures?: string[];
1516
- /**
1517
- * Whether to allow route responses requiring multiple
1518
- * transactions
1519
- */
1520
- allowMultiTx?: boolean;
1521
- /** Array of bridges to use */
1522
- bridges?: BridgeType[];
1523
- /** Indicates whether this transfer route should be relayed via Skip's Smart Relay service - true by default. */
1524
- smartRelay?: boolean;
1525
- smartSwapOptions?: SmartSwapOptions;
1526
- /** Whether to allow swaps in the route */
1527
- allowSwaps?: boolean;
1528
- /** Whether to enable Go Fast routes */
1529
- goFast?: boolean;
1530
- /** Whether to enable fast transfer routes */
1531
- fastTransfer?: boolean;
1532
- }
1533
- interface MsgsRequest {
1534
- /** Denom of the source asset */
1535
- sourceAssetDenom?: string;
1536
- /** Chain-id of the source asset */
1537
- sourceAssetChainId?: string;
1538
- /** Denom of the destination asset */
1539
- destAssetDenom?: string;
1540
- /** Chain-id of the destination asset */
1541
- destAssetChainId?: string;
1542
- /** Amount of source asset to be transferred or swapped */
1543
- amountIn?: string;
1544
- /** Amount of destination asset out */
1545
- amountOut?: string;
1546
- /** Array of receipient and/or sender address for each chain in the path, corresponding to the required_chain_addresses array returned from a route request */
1547
- addressList?: string[];
1548
- /** Array of operations required to perform the transfer or swap */
1549
- operations?: Operation[];
1550
- estimatedAmountOut?: string;
1551
- /** Percent tolerance for slippage on swap, if a swap is performed */
1552
- slippageTolerancePercent?: string;
1553
- /** Map of chain-ids to arrays of affiliates. The API expects all chains to have the same cumulative affiliate fee bps for each chain specified. If any of the provided affiliate arrays does not have the same cumulative fee, the API will return an error. */
1554
- chainIdsToAffiliates?: Record<string, ChainAffiliates>;
1555
- postRouteHandler?: PostHandler;
1556
- /** Number of seconds for the IBC transfer timeout, defaults to 5 minutes */
1557
- timeoutSeconds?: string;
1558
- /**
1559
- * Whether to enable gas warnings for intermediate and destination chains
1560
- * @default false
1561
- */
1562
- enableGasWarnings?: boolean;
1563
- /**
1564
- * Alternative address to use for paying for fees, currently only for SVM source CCTP transfers, in b58 format.
1565
- * @default false
1566
- */
1567
- feePayerAddress?: string;
1568
- }
1569
- interface MsgsDirectRequest {
1570
- /** Denom of the source asset */
1571
- sourceAssetDenom?: string;
1572
- /** Chain-id of the source asset */
1573
- sourceAssetChainId?: string;
1574
- /** Denom of the destination asset */
1575
- destAssetDenom?: string;
1576
- /** Chain-id of the destination asset */
1577
- destAssetChainId?: string;
1578
- /** Amount of source asset to be transferred or swapped. If this is a swap, only one of amount_in and amount_out should be provided. */
1579
- amountIn?: string;
1580
- /** Amount of destination asset out. If this is a swap, only one of amount_in and amount_out should be provided. If amount_out is provided for a swap, the route will be computed to give exactly amount_out. */
1581
- amountOut?: string;
1582
- /** Map of chain-ids to receipient and/or sender address for each chain in the path. Since the path is not known to the caller beforehand, the caller should attempt to provide addresses for all chains in the path, and the API will return an error if the path cannot be constructed. */
1583
- chainIdsToAddresses?: Record<string, string>;
1584
- /** Swap venues to consider, if provided (optional) */
1585
- swapVenues?: SwapVenue[];
1586
- /** Percent tolerance for slippage on swap, if a swap is performed */
1587
- slippageTolerancePercent?: string;
1588
- /** Map of chain-ids to arrays of affiliates. Since cumulative_affiliate_fee_bps must be provided to retrieve a route, and the swap chain is not known at this time, all chains must have the same cumulative_affiliate_fee_bps otherwise the API will return an error. */
1589
- chainIdsToAffiliates?: Record<string, ChainAffiliates>;
1590
- postRouteHandler?: PostHandler;
1591
- /** Number of seconds for the IBC transfer timeout, defaults to 5 minutes */
1592
- timeoutSeconds?: string;
1593
- /** Toggles whether the api should return routes that fail price safety checks. */
1594
- allowUnsafe?: boolean;
1595
- /** Array of experimental features to enable */
1596
- experimentalFeatures?: string[];
1597
- /**
1598
- * Whether to allow route responses requiring multiple
1599
- * transactions
1600
- */
1601
- allowMultiTx?: boolean;
1602
- /** Array of bridges to use */
1603
- bridges?: BridgeType[];
1604
- /** Indicates whether this transfer route should be relayed via Skip's Smart Relay service */
1605
- smartRelay?: boolean;
1606
- smartSwapOptions?: SmartSwapOptions;
1607
- /** Whether to allow swaps in the route */
1608
- allowSwaps?: boolean;
1609
- /**
1610
- * Whether to enable gas warnings for intermediate and destination chains
1611
- * @default false
1612
- */
1613
- enableGasWarnings?: boolean;
1614
- /** Whether to enable Go Fast routes */
1615
- goFast?: boolean;
1616
- /**
1617
- * Alternative address to use for paying for fees, currently only for SVM source CCTP transfers, in b58 format.
1618
- * @default false
1619
- */
1620
- feePayerAddress?: string;
1621
- }
1622
- interface AssetRecommendationsRequest {
1623
- /** Array where each entry corresponds to a distinct asset recommendation request. */
1624
- requests?: RecommendationRequest[];
1625
- }
1626
- interface SubmitTxRequest {
1627
- /** Signed base64 encoded transaction */
1628
- tx?: string;
1629
- /** Chain ID of the transaction */
1630
- chainId?: string;
1631
- }
1632
- interface TrackTxRequest {
1633
- /** Hex encoded hash of the transaction to track */
1634
- txHash: string;
1635
- /** Chain ID of the transaction */
1636
- chainId: string;
1637
- }
1638
- interface TrackTxResponse {
1639
- /** Hash of the transaction */
1640
- txHash: string;
1641
- /** Link to the transaction on the relevant block explorer */
1642
- explorerLink: string;
1643
- }
1644
- interface StatusTxResponse {
1645
- /** Transfer status for all transfers initiated by the transaction in the order they were initiated. */
1646
- transfers?: TransferStatus[];
1647
- /** The overall state reflecting the end-to-end status of all transfers initiated by the original transaction. */
1648
- state: TransactionState;
1649
- /** Details about the next transfer in the sequence that is preventing further progress, if any. */
1650
- nextBlockingTransfer?: {
1651
- transferSequenceIndex?: number;
1652
- };
1653
- /** Indicates location and denom of transfer asset release. */
1654
- transferAssetRelease?: TransferAssetRelease;
1655
- /** Details about any error encountered during the transaction or its subsequent transfers. */
1656
- error?: StatusError;
1657
- /**
1658
- * **DEPRECATED.** This field provides a flat list of all transfer events. For a more structured and detailed status of each transfer leg, including its individual events, please use the 'transfers' array instead. This field may be removed in a future version.
1659
- * @deprecated
1660
- */
1661
- transferSequence: TransferEvent[];
1662
- /**
1663
- * A high-level status indicator for the transaction's completion state.
1664
- * @example "STATE_COMPLETED"
1665
- */
1666
- status?: string;
1667
- }
1668
- interface IbcOriginAssetsRequest {
1669
- /** Array of assets to get origin assets for */
1670
- assets?: {
1671
- /** Denom of the asset */
1672
- denom?: string;
1673
- /** Chain-id of the asset */
1674
- chainId?: string;
1675
- }[];
1676
- }
1677
- interface AssetsBetweenChainsRequest {
1678
- /** Chain-id of the source chain */
1679
- sourceChainId?: string;
1680
- /** Chain-id of the destination chain */
1681
- destChainId?: string;
1682
- /**
1683
- * Whether to include assets without metadata (symbol, name, logo_uri, etc.)
1684
- * @default false
1685
- */
1686
- includeNoMetadataAssets?: boolean;
1687
- /**
1688
- * Whether to include CW20 tokens
1689
- * @default false
1690
- */
1691
- includeCw20Assets?: boolean;
1692
- /**
1693
- * Whether to include EVM tokens
1694
- * @default false
1695
- */
1696
- includeEvmAssets?: boolean;
1697
- /**
1698
- * Whether to include recommendations requiring multiple transactions to reach the destination
1699
- * @default false
1700
- */
1701
- allowMultiTx?: boolean;
1702
- }
1703
- interface ChainsRequest {
1704
- /** Chain IDs to limit the response to, defaults to all chains if not provided */
1705
- chainIds?: string[];
1706
- /**
1707
- * Whether to include EVM chains in the response
1708
- * @example false
1709
- */
1710
- includeEvm?: boolean;
1711
- /** Whether to include SVM chains in the response */
1712
- includeSvm?: boolean;
1713
- /**
1714
- * Whether to display only testnets in the response
1715
- * @example false
1716
- */
1717
- onlyTestnets?: boolean;
1718
- }
1719
- interface ChainsResponse {
1720
- /** Array of supported chain-ids */
1721
- chains?: Chain[];
1722
- }
1723
- interface BalancesResponse {
1724
- chains?: Record<string, BalanceResponseChainEntry>;
1725
- }
1726
- interface BridgesResponse {
1727
- /** Array of supported bridges */
1728
- bridges?: Bridge[];
1729
- }
1730
- interface VenuesRequest {
1731
- /**
1732
- * Whether to display only venues from testnets in the response
1733
- * @example false
1734
- */
1735
- onlyTestnets?: boolean;
1736
- }
1737
- interface VenuesResponse {
1738
- /** Array of supported swap venues */
1739
- venues?: SwapVenue[];
1740
- }
1741
- interface AssetsRequest {
1742
- /** Chain IDs to limit the response to, defaults to all chains if not provided */
1743
- chainIds?: string[];
1744
- /** Whether to restrict assets to those native to their chain */
1745
- nativeOnly?: boolean;
1746
- /** Whether to include assets without metadata (symbol, name, logo_uri, etc.) */
1747
- includeNoMetadataAssets?: boolean;
1748
- /** Whether to include CW20 tokens */
1749
- includeCw20Assets?: boolean;
1750
- /** Whether to include EVM tokens */
1751
- includeEvmAssets?: boolean;
1752
- /** Whether to include SVM tokens */
1753
- includeSvmAssets?: boolean;
1754
- /**
1755
- * Whether to display only assets from testnets in the response
1756
- * @example false
1757
- */
1758
- onlyTestnets?: boolean;
1759
- }
1760
- interface AssetsResponse {
1761
- /** Map of chain-ids to array of assets supported on the chain */
1762
- chainToAssetsMap?: Record<string, {
1763
- assets?: Asset[];
1764
- }>;
1765
- }
1766
- interface AssetsFromSourceResponse {
1767
- /** Array of assets that are reachable from the specified source asset */
1768
- destAssets?: Record<string, {
1769
- assets?: Asset[];
1770
- }>;
1771
- }
1772
- type RouteResponse = Route;
1773
- interface MsgsResponse {
1774
- msgs?: Msg[];
1775
- txs?: Tx[];
1776
- /** Minimum possible output after all operations, including fees and slippage */
1777
- minAmountOut?: string;
1778
- /** Indicates fees incurred in the execution of the transfer */
1779
- estimatedFees?: Fee[];
1780
- }
1781
- interface MsgsDirectResponse {
1782
- msgs?: Msg[];
1783
- txs?: Tx[];
1784
- /** Minimum possible output after all operations, including fees and slippage */
1785
- minAmountOut?: string;
1786
- route?: Route;
1787
- }
1788
- interface AssetRecommendationsResponse {
1789
- /** Array of recommendations for each entry in the `request` field. */
1790
- recommendationEntries?: {
1791
- recommendations?: AssetRecommendation[];
1792
- error?: ApiError;
1793
- }[];
1794
- }
1795
- interface SubmitResponse {
1796
- /** Hash of the transaction */
1797
- txHash?: string;
1798
- /** Link to the transaction on the relevant block explorer */
1799
- explorerLink?: string;
1800
- }
1801
- type TrackResponse = TrackTxResponse;
1802
- interface StatusRequest {
1803
- /**
1804
- * Hex encoded hash of the transaction to query for
1805
- * @example "EEC65138E6A7BDD047ED0D4BBA249A754F0BBBC7AA976568C4F35A32CD7FB8EB"
1806
- */
1807
- txHash: string;
1808
- /**
1809
- * Chain ID of the transaction
1810
- * @example "cosmoshub-4"
1811
- */
1812
- chainId: string;
1813
- }
1814
- type StatusResponse = StatusTxResponse;
1815
- interface IbcOriginAssetsResponse {
1816
- originAssets?: OptionalAsset[];
1817
- }
1818
- interface FungibleAssetsBetweenChainsCreateResponse {
1819
- assetsBetweenChains?: AssetBetweenChains[];
1820
- }
1821
- type QueryParamsType = Record<string | number, any>;
1822
- type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
1823
- interface FullRequestParams extends Omit<RequestInit, "body"> {
1824
- /** set parameter to `true` for call `securityWorker` for this request */
1825
- secure?: boolean;
1826
- /** request path */
1827
- path: string;
1828
- /** content type of request body */
1829
- type?: ContentType;
1830
- /** query params */
1831
- query?: QueryParamsType;
1832
- /** format of response (i.e. response.json() -> format: "json") */
1833
- format?: ResponseFormat;
1834
- /** request body */
1835
- body?: unknown;
1836
- /** base url */
1837
- baseUrl?: string;
1838
- /** request cancellation token */
1839
- cancelToken?: CancelToken;
1840
- }
1841
- type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
1842
- interface ApiConfig<SecurityDataType = unknown> {
1843
- baseUrl?: string;
1844
- baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
1845
- securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
1846
- customFetch?: typeof fetch;
1847
- }
1848
- interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
1849
- data: D;
1850
- error: E;
1851
- }
1852
- type CancelToken = Symbol | string | number;
1853
- declare enum ContentType {
1854
- Json = "application/json",
1855
- JsonApi = "application/vnd.api+json",
1856
- FormData = "multipart/form-data",
1857
- UrlEncoded = "application/x-www-form-urlencoded",
1858
- Text = "text/plain"
1859
- }
1860
- declare class HttpClient<SecurityDataType = unknown> {
1861
- baseUrl: string;
1862
- private securityData;
1863
- private securityWorker?;
1864
- private abortControllers;
1865
- private customFetch;
1866
- private baseApiParams;
1867
- constructor(apiConfig?: ApiConfig<SecurityDataType>);
1868
- setSecurityData: (data: SecurityDataType | null) => void;
1869
- protected encodeQueryParam(key: string, value: any): string;
1870
- protected addQueryParam(query: QueryParamsType, key: string): string;
1871
- protected addArrayQueryParam(query: QueryParamsType, key: string): any;
1872
- protected toQueryString(rawQuery?: QueryParamsType): string;
1873
- protected addQueryParams(rawQuery?: QueryParamsType): string;
1874
- private contentFormatters;
1875
- protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
1876
- protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
1877
- abortRequest: (cancelToken: CancelToken) => void;
1878
- request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
1879
- }
1880
- /**
1881
- * @title Skip Go API
1882
- * @version 0.1.0
1883
- * @baseUrl https://api.skip.build
1884
- *
1885
- * Simple APIs to build seamless cross-chain products that do more with fewer transactions. For devs with all levels of cross-chain experience.
1886
- */
1887
- declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
1888
- /**
1889
- * @description Get all supported chains along with additional data useful for building applications + frontends that interface with them (e.g. logo URI, IBC capabilities, fee assets, bech32 prefix, etc...)
1890
- *
1891
- * @tags Info
1892
- * @name Chains
1893
- * @request GET:/v2/info/chains
1894
- * @response `200` `ChainsResponse` Returns a list of supported chains with additional data
1895
- */
1896
- chains: (query: ChainsRequest, params?: RequestParams) => Promise<HttpResponse<ChainsResponse, any>>;
1897
- /**
1898
- * @description Get the balances of a given set of assets on a given chain and wallet address. Compatible with all Skip Go-supported assets, excluding CW20 assets, across SVM, EVM, and Cosmos chains.
1899
- *
1900
- * @tags Info
1901
- * @name Balances
1902
- * @request POST:/v2/info/balances
1903
- * @response `200` `BalancesResponse` The balances of the assets
1904
- */
1905
- balances: (data: BalancesRequest, params?: RequestParams) => Promise<HttpResponse<BalancesResponse, any>>;
1906
- /**
1907
- * @description Get all supported bridges
1908
- *
1909
- * @tags Info
1910
- * @name Bridges
1911
- * @request GET:/v2/info/bridges
1912
- * @response `200` `BridgesResponse` A list of supported bridges
1913
- */
1914
- bridges: (params?: RequestParams) => Promise<HttpResponse<BridgesResponse, any>>;
1915
- /**
1916
- * @description Get supported swap venues.
1917
- *
1918
- * @tags Fungible
1919
- * @name Venues
1920
- * @request GET:/v2/fungible/venues
1921
- * @response `200` `VenuesResponse` A list of supported swap venues
1922
- */
1923
- venues: (query: VenuesRequest, params?: RequestParams) => Promise<HttpResponse<VenuesResponse, any>>;
1924
- /**
1925
- * @description Get supported assets. Optionally limit to assets on a given chain and/or native assets.
1926
- *
1927
- * @tags Fungible
1928
- * @name Assets
1929
- * @request GET:/v2/fungible/assets
1930
- * @response `200` `AssetsResponse` A map of chain_id to assets
1931
- * @response `400` `Error` The request was invalid, e.g. field is invalid
1932
- * @response `500` `Error` Internal server error
1933
- */
1934
- assets: (query: AssetsRequest, params?: RequestParams) => Promise<HttpResponse<AssetsResponse, Error>>;
1935
- /**
1936
- * @description Get assets that can be reached from a source via transfers under different conditions (e.g. single vs multiple txs)
1937
- *
1938
- * @tags Fungible
1939
- * @name AssetsFromSource
1940
- * @request POST:/v2/fungible/assets_from_source
1941
- * @response `200` `AssetsFromSourceResponse` Assets reachable from the specified source without swapping
1942
- * @response `400` `Error` The request was invalid, e.g. field is invalid
1943
- * @response `500` `Error` Internal server error
1944
- */
1945
- assetsFromSource: (data: AssetsFromSourceRequest, params?: RequestParams) => Promise<HttpResponse<AssetsFromSourceResponse, Error>>;
1946
- /**
1947
- * @description This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns the sequence of transfers and/or swaps to reach the given destination asset from the given source asset, along with estimated amount out. Commonly called before /msgs to generate route info and quote.
1948
- *
1949
- * @tags Fungible
1950
- * @name Route
1951
- * @request POST:/v2/fungible/route
1952
- * @response `200` `RouteResponse` Swap and transfer route summary & quote
1953
- * @response `400` `Error` The request was invalid, e.g. an invalid amount was passed or the swap size is unsafe
1954
- * @response `500` `Error` Internal server error
1955
- */
1956
- route: (data: RouteRequest, params?: RequestParams) => Promise<HttpResponse<Route, Error>>;
1957
- /**
1958
- * @description This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns minimal number of messages required to execute a multi-chain swap or transfer. Input consists of the output of route with additional information required for message construction (e.g. destination addresses for each chain)
1959
- *
1960
- * @tags Fungible
1961
- * @name Msgs
1962
- * @request POST:/v2/fungible/msgs
1963
- * @response `200` `MsgsResponse` The messages required to execute the swap, as JSON.
1964
- * @response `400` `Error` The request was invalid, e.g. an invalid amount was passed.
1965
- * @response `500` `Error` Internal server error
1966
- */
1967
- msgs: (data: MsgsRequest, params?: RequestParams) => Promise<HttpResponse<MsgsResponse, Error>>;
1968
- /**
1969
- * @description This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns minimal number of messages required to execute a multi-chain swap or transfer. This is a convenience endpoint that combines /route and /msgs into a single call.
1970
- *
1971
- * @tags Fungible
1972
- * @name MsgsDirect
1973
- * @request POST:/v2/fungible/msgs_direct
1974
- * @response `200` `MsgsDirectResponse` The messages required to execute the swap, as JSON.
1975
- * @response `400` `Error` The request was invalid, e.g. an invalid amount was passed or the swap size is unsafe
1976
- * @response `500` `Error` Internal server error
1977
- */
1978
- msgsDirect: (data: MsgsDirectRequest, params?: RequestParams) => Promise<HttpResponse<MsgsDirectResponse, Error>>;
1979
- /**
1980
- * @description Request asset recommendations for the given source assets on a given destination chain. The response includes recommended destination assets and recommendation reasons.
1981
- *
1982
- * @tags Fungible
1983
- * @name AssetRecommendations
1984
- * @request POST:/v2/fungible/recommend_assets
1985
- * @response `200` `AssetRecommendationsResponse` Recommended destination assets and reasons
1986
- * @response `400` `Error` The request was invalid, i.e. required fields are missing
1987
- * @response `404` `Error` A recommendation or the specified token was not found
1988
- * @response `500` `Error` Internal server error
1989
- */
1990
- assetRecommendations: (data: AssetRecommendationsRequest, params?: RequestParams) => Promise<HttpResponse<AssetRecommendationsResponse, Error>>;
1991
- /**
1992
- * @description Submit a signed base64 encoded transaction to be broadcast to the specified network. On successful submission, the status of the transaction and any subsequent IBC or Axelar transfers can be queried through the /status endpoint.
1993
- *
1994
- * @tags Transaction
1995
- * @name Submit
1996
- * @request POST:/v2/tx/submit
1997
- * @response `200` `SubmitResponse` The hash of the transaction.
1998
- * @response `400` `Error` The request was invalid, i.e. the submitted transaction was malformed or fails on execution.
1999
- * @response `404` `Error` The specified chain is not supported.
2000
- * @response `500` `Error` Internal server error
2001
- */
2002
- submit: (data: SubmitTxRequest, params?: RequestParams) => Promise<HttpResponse<SubmitResponse, Error>>;
2003
- /**
2004
- * @description Requests tracking of a transaction that has already landed on-chain but was not broadcast through the Skip Go API. The status of a tracked transaction and subsequent IBC or Axelar transfers if routing assets cross chain can be queried through the /status endpoint.
2005
- *
2006
- * @tags Transaction
2007
- * @name Track
2008
- * @request POST:/v2/tx/track
2009
- * @response `200` `TrackResponse` The hash of the transaction and a link to its explorer page.
2010
- * @response `400` `Error` The request was invalid, i.e. the transaction hash was malformed or the specified transaction did not execute successfully.
2011
- * @response `404` `Error` The specified chain is not supported or the specified transaction was not found.
2012
- * @response `500` `Error` Internal server error
2013
- */
2014
- track: (data: TrackTxRequest, params?: RequestParams) => Promise<HttpResponse<TrackTxResponse, Error>>;
2015
- /**
2016
- * @description Get the status of the specified transaction and any subsequent IBC or Axelar transfers if routing assets cross chain. The transaction must have previously been submitted to either the /submit or /track endpoints.
2017
- *
2018
- * @tags Transaction
2019
- * @name Status
2020
- * @request GET:/v2/tx/status
2021
- * @response `200` `StatusResponse` The status of the transaction and any subsequent ibc or Axelar transfers.
2022
- * @response `404` `Error` The specified tx was not found.
2023
- * @response `500` `Error` Internal server error
2024
- */
2025
- status: (query: StatusRequest, params?: RequestParams) => Promise<HttpResponse<StatusTxResponse, Error>>;
2026
- /**
2027
- * @description Get origin assets from a given list of denoms and chain IDs.
2028
- *
2029
- * @tags Fungible
2030
- * @name IbcOriginAssets
2031
- * @request POST:/v2/fungible/ibc_origin_assets
2032
- * @response `200` `IbcOriginAssetsResponse` The origin assets of the specified denoms and chain IDs.
2033
- * @response `400` `Error` The request was invalid, i.e. required fields are missing
2034
- * @response `500` `Error` Internal server error
2035
- */
2036
- ibcOriginAssets: (data: IbcOriginAssetsRequest, params?: RequestParams) => Promise<HttpResponse<IbcOriginAssetsResponse, Error>>;
2037
- /**
2038
- * @description Given 2 chain IDs, returns a list of equivalent assets that can be transferred
2039
- *
2040
- * @tags Fungible
2041
- * @name FungibleAssetsBetweenChainsCreate
2042
- * @request POST:/v2/fungible/assets_between_chains
2043
- * @response `200` `FungibleAssetsBetweenChainsCreateResponse` OK
2044
- * @response `404` `Error` One of the chain IDs was not found
2045
- * @response `500` `Error` Internal server error
2046
- */
2047
- fungibleAssetsBetweenChainsCreate: (data: AssetsBetweenChainsRequest, params?: RequestParams) => Promise<HttpResponse<FungibleAssetsBetweenChainsCreateResponse, Error>>;
2048
- }
2049
-
2050
- export { type ContractCallWithTokenError as $, AxelarTransferType as A, BridgeType as B, ContractCallWithTokenErrorType as C, type StargateTransferTxs as D, type StargateTransferInfo as E, FeeBehavior as F, GoFastTransferState as G, HyperlaneTransferState as H, type StargateTransferWrapper as I, type GoFastTransfer as J, type GoFastTransferTxs as K, LayerZeroTransferState as L, type GoFastTransferInfo as M, type GoFastTransferWrapper as N, OPInitTransferState as O, PacketErrorType as P, type BalanceRequestChainEntry as Q, RoutePriceWarningType as R, StatusErrorType as S, TransferState as T, type BalanceResponseDenomEntry as U, type BalanceResponseChainEntry as V, type BankSend as W, type BankSendWrapper as X, type Bridge as Y, type Chain as Z, type ChainAffiliates as _, FeeType as a, type LayerZeroTransfer as a$, type ContractCallWithTokenTxs as a0, type CosmWasmContractMsg as a1, type CosmWasmContractMsgWrapper as a2, type Erc20Approval as a3, type ErrorDetail as a4, type Error as a5, type CosmosMsg as a6, type CosmosTx as a7, type CosmosTxWrapper as a8, type EvmSwap as a9, type SendTokenTxs as aA, type StatusError as aB, type Swap as aC, type SwapExactCoinIn as aD, type SwapExactCoinOut as aE, type SwapInWrapper as aF, type SwapOperation as aG, type SwapOutWrapper as aH, type SwapRoute as aI, type SmartSwapExactCoinIn as aJ, type SmartSwapOptions as aK, type SmartSwapInWrapper as aL, type SwapVenue as aM, type SwapWrapper as aN, type TransactionExecutionErrorDetails as aO, type OPInitTransfer as aP, type OPInitTransferWrapper as aQ, type OPInitTransferInfo as aR, type OPInitTransferTxs as aS, type Transfer as aT, type TransferEvent as aU, type TransferAssetRelease as aV, type TransferStatus as aW, type TransferWrapper as aX, type EurekaTransfer as aY, type EurekaTransferInfo as aZ, type EurekaTransferWrapper as a_, type EvmSwapWrapper as aa, type EvmTx as ab, type EvmTxWrapper as ac, type SvmTx as ad, type SvmTxWrapper as ae, type FeeAsset as af, type GoFastFee as ag, type GRPCStatusCode as ah, type HyperlaneTransfer as ai, type HyperlaneTransferInfo as aj, type HyperlaneTransferTransactions as ak, type HyperlaneTransferWrapper as al, type IBCTransferInfo as am, type Msg as an, type Tx as ao, type MultiChainMsg as ap, type MultiChainMsgWrapper as aq, type Operation as ar, type OptionalAsset as as, type LayerZeroTransferTransactions as at, type Packet as au, type PacketError as av, type ChainTransaction as aw, type PostHandler as ax, type Route as ay, type SendTokenError as az, TransactionState as b, type LayerZeroTransferInfo as b0, type LayerZeroTransferWrapper as b1, type RecommendationRequest as b2, type CosmosModuleSupport as b3, type IbcCapabilities as b4, type Fee as b5, type BalancesRequest as b6, type AssetsFromSourceRequest as b7, type MsgsRequest as b8, type MsgsDirectRequest as b9, type QueryParamsType as bA, type ResponseFormat as bB, type FullRequestParams as bC, type RequestParams as bD, type ApiConfig as bE, type HttpResponse as bF, ContentType as bG, HttpClient as bH, Api as bI, type RouteRequest as bJ, type AssetRecommendationsRequest as ba, type SubmitTxRequest as bb, type TrackTxRequest as bc, type TrackTxResponse as bd, type StatusTxResponse as be, type IbcOriginAssetsRequest as bf, type AssetsBetweenChainsRequest as bg, type ChainsRequest as bh, type ChainsResponse as bi, type BalancesResponse as bj, type BridgesResponse as bk, type VenuesRequest as bl, type VenuesResponse as bm, type AssetsRequest as bn, type AssetsResponse as bo, type AssetsFromSourceResponse as bp, type RouteResponse as bq, type MsgsResponse as br, type MsgsDirectResponse as bs, type AssetRecommendationsResponse as bt, type SubmitResponse as bu, type TrackResponse as bv, type StatusRequest as bw, type StatusResponse as bx, type IbcOriginAssetsResponse as by, type FungibleAssetsBetweenChainsCreateResponse as bz, SendTokenErrorType as c, Reason as d, ChainType as e, StargateTransferState as f, CCTPTransferState as g, AxelarTransferState as h, AutopilotAction as i, type AcknowledgementErrorDetails as j, type Affiliate as k, type ApiError as l, type Asset as m, type AssetBetweenChains as n, type AssetRecommendation as o, type AutopilotMsg as p, type AutopilotMsgWrapper as q, type AxelarTransfer as r, type AxelarTransferInfo as s, type AxelarTransferWrapper as t, type SmartRelayFeeQuote as u, type CCTPTransfer as v, type CCTPTransferInfo as w, type CCTPTransferTxs as x, type CCTPTransferWrapper as y, type StargateTransfer as z };