@polyester/sdk 0.31.0 → 0.32.0-devnet-20261102134326

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 (378) hide show
  1. package/CHANGELOG.md +116 -0
  2. package/README.md +7 -0
  3. package/dist/browser-core.d.ts.map +1 -1
  4. package/dist/browser-core.js.map +1 -1
  5. package/dist/catalogs/market-data-catalog.d.ts +2 -0
  6. package/dist/catalogs/market-data-catalog.d.ts.map +1 -1
  7. package/dist/catalogs/market-data-catalog.js +1 -0
  8. package/dist/catalogs/market-data-catalog.js.map +1 -1
  9. package/dist/catalogs/snapshot-validation.js +6 -0
  10. package/dist/catalogs/snapshot-validation.js.map +1 -1
  11. package/dist/client.d.ts +2 -2
  12. package/dist/client.js +2 -2
  13. package/dist/client.js.map +1 -1
  14. package/dist/core-client.d.ts.map +1 -1
  15. package/dist/core-client.js +1 -0
  16. package/dist/core-client.js.map +1 -1
  17. package/dist/gen/auth/v1/api_keys_pb.d.ts +6 -3
  18. package/dist/gen/auth/v1/api_keys_pb.d.ts.map +1 -1
  19. package/dist/gen/auth/v1/api_keys_pb.js.map +1 -1
  20. package/dist/gen/auth/v1/auth_pb.d.ts +16 -2
  21. package/dist/gen/auth/v1/auth_pb.d.ts.map +1 -1
  22. package/dist/gen/auth/v1/auth_pb.js +16 -2
  23. package/dist/gen/auth/v1/auth_pb.js.map +1 -1
  24. package/dist/gen/auth/v1/policies_pb.d.ts +26 -2
  25. package/dist/gen/auth/v1/policies_pb.d.ts.map +1 -1
  26. package/dist/gen/auth/v1/policies_pb.js +26 -2
  27. package/dist/gen/auth/v1/policies_pb.js.map +1 -1
  28. package/dist/gen/auth/v1/subaccounts_pb.d.ts +41 -17
  29. package/dist/gen/auth/v1/subaccounts_pb.d.ts.map +1 -1
  30. package/dist/gen/auth/v1/subaccounts_pb.js +20 -3
  31. package/dist/gen/auth/v1/subaccounts_pb.js.map +1 -1
  32. package/dist/gen/chain/analytics/v1/analytics_read_pb.d.ts.map +1 -1
  33. package/dist/gen/chain/analytics/v1/analytics_read_pb.js +2 -1
  34. package/dist/gen/chain/analytics/v1/analytics_read_pb.js.map +1 -1
  35. package/dist/gen/chain/deposit/v1/deposit_pb.d.ts +10 -6
  36. package/dist/gen/chain/deposit/v1/deposit_pb.d.ts.map +1 -1
  37. package/dist/gen/chain/deposit/v1/deposit_pb.js +2 -1
  38. package/dist/gen/chain/deposit/v1/deposit_pb.js.map +1 -1
  39. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.d.ts +32 -2
  40. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.d.ts.map +1 -1
  41. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.js +2 -2
  42. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.js.map +1 -1
  43. package/dist/gen/chain/lifecycle/v1/types_pb.d.ts +19 -3
  44. package/dist/gen/chain/lifecycle/v1/types_pb.d.ts.map +1 -1
  45. package/dist/gen/chain/lifecycle/v1/types_pb.js +18 -2
  46. package/dist/gen/chain/lifecycle/v1/types_pb.js.map +1 -1
  47. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.d.ts +840 -0
  48. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.d.ts.map +1 -0
  49. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.js +351 -0
  50. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.js.map +1 -0
  51. package/dist/gen/chain/withdraw/v1/withdraw_pb.d.ts +22 -2
  52. package/dist/gen/chain/withdraw/v1/withdraw_pb.d.ts.map +1 -1
  53. package/dist/gen/chain/withdraw/v1/withdraw_pb.js +17 -1
  54. package/dist/gen/chain/withdraw/v1/withdraw_pb.js.map +1 -1
  55. package/dist/gen/chain/zipper/v1/reason_pb.d.ts +14 -0
  56. package/dist/gen/chain/zipper/v1/reason_pb.d.ts.map +1 -1
  57. package/dist/gen/chain/zipper/v1/reason_pb.js +15 -1
  58. package/dist/gen/chain/zipper/v1/reason_pb.js.map +1 -1
  59. package/dist/gen/checkpoints/v1/checkpoints_pb.d.ts +1134 -0
  60. package/dist/gen/checkpoints/v1/checkpoints_pb.d.ts.map +1 -0
  61. package/dist/gen/checkpoints/v1/checkpoints_pb.js +327 -0
  62. package/dist/gen/checkpoints/v1/checkpoints_pb.js.map +1 -0
  63. package/dist/gen/claims/v1/claims_pb.d.ts +61 -4
  64. package/dist/gen/claims/v1/claims_pb.d.ts.map +1 -1
  65. package/dist/gen/claims/v1/claims_pb.js +26 -1
  66. package/dist/gen/claims/v1/claims_pb.js.map +1 -1
  67. package/dist/gen/fees/v1/fees_pb.d.ts.map +1 -1
  68. package/dist/gen/fees/v1/fees_pb.js +2 -1
  69. package/dist/gen/fees/v1/fees_pb.js.map +1 -1
  70. package/dist/gen/index.d.ts +7 -5
  71. package/dist/gen/index.js +12 -10
  72. package/dist/gen/ledger/read/v1/ledger_read_pb.d.ts +45 -3
  73. package/dist/gen/ledger/read/v1/ledger_read_pb.d.ts.map +1 -1
  74. package/dist/gen/ledger/read/v1/ledger_read_pb.js +19 -7
  75. package/dist/gen/ledger/read/v1/ledger_read_pb.js.map +1 -1
  76. package/dist/gen/marketdata/v1/marketdata_pb.d.ts +248 -27
  77. package/dist/gen/marketdata/v1/marketdata_pb.d.ts.map +1 -1
  78. package/dist/gen/marketdata/v1/marketdata_pb.js +73 -20
  79. package/dist/gen/marketdata/v1/marketdata_pb.js.map +1 -1
  80. package/dist/gen/marketoverview/v1/marketoverview_pb.d.ts +2 -1
  81. package/dist/gen/marketoverview/v1/marketoverview_pb.d.ts.map +1 -1
  82. package/dist/gen/marketoverview/v1/marketoverview_pb.js.map +1 -1
  83. package/dist/gen/orderbook/v1/orderbook_pb.d.ts +16 -4
  84. package/dist/gen/orderbook/v1/orderbook_pb.d.ts.map +1 -1
  85. package/dist/gen/orderbook/v1/orderbook_pb.js +1 -1
  86. package/dist/gen/orderbook/v1/orderbook_pb.js.map +1 -1
  87. package/dist/gen/orders/v1/orders_pb.d.ts +1222 -63
  88. package/dist/gen/orders/v1/orders_pb.d.ts.map +1 -1
  89. package/dist/gen/orders/v1/orders_pb.js +971 -44
  90. package/dist/gen/orders/v1/orders_pb.js.map +1 -1
  91. package/dist/gen/orders/v1/orders_read_pb.d.ts +214 -25
  92. package/dist/gen/orders/v1/orders_read_pb.d.ts.map +1 -1
  93. package/dist/gen/orders/v1/orders_read_pb.js +159 -20
  94. package/dist/gen/orders/v1/orders_read_pb.js.map +1 -1
  95. package/dist/gen/polyester/api/options_pb.d.ts +8 -1
  96. package/dist/gen/polyester/api/options_pb.d.ts.map +1 -1
  97. package/dist/gen/polyester/api/options_pb.js +8 -1
  98. package/dist/gen/polyester/api/options_pb.js.map +1 -1
  99. package/dist/gen/privatews/v1/private_ws_pb.d.ts +1419 -0
  100. package/dist/gen/privatews/v1/private_ws_pb.d.ts.map +1 -0
  101. package/dist/gen/privatews/v1/private_ws_pb.js +551 -0
  102. package/dist/gen/privatews/v1/private_ws_pb.js.map +1 -0
  103. package/dist/gen/ratelimit/v1/ratelimit_pb.d.ts +1 -0
  104. package/dist/gen/ratelimit/v1/ratelimit_pb.d.ts.map +1 -1
  105. package/dist/gen/ratelimit/v1/ratelimit_pb.js +1 -1
  106. package/dist/gen/ratelimit/v1/ratelimit_pb.js.map +1 -1
  107. package/dist/gen/rewards/v1/rewards_pb.d.ts +6 -0
  108. package/dist/gen/rewards/v1/rewards_pb.d.ts.map +1 -1
  109. package/dist/gen/rewards/v1/rewards_pb.js +1 -1
  110. package/dist/gen/rewards/v1/rewards_pb.js.map +1 -1
  111. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.d.ts +2108 -0
  112. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.d.ts.map +1 -0
  113. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.js +522 -0
  114. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.js.map +1 -0
  115. package/dist/gen/swap/quickswap/v1/quickswap_pb.d.ts +2296 -0
  116. package/dist/gen/swap/quickswap/v1/quickswap_pb.d.ts.map +1 -0
  117. package/dist/gen/swap/quickswap/v1/quickswap_pb.js +1014 -0
  118. package/dist/gen/swap/quickswap/v1/quickswap_pb.js.map +1 -0
  119. package/dist/gen/swap/v1/swap_pb.d.ts +958 -0
  120. package/dist/gen/swap/v1/swap_pb.d.ts.map +1 -0
  121. package/dist/gen/swap/v1/swap_pb.js +434 -0
  122. package/dist/gen/swap/v1/swap_pb.js.map +1 -0
  123. package/dist/gen/tradews/v1/trade_ws_pb.d.ts +68 -3
  124. package/dist/gen/tradews/v1/trade_ws_pb.d.ts.map +1 -1
  125. package/dist/gen/tradews/v1/trade_ws_pb.js +1 -1
  126. package/dist/gen/tradews/v1/trade_ws_pb.js.map +1 -1
  127. package/dist/gen/triggers/v1/triggers_pb.d.ts +612 -33
  128. package/dist/gen/triggers/v1/triggers_pb.d.ts.map +1 -1
  129. package/dist/gen/triggers/v1/triggers_pb.js +437 -20
  130. package/dist/gen/triggers/v1/triggers_pb.js.map +1 -1
  131. package/dist/gen/vip/v1/vip_pb.d.ts +95 -7
  132. package/dist/gen/vip/v1/vip_pb.d.ts.map +1 -1
  133. package/dist/gen/vip/v1/vip_pb.js +53 -5
  134. package/dist/gen/vip/v1/vip_pb.js.map +1 -1
  135. package/dist/index.d.ts +9 -7
  136. package/dist/index.js +2 -2
  137. package/dist/realtime/client.d.ts +3 -0
  138. package/dist/realtime/client.d.ts.map +1 -1
  139. package/dist/realtime/client.js +76 -24
  140. package/dist/realtime/client.js.map +1 -1
  141. package/dist/realtime/index.d.ts +2 -1
  142. package/dist/realtime/private-orders.d.ts +38 -0
  143. package/dist/realtime/private-orders.d.ts.map +1 -0
  144. package/dist/realtime/private-orders.js +594 -0
  145. package/dist/realtime/private-orders.js.map +1 -0
  146. package/dist/realtime/ready-gated-subscription.js +10 -4
  147. package/dist/realtime/ready-gated-subscription.js.map +1 -1
  148. package/dist/realtime/types.d.ts +3 -0
  149. package/dist/realtime/types.d.ts.map +1 -1
  150. package/dist/services/auth/account-signer-auth.d.ts +5 -3
  151. package/dist/services/auth/account-signer-auth.d.ts.map +1 -1
  152. package/dist/services/auth/account-signer-auth.js +21 -3
  153. package/dist/services/auth/account-signer-auth.js.map +1 -1
  154. package/dist/services/auth/profile/profile.schemas.js +1 -1
  155. package/dist/services/balances/balances.js +1 -1
  156. package/dist/services/balances/balances.schemas.d.ts +3 -3
  157. package/dist/services/candles/candles.codecs.js +15 -0
  158. package/dist/services/candles/candles.codecs.js.map +1 -1
  159. package/dist/services/candles/candles.schemas.d.ts +13 -13
  160. package/dist/services/checkpoints/checkpoints.codecs.d.ts +8 -0
  161. package/dist/services/checkpoints/checkpoints.codecs.d.ts.map +1 -0
  162. package/dist/services/checkpoints/checkpoints.codecs.js +36 -0
  163. package/dist/services/checkpoints/checkpoints.codecs.js.map +1 -0
  164. package/dist/services/checkpoints/checkpoints.d.ts +22 -0
  165. package/dist/services/checkpoints/checkpoints.d.ts.map +1 -0
  166. package/dist/services/checkpoints/checkpoints.js +31 -0
  167. package/dist/services/checkpoints/checkpoints.js.map +1 -0
  168. package/dist/services/checkpoints/checkpoints.schemas.d.ts +437 -0
  169. package/dist/services/checkpoints/checkpoints.schemas.d.ts.map +1 -0
  170. package/dist/services/checkpoints/checkpoints.schemas.js +176 -0
  171. package/dist/services/checkpoints/checkpoints.schemas.js.map +1 -0
  172. package/dist/services/checkpoints/checkpoints.types.d.ts +3 -0
  173. package/dist/services/checkpoints/service.d.ts +8 -0
  174. package/dist/services/checkpoints/service.d.ts.map +1 -0
  175. package/dist/services/checkpoints/service.js +9 -0
  176. package/dist/services/checkpoints/service.js.map +1 -0
  177. package/dist/services/claims/claims.codecs.d.ts +1 -1
  178. package/dist/services/claims/claims.codecs.d.ts.map +1 -1
  179. package/dist/services/claims/claims.codecs.js +2 -1
  180. package/dist/services/claims/claims.codecs.js.map +1 -1
  181. package/dist/services/claims/claims.d.ts +13 -5
  182. package/dist/services/claims/claims.d.ts.map +1 -1
  183. package/dist/services/claims/claims.js +15 -6
  184. package/dist/services/claims/claims.js.map +1 -1
  185. package/dist/services/claims/claims.schemas.d.ts +13 -3
  186. package/dist/services/claims/claims.schemas.d.ts.map +1 -1
  187. package/dist/services/claims/claims.schemas.js +10 -4
  188. package/dist/services/claims/claims.schemas.js.map +1 -1
  189. package/dist/services/claims/claims.types.d.ts +2 -2
  190. package/dist/services/heatmap/heatmap.schemas.d.ts +13 -13
  191. package/dist/services/lifecycle/lifecycle.codecs.d.ts +1 -1
  192. package/dist/services/lifecycle/lifecycle.codecs.d.ts.map +1 -1
  193. package/dist/services/lifecycle/lifecycle.codecs.js +4 -2
  194. package/dist/services/lifecycle/lifecycle.codecs.js.map +1 -1
  195. package/dist/services/lifecycle/lifecycle.schemas.d.ts +185 -135
  196. package/dist/services/lifecycle/lifecycle.schemas.d.ts.map +1 -1
  197. package/dist/services/lifecycle/lifecycle.schemas.js +7 -1
  198. package/dist/services/lifecycle/lifecycle.schemas.js.map +1 -1
  199. package/dist/services/market-data/market-data.codecs.js +2 -1
  200. package/dist/services/market-data/market-data.codecs.js.map +1 -1
  201. package/dist/services/market-data/market-data.d.ts +10 -1
  202. package/dist/services/market-data/market-data.d.ts.map +1 -1
  203. package/dist/services/market-data/market-data.js +21 -9
  204. package/dist/services/market-data/market-data.js.map +1 -1
  205. package/dist/services/market-data/market-data.schemas.d.ts +29 -2
  206. package/dist/services/market-data/market-data.schemas.d.ts.map +1 -1
  207. package/dist/services/market-data/market-data.schemas.js +53 -4
  208. package/dist/services/market-data/market-data.schemas.js.map +1 -1
  209. package/dist/services/market-data/market-data.types.d.ts +2 -2
  210. package/dist/services/market-overview/market-overview.schemas.d.ts +3 -3
  211. package/dist/services/orderbook/orderbook.d.ts +2 -1
  212. package/dist/services/orderbook/orderbook.d.ts.map +1 -1
  213. package/dist/services/orderbook/orderbook.js +17 -2
  214. package/dist/services/orderbook/orderbook.js.map +1 -1
  215. package/dist/services/orderbook/orderbook.schemas.d.ts +5 -1
  216. package/dist/services/orderbook/orderbook.schemas.d.ts.map +1 -1
  217. package/dist/services/orderbook/orderbook.schemas.js +2 -0
  218. package/dist/services/orderbook/orderbook.schemas.js.map +1 -1
  219. package/dist/services/orders/order-enums.codecs.js +7 -1
  220. package/dist/services/orders/order-enums.codecs.js.map +1 -1
  221. package/dist/services/orders/order-errors.schemas.d.ts +4 -2
  222. package/dist/services/orders/order-errors.schemas.d.ts.map +1 -1
  223. package/dist/services/orders/order-errors.schemas.js +4 -1
  224. package/dist/services/orders/order-errors.schemas.js.map +1 -1
  225. package/dist/services/orders/orders-batch.schemas.d.ts +375 -54
  226. package/dist/services/orders/orders-batch.schemas.d.ts.map +1 -1
  227. package/dist/services/orders/orders-batch.schemas.js +12 -2
  228. package/dist/services/orders/orders-batch.schemas.js.map +1 -1
  229. package/dist/services/orders/orders-input.schemas.d.ts +551 -9
  230. package/dist/services/orders/orders-input.schemas.d.ts.map +1 -1
  231. package/dist/services/orders/orders-input.schemas.js +23 -5
  232. package/dist/services/orders/orders-input.schemas.js.map +1 -1
  233. package/dist/services/orders/orders-modify.schemas.d.ts +106 -1
  234. package/dist/services/orders/orders-modify.schemas.d.ts.map +1 -1
  235. package/dist/services/orders/orders-modify.schemas.js +1 -1
  236. package/dist/services/orders/orders-output.schemas.d.ts +80 -61
  237. package/dist/services/orders/orders-output.schemas.d.ts.map +1 -1
  238. package/dist/services/orders/orders-output.schemas.js +15 -22
  239. package/dist/services/orders/orders-output.schemas.js.map +1 -1
  240. package/dist/services/orders/orders-risk.schemas.d.ts +69 -1
  241. package/dist/services/orders/orders-risk.schemas.d.ts.map +1 -1
  242. package/dist/services/orders/orders-risk.schemas.js +21 -11
  243. package/dist/services/orders/orders-risk.schemas.js.map +1 -1
  244. package/dist/services/orders/orders.codecs.js +26 -2
  245. package/dist/services/orders/orders.codecs.js.map +1 -1
  246. package/dist/services/orders/orders.d.ts +31 -5
  247. package/dist/services/orders/orders.d.ts.map +1 -1
  248. package/dist/services/orders/orders.js +53 -15
  249. package/dist/services/orders/orders.js.map +1 -1
  250. package/dist/services/policies/api-key-policies/api-key-policies.schemas.d.ts +15 -15
  251. package/dist/services/policies/shared.codecs.js +8 -2
  252. package/dist/services/policies/shared.codecs.js.map +1 -1
  253. package/dist/services/policies/shared.d.ts +1 -1
  254. package/dist/services/policies/shared.d.ts.map +1 -1
  255. package/dist/services/policies/shared.js +4 -1
  256. package/dist/services/policies/shared.js.map +1 -1
  257. package/dist/services/policies/subaccount-policies/subaccount-policies.schemas.d.ts +9 -9
  258. package/dist/services/policies/subaccount-policies/subaccount-policies.schemas.js +1 -1
  259. package/dist/services/subaccounts/subaccounts.codecs.js +4 -1
  260. package/dist/services/subaccounts/subaccounts.codecs.js.map +1 -1
  261. package/dist/services/subaccounts/subaccounts.d.ts +1 -1
  262. package/dist/services/subaccounts/subaccounts.d.ts.map +1 -1
  263. package/dist/services/subaccounts/subaccounts.js +1 -2
  264. package/dist/services/subaccounts/subaccounts.js.map +1 -1
  265. package/dist/services/subaccounts/subaccounts.schemas.d.ts +10 -10
  266. package/dist/services/trades/trades.d.ts +2 -0
  267. package/dist/services/trades/trades.d.ts.map +1 -1
  268. package/dist/services/trades/trades.js +6 -6
  269. package/dist/services/trades/trades.js.map +1 -1
  270. package/dist/services/trades/trades.schemas.d.ts +2 -2
  271. package/dist/services/trades/trades.schemas.js +1 -1
  272. package/dist/services/trading-withdraws/trading-withdraws.d.ts +9 -5
  273. package/dist/services/trading-withdraws/trading-withdraws.d.ts.map +1 -1
  274. package/dist/services/trading-withdraws/trading-withdraws.js +45 -26
  275. package/dist/services/trading-withdraws/trading-withdraws.js.map +1 -1
  276. package/dist/services/trading-withdraws/trading-withdraws.schemas.d.ts +12 -0
  277. package/dist/services/trading-withdraws/trading-withdraws.schemas.d.ts.map +1 -1
  278. package/dist/services/trading-withdraws/trading-withdraws.schemas.js +26 -6
  279. package/dist/services/trading-withdraws/trading-withdraws.schemas.js.map +1 -1
  280. package/dist/services/trailing-oneof-inputs.js +6 -1
  281. package/dist/services/trailing-oneof-inputs.js.map +1 -1
  282. package/dist/services/transfers/transfers.d.ts +2 -0
  283. package/dist/services/transfers/transfers.d.ts.map +1 -1
  284. package/dist/services/transfers/transfers.js +6 -11
  285. package/dist/services/transfers/transfers.js.map +1 -1
  286. package/dist/services/transfers/transfers.schemas.d.ts +4 -1
  287. package/dist/services/transfers/transfers.schemas.d.ts.map +1 -1
  288. package/dist/services/transfers/transfers.schemas.js +3 -1
  289. package/dist/services/transfers/transfers.schemas.js.map +1 -1
  290. package/dist/services/triggers/trigger-child-order.schemas.js +23 -18
  291. package/dist/services/triggers/trigger-child-order.schemas.js.map +1 -1
  292. package/dist/services/triggers/trigger-input.schemas.d.ts +291 -28
  293. package/dist/services/triggers/trigger-input.schemas.d.ts.map +1 -1
  294. package/dist/services/triggers/trigger-input.schemas.js +38 -22
  295. package/dist/services/triggers/trigger-input.schemas.js.map +1 -1
  296. package/dist/services/triggers/triggers-output.schemas.d.ts +183 -59
  297. package/dist/services/triggers/triggers-output.schemas.d.ts.map +1 -1
  298. package/dist/services/triggers/triggers-output.schemas.js +28 -20
  299. package/dist/services/triggers/triggers-output.schemas.js.map +1 -1
  300. package/dist/services/triggers/triggers.codecs.js +66 -3
  301. package/dist/services/triggers/triggers.codecs.js.map +1 -1
  302. package/dist/services/triggers/triggers.d.ts +6 -2
  303. package/dist/services/triggers/triggers.d.ts.map +1 -1
  304. package/dist/services/triggers/triggers.js +10 -8
  305. package/dist/services/triggers/triggers.js.map +1 -1
  306. package/dist/services/vip/vip.js +1 -1
  307. package/dist/services/vip/vip.schemas.d.ts +23 -1
  308. package/dist/services/vip/vip.schemas.d.ts.map +1 -1
  309. package/dist/services/vip/vip.schemas.js +20 -2
  310. package/dist/services/vip/vip.schemas.js.map +1 -1
  311. package/dist/services/vip/vip.types.d.ts +2 -2
  312. package/dist/shared/catalog-config.d.ts +14 -2
  313. package/dist/shared/catalog-config.d.ts.map +1 -1
  314. package/dist/shared/catalog-config.js +2 -1
  315. package/dist/shared/catalog-config.js.map +1 -1
  316. package/dist/shared/connect-error-mapping.d.ts +3 -0
  317. package/dist/shared/connect-error-mapping.d.ts.map +1 -1
  318. package/dist/shared/connect-error-mapping.js +45 -6
  319. package/dist/shared/connect-error-mapping.js.map +1 -1
  320. package/dist/shared/errors.d.ts +79 -6
  321. package/dist/shared/errors.d.ts.map +1 -1
  322. package/dist/shared/errors.js +92 -4
  323. package/dist/shared/errors.js.map +1 -1
  324. package/dist/shared/rate-limit.schemas.d.ts +1 -1
  325. package/dist/shared/request-options.d.ts +7 -0
  326. package/dist/shared/request-options.d.ts.map +1 -1
  327. package/dist/shared/request-options.js +6 -1
  328. package/dist/shared/request-options.js.map +1 -1
  329. package/dist/shared/schemas.js +1 -1
  330. package/dist/shared/subscription-errors.js +12 -1
  331. package/dist/shared/subscription-errors.js.map +1 -1
  332. package/dist/shared/transports.d.ts.map +1 -1
  333. package/dist/shared/transports.js +9 -2
  334. package/dist/shared/transports.js.map +1 -1
  335. package/dist/shared/wire-bounds.js +3 -1
  336. package/dist/shared/wire-bounds.js.map +1 -1
  337. package/dist/smart-account/index.d.ts +2 -1
  338. package/dist/smart-account/index.js +2 -1
  339. package/dist/smart-account/smart-account.d.ts +5 -4
  340. package/dist/smart-account/smart-account.d.ts.map +1 -1
  341. package/dist/smart-account/smart-account.js +37 -8
  342. package/dist/smart-account/smart-account.js.map +1 -1
  343. package/dist/utils/numbers.js +4 -1
  344. package/dist/utils/numbers.js.map +1 -1
  345. package/dist/wired-services.js +5 -5
  346. package/dist/wired-services.js.map +1 -1
  347. package/package.json +9 -4
  348. package/dist/gen/collab/v1/whiteboard_pb.d.ts +0 -829
  349. package/dist/gen/collab/v1/whiteboard_pb.d.ts.map +0 -1
  350. package/dist/gen/collab/v1/whiteboard_pb.js +0 -250
  351. package/dist/gen/collab/v1/whiteboard_pb.js.map +0 -1
  352. package/dist/gen/layout/v1/layout_pb.d.ts +0 -1289
  353. package/dist/gen/layout/v1/layout_pb.d.ts.map +0 -1
  354. package/dist/gen/layout/v1/layout_pb.js +0 -313
  355. package/dist/gen/layout/v1/layout_pb.js.map +0 -1
  356. package/dist/gen/polychart/events/v1/polychart_events_pb.d.ts +0 -192
  357. package/dist/gen/polychart/events/v1/polychart_events_pb.d.ts.map +0 -1
  358. package/dist/gen/polychart/events/v1/polychart_events_pb.js +0 -57
  359. package/dist/gen/polychart/events/v1/polychart_events_pb.js.map +0 -1
  360. package/dist/gen/polychart/v1/polychart_pb.d.ts +0 -1208
  361. package/dist/gen/polychart/v1/polychart_pb.d.ts.map +0 -1
  362. package/dist/gen/polychart/v1/polychart_pb.js +0 -244
  363. package/dist/gen/polychart/v1/polychart_pb.js.map +0 -1
  364. package/dist/services/whiteboard/service.d.ts +0 -8
  365. package/dist/services/whiteboard/service.d.ts.map +0 -1
  366. package/dist/services/whiteboard/service.js +0 -9
  367. package/dist/services/whiteboard/service.js.map +0 -1
  368. package/dist/services/whiteboard/whiteboard.codecs.js +0 -55
  369. package/dist/services/whiteboard/whiteboard.codecs.js.map +0 -1
  370. package/dist/services/whiteboard/whiteboard.d.ts +0 -42
  371. package/dist/services/whiteboard/whiteboard.d.ts.map +0 -1
  372. package/dist/services/whiteboard/whiteboard.js +0 -76
  373. package/dist/services/whiteboard/whiteboard.js.map +0 -1
  374. package/dist/services/whiteboard/whiteboard.schemas.d.ts +0 -771
  375. package/dist/services/whiteboard/whiteboard.schemas.d.ts.map +0 -1
  376. package/dist/services/whiteboard/whiteboard.schemas.js +0 -132
  377. package/dist/services/whiteboard/whiteboard.schemas.js.map +0 -1
  378. package/dist/services/whiteboard/whiteboard.types.d.ts +0 -2
@@ -0,0 +1,2296 @@
1
+ import { Message } from "@bufbuild/protobuf";
2
+ import { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
3
+ import { Timestamp } from "@bufbuild/protobuf/wkt";
4
+ declare namespace quickswap_pb_d_exports {
5
+ export { AffiliateShare, AffiliateShareSchema, ChargedFee, ChargedFeeSchema, CreateQuickSwapRequest, CreateQuickSwapRequestSchema, CreateQuickSwapResponse, CreateQuickSwapResponseSchema, Deposit, DepositAddressState, DepositAddressStateSchema, DepositDisposition, DepositDispositionSchema, DepositInstructions, DepositInstructionsSchema, DepositSchema, ErrorCode, ErrorCodeSchema, ErrorDetail, ErrorDetailSchema, Execution, ExecutionProgress, ExecutionProgressSchema, ExecutionSchema, FeeKind, FeeKindSchema, GetQuickSwapRequest, GetQuickSwapRequestSchema, GetQuickSwapResponse, GetQuickSwapResponseSchema, MarketExecution, MarketExecutionSchema, Protection, ProtectionSchema, QuickSwap, QuickSwapQuote, QuickSwapQuoteSchema, QuickSwapReason, QuickSwapReasonSchema, QuickSwapSchema, QuickSwapService, QuickSwapStatus, QuickSwapStatusSchema, QuickSwapTerms, QuickSwapTermsSchema, QuoteBasis, QuoteBasisSchema, QuoteFee, QuoteFeeSchema, QuoteQuickSwapRequest, QuoteQuickSwapRequestSchema, QuoteQuickSwapResponse, QuoteQuickSwapResponseSchema, RequestedFees, RequestedFeesSchema, Screening, ScreeningSchema, TokenAmount, TokenAmountSchema, TwapExecution, TwapExecutionSchema, Withdrawal, WithdrawalRole, WithdrawalRoleSchema, WithdrawalSchema, WithdrawalState, WithdrawalStateSchema, file_swap_quickswap_v1_quickswap };
6
+ }
7
+ /**
8
+ * Describes the file swap/quickswap/v1/quickswap.proto.
9
+ */
10
+ declare const file_swap_quickswap_v1_quickswap: GenFile;
11
+ /**
12
+ * TokenAmount is an exact token amount in the token's smallest unit.
13
+ *
14
+ * @generated from message swap.quickswap.v1.TokenAmount
15
+ */
16
+ type TokenAmount = Message<"swap.quickswap.v1.TokenAmount"> & {
17
+ /**
18
+ * Unsigned integer amount in the token's smallest unit (for example
19
+ * satoshis or wei), as a decimal string without sign, exponent, separators or
20
+ * leading zeros; at most 78 digits.
21
+ *
22
+ * @generated from field: string base_units = 1;
23
+ */
24
+ baseUnits: string;
25
+ /**
26
+ * Token decimals: the display amount is base_units / 10^decimals. Required in
27
+ * requests, where it must equal AssetChainVariant.source_decimals (the
28
+ * token's on-chain decimals) in GET /v1/chain/deposit-withdraw/config of the
29
+ * asset the amount is in: the source asset for a SOURCE_AMOUNT amount; the
30
+ * destination asset for a DESTINATION_AMOUNT amount and for
31
+ * Protection.min_amount_out.
32
+ *
33
+ * @generated from field: uint32 decimals = 2;
34
+ */
35
+ decimals: number;
36
+ };
37
+ /**
38
+ * Describes the message swap.quickswap.v1.TokenAmount.
39
+ * Use `create(TokenAmountSchema)` to create a new message.
40
+ */
41
+ declare const TokenAmountSchema: GenMessage<TokenAmount>;
42
+ /**
43
+ * Protection bounds the worst execution the end user accepts. It is fixed when
44
+ * the QuickSwap is created and is enforced on every execution, however long
45
+ * after the quote the deposit arrives.
46
+ *
47
+ * @generated from message swap.quickswap.v1.Protection
48
+ */
49
+ type Protection = Message<"swap.quickswap.v1.Protection"> & {
50
+ /**
51
+ * Exactly one bound.
52
+ *
53
+ * @generated from oneof swap.quickswap.v1.Protection.bound
54
+ */
55
+ bound: {
56
+ /**
57
+ * Maximum shortfall from the quoted expected output in basis points
58
+ * (1 bp = 0.01%), from 1 to 1000. Converted at creation into the quote's
59
+ * min_amount_out and min_rate.
60
+ *
61
+ * @generated from field: uint32 max_slippage_bps = 1;
62
+ */
63
+ value: number;
64
+ case: "maxSlippageBps";
65
+ } | {
66
+ /**
67
+ * Positive minimum destination amount after fees for the quoted deposit
68
+ * amount, in destination token units. Converted at creation into the
69
+ * quote's min_rate.
70
+ *
71
+ * @generated from field: swap.quickswap.v1.TokenAmount min_amount_out = 2;
72
+ */
73
+ value: TokenAmount;
74
+ case: "minAmountOut";
75
+ } | {
76
+ case: undefined;
77
+ value?: undefined;
78
+ };
79
+ };
80
+ /**
81
+ * Describes the message swap.quickswap.v1.Protection.
82
+ * Use `create(ProtectionSchema)` to create a new message.
83
+ */
84
+ declare const ProtectionSchema: GenMessage<Protection>;
85
+ /**
86
+ * MarketExecution executes the credited deposit as soon as possible, in one or
87
+ * more immediate orders, within the service's market execution window.
88
+ *
89
+ * @generated from message swap.quickswap.v1.MarketExecution
90
+ */
91
+ type MarketExecution = Message<"swap.quickswap.v1.MarketExecution"> & {};
92
+ /**
93
+ * Describes the message swap.quickswap.v1.MarketExecution.
94
+ * Use `create(MarketExecutionSchema)` to create a new message.
95
+ */
96
+ declare const MarketExecutionSchema: GenMessage<MarketExecution>;
97
+ /**
98
+ * TwapExecution spreads execution evenly over a duration, one slice per
99
+ * slot. Slot k starts k slice intervals after execution starts. Each slice
100
+ * trades what is left of the credited deposit over the slots left, and is
101
+ * protected by the quote's min_rate on what it trades. A slice is sent only
102
+ * within its slot: a slot missed is skipped, never sent late. On a two-leg
103
+ * route, each slice's second leg converts that slice's intermediate funds
104
+ * before the next slice. Intermediate funds below the smallest order the
105
+ * second leg's market accepts do not end the TWAP: they are added to the
106
+ * next slice's conversion, and what is still unconverted when execution
107
+ * ends is refunded to refund_address (INTERMEDIATE_BELOW_MINIMUM). Only the
108
+ * second leg's market closing ends a TWAP early. A TWAP needs a larger
109
+ * deposit than a market execution, since every slice must be a valid order
110
+ * (see QuickSwapQuote.min_deposit_amount). A bridge takes market execution
111
+ * only.
112
+ *
113
+ * @generated from message swap.quickswap.v1.TwapExecution
114
+ */
115
+ type TwapExecution = Message<"swap.quickswap.v1.TwapExecution"> & {
116
+ /**
117
+ * Total execution duration in milliseconds, from 60000 (1 minute) to
118
+ * 86400000 (24 hours). The duration starts when execution starts, not when
119
+ * the QuickSwap is created.
120
+ *
121
+ * @generated from field: uint64 duration_ms = 1;
122
+ */
123
+ durationMs: bigint;
124
+ /**
125
+ * Interval between slices in milliseconds, from 10000 (10 seconds) up to
126
+ * duration_ms. The slice count is duration_ms / slice_interval_ms, rounded
127
+ * up.
128
+ *
129
+ * @generated from field: uint64 slice_interval_ms = 2;
130
+ */
131
+ sliceIntervalMs: bigint;
132
+ };
133
+ /**
134
+ * Describes the message swap.quickswap.v1.TwapExecution.
135
+ * Use `create(TwapExecutionSchema)` to create a new message.
136
+ */
137
+ declare const TwapExecutionSchema: GenMessage<TwapExecution>;
138
+ /**
139
+ * Execution selects how the credited deposit is traded.
140
+ *
141
+ * @generated from message swap.quickswap.v1.Execution
142
+ */
143
+ type Execution = Message<"swap.quickswap.v1.Execution"> & {
144
+ /**
145
+ * Exactly one strategy.
146
+ *
147
+ * @generated from oneof swap.quickswap.v1.Execution.strategy
148
+ */
149
+ strategy: {
150
+ /**
151
+ * Execute immediately.
152
+ *
153
+ * @generated from field: swap.quickswap.v1.MarketExecution market = 1;
154
+ */
155
+ value: MarketExecution;
156
+ case: "market";
157
+ } | {
158
+ /**
159
+ * Execute in equal time slices.
160
+ *
161
+ * @generated from field: swap.quickswap.v1.TwapExecution twap = 2;
162
+ */
163
+ value: TwapExecution;
164
+ case: "twap";
165
+ } | {
166
+ case: undefined;
167
+ value?: undefined;
168
+ };
169
+ };
170
+ /**
171
+ * Describes the message swap.quickswap.v1.Execution.
172
+ * Use `create(ExecutionSchema)` to create a new message.
173
+ */
174
+ declare const ExecutionSchema: GenMessage<Execution>;
175
+ /**
176
+ * QuickSwapTerms are the economic terms of one QuickSwap. The same terms are
177
+ * used to quote and to create, and are echoed unchanged on the QuickSwap.
178
+ * Source and destination are either two assets, which are traded, or one asset
179
+ * on two networks, a bridge: the deposit is credited and withdrawn to the
180
+ * destination network without a trade. Any two zipped_asset_ids from the
181
+ * config may be quoted; QuoteQuickSwap is authoritative for whether the route
182
+ * is offered.
183
+ *
184
+ * @generated from message swap.quickswap.v1.QuickSwapTerms
185
+ */
186
+ type QuickSwapTerms = Message<"swap.quickswap.v1.QuickSwapTerms"> & {
187
+ /**
188
+ * Source asset and network: an AssetChainVariant.zipped_asset_id from
189
+ * GET /v1/chain/deposit-withdraw/config. The end user deposits this asset on
190
+ * this network.
191
+ *
192
+ * @generated from field: uint32 source_zipped_asset_id = 1;
193
+ */
194
+ sourceZippedAssetId: number;
195
+ /**
196
+ * Destination asset and network: an AssetChainVariant.zipped_asset_id from
197
+ * GET /v1/chain/deposit-withdraw/config. The end user receives this asset on
198
+ * this network.
199
+ *
200
+ * @generated from field: uint32 destination_zipped_asset_id = 2;
201
+ */
202
+ destinationZippedAssetId: number;
203
+ /**
204
+ * Side of the swap that amount denominates.
205
+ *
206
+ * @generated from field: swap.quickswap.v1.QuoteBasis basis = 3;
207
+ */
208
+ basis: QuoteBasis;
209
+ /**
210
+ * Positive amount in the token units of the route selected by basis: source
211
+ * route for SOURCE_AMOUNT, destination route for DESTINATION_AMOUNT.
212
+ *
213
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 4;
214
+ */
215
+ amount?: TokenAmount | undefined;
216
+ /**
217
+ * Worst execution the end user accepts.
218
+ *
219
+ * @generated from field: swap.quickswap.v1.Protection protection = 5;
220
+ */
221
+ protection?: Protection | undefined;
222
+ /**
223
+ * Market or TWAP execution. A bridge trades nothing and takes market only;
224
+ * TWAP on a bridge is ROUTE_UNSUPPORTED.
225
+ *
226
+ * @generated from field: swap.quickswap.v1.Execution execution = 6;
227
+ */
228
+ execution?: Execution | undefined;
229
+ };
230
+ /**
231
+ * Describes the message swap.quickswap.v1.QuickSwapTerms.
232
+ * Use `create(QuickSwapTermsSchema)` to create a new message.
233
+ */
234
+ declare const QuickSwapTermsSchema: GenMessage<QuickSwapTerms>;
235
+ /**
236
+ * QuoteFee is one fee component of a quote. Trading fees (SERVICE, BROKER
237
+ * and AFFILIATE) are charged when each leg settles, in the asset that leg
238
+ * receives: the base asset on a buy, the quote asset on a sell. Each is
239
+ * computed on its own from what the leg receives and rounded down when
240
+ * charged. A bridge has no settlement; its fees are charged at payout, in
241
+ * the destination asset.
242
+ *
243
+ * @generated from message swap.quickswap.v1.QuoteFee
244
+ */
245
+ type QuoteFee = Message<"swap.quickswap.v1.QuoteFee"> & {
246
+ /**
247
+ * Fee component.
248
+ *
249
+ * @generated from field: swap.quickswap.v1.FeeKind kind = 1;
250
+ */
251
+ kind: FeeKind;
252
+ /**
253
+ * Asset and network the fee is charged in, as a zipped_asset_id. Zero for a
254
+ * trading fee of the first leg of a two-leg route, which is charged in the
255
+ * intermediate asset (intermediate_asset_id).
256
+ *
257
+ * @generated from field: uint32 zipped_asset_id = 2;
258
+ */
259
+ zippedAssetId: number;
260
+ /**
261
+ * Fee in zipped_asset_id's token units; for a fee charged in the
262
+ * intermediate asset, in the intermediate asset at its trading precision
263
+ * (amount.decimals). Trading fees are rounded up, so the charged fee never
264
+ * exceeds the quoted one.
265
+ *
266
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 3;
267
+ */
268
+ amount?: TokenAmount | undefined;
269
+ /**
270
+ * Rate of a trading fee in basis points of what the leg receives; zero for
271
+ * a network fee.
272
+ *
273
+ * @generated from field: uint32 bps = 4;
274
+ */
275
+ bps: number;
276
+ /**
277
+ * AFFILIATE only: public sub-account ID of the affiliate vault credited
278
+ * with the fee; zero for every other kind.
279
+ *
280
+ * @generated from field: fixed64 account_id = 5;
281
+ */
282
+ accountId: bigint;
283
+ };
284
+ /**
285
+ * Describes the message swap.quickswap.v1.QuoteFee.
286
+ * Use `create(QuoteFeeSchema)` to create a new message.
287
+ */
288
+ declare const QuoteFeeSchema: GenMessage<QuoteFee>;
289
+ /**
290
+ * QuickSwapQuote is the priced view of a QuickSwap's terms. Price fields are
291
+ * estimates at quoted_at; only the protection fields are guarantees.
292
+ *
293
+ * The end user may deposit any amount from min_deposit_amount to
294
+ * max_deposit_amount. min_amount_out applies only to a deposit of exactly
295
+ * deposit_amount that fully converts; for any other deposit the guarantee is
296
+ * min_rate on the converted part.
297
+ *
298
+ * The credit is the deposit less the deposit network fee. Every amount below
299
+ * is in token units of its route.
300
+ *
301
+ * @generated from message swap.quickswap.v1.QuickSwapQuote
302
+ */
303
+ type QuickSwapQuote = Message<"swap.quickswap.v1.QuickSwapQuote"> & {
304
+ /**
305
+ * Source amount the quote was computed for, in source token units. Equals
306
+ * the request amount for SOURCE_AMOUNT; computed for DESTINATION_AMOUNT.
307
+ *
308
+ * @generated from field: swap.quickswap.v1.TokenAmount deposit_amount = 1;
309
+ */
310
+ depositAmount?: TokenAmount | undefined;
311
+ /**
312
+ * Expected destination amount for deposit_amount at quoted_at, after
313
+ * trading fees and both quoted network fees, in destination token units. An
314
+ * estimate, not a guarantee.
315
+ *
316
+ * @generated from field: swap.quickswap.v1.TokenAmount expected_amount_out = 2;
317
+ */
318
+ expectedAmountOut?: TokenAmount | undefined;
319
+ /**
320
+ * Guaranteed minimum delivered amount, in destination token units, at the
321
+ * quoted network fees, for a deposit of exactly deposit_amount that fully
322
+ * converts to the destination asset. For any other deposit, and for a
323
+ * deposit only partly converted, the guarantee is min_rate on the converted
324
+ * part.
325
+ *
326
+ * @generated from field: swap.quickswap.v1.TokenAmount min_amount_out = 3;
327
+ */
328
+ minAmountOut?: TokenAmount | undefined;
329
+ /**
330
+ * Guaranteed minimum execution rate: destination display units per source
331
+ * display unit, as a decimal string with at most 18 fractional digits,
332
+ * rounded up when quoted. Guarantee: for the source amount converted all the
333
+ * way to the destination asset, the destination output before the
334
+ * withdrawal network fee is at least that amount × min_rate, rounded down to
335
+ * destination token units. On a two-leg route, the source amount converted
336
+ * is the first leg's input in proportion to the intermediate funds the
337
+ * second leg converted. Source that is not traded is returned to
338
+ * return_address, and intermediate funds that the second leg does not
339
+ * convert are refunded in the intermediate asset to refund_address; those
340
+ * parts are outside the destination guarantee. The amount delivered is the
341
+ * output less the actual withdrawal network fee, which can differ from the
342
+ * quote.
343
+ *
344
+ * @generated from field: string min_rate = 4;
345
+ */
346
+ minRate: string;
347
+ /**
348
+ * Published minimum deposit, in source token units, compared with the
349
+ * deposit before its network fee. A smaller deposit is returned to
350
+ * return_address (DEPOSIT_BELOW_MINIMUM). It is never below the source
351
+ * network's minimum
352
+ * (AssetChainVariant.deposit_min_amount in the config), and differs from
353
+ * ErrorDetail.min_deposit_amount, the smallest deposit that currently
354
+ * quotes. For a TWAP it is the slice count times the smallest deposit one
355
+ * slice takes, and at least a market execution's minimum.
356
+ *
357
+ * @generated from field: swap.quickswap.v1.TokenAmount min_deposit_amount = 5;
358
+ */
359
+ minDepositAmount?: TokenAmount | undefined;
360
+ /**
361
+ * Largest deposit that is eligible to execute, in source token units,
362
+ * compared with the deposit before its network fee. Fixed when the
363
+ * QuickSwap is created. A larger deposit is returned to return_address
364
+ * (DEPOSIT_ABOVE_MAXIMUM). Unset for a bridge, whose deposit no order book
365
+ * bounds.
366
+ *
367
+ * @generated from field: swap.quickswap.v1.TokenAmount max_deposit_amount = 6;
368
+ */
369
+ maxDepositAmount?: TokenAmount | undefined;
370
+ /**
371
+ * Unified asset ID of the intermediate asset of a two-leg route (for
372
+ * example USDT for BTC to SOL): the AssetConfig.ledger_id from
373
+ * GET /v1/chain/deposit-withdraw/config. Zero for a direct route or a
374
+ * bridge. When non-zero, CreateQuickSwap requires a refund address for that
375
+ * asset. The route is fixed at creation.
376
+ *
377
+ * @generated from field: uint32 intermediate_asset_id = 7;
378
+ */
379
+ intermediateAssetId: number;
380
+ /**
381
+ * Quoted fee components for deposit_amount: each leg's service, broker and
382
+ * affiliate fees, in that order, legs in route order (a bridge has one set,
383
+ * charged at payout), then network fees. Affiliates are in ascending
384
+ * account_id order. Zero fees are omitted.
385
+ *
386
+ * @generated from field: repeated swap.quickswap.v1.QuoteFee fees = 8;
387
+ */
388
+ fees: QuoteFee[];
389
+ /**
390
+ * When the quote was priced.
391
+ *
392
+ * @generated from field: google.protobuf.Timestamp quoted_at = 9;
393
+ */
394
+ quotedAt?: Timestamp | undefined;
395
+ /**
396
+ * End of the short quote validity, typically seconds to minutes after
397
+ * quoted_at. Display the quote until expires_at. CreateQuickSwap prices the
398
+ * terms again and never fails because a quote expired. After it the price
399
+ * fields are stale; the protection of a created QuickSwap still applies.
400
+ * Independent of the funding window and the execution deadline.
401
+ *
402
+ * @generated from field: google.protobuf.Timestamp expires_at = 10;
403
+ */
404
+ expiresAt?: Timestamp | undefined;
405
+ };
406
+ /**
407
+ * Describes the message swap.quickswap.v1.QuickSwapQuote.
408
+ * Use `create(QuickSwapQuoteSchema)` to create a new message.
409
+ */
410
+ declare const QuickSwapQuoteSchema: GenMessage<QuickSwapQuote>;
411
+ /**
412
+ * Screening is the risk screening of a QuickSwap. Deposits are screened on
413
+ * arrival; the outcome shows in the status, its reason and each deposit's
414
+ * disposition and reason.
415
+ *
416
+ * @generated from message swap.quickswap.v1.Screening
417
+ */
418
+ type Screening = Message<"swap.quickswap.v1.Screening"> & {
419
+ /**
420
+ * Source wallet supplied in the request; empty when none was supplied.
421
+ * Recorded and shown; not used to accept or reject a deposit.
422
+ *
423
+ * @generated from field: string source_wallet = 2;
424
+ */
425
+ sourceWallet: string;
426
+ };
427
+ /**
428
+ * Describes the message swap.quickswap.v1.Screening.
429
+ * Use `create(ScreeningSchema)` to create a new message.
430
+ */
431
+ declare const ScreeningSchema: GenMessage<Screening>;
432
+ /**
433
+ * DepositInstructions tell the end user where and until when to deposit.
434
+ *
435
+ * @generated from message swap.quickswap.v1.DepositInstructions
436
+ */
437
+ type DepositInstructions = Message<"swap.quickswap.v1.DepositInstructions"> & {
438
+ /**
439
+ * Deposit address in the source network's native text form, without memo.
440
+ *
441
+ * @generated from field: string address = 1;
442
+ */
443
+ address: string;
444
+ /**
445
+ * Destination tag or memo the deposit must carry; empty when the source
446
+ * network uses none. A deposit without it cannot be attributed.
447
+ *
448
+ * @generated from field: string memo = 2;
449
+ */
450
+ memo: string;
451
+ /**
452
+ * Asset and network to deposit; equal to terms.source_zipped_asset_id.
453
+ *
454
+ * @generated from field: uint32 zipped_asset_id = 3;
455
+ */
456
+ zippedAssetId: number;
457
+ /**
458
+ * When the address was issued to this QuickSwap; the funding window starts
459
+ * here. After ADDRESS_UNAVAILABLE it can be long after created_at.
460
+ *
461
+ * @generated from field: google.protobuf.Timestamp issued_at = 4;
462
+ */
463
+ issuedAt?: Timestamp | undefined;
464
+ /**
465
+ * End of the funding window, fixed when the address is issued (currently 7
466
+ * days after issued_at). A deposit can execute only if Polyester detects it
467
+ * before this time; detection time counts, not block time, and
468
+ * confirmations may finish later. A deposit detected at or after this time
469
+ * never executes. A deposit observed on a retired address is
470
+ * MANUAL_RECOVERY and is not returned automatically; other late deposits
471
+ * are RETURN_ONLY. For an unfunded address, address_retires_at equals this
472
+ * time, so there is no separate scheduled return period. Send deposits well
473
+ * before this time. Never changes.
474
+ *
475
+ * @generated from field: google.protobuf.Timestamp funding_expires_at = 5;
476
+ */
477
+ fundingExpiresAt?: Timestamp | undefined;
478
+ /**
479
+ * After this time the deposit address is retired and funds sent to it may
480
+ * not be recoverable. For an unfunded address it equals funding_expires_at.
481
+ * After a deposit is accepted it is provisional, a lower bound, until
482
+ * Polyester releases the deposit address, which can be shortly after the
483
+ * QuickSwap becomes terminal; from then on it is at least 7 days after all
484
+ * payouts finish. It only moves later, never earlier, and never before
485
+ * funding_expires_at.
486
+ *
487
+ * @generated from field: google.protobuf.Timestamp address_retires_at = 6;
488
+ */
489
+ addressRetiresAt?: Timestamp | undefined;
490
+ /**
491
+ * Current lifecycle state of the address.
492
+ *
493
+ * @generated from field: swap.quickswap.v1.DepositAddressState address_state = 7;
494
+ */
495
+ addressState: DepositAddressState;
496
+ /**
497
+ * Recommended gas limit, in gas units, for native-coin deposits on EVM
498
+ * networks: 250000. Polyester does not enforce this limit. On some networks,
499
+ * depositing to an address that has never received funds requires far more
500
+ * than 21000 gas. If the limit is too low, the transaction fails on chain
501
+ * without depositing funds, and the network fee is still charged. Use at
502
+ * least the recommended limit. Unused gas is not charged. Zero for token
503
+ * deposits and non-EVM networks.
504
+ *
505
+ * @generated from field: uint64 min_native_gas_limit = 8;
506
+ */
507
+ minNativeGasLimit: bigint;
508
+ };
509
+ /**
510
+ * Describes the message swap.quickswap.v1.DepositInstructions.
511
+ * Use `create(DepositInstructionsSchema)` to create a new message.
512
+ */
513
+ declare const DepositInstructionsSchema: GenMessage<DepositInstructions>;
514
+ /**
515
+ * Deposit is one deposit detected on the QuickSwap's deposit address.
516
+ *
517
+ * @generated from message swap.quickswap.v1.Deposit
518
+ */
519
+ type Deposit = Message<"swap.quickswap.v1.Deposit"> & {
520
+ /**
521
+ * Zero-based position in detection order; stable for the QuickSwap's life.
522
+ *
523
+ * @generated from field: uint32 index = 1;
524
+ */
525
+ index: number;
526
+ /**
527
+ * Source-network transaction identifier in the network's native text form.
528
+ *
529
+ * @generated from field: string tx_hash = 2;
530
+ */
531
+ txHash: string;
532
+ /**
533
+ * Output or log index of the deposit within tx_hash; zero is valid.
534
+ *
535
+ * @generated from field: uint64 tx_occurrence_index = 3;
536
+ */
537
+ txOccurrenceIndex: bigint;
538
+ /**
539
+ * Asset and network actually received, as a zipped_asset_id. Zero until
540
+ * Polyester has identified the deposit's asset, shortly after detection,
541
+ * and when the asset is not a supported route.
542
+ *
543
+ * @generated from field: uint32 zipped_asset_id = 4;
544
+ */
545
+ zippedAssetId: number;
546
+ /**
547
+ * Received amount, before the deposit network fee, in zipped_asset_id's
548
+ * token units; unset while zipped_asset_id is zero.
549
+ *
550
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 5;
551
+ */
552
+ amount?: TokenAmount | undefined;
553
+ /**
554
+ * What this deposit may do.
555
+ *
556
+ * @generated from field: swap.quickswap.v1.DepositDisposition disposition = 8;
557
+ */
558
+ disposition: DepositDisposition;
559
+ /**
560
+ * Why the disposition is RETURN_ONLY, ON_HOLD or MANUAL_RECOVERY;
561
+ * REASON_UNSPECIFIED otherwise, and for a deposit ON_HOLD for review
562
+ * without a more specific reason.
563
+ *
564
+ * @generated from field: swap.quickswap.v1.QuickSwapReason reason = 9;
565
+ */
566
+ reason: QuickSwapReason;
567
+ /**
568
+ * Current source-network confirmations; zero until the source network
569
+ * reports any. Never decreases.
570
+ *
571
+ * @generated from field: uint32 confirmations = 10;
572
+ */
573
+ confirmations: number;
574
+ /**
575
+ * Source-network confirmations required before credit; zero until known.
576
+ *
577
+ * @generated from field: uint32 required_confirmations = 11;
578
+ */
579
+ requiredConfirmations: number;
580
+ /**
581
+ * When the deposit was first seen. Eligibility compares this time with
582
+ * funding_expires_at.
583
+ *
584
+ * @generated from field: google.protobuf.Timestamp detected_at = 12;
585
+ */
586
+ detectedAt?: Timestamp | undefined;
587
+ /**
588
+ * When the deposit was credited; unset until credited. Credit does not
589
+ * decide eligibility: a credited deposit can still be EVALUATING, and one
590
+ * then found ineligible, such as a late deposit, stays credited and is
591
+ * returned (RETURN_ONLY).
592
+ *
593
+ * @generated from field: google.protobuf.Timestamp credited_at = 13;
594
+ */
595
+ creditedAt?: Timestamp | undefined;
596
+ /**
597
+ * Public, URL-safe lifecycle flow identifier of this deposit, usable with
598
+ * GET /v1/chain/flows/{flow_id}; empty until the flow exists. Lifecycle flow
599
+ * amounts are 18-decimal unified units (amount_e18), not token base units.
600
+ *
601
+ * @generated from field: string flow_id = 14;
602
+ */
603
+ flowId: string;
604
+ };
605
+ /**
606
+ * Describes the message swap.quickswap.v1.Deposit.
607
+ * Use `create(DepositSchema)` to create a new message.
608
+ */
609
+ declare const DepositSchema: GenMessage<Deposit>;
610
+ /**
611
+ * ExecutionProgress is the trading progress of a QuickSwap.
612
+ *
613
+ * @generated from message swap.quickswap.v1.ExecutionProgress
614
+ */
615
+ type ExecutionProgress = Message<"swap.quickswap.v1.ExecutionProgress"> & {
616
+ /**
617
+ * Credited amount committed to execution, in source token units.
618
+ *
619
+ * @generated from field: swap.quickswap.v1.TokenAmount input_amount = 1;
620
+ */
621
+ inputAmount?: TokenAmount | undefined;
622
+ /**
623
+ * Source amount traded so far, in source token units. On a two-leg route
624
+ * this counts the first leg. Zero for a bridge, which trades nothing.
625
+ *
626
+ * @generated from field: swap.quickswap.v1.TokenAmount executed_input = 2;
627
+ */
628
+ executedInput?: TokenAmount | undefined;
629
+ /**
630
+ * Destination amount acquired so far after service, broker and affiliate
631
+ * fees and before withdrawal network fees, in destination token units. Zero for a
632
+ * bridge: its destination withdrawal pays the credit less its fees.
633
+ *
634
+ * @generated from field: swap.quickswap.v1.TokenAmount output_amount = 3;
635
+ */
636
+ outputAmount?: TokenAmount | undefined;
637
+ /**
638
+ * On a two-leg route, intermediate asset acquired but not yet converted, in
639
+ * the refund route's token units; unset for a direct route and a bridge.
640
+ *
641
+ * @generated from field: swap.quickswap.v1.TokenAmount intermediate_remainder = 4;
642
+ */
643
+ intermediateRemainder?: TokenAmount | undefined;
644
+ /**
645
+ * Completed slices: a market execution's one slice completes when
646
+ * execution finishes; a TWAP slice completes once it has traded and is
647
+ * over, so a slot that traded nothing or was skipped never completes.
648
+ * Zero for a bridge.
649
+ *
650
+ * @generated from field: uint32 completed_slices = 5;
651
+ */
652
+ completedSlices: number;
653
+ /**
654
+ * Planned slices: a market execution has one once it is planned; a TWAP
655
+ * has its slice count, duration_ms over slice_interval_ms rounded up. Zero
656
+ * until then, and for a bridge, which trades nothing.
657
+ *
658
+ * @generated from field: uint32 total_slices = 6;
659
+ */
660
+ totalSlices: number;
661
+ /**
662
+ * When execution started.
663
+ *
664
+ * @generated from field: google.protobuf.Timestamp started_at = 7;
665
+ */
666
+ startedAt?: Timestamp | undefined;
667
+ /**
668
+ * Execution deadline: started_at plus the TWAP duration, or plus the market
669
+ * execution window. Funds not converted by then are refunded or returned.
670
+ * Independent of the quote validity and the funding window. Unset until
671
+ * the execution is planned, and for a bridge, which trades nothing.
672
+ *
673
+ * @generated from field: google.protobuf.Timestamp deadline = 8;
674
+ */
675
+ deadline?: Timestamp | undefined;
676
+ /**
677
+ * When execution finished; unset while executing.
678
+ *
679
+ * @generated from field: google.protobuf.Timestamp finished_at = 9;
680
+ */
681
+ finishedAt?: Timestamp | undefined;
682
+ };
683
+ /**
684
+ * Describes the message swap.quickswap.v1.ExecutionProgress.
685
+ * Use `create(ExecutionProgressSchema)` to create a new message.
686
+ */
687
+ declare const ExecutionProgressSchema: GenMessage<ExecutionProgress>;
688
+ /**
689
+ * Withdrawal is one outgoing payment. A QuickSwap can end with several, for
690
+ * example a partial refund plus the destination payout; the best case is a
691
+ * single destination withdrawal.
692
+ *
693
+ * @generated from message swap.quickswap.v1.Withdrawal
694
+ */
695
+ type Withdrawal = Message<"swap.quickswap.v1.Withdrawal"> & {
696
+ /**
697
+ * Zero-based position in the withdrawals list. Not stable: a withdrawal's
698
+ * position can change between reads, so do not use it as an identifier.
699
+ *
700
+ * @generated from field: uint32 index = 1;
701
+ */
702
+ index: number;
703
+ /**
704
+ * Why this withdrawal pays its recipient.
705
+ *
706
+ * @generated from field: swap.quickswap.v1.WithdrawalRole role = 2;
707
+ */
708
+ role: WithdrawalRole;
709
+ /**
710
+ * Deposit whose funds this withdrawal moves.
711
+ *
712
+ * @generated from field: uint32 deposit_index = 3;
713
+ */
714
+ depositIndex: number;
715
+ /**
716
+ * Asset and network paid, as a zipped_asset_id.
717
+ *
718
+ * @generated from field: uint32 zipped_asset_id = 4;
719
+ */
720
+ zippedAssetId: number;
721
+ /**
722
+ * Recipient address in the network's native text form.
723
+ *
724
+ * @generated from field: string address = 5;
725
+ */
726
+ address: string;
727
+ /**
728
+ * Recipient destination tag or memo; empty when the network uses none.
729
+ *
730
+ * @generated from field: string memo = 6;
731
+ */
732
+ memo: string;
733
+ /**
734
+ * Amount delivered to address after the network fee, in zipped_asset_id's
735
+ * token units; set once FINALIZED. Like tx_hash, it is the amount recorded
736
+ * for this withdrawal and can be corrected for up to 24 hours after the
737
+ * QuickSwap ends (terminal_at).
738
+ *
739
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 7;
740
+ */
741
+ amount?: TokenAmount | undefined;
742
+ /**
743
+ * Actual network fee withheld from this withdrawal, in the same units; set
744
+ * once FINALIZED. Can be corrected for up to 24 hours after the QuickSwap
745
+ * ends, like amount.
746
+ *
747
+ * @generated from field: swap.quickswap.v1.TokenAmount network_fee = 8;
748
+ */
749
+ networkFee?: TokenAmount | undefined;
750
+ /**
751
+ * Withdrawal progress.
752
+ *
753
+ * @generated from field: swap.quickswap.v1.WithdrawalState state = 9;
754
+ */
755
+ state: WithdrawalState;
756
+ /**
757
+ * Recipient-network transaction recorded for this withdrawal; empty until
758
+ * the transaction is committed on the recipient network. It can be
759
+ * corrected for up to 24 hours after the QuickSwap ends (terminal_at) and is
760
+ * not updated after that. For the authoritative, latest state of the
761
+ * transfer, read flow_id.
762
+ *
763
+ * @generated from field: string tx_hash = 10;
764
+ */
765
+ txHash: string;
766
+ /**
767
+ * When the withdrawal was submitted; unset until submitted.
768
+ *
769
+ * @generated from field: google.protobuf.Timestamp submitted_at = 11;
770
+ */
771
+ submittedAt?: Timestamp | undefined;
772
+ /**
773
+ * When the withdrawal became final; unset until FINALIZED.
774
+ *
775
+ * @generated from field: google.protobuf.Timestamp finalized_at = 12;
776
+ */
777
+ finalizedAt?: Timestamp | undefined;
778
+ /**
779
+ * Public, URL-safe lifecycle flow identifier of this withdrawal, usable with
780
+ * GET /v1/chain/flows/{flow_id}; empty until the flow exists. The flow is
781
+ * the authoritative, latest state of the transfer, including a correction
782
+ * made after tx_hash, amount and network_fee stop being updated. Lifecycle
783
+ * flow amounts are 18-decimal unified units (amount_e18), not token base
784
+ * units.
785
+ *
786
+ * @generated from field: string flow_id = 13;
787
+ */
788
+ flowId: string;
789
+ /**
790
+ * Set only when state is NOT_SENT: the amount for which no withdrawal was
791
+ * made because it was below the withdrawal minimum of its asset and
792
+ * network. In zipped_asset_id's token units, rounded down to the token's
793
+ * smallest unit.
794
+ *
795
+ * @generated from field: swap.quickswap.v1.TokenAmount unsent_amount = 14;
796
+ */
797
+ unsentAmount?: TokenAmount | undefined;
798
+ };
799
+ /**
800
+ * Describes the message swap.quickswap.v1.Withdrawal.
801
+ * Use `create(WithdrawalSchema)` to create a new message.
802
+ */
803
+ declare const WithdrawalSchema: GenMessage<Withdrawal>;
804
+ /**
805
+ * QuickSwap is one broker-owned swap of an external deposit into external
806
+ * withdrawals. The end user needs no account.
807
+ *
808
+ * @generated from message swap.quickswap.v1.QuickSwap
809
+ */
810
+ type QuickSwap = Message<"swap.quickswap.v1.QuickSwap"> & {
811
+ /**
812
+ * Public QuickSwap identifier.
813
+ *
814
+ * @generated from field: fixed64 swap_id = 1;
815
+ */
816
+ swapId: bigint;
817
+ /**
818
+ * The broker's idempotency key that created this QuickSwap.
819
+ *
820
+ * @generated from field: string idempotency_key = 2;
821
+ */
822
+ idempotencyKey: string;
823
+ /**
824
+ * Current status.
825
+ *
826
+ * @generated from field: swap.quickswap.v1.QuickSwapStatus status = 3;
827
+ */
828
+ status: QuickSwapStatus;
829
+ /**
830
+ * Why the status is notable (held, returning, delayed, terminal without
831
+ * destination output); REASON_UNSPECIFIED otherwise. When a payout
832
+ * completes but a refund or return was NOT_SENT, the status follows the
833
+ * paid withdrawals (for example COMPLETED) and the reason is
834
+ * REFUND_BELOW_MINIMUM. A FAILED withdrawal takes precedence: the status is
835
+ * HELD and the reason WITHDRAWAL_FAILED.
836
+ *
837
+ * @generated from field: swap.quickswap.v1.QuickSwapReason reason = 4;
838
+ */
839
+ reason: QuickSwapReason;
840
+ /**
841
+ * True when status is terminal; authoritative, including for status values
842
+ * added later. Polling can stop at a terminal status. A terminal status
843
+ * never changes. Shortly after it, address_retires_at can still move later,
844
+ * and withdrawal details can be corrected as documented on Withdrawal;
845
+ * another deposit reaching the address also shows as RETURN_ONLY, and
846
+ * another deposit observed on an already retired address shows as
847
+ * MANUAL_RECOVERY. Returns made directly for such deposits are not yet
848
+ * reported in withdrawals; RETURN_ONLY does not confirm a completed return.
849
+ * Read again if the end user reports such a deposit or needs the final
850
+ * retirement time.
851
+ *
852
+ * @generated from field: bool is_terminal = 5;
853
+ */
854
+ isTerminal: boolean;
855
+ /**
856
+ * Accepted economic terms.
857
+ *
858
+ * @generated from field: swap.quickswap.v1.QuickSwapTerms terms = 6;
859
+ */
860
+ terms?: QuickSwapTerms | undefined;
861
+ /**
862
+ * Recipient of the swap output on the destination network. Addresses and
863
+ * memos are in their network's canonical form (for example lowercase EVM
864
+ * hex), which can differ in case or encoding from the create request; that
865
+ * form is the one paid.
866
+ *
867
+ * @generated from field: string destination_address = 7;
868
+ */
869
+ destinationAddress: string;
870
+ /**
871
+ * Destination tag or memo for destination_address; empty when none.
872
+ *
873
+ * @generated from field: string destination_memo = 8;
874
+ */
875
+ destinationMemo: string;
876
+ /**
877
+ * Recipient of returned source funds on the source network.
878
+ *
879
+ * @generated from field: string return_address = 9;
880
+ */
881
+ returnAddress: string;
882
+ /**
883
+ * Destination tag or memo for return_address; empty when none.
884
+ *
885
+ * @generated from field: string return_memo = 10;
886
+ */
887
+ returnMemo: string;
888
+ /**
889
+ * Refund route (asset and network) of the intermediate asset; zero when
890
+ * none was supplied.
891
+ *
892
+ * @generated from field: uint32 refund_zipped_asset_id = 11;
893
+ */
894
+ refundZippedAssetId: number;
895
+ /**
896
+ * Recipient of refunded intermediate asset; empty when none was supplied.
897
+ *
898
+ * @generated from field: string refund_address = 12;
899
+ */
900
+ refundAddress: string;
901
+ /**
902
+ * Destination tag or memo for refund_address; empty when none.
903
+ *
904
+ * @generated from field: string refund_memo = 13;
905
+ */
906
+ refundMemo: string;
907
+ /**
908
+ * Quote and protection fixed at creation. Not refreshed on retries.
909
+ *
910
+ * @generated from field: swap.quickswap.v1.QuickSwapQuote quote = 14;
911
+ */
912
+ quote?: QuickSwapQuote | undefined;
913
+ /**
914
+ * Where and until when to deposit; absent while ALLOCATING and on a
915
+ * QuickSwap that never got an address (EXPIRED with
916
+ * DEPOSIT_ADDRESS_CONFLICT).
917
+ *
918
+ * @generated from field: swap.quickswap.v1.DepositInstructions deposit_instructions = 15;
919
+ */
920
+ depositInstructions?: DepositInstructions | undefined;
921
+ /**
922
+ * Risk screening.
923
+ *
924
+ * @generated from field: swap.quickswap.v1.Screening screening = 16;
925
+ */
926
+ screening?: Screening | undefined;
927
+ /**
928
+ * Detected deposits, oldest first, at most 50.
929
+ *
930
+ * @generated from field: repeated swap.quickswap.v1.Deposit deposits = 17;
931
+ */
932
+ deposits: Deposit[];
933
+ /**
934
+ * True when more than 50 deposits were detected; only the first 50 are
935
+ * listed.
936
+ *
937
+ * @generated from field: bool deposits_truncated = 18;
938
+ */
939
+ depositsTruncated: boolean;
940
+ /**
941
+ * Execution progress; absent before execution starts.
942
+ *
943
+ * @generated from field: swap.quickswap.v1.ExecutionProgress execution = 20;
944
+ */
945
+ execution?: ExecutionProgress | undefined;
946
+ /**
947
+ * Withdrawals, oldest first, at most 50.
948
+ *
949
+ * @generated from field: repeated swap.quickswap.v1.Withdrawal withdrawals = 21;
950
+ */
951
+ withdrawals: Withdrawal[];
952
+ /**
953
+ * True when more than 50 withdrawals exist; only the first 50 are listed.
954
+ *
955
+ * @generated from field: bool withdrawals_truncated = 22;
956
+ */
957
+ withdrawalsTruncated: boolean;
958
+ /**
959
+ * When the QuickSwap was created.
960
+ *
961
+ * @generated from field: google.protobuf.Timestamp created_at = 23;
962
+ */
963
+ createdAt?: Timestamp | undefined;
964
+ /**
965
+ * When the QuickSwap last changed.
966
+ *
967
+ * @generated from field: google.protobuf.Timestamp updated_at = 24;
968
+ */
969
+ updatedAt?: Timestamp | undefined;
970
+ /**
971
+ * When status became terminal; unset while not terminal.
972
+ *
973
+ * @generated from field: google.protobuf.Timestamp terminal_at = 25;
974
+ */
975
+ terminalAt?: Timestamp | undefined;
976
+ /**
977
+ * Monotonic state version: a snapshot with a lower version is older. Zero
978
+ * while ALLOCATING; 1 once the deposit address is issued (AWAITING_DEPOSIT)
979
+ * or allocation ends without one (EXPIRED with DEPOSIT_ADDRESS_CONFLICT);
980
+ * every later change increments it.
981
+ *
982
+ * @generated from field: uint64 version = 26;
983
+ */
984
+ version: bigint;
985
+ /**
986
+ * Fee schedule version fixed at creation. Every execution or bridge payout
987
+ * of this QuickSwap is charged that version's service fees, whatever later
988
+ * versions change.
989
+ *
990
+ * @generated from field: uint64 fee_schedule_version = 28;
991
+ */
992
+ feeScheduleVersion: bigint;
993
+ /**
994
+ * Broker and affiliate fees as requested, fixed at creation.
995
+ *
996
+ * @generated from field: swap.quickswap.v1.RequestedFees fees = 29;
997
+ */
998
+ fees?: RequestedFees | undefined;
999
+ /**
1000
+ * Broker and affiliate fees charged so far, as settled: one entry per fee
1001
+ * kind, credited vault and asset, in kind, then account_id, then asset_id
1002
+ * order. Grows while the QuickSwap executes or pays out a bridge.
1003
+ *
1004
+ * @generated from field: repeated swap.quickswap.v1.ChargedFee charged_fees = 30;
1005
+ */
1006
+ chargedFees: ChargedFee[];
1007
+ };
1008
+ /**
1009
+ * Describes the message swap.quickswap.v1.QuickSwap.
1010
+ * Use `create(QuickSwapSchema)` to create a new message.
1011
+ */
1012
+ declare const QuickSwapSchema: GenMessage<QuickSwap>;
1013
+ /**
1014
+ * RequestedFees are the broker and affiliate fees a QuickSwap request set,
1015
+ * charged on top of the service fee.
1016
+ *
1017
+ * @generated from message swap.quickswap.v1.RequestedFees
1018
+ */
1019
+ type RequestedFees = Message<"swap.quickswap.v1.RequestedFees"> & {
1020
+ /**
1021
+ * Broker fee in basis points of what each leg receives, credited to the
1022
+ * broker's default vault.
1023
+ *
1024
+ * @generated from field: uint32 broker_bps = 1;
1025
+ */
1026
+ brokerBps: number;
1027
+ /**
1028
+ * Affiliate fees, in ascending account_id order.
1029
+ *
1030
+ * @generated from field: repeated swap.quickswap.v1.AffiliateShare affiliates = 2;
1031
+ */
1032
+ affiliates: AffiliateShare[];
1033
+ };
1034
+ /**
1035
+ * Describes the message swap.quickswap.v1.RequestedFees.
1036
+ * Use `create(RequestedFeesSchema)` to create a new message.
1037
+ */
1038
+ declare const RequestedFeesSchema: GenMessage<RequestedFees>;
1039
+ /**
1040
+ * ChargedFee is what one vault has been credited with for a QuickSwap in
1041
+ * one asset, from settled fills and bridge payouts.
1042
+ *
1043
+ * @generated from message swap.quickswap.v1.ChargedFee
1044
+ */
1045
+ type ChargedFee = Message<"swap.quickswap.v1.ChargedFee"> & {
1046
+ /**
1047
+ * BROKER or AFFILIATE.
1048
+ *
1049
+ * @generated from field: swap.quickswap.v1.FeeKind kind = 1;
1050
+ */
1051
+ kind: FeeKind;
1052
+ /**
1053
+ * Public sub-account ID of the credited vault: the default vault for
1054
+ * BROKER, the affiliate vault for AFFILIATE.
1055
+ *
1056
+ * @generated from field: fixed64 account_id = 2;
1057
+ */
1058
+ accountId: bigint;
1059
+ /**
1060
+ * Asset credited, as an AssetConfig.ledger_id from
1061
+ * GET /v1/chain/deposit-withdraw/config.
1062
+ *
1063
+ * @generated from field: uint32 asset_id = 3;
1064
+ */
1065
+ assetId: number;
1066
+ /**
1067
+ * Amount credited, in base units of 18 decimals.
1068
+ *
1069
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 4;
1070
+ */
1071
+ amount?: TokenAmount | undefined;
1072
+ };
1073
+ /**
1074
+ * Describes the message swap.quickswap.v1.ChargedFee.
1075
+ * Use `create(ChargedFeeSchema)` to create a new message.
1076
+ */
1077
+ declare const ChargedFeeSchema: GenMessage<ChargedFee>;
1078
+ /**
1079
+ * QuoteQuickSwapRequest prices terms, with the broker and affiliate fees,
1080
+ * without reserving anything.
1081
+ *
1082
+ * @generated from message swap.quickswap.v1.QuoteQuickSwapRequest
1083
+ */
1084
+ type QuoteQuickSwapRequest = Message<"swap.quickswap.v1.QuoteQuickSwapRequest"> & {
1085
+ /**
1086
+ * Terms to price.
1087
+ *
1088
+ * @generated from field: swap.quickswap.v1.QuickSwapTerms terms = 1;
1089
+ */
1090
+ terms?: QuickSwapTerms | undefined;
1091
+ /**
1092
+ * Broker fee in basis points of what each leg receives, charged on top of
1093
+ * the service fee and credited to the broker's default vault; 0 for none.
1094
+ * broker_bps and the affiliates' bps total at most 300. Fees outside these
1095
+ * rules fail with FEES_INVALID.
1096
+ *
1097
+ * @generated from field: uint32 broker_bps = 2;
1098
+ */
1099
+ brokerBps: number;
1100
+ /**
1101
+ * Affiliate fees, each charged on top and credited to its affiliate vault:
1102
+ * at most three distinct vaults.
1103
+ *
1104
+ * @generated from field: repeated swap.quickswap.v1.AffiliateShare affiliates = 3;
1105
+ */
1106
+ affiliates: AffiliateShare[];
1107
+ };
1108
+ /**
1109
+ * Describes the message swap.quickswap.v1.QuoteQuickSwapRequest.
1110
+ * Use `create(QuoteQuickSwapRequestSchema)` to create a new message.
1111
+ */
1112
+ declare const QuoteQuickSwapRequestSchema: GenMessage<QuoteQuickSwapRequest>;
1113
+ /**
1114
+ * QuoteQuickSwapResponse is an indicative quote.
1115
+ *
1116
+ * @generated from message swap.quickswap.v1.QuoteQuickSwapResponse
1117
+ */
1118
+ type QuoteQuickSwapResponse = Message<"swap.quickswap.v1.QuoteQuickSwapResponse"> & {
1119
+ /**
1120
+ * Indicative quote, including whether the route needs a refund address.
1121
+ * Creating a QuickSwap prices the terms again.
1122
+ *
1123
+ * @generated from field: swap.quickswap.v1.QuickSwapQuote quote = 1;
1124
+ */
1125
+ quote?: QuickSwapQuote | undefined;
1126
+ };
1127
+ /**
1128
+ * Describes the message swap.quickswap.v1.QuoteQuickSwapResponse.
1129
+ * Use `create(QuoteQuickSwapResponseSchema)` to create a new message.
1130
+ */
1131
+ declare const QuoteQuickSwapResponseSchema: GenMessage<QuoteQuickSwapResponse>;
1132
+ /**
1133
+ * AffiliateShare credits one affiliate vault, a sub-account the broker owns,
1134
+ * with a fee charged on top of the service and broker fees.
1135
+ *
1136
+ * @generated from message swap.quickswap.v1.AffiliateShare
1137
+ */
1138
+ type AffiliateShare = Message<"swap.quickswap.v1.AffiliateShare"> & {
1139
+ /**
1140
+ * Public sub-account ID of an active affiliate vault of the broker
1141
+ * (QuickSwapBrokerService.CreateAffiliateVault). Create the vault first: an
1142
+ * unknown, disabled or other broker's vault, or the default vault, fails
1143
+ * with AFFILIATE_VAULT_UNKNOWN.
1144
+ *
1145
+ * @generated from field: fixed64 account_id = 1;
1146
+ */
1147
+ accountId: bigint;
1148
+ /**
1149
+ * Fee in basis points of what each leg receives, from 1 to 300.
1150
+ *
1151
+ * @generated from field: uint32 bps = 2;
1152
+ */
1153
+ bps: number;
1154
+ };
1155
+ /**
1156
+ * Describes the message swap.quickswap.v1.AffiliateShare.
1157
+ * Use `create(AffiliateShareSchema)` to create a new message.
1158
+ */
1159
+ declare const AffiliateShareSchema: GenMessage<AffiliateShare>;
1160
+ /**
1161
+ * CreateQuickSwapRequest creates, or returns, the QuickSwap for one
1162
+ * idempotency key.
1163
+ *
1164
+ * @generated from message swap.quickswap.v1.CreateQuickSwapRequest
1165
+ */
1166
+ type CreateQuickSwapRequest = Message<"swap.quickswap.v1.CreateQuickSwapRequest"> & {
1167
+ /**
1168
+ * Broker-chosen idempotency key, 1 to 128 characters of letters, digits,
1169
+ * '.', '_', ':' or '-'. Scoped to the authenticated broker and retained
1170
+ * permanently. The same key with the same request returns the same QuickSwap
1171
+ * and deposit address; with a different request it fails with
1172
+ * IDEMPOTENCY_CONFLICT. Requests are compared after every valid address and
1173
+ * memo is put in its network's canonical form, so the same address in
1174
+ * another case or encoding is the same request; affiliate order is
1175
+ * ignored; every other field, the fees included, must be equal.
1176
+ *
1177
+ * @generated from field: string idempotency_key = 1;
1178
+ */
1179
+ idempotencyKey: string;
1180
+ /**
1181
+ * Economic terms.
1182
+ *
1183
+ * @generated from field: swap.quickswap.v1.QuickSwapTerms terms = 2;
1184
+ */
1185
+ terms?: QuickSwapTerms | undefined;
1186
+ /**
1187
+ * Recipient of the swap output on the destination network, in its native
1188
+ * text form without memo.
1189
+ *
1190
+ * @generated from field: string destination_address = 3;
1191
+ */
1192
+ destinationAddress: string;
1193
+ /**
1194
+ * Destination tag or memo for destination_address. Required when the
1195
+ * destination network needs one; must be empty otherwise.
1196
+ *
1197
+ * @generated from field: string destination_memo = 4;
1198
+ */
1199
+ destinationMemo: string;
1200
+ /**
1201
+ * Recipient of returned source funds on the source network, in its native
1202
+ * text form without memo. Deposits that are not accepted, and source funds
1203
+ * that are not traded, go here; never to an observed sender.
1204
+ *
1205
+ * @generated from field: string return_address = 5;
1206
+ */
1207
+ returnAddress: string;
1208
+ /**
1209
+ * Destination tag or memo for return_address. Required when the source
1210
+ * network needs one; must be empty otherwise.
1211
+ *
1212
+ * @generated from field: string return_memo = 6;
1213
+ */
1214
+ returnMemo: string;
1215
+ /**
1216
+ * Refund route for the intermediate asset of a two-leg route: an
1217
+ * AssetChainVariant.zipped_asset_id of the asset whose AssetConfig.ledger_id
1218
+ * is the quote's intermediate_asset_id in GET
1219
+ * /v1/chain/deposit-withdraw/config, for example USDT on Ethereum. Required
1220
+ * with refund_address when the route has an intermediate asset; optional
1221
+ * and unused otherwise.
1222
+ *
1223
+ * @generated from field: uint32 refund_zipped_asset_id = 7;
1224
+ */
1225
+ refundZippedAssetId: number;
1226
+ /**
1227
+ * Recipient of refunded intermediate asset on the refund route's network,
1228
+ * in its native text form without memo.
1229
+ *
1230
+ * @generated from field: string refund_address = 8;
1231
+ */
1232
+ refundAddress: string;
1233
+ /**
1234
+ * Destination tag or memo for refund_address. Required when the refund
1235
+ * network needs one; must be empty otherwise.
1236
+ *
1237
+ * @generated from field: string refund_memo = 9;
1238
+ */
1239
+ refundMemo: string;
1240
+ /**
1241
+ * Optional source wallet the end user will deposit from, for brokers that
1242
+ * know it in advance. It must be a valid address on the source network and
1243
+ * is shown on the QuickSwap.
1244
+ *
1245
+ * @generated from field: string source_wallet = 10;
1246
+ */
1247
+ sourceWallet: string;
1248
+ /**
1249
+ * Affiliate fees, each charged on top and credited to its affiliate vault:
1250
+ * at most three distinct vaults. Fixed at creation with broker_bps.
1251
+ *
1252
+ * @generated from field: repeated swap.quickswap.v1.AffiliateShare affiliates = 11;
1253
+ */
1254
+ affiliates: AffiliateShare[];
1255
+ /**
1256
+ * Broker fee in basis points of what each leg receives, charged on top of
1257
+ * the service fee and credited to the broker's default vault; 0 for none.
1258
+ * broker_bps and the affiliates' bps total at most 300. Fees outside these
1259
+ * rules fail with FEES_INVALID.
1260
+ *
1261
+ * @generated from field: uint32 broker_bps = 12;
1262
+ */
1263
+ brokerBps: number;
1264
+ };
1265
+ /**
1266
+ * Describes the message swap.quickswap.v1.CreateQuickSwapRequest.
1267
+ * Use `create(CreateQuickSwapRequestSchema)` to create a new message.
1268
+ */
1269
+ declare const CreateQuickSwapRequestSchema: GenMessage<CreateQuickSwapRequest>;
1270
+ /**
1271
+ * CreateQuickSwapResponse returns the QuickSwap bound to the idempotency key.
1272
+ *
1273
+ * @generated from message swap.quickswap.v1.CreateQuickSwapResponse
1274
+ */
1275
+ type CreateQuickSwapResponse = Message<"swap.quickswap.v1.CreateQuickSwapResponse"> & {
1276
+ /**
1277
+ * The QuickSwap, normally AWAITING_DEPOSIT with deposit_instructions. A
1278
+ * retry returns its current state with the original quote and address.
1279
+ *
1280
+ * @generated from field: swap.quickswap.v1.QuickSwap quick_swap = 1;
1281
+ */
1282
+ quickSwap?: QuickSwap | undefined;
1283
+ };
1284
+ /**
1285
+ * Describes the message swap.quickswap.v1.CreateQuickSwapResponse.
1286
+ * Use `create(CreateQuickSwapResponseSchema)` to create a new message.
1287
+ */
1288
+ declare const CreateQuickSwapResponseSchema: GenMessage<CreateQuickSwapResponse>;
1289
+ /**
1290
+ * GetQuickSwapRequest selects one of the broker's QuickSwaps.
1291
+ *
1292
+ * @generated from message swap.quickswap.v1.GetQuickSwapRequest
1293
+ */
1294
+ type GetQuickSwapRequest = Message<"swap.quickswap.v1.GetQuickSwapRequest"> & {
1295
+ /**
1296
+ * Exactly one selector.
1297
+ *
1298
+ * @generated from oneof swap.quickswap.v1.GetQuickSwapRequest.selector
1299
+ */
1300
+ selector: {
1301
+ /**
1302
+ * Public QuickSwap identifier.
1303
+ *
1304
+ * @generated from field: fixed64 swap_id = 1;
1305
+ */
1306
+ value: bigint;
1307
+ case: "swapId";
1308
+ } | {
1309
+ /**
1310
+ * Idempotency key used to create it; resolves a QuickSwap whose create
1311
+ * outcome was unknown.
1312
+ *
1313
+ * @generated from field: string idempotency_key = 2;
1314
+ */
1315
+ value: string;
1316
+ case: "idempotencyKey";
1317
+ } | {
1318
+ case: undefined;
1319
+ value?: undefined;
1320
+ };
1321
+ };
1322
+ /**
1323
+ * Describes the message swap.quickswap.v1.GetQuickSwapRequest.
1324
+ * Use `create(GetQuickSwapRequestSchema)` to create a new message.
1325
+ */
1326
+ declare const GetQuickSwapRequestSchema: GenMessage<GetQuickSwapRequest>;
1327
+ /**
1328
+ * GetQuickSwapResponse returns one QuickSwap.
1329
+ *
1330
+ * @generated from message swap.quickswap.v1.GetQuickSwapResponse
1331
+ */
1332
+ type GetQuickSwapResponse = Message<"swap.quickswap.v1.GetQuickSwapResponse"> & {
1333
+ /**
1334
+ * Current state.
1335
+ *
1336
+ * @generated from field: swap.quickswap.v1.QuickSwap quick_swap = 1;
1337
+ */
1338
+ quickSwap?: QuickSwap | undefined;
1339
+ };
1340
+ /**
1341
+ * Describes the message swap.quickswap.v1.GetQuickSwapResponse.
1342
+ * Use `create(GetQuickSwapResponseSchema)` to create a new message.
1343
+ */
1344
+ declare const GetQuickSwapResponseSchema: GenMessage<GetQuickSwapResponse>;
1345
+ /**
1346
+ * ErrorDetail is attached to QuickSwap errors. ConnectRPC clients receive it
1347
+ * as an error detail of type swap.quickswap.v1.ErrorDetail. REST clients
1348
+ * receive an application/problem+json body {type, title, status, detail,
1349
+ * code, swapId, minDepositAmount, maxDepositAmount} whose code is the
1350
+ * ErrorCode name, or the status name (for example INVALID_ARGUMENT) when no
1351
+ * ErrorCode applies; swapId and the limits appear only when set.
1352
+ *
1353
+ * @generated from message swap.quickswap.v1.ErrorDetail
1354
+ */
1355
+ type ErrorDetail = Message<"swap.quickswap.v1.ErrorDetail"> & {
1356
+ /**
1357
+ * Stable error code.
1358
+ *
1359
+ * @generated from field: swap.quickswap.v1.ErrorCode code = 1;
1360
+ */
1361
+ code: ErrorCode;
1362
+ /**
1363
+ * QuickSwap bound to the request's idempotency key, when one exists: for
1364
+ * example the original QuickSwap on IDEMPOTENCY_CONFLICT, or the QuickSwap
1365
+ * whose deposit address could not be allocated.
1366
+ *
1367
+ * @generated from field: fixed64 swap_id = 2;
1368
+ */
1369
+ swapId: bigint;
1370
+ /**
1371
+ * AMOUNT_OUT_OF_RANGE only: the smallest deposit that currently quotes on
1372
+ * the route with the requested protection, in source token units, whatever
1373
+ * the request's basis. It moves with prices and network fees; show it as
1374
+ * guidance, not a guarantee. A deposit below QuickSwapQuote.min_deposit_amount
1375
+ * is returned to return_address (DEPOSIT_BELOW_MINIMUM). Unset for other
1376
+ * codes and when no deposit currently quotes.
1377
+ *
1378
+ * @generated from field: swap.quickswap.v1.TokenAmount min_deposit_amount = 3;
1379
+ */
1380
+ minDepositAmount?: TokenAmount | undefined;
1381
+ /**
1382
+ * AMOUNT_OUT_OF_RANGE only: the largest deposit that quotes, in source token
1383
+ * units. Unset for other codes, when no deposit currently quotes, and for a
1384
+ * bridge, whose deposit no order book bounds.
1385
+ *
1386
+ * @generated from field: swap.quickswap.v1.TokenAmount max_deposit_amount = 4;
1387
+ */
1388
+ maxDepositAmount?: TokenAmount | undefined;
1389
+ };
1390
+ /**
1391
+ * Describes the message swap.quickswap.v1.ErrorDetail.
1392
+ * Use `create(ErrorDetailSchema)` to create a new message.
1393
+ */
1394
+ declare const ErrorDetailSchema: GenMessage<ErrorDetail>;
1395
+ /**
1396
+ * QuoteBasis states which side of the swap the request amount denominates.
1397
+ *
1398
+ * @generated from enum swap.quickswap.v1.QuoteBasis
1399
+ */
1400
+ declare enum QuoteBasis {
1401
+ /**
1402
+ * No basis selected; rejected.
1403
+ *
1404
+ * @generated from enum value: BASIS_UNSPECIFIED = 0;
1405
+ */
1406
+ BASIS_UNSPECIFIED = 0,
1407
+ /**
1408
+ * amount is the source amount the end user intends to deposit, in source
1409
+ * token units.
1410
+ *
1411
+ * @generated from enum value: SOURCE_AMOUNT = 1;
1412
+ */
1413
+ SOURCE_AMOUNT = 1,
1414
+ /**
1415
+ * amount is the destination amount the end user wants to receive after fees,
1416
+ * in destination token units. The quote reports the deposit amount needed at
1417
+ * the quoted price. The delivered amount still follows the actual deposit
1418
+ * and execution, bounded below by the protection.
1419
+ *
1420
+ * @generated from enum value: DESTINATION_AMOUNT = 2;
1421
+ */
1422
+ DESTINATION_AMOUNT = 2
1423
+ }
1424
+ /**
1425
+ * Describes the enum swap.quickswap.v1.QuoteBasis.
1426
+ */
1427
+ declare const QuoteBasisSchema: GenEnum<QuoteBasis>;
1428
+ /**
1429
+ * FeeKind identifies one component of a QuickSwap's fees.
1430
+ *
1431
+ * @generated from enum swap.quickswap.v1.FeeKind
1432
+ */
1433
+ declare enum FeeKind {
1434
+ /**
1435
+ * No kind; never returned.
1436
+ *
1437
+ * @generated from enum value: FEE_UNSPECIFIED = 0;
1438
+ */
1439
+ FEE_UNSPECIFIED = 0,
1440
+ /**
1441
+ * Service fee of one trading leg: the leg's pair fee in basis points of
1442
+ * what the leg receives. A two-leg route has one per leg. On a bridge, the
1443
+ * one bridge fee in basis points of the credited amount, charged at payout.
1444
+ *
1445
+ * @generated from enum value: SERVICE = 1;
1446
+ */
1447
+ SERVICE = 1,
1448
+ /**
1449
+ * Broker fee of one trading leg, the request's broker_bps of what the leg
1450
+ * receives, credited to the broker's default vault. A two-leg route has one
1451
+ * per leg; a bridge has one, on the credited amount, charged at payout.
1452
+ *
1453
+ * @generated from enum value: BROKER = 2;
1454
+ */
1455
+ BROKER = 2,
1456
+ /**
1457
+ * Affiliate fee of one trading leg, one affiliate's bps of what the leg
1458
+ * receives, credited to that affiliate vault. Each affiliate has one per
1459
+ * leg; on a bridge one, on the credited amount, charged at payout.
1460
+ *
1461
+ * @generated from enum value: AFFILIATE = 3;
1462
+ */
1463
+ AFFILIATE = 3,
1464
+ /**
1465
+ * Network fee withheld from the deposit before it is credited.
1466
+ *
1467
+ * @generated from enum value: DEPOSIT_NETWORK = 4;
1468
+ */
1469
+ DEPOSIT_NETWORK = 4,
1470
+ /**
1471
+ * Estimated network fee for a withdrawal. The actual fee is charged at
1472
+ * withdrawal time and reported on the withdrawal.
1473
+ *
1474
+ * @generated from enum value: WITHDRAWAL_NETWORK = 5;
1475
+ */
1476
+ WITHDRAWAL_NETWORK = 5
1477
+ }
1478
+ /**
1479
+ * Describes the enum swap.quickswap.v1.FeeKind.
1480
+ */
1481
+ declare const FeeKindSchema: GenEnum<FeeKind>;
1482
+ /**
1483
+ * DepositAddressState is the lifecycle state of a QuickSwap deposit address.
1484
+ *
1485
+ * @generated from enum swap.quickswap.v1.DepositAddressState
1486
+ */
1487
+ declare enum DepositAddressState {
1488
+ /**
1489
+ * No address yet.
1490
+ *
1491
+ * @generated from enum value: ADDRESS_UNSPECIFIED = 0;
1492
+ */
1493
+ ADDRESS_UNSPECIFIED = 0,
1494
+ /**
1495
+ * The address accepts the first eligible deposit.
1496
+ *
1497
+ * @generated from enum value: ACTIVE = 1;
1498
+ */
1499
+ ACTIVE = 1,
1500
+ /**
1501
+ * Entered on the first confirmed deposit. Any further deposit is returned
1502
+ * or held and never executes. Ends at address_retires_at. An address that
1503
+ * expires unfunded goes from ACTIVE straight to RETIRED.
1504
+ *
1505
+ * @generated from enum value: REFUND_MODE = 2;
1506
+ */
1507
+ REFUND_MODE = 2,
1508
+ /**
1509
+ * The address is retired. A deposit sent to it is not processed
1510
+ * automatically; it is handled only through support-assisted recovery, and
1511
+ * recovery is not guaranteed.
1512
+ *
1513
+ * @generated from enum value: RETIRED = 3;
1514
+ */
1515
+ RETIRED = 3
1516
+ }
1517
+ /**
1518
+ * Describes the enum swap.quickswap.v1.DepositAddressState.
1519
+ */
1520
+ declare const DepositAddressStateSchema: GenEnum<DepositAddressState>;
1521
+ /**
1522
+ * DepositDisposition is what a detected deposit is allowed to do.
1523
+ *
1524
+ * @generated from enum swap.quickswap.v1.DepositDisposition
1525
+ */
1526
+ declare enum DepositDisposition {
1527
+ /**
1528
+ * Not yet decided.
1529
+ *
1530
+ * @generated from enum value: DISPOSITION_UNSPECIFIED = 0;
1531
+ */
1532
+ DISPOSITION_UNSPECIFIED = 0,
1533
+ /**
1534
+ * Detected; eligibility is being evaluated. A deposit can already be
1535
+ * credited (credited_at) while it is evaluated.
1536
+ *
1537
+ * @generated from enum value: EVALUATING = 1;
1538
+ */
1539
+ EVALUATING = 1,
1540
+ /**
1541
+ * The eligible deposit that confirmed first. It consumed the QuickSwap and
1542
+ * is the only deposit that can execute.
1543
+ *
1544
+ * @generated from enum value: ELIGIBLE = 2;
1545
+ */
1546
+ ELIGIBLE = 2,
1547
+ /**
1548
+ * Not accepted: it is returned to return_address and never executes. A
1549
+ * deposit found ineligible after it was credited, such as a late deposit
1550
+ * (LATE_DEPOSIT), one below min_deposit_amount (DEPOSIT_BELOW_MINIMUM) or
1551
+ * above max_deposit_amount (DEPOSIT_ABOVE_MAXIMUM), or one of the wrong
1552
+ * asset or network (WRONG_ASSET), keeps credited_at and is returned from its
1553
+ * credit.
1554
+ *
1555
+ * @generated from enum value: RETURN_ONLY = 3;
1556
+ */
1557
+ RETURN_ONLY = 3,
1558
+ /**
1559
+ * Held for review; it neither executes nor returns until released.
1560
+ *
1561
+ * @generated from enum value: ON_HOLD = 4;
1562
+ */
1563
+ ON_HOLD = 4,
1564
+ /**
1565
+ * Observed on an address that was already retired (DEPOSIT_ADDRESS_RETIRED).
1566
+ * It never executes and is not returned automatically. It is handled only
1567
+ * through support-assisted recovery, and it is potentially unrecoverable.
1568
+ * The broker contacts Polyester broker support with the swap_id.
1569
+ *
1570
+ * @generated from enum value: MANUAL_RECOVERY = 5;
1571
+ */
1572
+ MANUAL_RECOVERY = 5
1573
+ }
1574
+ /**
1575
+ * Describes the enum swap.quickswap.v1.DepositDisposition.
1576
+ */
1577
+ declare const DepositDispositionSchema: GenEnum<DepositDisposition>;
1578
+ /**
1579
+ * QuickSwapReason explains a notable status or deposit disposition.
1580
+ *
1581
+ * @generated from enum swap.quickswap.v1.QuickSwapReason
1582
+ */
1583
+ declare enum QuickSwapReason {
1584
+ /**
1585
+ * No notable reason. On a HELD QuickSwap or an ON_HOLD deposit: held for
1586
+ * review without a more specific reason; the broker contacts Polyester
1587
+ * broker support with the swap_id.
1588
+ *
1589
+ * @generated from enum value: REASON_UNSPECIFIED = 0;
1590
+ */
1591
+ REASON_UNSPECIFIED = 0,
1592
+ /**
1593
+ * The deposit's risk screen failed with a return verdict; the deposit is
1594
+ * not accepted and is returned to return_address.
1595
+ *
1596
+ * @generated from enum value: SOURCE_SCREENING_FAILED = 1;
1597
+ */
1598
+ SOURCE_SCREENING_FAILED = 1,
1599
+ /**
1600
+ * The deposit arrived and is safe, but processing capacity is temporarily
1601
+ * unavailable. Processing resumes automatically when capacity frees up; no
1602
+ * action is needed.
1603
+ *
1604
+ * @generated from enum value: CAPACITY_UNAVAILABLE = 4;
1605
+ */
1606
+ CAPACITY_UNAVAILABLE = 4,
1607
+ /**
1608
+ * Execution could not meet the protection. On a HELD QuickSwap nothing was
1609
+ * traded and the funds are held for review; otherwise untraded funds are
1610
+ * refunded or returned.
1611
+ *
1612
+ * @generated from enum value: PROTECTION_NOT_MET = 7;
1613
+ */
1614
+ PROTECTION_NOT_MET = 7,
1615
+ /**
1616
+ * The execution deadline passed before all input executed; untraded funds
1617
+ * are refunded or returned. Shown while EXECUTING once the deadline ended
1618
+ * trading, and on the payout statuses that follow.
1619
+ *
1620
+ * @generated from enum value: EXECUTION_DEADLINE_REACHED = 8;
1621
+ */
1622
+ EXECUTION_DEADLINE_REACHED = 8,
1623
+ /**
1624
+ * The deposit was first seen after funding_expires_at.
1625
+ *
1626
+ * @generated from enum value: LATE_DEPOSIT = 9;
1627
+ */
1628
+ LATE_DEPOSIT = 9,
1629
+ /**
1630
+ * The deposit is below the published min_deposit_amount. It is not
1631
+ * executed: it is returned to return_address, and the QuickSwap shows
1632
+ * RETURNING and RETURNED with this reason. A deposit that cannot be returned
1633
+ * on the network it was received on is held (HELD with this reason); the
1634
+ * broker contacts Polyester broker support with the swap_id.
1635
+ *
1636
+ * @generated from enum value: DEPOSIT_BELOW_MINIMUM = 11;
1637
+ */
1638
+ DEPOSIT_BELOW_MINIMUM = 11,
1639
+ /**
1640
+ * The deposit is above max_deposit_amount; it is returned to
1641
+ * return_address.
1642
+ *
1643
+ * @generated from enum value: DEPOSIT_ABOVE_MAXIMUM = 12;
1644
+ */
1645
+ DEPOSIT_ABOVE_MAXIMUM = 12,
1646
+ /**
1647
+ * The deposit is not the quoted source asset or network. It is not
1648
+ * executed: it is returned to return_address on the network and in the
1649
+ * asset it was received in, and the QuickSwap shows RETURNING and RETURNED
1650
+ * with this reason. A deposit that cannot be returned there, such as one
1651
+ * received on a network where return_address is not valid, is held (HELD
1652
+ * with this reason); the broker contacts Polyester broker support with the
1653
+ * swap_id.
1654
+ *
1655
+ * @generated from enum value: WRONG_ASSET = 13;
1656
+ */
1657
+ WRONG_ASSET = 13,
1658
+ /**
1659
+ * The funding window ended without an eligible deposit.
1660
+ *
1661
+ * @generated from enum value: FUNDING_WINDOW_ENDED = 15;
1662
+ */
1663
+ FUNDING_WINDOW_ENDED = 15,
1664
+ /**
1665
+ * A withdrawal cannot be completed and is held for review. The broker
1666
+ * contacts Polyester broker support with the swap_id.
1667
+ *
1668
+ * @generated from enum value: WITHDRAWAL_FAILED = 16;
1669
+ */
1670
+ WITHDRAWAL_FAILED = 16,
1671
+ /**
1672
+ * A processing step is being confirmed. Processing resumes automatically; no
1673
+ * action is needed.
1674
+ *
1675
+ * @generated from enum value: OUTCOME_RECONCILING = 17;
1676
+ */
1677
+ OUTCOME_RECONCILING = 17,
1678
+ /**
1679
+ * Polyester's deposit screening blocked the deposit. It is held for
1680
+ * compliance review; it is never executed or returned automatically. The
1681
+ * broker contacts Polyester broker support with the swap_id.
1682
+ *
1683
+ * @generated from enum value: SOURCE_SCREENING_BLOCKED = 20;
1684
+ */
1685
+ SOURCE_SCREENING_BLOCKED = 20,
1686
+ /**
1687
+ * Refund not possible: an amount left to refund or return was below the
1688
+ * withdrawal minimum of its asset and network, so no withdrawal was made
1689
+ * for it. Its withdrawal is NOT_SENT with the amount in unsent_amount.
1690
+ * Other withdrawals are unaffected.
1691
+ *
1692
+ * @generated from enum value: REFUND_BELOW_MINIMUM = 21;
1693
+ */
1694
+ REFUND_BELOW_MINIMUM = 21,
1695
+ /**
1696
+ * The QuickSwap could not be issued a deposit address and never gets one:
1697
+ * it is EXPIRED without deposit_instructions, and nothing can be deposited
1698
+ * to it. Create a new QuickSwap with a new idempotency key, and report the
1699
+ * swap_id to Polyester broker support.
1700
+ *
1701
+ * @generated from enum value: DEPOSIT_ADDRESS_CONFLICT = 22;
1702
+ */
1703
+ DEPOSIT_ADDRESS_CONFLICT = 22,
1704
+ /**
1705
+ * The address already accepted its one eligible deposit; this deposit is
1706
+ * returned to return_address and never executes.
1707
+ *
1708
+ * @generated from enum value: DEPOSIT_ADDRESS_ALREADY_USED = 23;
1709
+ */
1710
+ DEPOSIT_ADDRESS_ALREADY_USED = 23,
1711
+ /**
1712
+ * The address was retired when this deposit was observed. The deposit is
1713
+ * MANUAL_RECOVERY: it never executes, is not returned automatically, and is
1714
+ * potentially unrecoverable.
1715
+ *
1716
+ * @generated from enum value: DEPOSIT_ADDRESS_RETIRED = 24;
1717
+ */
1718
+ DEPOSIT_ADDRESS_RETIRED = 24,
1719
+ /**
1720
+ * The address had not been issued when this deposit was observed; it never executes.
1721
+ *
1722
+ * @generated from enum value: DEPOSIT_ADDRESS_NOT_ISSUED = 25;
1723
+ */
1724
+ DEPOSIT_ADDRESS_NOT_ISSUED = 25,
1725
+ /**
1726
+ * On a two-leg route, intermediate funds were below the smallest order the
1727
+ * second leg's market accepts, so they could not be converted to the
1728
+ * destination asset; they are refunded to refund_address. Shown on the
1729
+ * payout statuses that follow.
1730
+ *
1731
+ * @generated from enum value: INTERMEDIATE_BELOW_MINIMUM = 26;
1732
+ */
1733
+ INTERMEDIATE_BELOW_MINIMUM = 26
1734
+ }
1735
+ /**
1736
+ * Describes the enum swap.quickswap.v1.QuickSwapReason.
1737
+ */
1738
+ declare const QuickSwapReasonSchema: GenEnum<QuickSwapReason>;
1739
+ /**
1740
+ * WithdrawalRole is why a withdrawal pays its recipient.
1741
+ *
1742
+ * @generated from enum swap.quickswap.v1.WithdrawalRole
1743
+ */
1744
+ declare enum WithdrawalRole {
1745
+ /**
1746
+ * No role; never returned.
1747
+ *
1748
+ * @generated from enum value: ROLE_UNSPECIFIED = 0;
1749
+ */
1750
+ ROLE_UNSPECIFIED = 0,
1751
+ /**
1752
+ * Swap output to destination_address on the destination network.
1753
+ *
1754
+ * @generated from enum value: DESTINATION = 1;
1755
+ */
1756
+ DESTINATION = 1,
1757
+ /**
1758
+ * Untraded intermediate asset of a two-leg route, including a partial
1759
+ * refund, to refund_address on the refund route's network.
1760
+ *
1761
+ * @generated from enum value: REFUND = 2;
1762
+ */
1763
+ REFUND = 2,
1764
+ /**
1765
+ * Source funds that were not accepted or not traded, to return_address on
1766
+ * the network and in the asset they were received in: the source network,
1767
+ * or for a wrong asset the network it was sent on.
1768
+ *
1769
+ * @generated from enum value: RETURN = 3;
1770
+ */
1771
+ RETURN = 3
1772
+ }
1773
+ /**
1774
+ * Describes the enum swap.quickswap.v1.WithdrawalRole.
1775
+ */
1776
+ declare const WithdrawalRoleSchema: GenEnum<WithdrawalRole>;
1777
+ /**
1778
+ * WithdrawalState is the progress of one withdrawal. FINALIZED and NOT_SENT
1779
+ * are final: they never change. A FAILED withdrawal never changes either, but
1780
+ * it does not end the QuickSwap: while any withdrawal is FAILED, the
1781
+ * QuickSwap is HELD with reason WITHDRAWAL_FAILED and the funds stay
1782
+ * attributed to it until support resolves it.
1783
+ *
1784
+ * @generated from enum swap.quickswap.v1.WithdrawalState
1785
+ */
1786
+ declare enum WithdrawalState {
1787
+ /**
1788
+ * No state; never returned.
1789
+ *
1790
+ * @generated from enum value: WITHDRAWAL_UNSPECIFIED = 0;
1791
+ */
1792
+ WITHDRAWAL_UNSPECIFIED = 0,
1793
+ /**
1794
+ * Approved and waiting to be submitted.
1795
+ *
1796
+ * @generated from enum value: QUEUED = 1;
1797
+ */
1798
+ QUEUED = 1,
1799
+ /**
1800
+ * Submitted to the recipient's network; not yet final.
1801
+ *
1802
+ * @generated from enum value: SUBMITTED = 2;
1803
+ */
1804
+ SUBMITTED = 2,
1805
+ /**
1806
+ * Final on the recipient's network.
1807
+ *
1808
+ * @generated from enum value: FINALIZED = 3;
1809
+ */
1810
+ FINALIZED = 3,
1811
+ /**
1812
+ * Definitively failed. The QuickSwap is HELD (WITHDRAWAL_FAILED); the
1813
+ * broker contacts Polyester broker support with the swap_id.
1814
+ *
1815
+ * @generated from enum value: FAILED = 4;
1816
+ */
1817
+ FAILED = 4,
1818
+ /**
1819
+ * Final: no transaction was or will be made for this withdrawal, because
1820
+ * its amount was below the withdrawal minimum of its asset and network
1821
+ * (REFUND_BELOW_MINIMUM); unsent_amount is that amount.
1822
+ *
1823
+ * @generated from enum value: NOT_SENT = 5;
1824
+ */
1825
+ NOT_SENT = 5
1826
+ }
1827
+ /**
1828
+ * Describes the enum swap.quickswap.v1.WithdrawalState.
1829
+ */
1830
+ declare const WithdrawalStateSchema: GenEnum<WithdrawalState>;
1831
+ /**
1832
+ * QuickSwapStatus is the current state of a QuickSwap. While funds progress,
1833
+ * the status names the earliest gate still outstanding; gates that complete
1834
+ * concurrently are not reported separately.
1835
+ *
1836
+ * Flow: ALLOCATING → AWAITING_DEPOSIT → (WAITING_FOR_CAPACITY |
1837
+ * PREPARING_DEPOSIT | CONFIRMING) → CREDITED → EXECUTING (skipped for a
1838
+ * bridge) → PAYING_OUT | REFUNDING | RETURNING → a terminal status. A
1839
+ * QuickSwap that cannot be issued a deposit address goes from ALLOCATING
1840
+ * straight to EXPIRED (DEPOSIT_ADDRESS_CONFLICT). HELD can be entered from
1841
+ * any non-terminal status and is not terminal. The terminal statuses are
1842
+ * COMPLETED, REFUNDED, RETURNED and EXPIRED; a terminal status never
1843
+ * changes. Accept status values added later; is_terminal is authoritative.
1844
+ *
1845
+ * @generated from enum swap.quickswap.v1.QuickSwapStatus
1846
+ */
1847
+ declare enum QuickSwapStatus {
1848
+ /**
1849
+ * No status; never returned.
1850
+ *
1851
+ * @generated from enum value: STATUS_UNSPECIFIED = 0;
1852
+ */
1853
+ STATUS_UNSPECIFIED = 0,
1854
+ /**
1855
+ * The quote is fixed and the deposit address is being allocated. After
1856
+ * ADDRESS_UNAVAILABLE, allocation continues automatically until an address
1857
+ * frees up; the wait has no fixed bound.
1858
+ *
1859
+ * @generated from enum value: ALLOCATING = 2;
1860
+ */
1861
+ ALLOCATING = 2,
1862
+ /**
1863
+ * Quote and deposit address allocated; waiting for the first eligible
1864
+ * deposit before funding_expires_at.
1865
+ *
1866
+ * @generated from enum value: AWAITING_DEPOSIT = 3;
1867
+ */
1868
+ AWAITING_DEPOSIT = 3,
1869
+ /**
1870
+ * An eligible deposit arrived and is safe; waiting for processing capacity.
1871
+ * Processing resumes automatically when capacity frees up; the wait has no
1872
+ * fixed bound.
1873
+ *
1874
+ * @generated from enum value: WAITING_FOR_CAPACITY = 4;
1875
+ */
1876
+ WAITING_FOR_CAPACITY = 4,
1877
+ /**
1878
+ * The deposit is being prepared for credit. Retries keep this status.
1879
+ *
1880
+ * @generated from enum value: PREPARING_DEPOSIT = 5;
1881
+ */
1882
+ PREPARING_DEPOSIT = 5,
1883
+ /**
1884
+ * Waiting for source confirmations and deposit validation before credit.
1885
+ *
1886
+ * @generated from enum value: CONFIRMING = 6;
1887
+ */
1888
+ CONFIRMING = 6,
1889
+ /**
1890
+ * The deposit is credited; execution is starting.
1891
+ *
1892
+ * @generated from enum value: CREDITED = 7;
1893
+ */
1894
+ CREDITED = 7,
1895
+ /**
1896
+ * The credited deposit is being traded.
1897
+ *
1898
+ * @generated from enum value: EXECUTING = 8;
1899
+ */
1900
+ EXECUTING = 8,
1901
+ /**
1902
+ * Execution finished with destination output; withdrawals, including any
1903
+ * partial refund or return, are in progress.
1904
+ *
1905
+ * @generated from enum value: PAYING_OUT = 9;
1906
+ */
1907
+ PAYING_OUT = 9,
1908
+ /**
1909
+ * A two-leg route produced no destination output; the intermediate asset is
1910
+ * being refunded to refund_address.
1911
+ *
1912
+ * @generated from enum value: REFUNDING = 10;
1913
+ */
1914
+ REFUNDING = 10,
1915
+ /**
1916
+ * Nothing was traded or the deposit was not accepted; the source funds are
1917
+ * being returned to return_address.
1918
+ *
1919
+ * @generated from enum value: RETURNING = 11;
1920
+ */
1921
+ RETURNING = 11,
1922
+ /**
1923
+ * Funds are held for review. Not terminal: review resumes the QuickSwap or
1924
+ * returns the funds. reason says why when a specific reason applies, else
1925
+ * it is REASON_UNSPECIFIED. The broker contacts Polyester broker support
1926
+ * with the swap_id.
1927
+ *
1928
+ * @generated from enum value: HELD = 12;
1929
+ */
1930
+ HELD = 12,
1931
+ /**
1932
+ * Terminal: every withdrawal is final (FINALIZED or NOT_SENT) and at least
1933
+ * one is a DESTINATION withdrawal. A DESTINATION withdrawal is never
1934
+ * NOT_SENT.
1935
+ *
1936
+ * @generated from enum value: COMPLETED = 13;
1937
+ */
1938
+ COMPLETED = 13,
1939
+ /**
1940
+ * Terminal: every withdrawal is final, none is DESTINATION, and at least one
1941
+ * is REFUND (FINALIZED or NOT_SENT).
1942
+ *
1943
+ * @generated from enum value: REFUNDED = 14;
1944
+ */
1945
+ REFUNDED = 14,
1946
+ /**
1947
+ * Terminal: every withdrawal is final and all are RETURN (FINALIZED or
1948
+ * NOT_SENT).
1949
+ *
1950
+ * @generated from enum value: RETURNED = 15;
1951
+ */
1952
+ RETURNED = 15,
1953
+ /**
1954
+ * Terminal: the funding window ended without an eligible deposit
1955
+ * (FUNDING_WINDOW_ENDED), or the QuickSwap never got a deposit address
1956
+ * (DEPOSIT_ADDRESS_CONFLICT).
1957
+ *
1958
+ * @generated from enum value: EXPIRED = 16;
1959
+ */
1960
+ EXPIRED = 16
1961
+ }
1962
+ /**
1963
+ * Describes the enum swap.quickswap.v1.QuickSwapStatus.
1964
+ */
1965
+ declare const QuickSwapStatusSchema: GenEnum<QuickSwapStatus>;
1966
+ /**
1967
+ * ErrorCode is the stable machine-readable QuickSwap error code.
1968
+ *
1969
+ * @generated from enum swap.quickswap.v1.ErrorCode
1970
+ */
1971
+ declare enum ErrorCode {
1972
+ /**
1973
+ * No code.
1974
+ *
1975
+ * @generated from enum value: ERROR_UNSPECIFIED = 0;
1976
+ */
1977
+ ERROR_UNSPECIFIED = 0,
1978
+ /**
1979
+ * The source and destination route is not offered, or a bridge was
1980
+ * requested with TWAP execution.
1981
+ *
1982
+ * @generated from enum value: ROUTE_UNSUPPORTED = 1;
1983
+ */
1984
+ ROUTE_UNSUPPORTED = 1,
1985
+ /**
1986
+ * The amount is outside the route's current limits. The error carries the
1987
+ * limits (min_deposit_amount, max_deposit_amount) when known.
1988
+ *
1989
+ * @generated from enum value: AMOUNT_OUT_OF_RANGE = 2;
1990
+ */
1991
+ AMOUNT_OUT_OF_RANGE = 2,
1992
+ /**
1993
+ * An amount's decimals do not match its route's token decimals.
1994
+ *
1995
+ * @generated from enum value: DECIMALS_MISMATCH = 3;
1996
+ */
1997
+ DECIMALS_MISMATCH = 3,
1998
+ /**
1999
+ * destination_address or destination_memo is not valid on the destination
2000
+ * network.
2001
+ *
2002
+ * @generated from enum value: DESTINATION_ADDRESS_INVALID = 4;
2003
+ */
2004
+ DESTINATION_ADDRESS_INVALID = 4,
2005
+ /**
2006
+ * return_address or return_memo is not valid on the source network.
2007
+ *
2008
+ * @generated from enum value: RETURN_ADDRESS_INVALID = 5;
2009
+ */
2010
+ RETURN_ADDRESS_INVALID = 5,
2011
+ /**
2012
+ * The route has an intermediate asset and no refund address was supplied.
2013
+ *
2014
+ * @generated from enum value: REFUND_ADDRESS_REQUIRED = 6;
2015
+ */
2016
+ REFUND_ADDRESS_REQUIRED = 6,
2017
+ /**
2018
+ * refund_zipped_asset_id is not a withdraw route of the intermediate asset,
2019
+ * or refund_address or refund_memo is not valid on its network.
2020
+ *
2021
+ * @generated from enum value: REFUND_ADDRESS_INVALID = 7;
2022
+ */
2023
+ REFUND_ADDRESS_INVALID = 7,
2024
+ /**
2025
+ * source_wallet is not valid on the source network.
2026
+ *
2027
+ * @generated from enum value: SOURCE_WALLET_INVALID = 8;
2028
+ */
2029
+ SOURCE_WALLET_INVALID = 8,
2030
+ /**
2031
+ * No price is currently available for the route; retry later.
2032
+ *
2033
+ * @generated from enum value: QUOTE_UNAVAILABLE = 11;
2034
+ */
2035
+ QUOTE_UNAVAILABLE = 11,
2036
+ /**
2037
+ * The protection cannot be met at the current price: a min_amount_out above
2038
+ * the expected output, or an order book that cannot fill the protected
2039
+ * execution at the quoted prices.
2040
+ *
2041
+ * @generated from enum value: PROTECTION_UNACHIEVABLE = 12;
2042
+ */
2043
+ PROTECTION_UNACHIEVABLE = 12,
2044
+ /**
2045
+ * No deposit address is available right now. The QuickSwap (swap_id in the
2046
+ * error) is kept, and its address is allocated automatically when one frees
2047
+ * up. Follow it with GetQuickSwap or by repeating the request unchanged. Its
2048
+ * quote stays the one priced at creation, and its funding window starts
2049
+ * when the address is issued (issued_at).
2050
+ *
2051
+ * @generated from enum value: ADDRESS_UNAVAILABLE = 13;
2052
+ */
2053
+ ADDRESS_UNAVAILABLE = 13,
2054
+ /**
2055
+ * The idempotency key was already used with a different request.
2056
+ *
2057
+ * @generated from enum value: IDEMPOTENCY_CONFLICT = 14;
2058
+ */
2059
+ IDEMPOTENCY_CONFLICT = 14,
2060
+ /**
2061
+ * No QuickSwap of this broker matches the selector.
2062
+ *
2063
+ * @generated from enum value: SWAP_NOT_FOUND = 15;
2064
+ */
2065
+ SWAP_NOT_FOUND = 15,
2066
+ /**
2067
+ * The broker is disabled: quotes and creates are refused. Reads and
2068
+ * QuickSwaps already created continue.
2069
+ *
2070
+ * @generated from enum value: BROKER_DISABLED = 18;
2071
+ */
2072
+ BROKER_DISABLED = 18,
2073
+ /**
2074
+ * A broker limit was reached: the unfunded QuickSwaps held at once, the
2075
+ * QuickSwaps created per hour, the request rate of the API key, or the
2076
+ * affiliate vaults the broker may create. Nothing is bound to the key. A
2077
+ * funded or expired QuickSwap frees an unfunded slot; when the response
2078
+ * carries a Retry-After header, retry after that many seconds.
2079
+ *
2080
+ * @generated from enum value: BROKER_LIMIT = 19;
2081
+ */
2082
+ BROKER_LIMIT = 19,
2083
+ /**
2084
+ * An affiliate names a vault that is not an active affiliate vault of the
2085
+ * broker: unknown, not yet created, disabled, another broker's, or the
2086
+ * default vault. Nothing is bound to the key; create or enable the vault
2087
+ * and repeat the request.
2088
+ *
2089
+ * @generated from enum value: AFFILIATE_VAULT_UNKNOWN = 20;
2090
+ */
2091
+ AFFILIATE_VAULT_UNKNOWN = 20,
2092
+ /**
2093
+ * No broker with this name has the caller as its key or member.
2094
+ *
2095
+ * @generated from enum value: BROKER_NOT_FOUND = 21;
2096
+ */
2097
+ BROKER_NOT_FOUND = 21,
2098
+ /**
2099
+ * The caller's role, or a broker API key, may not perform the action.
2100
+ *
2101
+ * @generated from enum value: ACTION_DENIED = 22;
2102
+ */
2103
+ ACTION_DENIED = 22,
2104
+ /**
2105
+ * The action needs a fresh step-up proof of the acting member in the
2106
+ * X-Auth-Step-Up header, and none was sent or it was already used or
2107
+ * expired. Complete an MFA challenge for fresh step-up and repeat the
2108
+ * request with the new proof.
2109
+ *
2110
+ * @generated from enum value: STEP_UP_REQUIRED = 23;
2111
+ */
2112
+ STEP_UP_REQUIRED = 23,
2113
+ /**
2114
+ * The broker has no affiliate vault with this ID.
2115
+ *
2116
+ * @generated from enum value: VAULT_NOT_FOUND = 24;
2117
+ */
2118
+ VAULT_NOT_FOUND = 24,
2119
+ /**
2120
+ * The broker has no API key with this ID, or it no longer works.
2121
+ *
2122
+ * @generated from enum value: KEY_NOT_FOUND = 25;
2123
+ */
2124
+ KEY_NOT_FOUND = 25,
2125
+ /**
2126
+ * The broker would have more than two working API keys. Revoke one first.
2127
+ *
2128
+ * @generated from enum value: KEY_LIMIT = 26;
2129
+ */
2130
+ KEY_LIMIT = 26,
2131
+ /**
2132
+ * The key is the broker's last key that works without an expiry; create
2133
+ * another key first.
2134
+ *
2135
+ * @generated from enum value: LAST_KEY = 27;
2136
+ */
2137
+ LAST_KEY = 27,
2138
+ /**
2139
+ * The person is not a member of the broker and has no pending invite, or
2140
+ * the account does not exist.
2141
+ *
2142
+ * @generated from enum value: MEMBER_NOT_FOUND = 28;
2143
+ */
2144
+ MEMBER_NOT_FOUND = 28,
2145
+ /**
2146
+ * The person is already a member of the broker.
2147
+ *
2148
+ * @generated from enum value: ALREADY_MEMBER = 29;
2149
+ */
2150
+ ALREADY_MEMBER = 29,
2151
+ /**
2152
+ * The Owner cannot be removed or given another role; transfer ownership
2153
+ * instead.
2154
+ *
2155
+ * @generated from enum value: OWNER_IMMUTABLE = 30;
2156
+ */
2157
+ OWNER_IMMUTABLE = 30,
2158
+ /**
2159
+ * No pending invite with this ID is addressed to the caller.
2160
+ *
2161
+ * @generated from enum value: INVITE_NOT_FOUND = 31;
2162
+ */
2163
+ INVITE_NOT_FOUND = 31,
2164
+ /**
2165
+ * The fees are not valid: more than three affiliates, an affiliate without
2166
+ * a valid account_id or with bps outside 1 to 300, a vault named twice, or
2167
+ * broker_bps and the affiliates' bps totalling more than 300.
2168
+ *
2169
+ * @generated from enum value: FEES_INVALID = 32;
2170
+ */
2171
+ FEES_INVALID = 32,
2172
+ /**
2173
+ * The broker stats cannot be read: a QuickSwap in the window, named by
2174
+ * ErrorDetail.swap_id, is missing a record they need. Contact Polyester
2175
+ * broker support with the swap_id.
2176
+ *
2177
+ * @generated from enum value: STATS_INCOMPLETE = 33;
2178
+ */
2179
+ STATS_INCOMPLETE = 33,
2180
+ /**
2181
+ * The QuickSwap (swap_id in the error) cannot be issued a deposit address
2182
+ * and never gets one, so nothing can be deposited to it; it is EXPIRED with
2183
+ * reason DEPOSIT_ADDRESS_CONFLICT. Create a new QuickSwap with a new
2184
+ * idempotency key, and report the swap_id to Polyester broker support.
2185
+ *
2186
+ * @generated from enum value: ADDRESS_CONFLICT = 34;
2187
+ */
2188
+ ADDRESS_CONFLICT = 34
2189
+ }
2190
+ /**
2191
+ * Describes the enum swap.quickswap.v1.ErrorCode.
2192
+ */
2193
+ declare const ErrorCodeSchema: GenEnum<ErrorCode>;
2194
+ /**
2195
+ * QuickSwapService is the broker-only QuickSwap API, served over ConnectRPC
2196
+ * and REST. Every RPC requires the broker's API key, sent as a bearer token
2197
+ * in the Authorization header; the broker is derived from it, never from the
2198
+ * request. End users need no account. Brokers see only their
2199
+ * own QuickSwaps.
2200
+ *
2201
+ * The broker API key is a server credential. Call this API from the broker's
2202
+ * backend, never from a browser or mobile app. The broker's members create,
2203
+ * rotate and revoke keys with QuickSwapBrokerService, and a key may rotate
2204
+ * itself.
2205
+ *
2206
+ * A QuickSwap's status advances as the deposit and execution progress; poll
2207
+ * GetQuickSwap to follow it, at most once every 5 seconds per QuickSwap while
2208
+ * it is not terminal. Polling can stop once is_terminal is true.
2209
+ *
2210
+ * REST errors are application/problem+json (see ErrorDetail) with these HTTP
2211
+ * statuses: 400 for INVALID_ARGUMENT and FAILED_PRECONDITION, 401 for
2212
+ * UNAUTHENTICATED, 403 for PERMISSION_DENIED, 404 for NOT_FOUND, 409 for
2213
+ * IDEMPOTENCY_CONFLICT, 413 when a request body is too large, 429 for
2214
+ * RESOURCE_EXHAUSTED (with a Retry-After header when the request rate was
2215
+ * exceeded), 500 for an internal error, 503 for UNAVAILABLE and 504 for
2216
+ * DEADLINE_EXCEEDED.
2217
+ *
2218
+ * @generated from service swap.quickswap.v1.QuickSwapService
2219
+ */
2220
+ declare const QuickSwapService: GenService<{
2221
+ /**
2222
+ * QuoteQuickSwap prices terms without creating a QuickSwap or reserving a
2223
+ * deposit address. The quote states whether the route needs a refund
2224
+ * address.
2225
+ *
2226
+ * Errors:
2227
+ * - INVALID_ARGUMENT: malformed request, AMOUNT_OUT_OF_RANGE,
2228
+ * DECIMALS_MISMATCH or FEES_INVALID.
2229
+ * - FAILED_PRECONDITION: ROUTE_UNSUPPORTED, PROTECTION_UNACHIEVABLE or
2230
+ * AFFILIATE_VAULT_UNKNOWN.
2231
+ * - UNAVAILABLE: QUOTE_UNAVAILABLE; retry later.
2232
+ * - PERMISSION_DENIED: BROKER_DISABLED.
2233
+ * - RESOURCE_EXHAUSTED: BROKER_LIMIT, the quote request rate of the key.
2234
+ * - UNAUTHENTICATED: missing or invalid broker API key.
2235
+ *
2236
+ * @generated from rpc swap.quickswap.v1.QuickSwapService.QuoteQuickSwap
2237
+ */
2238
+ quoteQuickSwap: {
2239
+ methodKind: "unary";
2240
+ input: typeof QuoteQuickSwapRequestSchema;
2241
+ output: typeof QuoteQuickSwapResponseSchema;
2242
+ };
2243
+ /**
2244
+ * CreateQuickSwap creates the QuickSwap for idempotency_key, prices it and
2245
+ * allocates its deposit address. It is idempotent per broker and key: a
2246
+ * repeated or concurrent request with the same body returns the same
2247
+ * QuickSwap, quote and address, so every unknown outcome is resolved by
2248
+ * repeating the request unchanged.
2249
+ *
2250
+ * Errors:
2251
+ * - INVALID_ARGUMENT: malformed request, AMOUNT_OUT_OF_RANGE,
2252
+ * DECIMALS_MISMATCH, DESTINATION_ADDRESS_INVALID, RETURN_ADDRESS_INVALID,
2253
+ * REFUND_ADDRESS_INVALID, SOURCE_WALLET_INVALID or FEES_INVALID.
2254
+ * - FAILED_PRECONDITION: ROUTE_UNSUPPORTED, PROTECTION_UNACHIEVABLE,
2255
+ * REFUND_ADDRESS_REQUIRED or AFFILIATE_VAULT_UNKNOWN; nothing is bound to
2256
+ * the key.
2257
+ * - ALREADY_EXISTS: IDEMPOTENCY_CONFLICT; the original QuickSwap stands.
2258
+ * - UNAVAILABLE: ADDRESS_UNAVAILABLE; the QuickSwap is kept and gets its
2259
+ * address automatically; follow it with GetQuickSwap or the same request.
2260
+ * - ABORTED: ADDRESS_CONFLICT; the QuickSwap never gets an address and is
2261
+ * EXPIRED (DEPOSIT_ADDRESS_CONFLICT); every repeat returns this error;
2262
+ * create a new one with a new idempotency key.
2263
+ * - UNAVAILABLE, DEADLINE_EXCEEDED: unknown outcome or QUOTE_UNAVAILABLE;
2264
+ * retry the same request.
2265
+ * - PERMISSION_DENIED: BROKER_DISABLED; nothing is bound to the key.
2266
+ * - RESOURCE_EXHAUSTED: BROKER_LIMIT; nothing is bound to the key.
2267
+ * - UNAUTHENTICATED: missing or invalid broker API key.
2268
+ *
2269
+ * @generated from rpc swap.quickswap.v1.QuickSwapService.CreateQuickSwap
2270
+ */
2271
+ createQuickSwap: {
2272
+ methodKind: "unary";
2273
+ input: typeof CreateQuickSwapRequestSchema;
2274
+ output: typeof CreateQuickSwapResponseSchema;
2275
+ };
2276
+ /**
2277
+ * GetQuickSwap returns the current state of one QuickSwap by swap_id or by
2278
+ * idempotency key.
2279
+ *
2280
+ * Errors:
2281
+ * - INVALID_ARGUMENT: malformed selector.
2282
+ * - NOT_FOUND: SWAP_NOT_FOUND.
2283
+ * - RESOURCE_EXHAUSTED: BROKER_LIMIT, the read request rate of the key.
2284
+ * - UNAUTHENTICATED: missing or invalid broker API key.
2285
+ *
2286
+ * @generated from rpc swap.quickswap.v1.QuickSwapService.GetQuickSwap
2287
+ */
2288
+ getQuickSwap: {
2289
+ methodKind: "unary";
2290
+ input: typeof GetQuickSwapRequestSchema;
2291
+ output: typeof GetQuickSwapResponseSchema;
2292
+ };
2293
+ }>;
2294
+ //#endregion
2295
+ export { AffiliateShare, AffiliateShareSchema, ChargedFee, ChargedFeeSchema, CreateQuickSwapRequest, CreateQuickSwapRequestSchema, CreateQuickSwapResponse, CreateQuickSwapResponseSchema, Deposit, DepositAddressState, DepositAddressStateSchema, DepositDisposition, DepositDispositionSchema, DepositInstructions, DepositInstructionsSchema, DepositSchema, ErrorCode, ErrorCodeSchema, ErrorDetail, ErrorDetailSchema, Execution, ExecutionProgress, ExecutionProgressSchema, ExecutionSchema, FeeKind, FeeKindSchema, GetQuickSwapRequest, GetQuickSwapRequestSchema, GetQuickSwapResponse, GetQuickSwapResponseSchema, MarketExecution, MarketExecutionSchema, Protection, ProtectionSchema, QuickSwap, QuickSwapQuote, QuickSwapQuoteSchema, QuickSwapReason, QuickSwapReasonSchema, QuickSwapSchema, QuickSwapService, QuickSwapStatus, QuickSwapStatusSchema, QuickSwapTerms, QuickSwapTermsSchema, QuoteBasis, QuoteBasisSchema, QuoteFee, QuoteFeeSchema, QuoteQuickSwapRequest, QuoteQuickSwapRequestSchema, QuoteQuickSwapResponse, QuoteQuickSwapResponseSchema, RequestedFees, RequestedFeesSchema, Screening, ScreeningSchema, TokenAmount, TokenAmountSchema, TwapExecution, TwapExecutionSchema, Withdrawal, WithdrawalRole, WithdrawalRoleSchema, WithdrawalSchema, WithdrawalState, WithdrawalStateSchema, file_swap_quickswap_v1_quickswap, quickswap_pb_d_exports };
2296
+ //# sourceMappingURL=quickswap_pb.d.ts.map