@polyester/sdk 0.35.0-devnet-20261111031027 → 0.35.0-devnet-20261111161451

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 (271) hide show
  1. package/CHANGELOG.md +35 -1
  2. package/dist/catalogs/snapshot-validation.js +2 -1
  3. package/dist/catalogs/snapshot-validation.js.map +1 -1
  4. package/dist/client.d.ts +6 -0
  5. package/dist/client.d.ts.map +1 -1
  6. package/dist/client.js +6 -0
  7. package/dist/client.js.map +1 -1
  8. package/dist/gen/ai/v1/assistant_pb.d.ts +4164 -0
  9. package/dist/gen/ai/v1/assistant_pb.d.ts.map +1 -0
  10. package/dist/gen/ai/v1/assistant_pb.js +1174 -0
  11. package/dist/gen/ai/v1/assistant_pb.js.map +1 -0
  12. package/dist/gen/alerts/v1/price_alerts_pb.d.ts +776 -0
  13. package/dist/gen/alerts/v1/price_alerts_pb.d.ts.map +1 -0
  14. package/dist/gen/alerts/v1/price_alerts_pb.js +378 -0
  15. package/dist/gen/alerts/v1/price_alerts_pb.js.map +1 -0
  16. package/dist/gen/auth/v1/address_book_pb.d.ts +6 -0
  17. package/dist/gen/auth/v1/address_book_pb.d.ts.map +1 -1
  18. package/dist/gen/auth/v1/address_book_pb.js +6 -0
  19. package/dist/gen/auth/v1/address_book_pb.js.map +1 -1
  20. package/dist/gen/auth/v1/api_keys_pb.d.ts +242 -2
  21. package/dist/gen/auth/v1/api_keys_pb.d.ts.map +1 -1
  22. package/dist/gen/auth/v1/api_keys_pb.js +81 -2
  23. package/dist/gen/auth/v1/api_keys_pb.js.map +1 -1
  24. package/dist/gen/auth/v1/auth_pb.d.ts +48 -6
  25. package/dist/gen/auth/v1/auth_pb.d.ts.map +1 -1
  26. package/dist/gen/auth/v1/auth_pb.js +48 -6
  27. package/dist/gen/auth/v1/auth_pb.js.map +1 -1
  28. package/dist/gen/auth/v1/policies_pb.d.ts +83 -19
  29. package/dist/gen/auth/v1/policies_pb.d.ts.map +1 -1
  30. package/dist/gen/auth/v1/policies_pb.js +74 -16
  31. package/dist/gen/auth/v1/policies_pb.js.map +1 -1
  32. package/dist/gen/auth/v1/social_verification_pb.d.ts +167 -11
  33. package/dist/gen/auth/v1/social_verification_pb.d.ts.map +1 -1
  34. package/dist/gen/auth/v1/social_verification_pb.js +41 -3
  35. package/dist/gen/auth/v1/social_verification_pb.js.map +1 -1
  36. package/dist/gen/auth/v1/subaccounts_pb.d.ts +17 -6
  37. package/dist/gen/auth/v1/subaccounts_pb.d.ts.map +1 -1
  38. package/dist/gen/auth/v1/subaccounts_pb.js.map +1 -1
  39. package/dist/gen/chain/deposit/v1/deposit_pb.d.ts +4 -2
  40. package/dist/gen/chain/deposit/v1/deposit_pb.d.ts.map +1 -1
  41. package/dist/gen/chain/deposit/v1/deposit_pb.js.map +1 -1
  42. package/dist/gen/chain/guard/v1/guard_signer_pb.d.ts +5 -0
  43. package/dist/gen/chain/guard/v1/guard_signer_pb.d.ts.map +1 -1
  44. package/dist/gen/chain/guard/v1/guard_signer_pb.js.map +1 -1
  45. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.d.ts +10 -0
  46. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.d.ts.map +1 -1
  47. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.js +1 -1
  48. package/dist/gen/chain/lifecycle/v1/lifecycle_read_pb.js.map +1 -1
  49. package/dist/gen/chain/lifecycle/v1/types_pb.d.ts +32 -4
  50. package/dist/gen/chain/lifecycle/v1/types_pb.d.ts.map +1 -1
  51. package/dist/gen/chain/lifecycle/v1/types_pb.js +32 -4
  52. package/dist/gen/chain/lifecycle/v1/types_pb.js.map +1 -1
  53. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.d.ts +391 -42
  54. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.d.ts.map +1 -1
  55. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.js +103 -17
  56. package/dist/gen/chain/withdraw/v1/auto_withdraw_pb.js.map +1 -1
  57. package/dist/gen/chain/withdraw/v1/withdraw_pb.d.ts +170 -3
  58. package/dist/gen/chain/withdraw/v1/withdraw_pb.d.ts.map +1 -1
  59. package/dist/gen/chain/withdraw/v1/withdraw_pb.js +63 -2
  60. package/dist/gen/chain/withdraw/v1/withdraw_pb.js.map +1 -1
  61. package/dist/gen/claims/v1/claims_pb.d.ts +1 -1
  62. package/dist/gen/claims/v1/claims_pb.js +1 -1
  63. package/dist/gen/claims/v1/claims_pb.js.map +1 -1
  64. package/dist/gen/index.d.ts +14 -10
  65. package/dist/gen/index.js +11 -7
  66. package/dist/gen/ledger/read/v1/ledger_read_pb.d.ts +1 -1
  67. package/dist/gen/ledger/v1/catalog_pb.d.ts +9 -1
  68. package/dist/gen/ledger/v1/catalog_pb.d.ts.map +1 -1
  69. package/dist/gen/ledger/v1/catalog_pb.js +9 -1
  70. package/dist/gen/ledger/v1/catalog_pb.js.map +1 -1
  71. package/dist/gen/marketdata/v1/marketdata_pb.d.ts +8 -0
  72. package/dist/gen/marketdata/v1/marketdata_pb.d.ts.map +1 -1
  73. package/dist/gen/marketdata/v1/marketdata_pb.js +1 -1
  74. package/dist/gen/marketdata/v1/marketdata_pb.js.map +1 -1
  75. package/dist/gen/orders/v1/orders_pb.d.ts +4 -4
  76. package/dist/gen/orders/v1/orders_pb.js.map +1 -1
  77. package/dist/gen/orders/v1/orders_read_pb.d.ts +1 -1
  78. package/dist/gen/polyester/ratelimit/v1/types_pb.d.ts +20 -1
  79. package/dist/gen/polyester/ratelimit/v1/types_pb.d.ts.map +1 -1
  80. package/dist/gen/polyester/ratelimit/v1/types_pb.js +20 -1
  81. package/dist/gen/polyester/ratelimit/v1/types_pb.js.map +1 -1
  82. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.d.ts +1186 -127
  83. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.d.ts.map +1 -1
  84. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.js +282 -5
  85. package/dist/gen/swap/quickswap/v1/quickswap_broker_pb.js.map +1 -1
  86. package/dist/gen/swap/quickswap/v1/quickswap_pb.d.ts +253 -38
  87. package/dist/gen/swap/quickswap/v1/quickswap_pb.d.ts.map +1 -1
  88. package/dist/gen/swap/quickswap/v1/quickswap_pb.js +180 -36
  89. package/dist/gen/swap/quickswap/v1/quickswap_pb.js.map +1 -1
  90. package/dist/gen/swap/quickswap/v1/quickswap_referral_pb.d.ts +933 -0
  91. package/dist/gen/swap/quickswap/v1/quickswap_referral_pb.d.ts.map +1 -0
  92. package/dist/gen/swap/quickswap/v1/quickswap_referral_pb.js +292 -0
  93. package/dist/gen/swap/quickswap/v1/quickswap_referral_pb.js.map +1 -0
  94. package/dist/gen/system/v1/system_pb.d.ts +77 -0
  95. package/dist/gen/system/v1/system_pb.d.ts.map +1 -0
  96. package/dist/gen/system/v1/system_pb.js +34 -0
  97. package/dist/gen/system/v1/system_pb.js.map +1 -0
  98. package/dist/gen/tradews/v1/trade_ws_pb.d.ts +2 -2
  99. package/dist/gen/tradews/v1/trade_ws_pb.js.map +1 -1
  100. package/dist/index.d.ts +14 -6
  101. package/dist/services/api-keys/api-keys.codecs.js +10 -1
  102. package/dist/services/api-keys/api-keys.codecs.js.map +1 -1
  103. package/dist/services/api-keys/api-keys.d.ts +16 -1
  104. package/dist/services/api-keys/api-keys.d.ts.map +1 -1
  105. package/dist/services/api-keys/api-keys.js +25 -1
  106. package/dist/services/api-keys/api-keys.js.map +1 -1
  107. package/dist/services/api-keys/api-keys.schemas.d.ts +116 -1
  108. package/dist/services/api-keys/api-keys.schemas.d.ts.map +1 -1
  109. package/dist/services/api-keys/api-keys.schemas.js +29 -3
  110. package/dist/services/api-keys/api-keys.schemas.js.map +1 -1
  111. package/dist/services/api-keys/api-keys.types.d.ts +2 -2
  112. package/dist/services/api-keys/index.d.ts +2 -2
  113. package/dist/services/assistant/assistant-events.schemas.d.ts +4618 -0
  114. package/dist/services/assistant/assistant-events.schemas.d.ts.map +1 -0
  115. package/dist/services/assistant/assistant-events.schemas.js +485 -0
  116. package/dist/services/assistant/assistant-events.schemas.js.map +1 -0
  117. package/dist/services/assistant/assistant.codecs.d.ts +24 -0
  118. package/dist/services/assistant/assistant.codecs.d.ts.map +1 -0
  119. package/dist/services/assistant/assistant.codecs.js +88 -0
  120. package/dist/services/assistant/assistant.codecs.js.map +1 -0
  121. package/dist/services/assistant/assistant.d.ts +76 -0
  122. package/dist/services/assistant/assistant.d.ts.map +1 -0
  123. package/dist/services/assistant/assistant.js +133 -0
  124. package/dist/services/assistant/assistant.js.map +1 -0
  125. package/dist/services/assistant/assistant.schemas.d.ts +184 -0
  126. package/dist/services/assistant/assistant.schemas.d.ts.map +1 -0
  127. package/dist/services/assistant/assistant.schemas.js +135 -0
  128. package/dist/services/assistant/assistant.schemas.js.map +1 -0
  129. package/dist/services/assistant/assistant.types.d.ts +4 -0
  130. package/dist/services/assistant/service.d.ts +8 -0
  131. package/dist/services/assistant/service.d.ts.map +1 -0
  132. package/dist/services/assistant/service.js +9 -0
  133. package/dist/services/assistant/service.js.map +1 -0
  134. package/dist/services/auto-withdraw/auto-withdraw.codecs.d.ts +9 -2
  135. package/dist/services/auto-withdraw/auto-withdraw.codecs.d.ts.map +1 -1
  136. package/dist/services/auto-withdraw/auto-withdraw.codecs.js +9 -1
  137. package/dist/services/auto-withdraw/auto-withdraw.codecs.js.map +1 -1
  138. package/dist/services/auto-withdraw/auto-withdraw.d.ts +15 -4
  139. package/dist/services/auto-withdraw/auto-withdraw.d.ts.map +1 -1
  140. package/dist/services/auto-withdraw/auto-withdraw.js +24 -8
  141. package/dist/services/auto-withdraw/auto-withdraw.js.map +1 -1
  142. package/dist/services/auto-withdraw/auto-withdraw.schemas.d.ts +394 -26
  143. package/dist/services/auto-withdraw/auto-withdraw.schemas.d.ts.map +1 -1
  144. package/dist/services/auto-withdraw/auto-withdraw.schemas.js +67 -12
  145. package/dist/services/auto-withdraw/auto-withdraw.schemas.js.map +1 -1
  146. package/dist/services/auto-withdraw/auto-withdraw.types.d.ts +3 -3
  147. package/dist/services/balances/balances.js +1 -1
  148. package/dist/services/balances/balances.schemas.d.ts +3 -3
  149. package/dist/services/candles/candles.js +1 -1
  150. package/dist/services/candles/candles.schemas.d.ts +10 -10
  151. package/dist/services/candles/candles.schemas.js +5 -2
  152. package/dist/services/candles/candles.schemas.js.map +1 -1
  153. package/dist/services/changelog/changelog.schemas.d.ts +17 -17
  154. package/dist/services/checkpoints/checkpoints.schemas.d.ts +1 -1
  155. package/dist/services/heatmap/heatmap.schemas.d.ts +4 -4
  156. package/dist/services/internal-transfers/internal-transfers.schemas.d.ts +3 -3
  157. package/dist/services/lifecycle/lifecycle.codecs.d.ts +2 -2
  158. package/dist/services/lifecycle/lifecycle.codecs.d.ts.map +1 -1
  159. package/dist/services/lifecycle/lifecycle.codecs.js +3 -1
  160. package/dist/services/lifecycle/lifecycle.codecs.js.map +1 -1
  161. package/dist/services/lifecycle/lifecycle.schemas.d.ts +210 -186
  162. package/dist/services/lifecycle/lifecycle.schemas.d.ts.map +1 -1
  163. package/dist/services/lifecycle/lifecycle.schemas.js +7 -1
  164. package/dist/services/lifecycle/lifecycle.schemas.js.map +1 -1
  165. package/dist/services/market-data/market-data.js +1 -1
  166. package/dist/services/market-data/market-data.schemas.js +7 -2
  167. package/dist/services/market-data/market-data.schemas.js.map +1 -1
  168. package/dist/services/market-overview/market-overview.schemas.d.ts +1 -1
  169. package/dist/services/orderbook/orderbook.schemas.d.ts +1 -1
  170. package/dist/services/orders/order-errors.schemas.d.ts +2 -2
  171. package/dist/services/orders/orders-batch.schemas.d.ts +54 -54
  172. package/dist/services/orders/orders-input.schemas.d.ts +6 -6
  173. package/dist/services/orders/orders-input.schemas.js +1 -1
  174. package/dist/services/orders/orders-modify.schemas.js +1 -1
  175. package/dist/services/orders/orders-output.schemas.d.ts +16 -16
  176. package/dist/services/orders/orders-output.schemas.js +3 -3
  177. package/dist/services/orders/orders-risk.schemas.js +1 -1
  178. package/dist/services/orders/orders.codecs.js +1 -1
  179. package/dist/services/orders/orders.js +3 -3
  180. package/dist/services/policies/api-key-policies/api-key-policies.schemas.d.ts +15 -15
  181. package/dist/services/policies/shared.codecs.js +24 -3
  182. package/dist/services/policies/shared.codecs.js.map +1 -1
  183. package/dist/services/policies/shared.d.ts +1 -1
  184. package/dist/services/policies/subaccount-policies/subaccount-policies.schemas.d.ts +3 -3
  185. package/dist/services/price-alerts/price-alerts.codecs.d.ts +20 -0
  186. package/dist/services/price-alerts/price-alerts.codecs.d.ts.map +1 -0
  187. package/dist/services/price-alerts/price-alerts.codecs.js +66 -0
  188. package/dist/services/price-alerts/price-alerts.codecs.js.map +1 -0
  189. package/dist/services/price-alerts/price-alerts.d.ts +38 -0
  190. package/dist/services/price-alerts/price-alerts.d.ts.map +1 -0
  191. package/dist/services/price-alerts/price-alerts.js +60 -0
  192. package/dist/services/price-alerts/price-alerts.js.map +1 -0
  193. package/dist/services/price-alerts/price-alerts.schemas.d.ts +309 -0
  194. package/dist/services/price-alerts/price-alerts.schemas.d.ts.map +1 -0
  195. package/dist/services/price-alerts/price-alerts.schemas.js +130 -0
  196. package/dist/services/price-alerts/price-alerts.schemas.js.map +1 -0
  197. package/dist/services/price-alerts/price-alerts.types.d.ts +3 -0
  198. package/dist/services/price-alerts/service.d.ts +8 -0
  199. package/dist/services/price-alerts/service.d.ts.map +1 -0
  200. package/dist/services/price-alerts/service.js +9 -0
  201. package/dist/services/price-alerts/service.js.map +1 -0
  202. package/dist/services/social-verification/social-verification.codecs.js +13 -5
  203. package/dist/services/social-verification/social-verification.codecs.js.map +1 -1
  204. package/dist/services/social-verification/social-verification.d.ts +18 -3
  205. package/dist/services/social-verification/social-verification.d.ts.map +1 -1
  206. package/dist/services/social-verification/social-verification.js +26 -3
  207. package/dist/services/social-verification/social-verification.js.map +1 -1
  208. package/dist/services/social-verification/social-verification.schemas.d.ts +33 -7
  209. package/dist/services/social-verification/social-verification.schemas.d.ts.map +1 -1
  210. package/dist/services/social-verification/social-verification.schemas.js +35 -10
  211. package/dist/services/social-verification/social-verification.schemas.js.map +1 -1
  212. package/dist/services/social-verification/social-verification.types.d.ts +2 -2
  213. package/dist/services/subaccounts/subaccounts.schemas.d.ts +8 -8
  214. package/dist/services/system/service.d.ts +8 -0
  215. package/dist/services/system/service.d.ts.map +1 -0
  216. package/dist/services/system/service.js +9 -0
  217. package/dist/services/system/service.js.map +1 -0
  218. package/dist/services/system/system.d.ts +25 -0
  219. package/dist/services/system/system.d.ts.map +1 -0
  220. package/dist/services/system/system.js +24 -0
  221. package/dist/services/system/system.js.map +1 -0
  222. package/dist/services/trades/trades.js +1 -1
  223. package/dist/services/trades/trades.schemas.d.ts +1 -1
  224. package/dist/services/trades/trades.schemas.js +1 -1
  225. package/dist/services/trading-withdraws/trading-withdraws.d.ts +7 -1
  226. package/dist/services/trading-withdraws/trading-withdraws.d.ts.map +1 -1
  227. package/dist/services/trading-withdraws/trading-withdraws.js +11 -1
  228. package/dist/services/trading-withdraws/trading-withdraws.js.map +1 -1
  229. package/dist/services/trading-withdraws/trading-withdraws.schemas.d.ts +42 -1
  230. package/dist/services/trading-withdraws/trading-withdraws.schemas.d.ts.map +1 -1
  231. package/dist/services/trading-withdraws/trading-withdraws.schemas.js +19 -3
  232. package/dist/services/trading-withdraws/trading-withdraws.schemas.js.map +1 -1
  233. package/dist/services/trading-withdraws/trading-withdraws.types.d.ts +2 -2
  234. package/dist/services/transfers/transfers.schemas.d.ts +5 -5
  235. package/dist/services/triggers/trigger-child-order.schemas.js +1 -1
  236. package/dist/services/triggers/trigger-input.schemas.d.ts +2 -2
  237. package/dist/services/triggers/trigger-input.schemas.js +1 -1
  238. package/dist/services/triggers/triggers-output.schemas.d.ts +49 -49
  239. package/dist/services/triggers/triggers.codecs.js +1 -1
  240. package/dist/services/triggers/triggers.js +2 -2
  241. package/dist/shared/catalog-config.d.ts +5 -0
  242. package/dist/shared/catalog-config.d.ts.map +1 -1
  243. package/dist/shared/catalog-config.js.map +1 -1
  244. package/dist/shared/connect-error-mapping.d.ts.map +1 -1
  245. package/dist/shared/connect-error-mapping.js +1 -0
  246. package/dist/shared/connect-error-mapping.js.map +1 -1
  247. package/dist/shared/error-detail.d.ts +24 -10
  248. package/dist/shared/error-detail.d.ts.map +1 -1
  249. package/dist/shared/error-detail.js +2 -0
  250. package/dist/shared/error-detail.js.map +1 -1
  251. package/dist/shared/error-details/alerts.js +15 -0
  252. package/dist/shared/error-details/alerts.js.map +1 -0
  253. package/dist/shared/error-details/assistant.js +15 -0
  254. package/dist/shared/error-details/assistant.js.map +1 -0
  255. package/dist/shared/error-details/withdraw.js +11 -2
  256. package/dist/shared/error-details/withdraw.js.map +1 -1
  257. package/dist/shared/ledger-codes.d.ts +4 -2
  258. package/dist/shared/ledger-codes.d.ts.map +1 -1
  259. package/dist/shared/ledger-codes.js +6 -3
  260. package/dist/shared/ledger-codes.js.map +1 -1
  261. package/dist/shared/rate-limit.schemas.d.ts +3 -3
  262. package/dist/shared/rate-limit.schemas.d.ts.map +1 -1
  263. package/dist/shared/rate-limit.schemas.js +4 -1
  264. package/dist/shared/rate-limit.schemas.js.map +1 -1
  265. package/dist/shared/transports.d.ts +2 -1
  266. package/dist/shared/transports.d.ts.map +1 -1
  267. package/dist/shared/transports.js.map +1 -1
  268. package/dist/wired-services.d.ts.map +1 -1
  269. package/dist/wired-services.js +11 -5
  270. package/dist/wired-services.js.map +1 -1
  271. package/package.json +1 -1
@@ -1,9 +1,10 @@
1
+ import { AutoWithdrawPause, AutoWithdrawPreviewStatus, AutoWithdrawSchedule } from "../../../chain/withdraw/v1/auto_withdraw_pb.js";
1
2
  import { ChargedFee, QuickSwap, QuickSwapReason, QuickSwapStatus, QuickSwapTerms, RequestedFees, TokenAmount } from "./quickswap_pb.js";
2
3
  import { Message } from "@bufbuild/protobuf";
3
4
  import { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
4
5
  import { Timestamp } from "@bufbuild/protobuf/wkt";
5
6
  declare namespace quickswap_broker_pb_d_exports {
6
- export { AffiliateVault, AffiliateVaultSchema, AssetVolume, AssetVolumeSchema, Broker, BrokerKey, BrokerKeySchema, BrokerRole, BrokerRoleSchema, BrokerSchema, BrokerStatsPeriod, BrokerStatsPeriodSchema, BrokerUsage, BrokerUsageSchema, CreateAffiliateVaultRequest, CreateAffiliateVaultRequestSchema, CreateAffiliateVaultResponse, CreateAffiliateVaultResponseSchema, CreateKeyRequest, CreateKeyRequestSchema, CreateKeyResponse, CreateKeyResponseSchema, FeeSplit, FeeSplitSchema, FeeTotal, FeeTotalSchema, FeeTotalsGrouping, FeeTotalsGroupingSchema, GetBrokerRequest, GetBrokerRequestSchema, GetBrokerResponse, GetBrokerResponseSchema, GetBrokerStatsRequest, GetBrokerStatsRequestSchema, GetBrokerStatsResponse, GetBrokerStatsResponseSchema, GetFeeTotalsRequest, GetFeeTotalsRequestSchema, GetFeeTotalsResponse, GetFeeTotalsResponseSchema, GetVaultRequest, GetVaultRequestSchema, GetVaultResponse, GetVaultResponseSchema, Invite, InviteMemberRequest, InviteMemberRequestSchema, InviteMemberResponse, InviteMemberResponseSchema, InviteSchema, ListKeysRequest, ListKeysRequestSchema, ListKeysResponse, ListKeysResponseSchema, ListMembersRequest, ListMembersRequestSchema, ListMembersResponse, ListMembersResponseSchema, ListMyBrokersRequest, ListMyBrokersRequestSchema, ListMyBrokersResponse, ListMyBrokersResponseSchema, ListQuickSwapsRequest, ListQuickSwapsRequestSchema, ListQuickSwapsResponse, ListQuickSwapsResponseSchema, ListVaultBalancesRequest, ListVaultBalancesRequestSchema, ListVaultBalancesResponse, ListVaultBalancesResponseSchema, ListVaultsRequest, ListVaultsRequestSchema, ListVaultsResponse, ListVaultsResponseSchema, Member, MemberSchema, Membership, MembershipSchema, QuickSwapBrokerService, QuickSwapBrokerServiceGetQuickSwapRequest, QuickSwapBrokerServiceGetQuickSwapRequestSchema, QuickSwapBrokerServiceGetQuickSwapResponse, QuickSwapBrokerServiceGetQuickSwapResponseSchema, QuickSwapSummary, QuickSwapSummarySchema, RemoveMemberRequest, RemoveMemberRequestSchema, RemoveMemberResponse, RemoveMemberResponseSchema, RespondToInviteRequest, RespondToInviteRequestSchema, RespondToInviteResponse, RespondToInviteResponseSchema, RevokeKeyRequest, RevokeKeyRequestSchema, RevokeKeyResponse, RevokeKeyResponseSchema, RotateKeyRequest, RotateKeyRequestSchema, RotateKeyResponse, RotateKeyResponseSchema, SetMemberRoleRequest, SetMemberRoleRequestSchema, SetMemberRoleResponse, SetMemberRoleResponseSchema, SetVaultStatusRequest, SetVaultStatusRequestSchema, SetVaultStatusResponse, SetVaultStatusResponseSchema, StatsPeriod, StatsPeriodSchema, StatusCount, StatusCountSchema, TransferOwnershipRequest, TransferOwnershipRequestSchema, TransferOwnershipResponse, TransferOwnershipResponseSchema, VaultAssetBalance, VaultAssetBalanceSchema, VaultBalance, VaultBalanceSchema, VaultStatus, VaultStatusSchema, file_swap_quickswap_v1_quickswap_broker };
7
+ export { AffiliateVault, AffiliateVaultSchema, AssetVolume, AssetVolumeSchema, AssetWithoutDestination, AssetWithoutDestinationSchema, Broker, BrokerKey, BrokerKeySchema, BrokerRole, BrokerRoleSchema, BrokerSchema, BrokerStatsPeriod, BrokerStatsPeriodSchema, BrokerUsage, BrokerUsageSchema, CreateAffiliateVaultRequest, CreateAffiliateVaultRequestSchema, CreateAffiliateVaultResponse, CreateAffiliateVaultResponseSchema, CreateKeyRequest, CreateKeyRequestSchema, CreateKeyResponse, CreateKeyResponseSchema, FeeSplit, FeeSplitSchema, FeeTotal, FeeTotalSchema, FeeTotalsGrouping, FeeTotalsGroupingSchema, GetBrokerRequest, GetBrokerRequestSchema, GetBrokerResponse, GetBrokerResponseSchema, GetBrokerStatsRequest, GetBrokerStatsRequestSchema, GetBrokerStatsResponse, GetBrokerStatsResponseSchema, GetFeeTotalsRequest, GetFeeTotalsRequestSchema, GetFeeTotalsResponse, GetFeeTotalsResponseSchema, GetPayoutRequest, GetPayoutRequestSchema, GetPayoutResponse, GetPayoutResponseSchema, GetVaultRequest, GetVaultRequestSchema, GetVaultResponse, GetVaultResponseSchema, Invite, InviteMemberRequest, InviteMemberRequestSchema, InviteMemberResponse, InviteMemberResponseSchema, InviteSchema, ListKeysRequest, ListKeysRequestSchema, ListKeysResponse, ListKeysResponseSchema, ListMembersRequest, ListMembersRequestSchema, ListMembersResponse, ListMembersResponseSchema, ListMyBrokersRequest, ListMyBrokersRequestSchema, ListMyBrokersResponse, ListMyBrokersResponseSchema, ListPayoutsRequest, ListPayoutsRequestSchema, ListPayoutsResponse, ListPayoutsResponseSchema, ListQuickSwapsRequest, ListQuickSwapsRequestSchema, ListQuickSwapsResponse, ListQuickSwapsResponseSchema, ListUpcomingPayoutsRequest, ListUpcomingPayoutsRequestSchema, ListUpcomingPayoutsResponse, ListUpcomingPayoutsResponseSchema, ListVaultBalancesRequest, ListVaultBalancesRequestSchema, ListVaultBalancesResponse, ListVaultBalancesResponseSchema, ListVaultPayoutRulesRequest, ListVaultPayoutRulesRequestSchema, ListVaultPayoutRulesResponse, ListVaultPayoutRulesResponseSchema, ListVaultsRequest, ListVaultsRequestSchema, ListVaultsResponse, ListVaultsResponseSchema, Member, MemberSchema, Membership, MembershipSchema, Payout, PayoutRuleDestination, PayoutRuleDestinationSchema, PayoutSchema, PayoutStage, PayoutStageSchema, PayoutStatus, PayoutStatusSchema, PayoutStep, PayoutStepSchema, PayoutStepState, PayoutStepStateSchema, QuickSwapBrokerService, QuickSwapBrokerServiceGetQuickSwapRequest, QuickSwapBrokerServiceGetQuickSwapRequestSchema, QuickSwapBrokerServiceGetQuickSwapResponse, QuickSwapBrokerServiceGetQuickSwapResponseSchema, QuickSwapSummary, QuickSwapSummarySchema, RemoveMemberRequest, RemoveMemberRequestSchema, RemoveMemberResponse, RemoveMemberResponseSchema, RespondToInviteRequest, RespondToInviteRequestSchema, RespondToInviteResponse, RespondToInviteResponseSchema, RevokeKeyRequest, RevokeKeyRequestSchema, RevokeKeyResponse, RevokeKeyResponseSchema, RotateKeyRequest, RotateKeyRequestSchema, RotateKeyResponse, RotateKeyResponseSchema, SetMemberRoleRequest, SetMemberRoleRequestSchema, SetMemberRoleResponse, SetMemberRoleResponseSchema, SetVaultStatusRequest, SetVaultStatusRequestSchema, SetVaultStatusResponse, SetVaultStatusResponseSchema, StatsPeriod, StatsPeriodSchema, StatusCount, StatusCountSchema, TransferOwnershipRequest, TransferOwnershipRequestSchema, TransferOwnershipResponse, TransferOwnershipResponseSchema, UpcomingPayout, UpcomingPayoutAsset, UpcomingPayoutAssetSchema, UpcomingPayoutSchema, VaultAssetBalance, VaultAssetBalanceSchema, VaultBalance, VaultBalanceSchema, VaultPayoutRule, VaultPayoutRuleSchema, VaultStatus, VaultStatusSchema, file_swap_quickswap_v1_quickswap_broker };
7
8
  }
8
9
  /**
9
10
  * Describes the file swap/quickswap/v1/quickswap_broker.proto.
@@ -974,7 +975,7 @@ type ListVaultsRequest = Message<"swap.quickswap.v1.ListVaultsRequest"> & {
974
975
  limit: number;
975
976
  /**
976
977
  * Opaque keyset cursor from a previous next_page_token, exclusive, bound to
977
- * the broker and ordered by ascending account_id. Empty for the first page.
978
+ * the broker and the list order. Empty for the first page.
978
979
  *
979
980
  * @generated from field: string page_token = 3;
980
981
  */
@@ -986,7 +987,8 @@ type ListVaultsRequest = Message<"swap.quickswap.v1.ListVaultsRequest"> & {
986
987
  */
987
988
  declare const ListVaultsRequestSchema: GenMessage<ListVaultsRequest>;
988
989
  /**
989
- * ListVaultsResponse lists vaults in ascending account_id order.
990
+ * ListVaultsResponse lists vaults in a stable server-defined order, the
991
+ * same on every page; it does not follow the public account_id values.
990
992
  *
991
993
  * @generated from message swap.quickswap.v1.ListVaultsResponse
992
994
  */
@@ -1232,7 +1234,8 @@ type ListQuickSwapsRequest = Message<"swap.quickswap.v1.ListQuickSwapsRequest">
1232
1234
  broker: string;
1233
1235
  /**
1234
1236
  * Only QuickSwaps whose fees credit this vault: an affiliate vault they
1235
- * name, or the default vault when they set a broker fee. Zero for every
1237
+ * name, or the default vault when they set a broker fee. A referral
1238
+ * partner's commission credits no vault of the broker. Zero for every
1236
1239
  * QuickSwap.
1237
1240
  *
1238
1241
  * @generated from field: fixed64 vault_account_id = 2;
@@ -1267,8 +1270,8 @@ type ListQuickSwapsRequest = Message<"swap.quickswap.v1.ListQuickSwapsRequest">
1267
1270
  limit: number;
1268
1271
  /**
1269
1272
  * Opaque keyset cursor from a previous next_page_token, exclusive, bound
1270
- * to the broker, the filters and the newest-first order by creation time,
1271
- * then swap_id. Reuse it with the same filters. Empty for the first page.
1273
+ * to the broker, the filters and the list order. Reuse it with the same
1274
+ * filters. Empty for the first page.
1272
1275
  *
1273
1276
  * @generated from field: string page_token = 7;
1274
1277
  */
@@ -1280,10 +1283,11 @@ type ListQuickSwapsRequest = Message<"swap.quickswap.v1.ListQuickSwapsRequest">
1280
1283
  */
1281
1284
  declare const ListQuickSwapsRequestSchema: GenMessage<ListQuickSwapsRequest>;
1282
1285
  /**
1283
- * ListQuickSwapsResponse lists QuickSwaps newest first: by creation time,
1284
- * then swap_id, both descending. A QuickSwap created after the first page
1285
- * was read is not listed by later pages; every earlier one is listed exactly
1286
- * once.
1286
+ * ListQuickSwapsResponse lists QuickSwaps newest first by creation time.
1287
+ * QuickSwaps created at the same time follow a stable server-defined order,
1288
+ * the same on every page; it does not follow swap_id. A QuickSwap created
1289
+ * after the first page was read is not listed by later pages; every earlier
1290
+ * one is listed exactly once.
1287
1291
  *
1288
1292
  * @generated from message swap.quickswap.v1.ListQuickSwapsResponse
1289
1293
  */
@@ -1308,7 +1312,8 @@ type ListQuickSwapsResponse = Message<"swap.quickswap.v1.ListQuickSwapsResponse"
1308
1312
  declare const ListQuickSwapsResponseSchema: GenMessage<ListQuickSwapsResponse>;
1309
1313
  /**
1310
1314
  * GetFeeTotalsRequest totals the broker and affiliate fees charged to the
1311
- * broker's QuickSwaps in a time window.
1315
+ * broker's QuickSwaps in a time window: the fees credited to the broker's
1316
+ * vaults, never a referral partner's commission.
1312
1317
  *
1313
1318
  * @generated from message swap.quickswap.v1.GetFeeTotalsRequest
1314
1319
  */
@@ -1533,6 +1538,13 @@ type FeeSplit = Message<"swap.quickswap.v1.FeeSplit"> & {
1533
1538
  * @generated from field: swap.quickswap.v1.TokenAmount affiliate_fee = 4;
1534
1539
  */
1535
1540
  affiliateFee?: TokenAmount | undefined;
1541
+ /**
1542
+ * Referral commissions, credited to referral partners rather than to a
1543
+ * vault of the broker, in base units of 18 decimals.
1544
+ *
1545
+ * @generated from field: swap.quickswap.v1.TokenAmount referral_fee = 5;
1546
+ */
1547
+ referralFee?: TokenAmount | undefined;
1536
1548
  };
1537
1549
  /**
1538
1550
  * Describes the message swap.quickswap.v1.FeeSplit.
@@ -1551,191 +1563,986 @@ declare const FeeSplitSchema: GenMessage<FeeSplit>;
1551
1563
  */
1552
1564
  type BrokerStatsPeriod = Message<"swap.quickswap.v1.BrokerStatsPeriod"> & {
1553
1565
  /**
1554
- * Start of the UTC day or month.
1566
+ * Start of the UTC day or month.
1567
+ *
1568
+ * @generated from field: google.protobuf.Timestamp period_start = 1;
1569
+ */
1570
+ periodStart?: Timestamp | undefined;
1571
+ /**
1572
+ * QuickSwaps created in the period, inside the window.
1573
+ *
1574
+ * @generated from field: uint64 created_count = 2;
1575
+ */
1576
+ createdCount: bigint;
1577
+ /**
1578
+ * Those QuickSwaps by current status, in QuickSwapStatus number order;
1579
+ * statuses with none are omitted. The counts total created_count.
1580
+ *
1581
+ * @generated from field: repeated swap.quickswap.v1.StatusCount statuses = 3;
1582
+ */
1583
+ statuses: StatusCount[];
1584
+ /**
1585
+ * Deposits credited to those QuickSwaps and taken in for execution, per
1586
+ * asset, in asset_id order: including a deposit later found ineligible
1587
+ * and returned, excluding a deposit held for review before credit.
1588
+ *
1589
+ * @generated from field: repeated swap.quickswap.v1.AssetVolume deposited = 4;
1590
+ */
1591
+ deposited: AssetVolume[];
1592
+ /**
1593
+ * Paid to the destination of those QuickSwaps whose DESTINATION
1594
+ * withdrawal is FINALIZED, per asset, in asset_id order: after service,
1595
+ * broker and affiliate fees, before the destination network fee.
1596
+ *
1597
+ * @generated from field: repeated swap.quickswap.v1.AssetVolume delivered = 5;
1598
+ */
1599
+ delivered: AssetVolume[];
1600
+ /**
1601
+ * Fees charged to the broker's QuickSwaps in the period, per asset, in
1602
+ * asset_id order. broker_fee plus affiliate_fee equals the GetFeeTotals
1603
+ * total of the same window, period and asset.
1604
+ *
1605
+ * @generated from field: repeated swap.quickswap.v1.FeeSplit fees = 6;
1606
+ */
1607
+ fees: FeeSplit[];
1608
+ };
1609
+ /**
1610
+ * Describes the message swap.quickswap.v1.BrokerStatsPeriod.
1611
+ * Use `create(BrokerStatsPeriodSchema)` to create a new message.
1612
+ */
1613
+ declare const BrokerStatsPeriodSchema: GenMessage<BrokerStatsPeriod>;
1614
+ /**
1615
+ * GetBrokerStatsResponse lists every period of the window with a QuickSwap
1616
+ * created or a fee charged, oldest first, complete (the window is bounded).
1617
+ * Periods with neither are omitted.
1618
+ *
1619
+ * @generated from message swap.quickswap.v1.GetBrokerStatsResponse
1620
+ */
1621
+ type GetBrokerStatsResponse = Message<"swap.quickswap.v1.GetBrokerStatsResponse"> & {
1622
+ /**
1623
+ * The periods.
1624
+ *
1625
+ * @generated from field: repeated swap.quickswap.v1.BrokerStatsPeriod periods = 1;
1626
+ */
1627
+ periods: BrokerStatsPeriod[];
1628
+ };
1629
+ /**
1630
+ * Describes the message swap.quickswap.v1.GetBrokerStatsResponse.
1631
+ * Use `create(GetBrokerStatsResponseSchema)` to create a new message.
1632
+ */
1633
+ declare const GetBrokerStatsResponseSchema: GenMessage<GetBrokerStatsResponse>;
1634
+ /**
1635
+ * ListVaultBalancesRequest selects a broker's default and affiliate vaults.
1636
+ *
1637
+ * @generated from message swap.quickswap.v1.ListVaultBalancesRequest
1638
+ */
1639
+ type ListVaultBalancesRequest = Message<"swap.quickswap.v1.ListVaultBalancesRequest"> & {
1640
+ /**
1641
+ * Broker name.
1642
+ *
1643
+ * @generated from field: string broker = 1;
1644
+ */
1645
+ broker: string;
1646
+ /**
1647
+ * Public vault subaccount ID. Omit to include every vault, including disabled
1648
+ * affiliates. A root account or another broker's vault is NOT_FOUND.
1649
+ *
1650
+ * @generated from field: fixed64 vault_account_id = 2;
1651
+ */
1652
+ vaultAccountId: bigint;
1653
+ /**
1654
+ * Maximum vaults, default 20, max 200.
1655
+ *
1656
+ * @generated from field: uint32 limit = 3;
1657
+ */
1658
+ limit: number;
1659
+ /**
1660
+ * Opaque exclusive keyset cursor, bound to the broker and vault filter.
1661
+ * Reuse with the same broker and vault_account_id; limit may change.
1662
+ *
1663
+ * @generated from field: string page_token = 4;
1664
+ */
1665
+ pageToken: string;
1666
+ };
1667
+ /**
1668
+ * Describes the message swap.quickswap.v1.ListVaultBalancesRequest.
1669
+ * Use `create(ListVaultBalancesRequestSchema)` to create a new message.
1670
+ */
1671
+ declare const ListVaultBalancesRequestSchema: GenMessage<ListVaultBalancesRequest>;
1672
+ /**
1673
+ * VaultAssetBalance is the current posted balance in one asset.
1674
+ *
1675
+ * @generated from message swap.quickswap.v1.VaultAssetBalance
1676
+ */
1677
+ type VaultAssetBalance = Message<"swap.quickswap.v1.VaultAssetBalance"> & {
1678
+ /**
1679
+ * Unified asset ID, including assets no longer enabled for new swaps.
1680
+ *
1681
+ * @generated from field: uint32 asset_id = 1;
1682
+ */
1683
+ assetId: number;
1684
+ /**
1685
+ * Settled balance of the vault's Funding and Trading accounts, at 18 decimals.
1686
+ * Pending credits are excluded. This is not a withdrawability guarantee.
1687
+ *
1688
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 2;
1689
+ */
1690
+ amount?: TokenAmount | undefined;
1691
+ /**
1692
+ * Funds committed to pending outgoing transfers, at 18 decimals. amount
1693
+ * still counts these funds and has NOT been reduced by pending_outgoing.
1694
+ * amount minus pending_outgoing is the balance not yet committed to an
1695
+ * outgoing transfer. This excludes order holds and is not a withdrawability guarantee.
1696
+ *
1697
+ * @generated from field: swap.quickswap.v1.TokenAmount pending_outgoing = 3;
1698
+ */
1699
+ pendingOutgoing?: TokenAmount | undefined;
1700
+ };
1701
+ /**
1702
+ * Describes the message swap.quickswap.v1.VaultAssetBalance.
1703
+ * Use `create(VaultAssetBalanceSchema)` to create a new message.
1704
+ */
1705
+ declare const VaultAssetBalanceSchema: GenMessage<VaultAssetBalance>;
1706
+ /**
1707
+ * VaultBalance is one vault's current balance observation.
1708
+ *
1709
+ * @generated from message swap.quickswap.v1.VaultBalance
1710
+ */
1711
+ type VaultBalance = Message<"swap.quickswap.v1.VaultBalance"> & {
1712
+ /**
1713
+ * Public vault subaccount ID.
1714
+ *
1715
+ * @generated from field: fixed64 vault_account_id = 1;
1716
+ */
1717
+ vaultAccountId: bigint;
1718
+ /**
1719
+ * Asset balances in ascending asset_id order. Empty for an unfunded vault.
1720
+ *
1721
+ * @generated from field: repeated swap.quickswap.v1.VaultAssetBalance assets = 2;
1722
+ */
1723
+ assets: VaultAssetBalance[];
1724
+ /**
1725
+ * UTC time this vault's balance read completed. Vaults are read separately;
1726
+ * this does not describe an atomic snapshot across vaults or pages.
1727
+ *
1728
+ * @generated from field: google.protobuf.Timestamp as_of = 3;
1729
+ */
1730
+ asOf?: Timestamp | undefined;
1731
+ };
1732
+ /**
1733
+ * Describes the message swap.quickswap.v1.VaultBalance.
1734
+ * Use `create(VaultBalanceSchema)` to create a new message.
1735
+ */
1736
+ declare const VaultBalanceSchema: GenMessage<VaultBalance>;
1737
+ /**
1738
+ * ListVaultBalancesResponse lists vaults in ascending account creation-ID
1739
+ * order, independent of their encoded public IDs. A failed balance read fails
1740
+ * the entire page; it is never represented as a zero balance.
1741
+ *
1742
+ * @generated from message swap.quickswap.v1.ListVaultBalancesResponse
1743
+ */
1744
+ type ListVaultBalancesResponse = Message<"swap.quickswap.v1.ListVaultBalancesResponse"> & {
1745
+ /**
1746
+ * Default and affiliate vault balances, at most limit vaults.
1747
+ *
1748
+ * @generated from field: repeated swap.quickswap.v1.VaultBalance vaults = 1;
1749
+ */
1750
+ vaults: VaultBalance[];
1751
+ /**
1752
+ * Opaque exclusive keyset cursor. Empty when no more results exist.
1753
+ *
1754
+ * @generated from field: string next_page_token = 2;
1755
+ */
1756
+ nextPageToken: string;
1757
+ };
1758
+ /**
1759
+ * Describes the message swap.quickswap.v1.ListVaultBalancesResponse.
1760
+ * Use `create(ListVaultBalancesResponseSchema)` to create a new message.
1761
+ */
1762
+ declare const ListVaultBalancesResponseSchema: GenMessage<ListVaultBalancesResponse>;
1763
+ /**
1764
+ * PayoutStep is one asset's payout in a run. Amounts are in base units of 18
1765
+ * decimals.
1766
+ *
1767
+ * @generated from message swap.quickswap.v1.PayoutStep
1768
+ */
1769
+ type PayoutStep = Message<"swap.quickswap.v1.PayoutStep"> & {
1770
+ /**
1771
+ * Asset paid, as an AssetConfig.ledger_id from
1772
+ * GET /v1/chain/deposit-withdraw/config.
1773
+ *
1774
+ * @generated from field: uint32 asset_id = 1;
1775
+ */
1776
+ assetId: number;
1777
+ /**
1778
+ * Destination chain identifier.
1779
+ *
1780
+ * @generated from field: uint64 destination_chain_id = 2;
1781
+ */
1782
+ destinationChainId: bigint;
1783
+ /**
1784
+ * Canonical destination address.
1785
+ *
1786
+ * @generated from field: string destination_address = 3;
1787
+ */
1788
+ destinationAddress: string;
1789
+ /**
1790
+ * Where the payout stands.
1791
+ *
1792
+ * @generated from field: swap.quickswap.v1.PayoutStepState state = 4;
1793
+ */
1794
+ state: PayoutStepState;
1795
+ /**
1796
+ * Machine-readable reason of a skipped or failed step: below_minimum,
1797
+ * price_unavailable, rule_superseded, destination_not_whitelisted,
1798
+ * destination_cooling_down (the destination was added to the vault's
1799
+ * external withdraw whitelist less than 24 hours ago; the balance stays
1800
+ * for a later run), destination_invalid, authority_revoked,
1801
+ * withdrawal_refused,
1802
+ * gateway_capacity_insufficient, withdrawal_released (the withdrawal was
1803
+ * released before it was sent; nothing left the vault) or
1804
+ * withdrawal_failed (the withdrawal ended without paying; see
1805
+ * PAYOUT_FAILED); empty otherwise.
1806
+ *
1807
+ * @generated from field: string reason = 5;
1808
+ */
1809
+ reason: string;
1810
+ /**
1811
+ * The vault's available balance of the asset when the run started.
1812
+ *
1813
+ * @generated from field: swap.quickswap.v1.TokenAmount available = 6;
1814
+ */
1815
+ available?: TokenAmount | undefined;
1816
+ /**
1817
+ * What the step pays: the available balance up to the rule's per-run
1818
+ * ceiling, rounded down to whole units of the destination network. Zero
1819
+ * when skipped. The network fee is taken out of it on the way.
1820
+ *
1821
+ * @generated from field: swap.quickswap.v1.TokenAmount amount = 7;
1822
+ */
1823
+ amount?: TokenAmount | undefined;
1824
+ /**
1825
+ * The least amount the rule pays for the asset (the destination's minimum
1826
+ * in the rule version the run executed). A withdrawal on the network may
1827
+ * need more, as below_minimum says.
1828
+ *
1829
+ * @generated from field: swap.quickswap.v1.TokenAmount minimum = 8;
1830
+ */
1831
+ minimum?: TokenAmount | undefined;
1832
+ /**
1833
+ * USD value of the payable amount when the run started, checked against
1834
+ * Payout.min_usd_value; unset when the rule has no USD minimum or no
1835
+ * current price valued the asset.
1836
+ *
1837
+ * @generated from field: swap.quickswap.v1.TokenAmount value_usd = 9;
1838
+ */
1839
+ valueUsd?: TokenAmount | undefined;
1840
+ /**
1841
+ * Destination-network transaction hash, once known.
1842
+ *
1843
+ * @generated from field: string tx_hash = 10;
1844
+ */
1845
+ txHash: string;
1846
+ /**
1847
+ * The network fee charged on the withdrawal. On a completed step it was
1848
+ * taken out of amount, so the destination received amount minus this fee.
1849
+ * On a failed step whose withdrawal the destination network's bridge
1850
+ * rejected or failed to execute, it is the fee kept, which is not
1851
+ * refunded. Unset until the step is final, on a skipped step or one that
1852
+ * failed before reaching that bridge, and when the fee was not reported;
1853
+ * never zero for unknown.
1854
+ *
1855
+ * @generated from field: swap.quickswap.v1.TokenAmount charged_network_fee = 11;
1856
+ */
1857
+ chargedNetworkFee?: TokenAmount | undefined;
1858
+ };
1859
+ /**
1860
+ * Describes the message swap.quickswap.v1.PayoutStep.
1861
+ * Use `create(PayoutStepSchema)` to create a new message.
1862
+ */
1863
+ declare const PayoutStepSchema: GenMessage<PayoutStep>;
1864
+ /**
1865
+ * Payout is one scheduled payout run of a broker vault's payout rule.
1866
+ *
1867
+ * @generated from message swap.quickswap.v1.Payout
1868
+ */
1869
+ type Payout = Message<"swap.quickswap.v1.Payout"> & {
1870
+ /**
1871
+ * Public payout run ID.
1872
+ *
1873
+ * @generated from field: fixed64 run_id = 1;
1874
+ */
1875
+ runId: bigint;
1876
+ /**
1877
+ * Public sub-account ID of the vault paid out: the default vault or an
1878
+ * affiliate vault.
1879
+ *
1880
+ * @generated from field: fixed64 vault_account_id = 2;
1881
+ */
1882
+ vaultAccountId: bigint;
1883
+ /**
1884
+ * What the run came to.
1885
+ *
1886
+ * @generated from field: swap.quickswap.v1.PayoutStatus status = 3;
1887
+ */
1888
+ status: PayoutStatus;
1889
+ /**
1890
+ * Machine-readable reason of the status (see PayoutStatus); empty for
1891
+ * PAYOUT_PAID and PAYOUT_IN_PROGRESS.
1892
+ *
1893
+ * @generated from field: string reason = 4;
1894
+ */
1895
+ reason: string;
1896
+ /**
1897
+ * Where an in-progress run stands; PAYOUT_STAGE_UNSPECIFIED otherwise.
1898
+ *
1899
+ * @generated from field: swap.quickswap.v1.PayoutStage stage = 5;
1900
+ */
1901
+ stage: PayoutStage;
1902
+ /**
1903
+ * The rule version the run executed.
1904
+ *
1905
+ * @generated from field: uint32 rule_version = 6;
1906
+ */
1907
+ ruleVersion: number;
1908
+ /**
1909
+ * The scheduled UTC slot the run belongs to.
1910
+ *
1911
+ * @generated from field: google.protobuf.Timestamp scheduled_for = 7;
1912
+ */
1913
+ scheduledFor?: Timestamp | undefined;
1914
+ /**
1915
+ * When the run started.
1916
+ *
1917
+ * @generated from field: google.protobuf.Timestamp started_at = 8;
1918
+ */
1919
+ startedAt?: Timestamp | undefined;
1920
+ /**
1921
+ * When the run ended; unset while it is in progress.
1922
+ *
1923
+ * @generated from field: google.protobuf.Timestamp finished_at = 9;
1924
+ */
1925
+ finishedAt?: Timestamp | undefined;
1926
+ /**
1927
+ * The rule's least USD value of one payout, in base units of 18 decimals;
1928
+ * unset when the rule has no USD minimum.
1929
+ *
1930
+ * @generated from field: swap.quickswap.v1.TokenAmount min_usd_value = 10;
1931
+ */
1932
+ minUsdValue?: TokenAmount | undefined;
1933
+ /**
1934
+ * One step per destination of the rule version, in asset_id order. Empty
1935
+ * while the run is planning.
1936
+ *
1937
+ * @generated from field: repeated swap.quickswap.v1.PayoutStep steps = 11;
1938
+ */
1939
+ steps: PayoutStep[];
1940
+ };
1941
+ /**
1942
+ * Describes the message swap.quickswap.v1.Payout.
1943
+ * Use `create(PayoutSchema)` to create a new message.
1944
+ */
1945
+ declare const PayoutSchema: GenMessage<Payout>;
1946
+ /**
1947
+ * ListPayoutsRequest lists the payout runs of the broker's vaults, newest
1948
+ * first. Every filter narrows the list.
1949
+ *
1950
+ * @generated from message swap.quickswap.v1.ListPayoutsRequest
1951
+ */
1952
+ type ListPayoutsRequest = Message<"swap.quickswap.v1.ListPayoutsRequest"> & {
1953
+ /**
1954
+ * Broker name. A broker API key may name only its own broker.
1955
+ *
1956
+ * @generated from field: string broker = 1;
1957
+ */
1958
+ broker: string;
1959
+ /**
1960
+ * Only this vault's payouts: the default vault or an affiliate vault, as
1961
+ * a public sub-account ID. Zero for every vault of the broker.
1962
+ *
1963
+ * @generated from field: fixed64 vault_account_id = 2;
1964
+ */
1965
+ vaultAccountId: bigint;
1966
+ /**
1967
+ * Only payouts in one of these statuses, at most 6; empty for every
1968
+ * status.
1969
+ *
1970
+ * @generated from field: repeated swap.quickswap.v1.PayoutStatus statuses = 3;
1971
+ */
1972
+ statuses: PayoutStatus[];
1973
+ /**
1974
+ * Only runs scheduled at or after start_time; unset for no lower bound.
1975
+ *
1976
+ * @generated from field: google.protobuf.Timestamp start_time = 4;
1977
+ */
1978
+ startTime?: Timestamp | undefined;
1979
+ /**
1980
+ * Only runs scheduled before end_time (exclusive); unset for no upper
1981
+ * bound.
1982
+ *
1983
+ * @generated from field: google.protobuf.Timestamp end_time = 5;
1984
+ */
1985
+ endTime?: Timestamp | undefined;
1986
+ /**
1987
+ * Maximum number of payouts to return; 0 means 50, at most 100.
1988
+ *
1989
+ * @generated from field: uint32 limit = 6;
1990
+ */
1991
+ limit: number;
1992
+ /**
1993
+ * Opaque keyset cursor from a previous next_page_token, exclusive, bound
1994
+ * to the broker, the filters and the list order. Reuse it with the same
1995
+ * filters; limit may change. Empty for the first page.
1996
+ *
1997
+ * @generated from field: string page_token = 7;
1998
+ */
1999
+ pageToken: string;
2000
+ };
2001
+ /**
2002
+ * Describes the message swap.quickswap.v1.ListPayoutsRequest.
2003
+ * Use `create(ListPayoutsRequestSchema)` to create a new message.
2004
+ */
2005
+ declare const ListPayoutsRequestSchema: GenMessage<ListPayoutsRequest>;
2006
+ /**
2007
+ * ListPayoutsResponse lists payouts newest first by scheduled slot. Runs of
2008
+ * the same slot follow a stable server-defined order, the same on every
2009
+ * page; it does not follow run_id. Paging lists exactly once every run that
2010
+ * sorts after the previous page's last run when the next page is read,
2011
+ * including a run started meanwhile for an older slot. A run started
2012
+ * meanwhile for a newer slot sorts before the cursor and appears only in a
2013
+ * listing started again from the first page.
2014
+ *
2015
+ * @generated from message swap.quickswap.v1.ListPayoutsResponse
2016
+ */
2017
+ type ListPayoutsResponse = Message<"swap.quickswap.v1.ListPayoutsResponse"> & {
2018
+ /**
2019
+ * The payouts.
2020
+ *
2021
+ * @generated from field: repeated swap.quickswap.v1.Payout payouts = 1;
2022
+ */
2023
+ payouts: Payout[];
2024
+ /**
2025
+ * Cursor of the next page. Empty when no more results exist.
2026
+ *
2027
+ * @generated from field: string next_page_token = 2;
2028
+ */
2029
+ nextPageToken: string;
2030
+ };
2031
+ /**
2032
+ * Describes the message swap.quickswap.v1.ListPayoutsResponse.
2033
+ * Use `create(ListPayoutsResponseSchema)` to create a new message.
2034
+ */
2035
+ declare const ListPayoutsResponseSchema: GenMessage<ListPayoutsResponse>;
2036
+ /**
2037
+ * GetPayoutRequest reads one payout run of the broker's vaults.
2038
+ *
2039
+ * @generated from message swap.quickswap.v1.GetPayoutRequest
2040
+ */
2041
+ type GetPayoutRequest = Message<"swap.quickswap.v1.GetPayoutRequest"> & {
2042
+ /**
2043
+ * Broker name. A broker API key may name only its own broker.
2044
+ *
2045
+ * @generated from field: string broker = 1;
2046
+ */
2047
+ broker: string;
2048
+ /**
2049
+ * Public payout run ID. A run of another broker's vault is
2050
+ * indistinguishable from an unknown ID.
2051
+ *
2052
+ * @generated from field: fixed64 run_id = 2;
2053
+ */
2054
+ runId: bigint;
2055
+ };
2056
+ /**
2057
+ * Describes the message swap.quickswap.v1.GetPayoutRequest.
2058
+ * Use `create(GetPayoutRequestSchema)` to create a new message.
2059
+ */
2060
+ declare const GetPayoutRequestSchema: GenMessage<GetPayoutRequest>;
2061
+ /**
2062
+ * GetPayoutResponse carries the payout.
2063
+ *
2064
+ * @generated from message swap.quickswap.v1.GetPayoutResponse
2065
+ */
2066
+ type GetPayoutResponse = Message<"swap.quickswap.v1.GetPayoutResponse"> & {
2067
+ /**
2068
+ * The payout run.
2069
+ *
2070
+ * @generated from field: swap.quickswap.v1.Payout payout = 1;
2071
+ */
2072
+ payout?: Payout | undefined;
2073
+ };
2074
+ /**
2075
+ * Describes the message swap.quickswap.v1.GetPayoutResponse.
2076
+ * Use `create(GetPayoutResponseSchema)` to create a new message.
2077
+ */
2078
+ declare const GetPayoutResponseSchema: GenMessage<GetPayoutResponse>;
2079
+ /**
2080
+ * UpcomingPayoutAsset is what a vault's next payout run would do with one
2081
+ * asset, sized from the vault's balance now. Amounts are in base units of 18
2082
+ * decimals.
2083
+ *
2084
+ * @generated from message swap.quickswap.v1.UpcomingPayoutAsset
2085
+ */
2086
+ type UpcomingPayoutAsset = Message<"swap.quickswap.v1.UpcomingPayoutAsset"> & {
2087
+ /**
2088
+ * Asset, as an AssetConfig.ledger_id from
2089
+ * GET /v1/chain/deposit-withdraw/config.
2090
+ *
2091
+ * @generated from field: uint32 asset_id = 1;
2092
+ */
2093
+ assetId: number;
2094
+ /**
2095
+ * Destination chain identifier; zero when the rule has no destination for
2096
+ * the asset.
2097
+ *
2098
+ * @generated from field: uint64 destination_chain_id = 2;
2099
+ */
2100
+ destinationChainId: bigint;
2101
+ /**
2102
+ * Canonical destination address; empty when the rule has no destination
2103
+ * for the asset.
2104
+ *
2105
+ * @generated from field: string destination_address = 3;
2106
+ */
2107
+ destinationAddress: string;
2108
+ /**
2109
+ * The vault's available balance of the asset now.
2110
+ *
2111
+ * @generated from field: swap.quickswap.v1.TokenAmount available = 4;
2112
+ */
2113
+ available?: TokenAmount | undefined;
2114
+ /**
2115
+ * What the run would pay: the available balance up to the rule's per-run
2116
+ * ceiling, rounded down to whole units of the destination network, or zero
2117
+ * when it holds.
2118
+ *
2119
+ * @generated from field: swap.quickswap.v1.TokenAmount payable = 5;
2120
+ */
2121
+ payable?: TokenAmount | undefined;
2122
+ /**
2123
+ * What would stay in the vault: available minus payable.
2124
+ *
2125
+ * @generated from field: swap.quickswap.v1.TokenAmount held_back = 6;
2126
+ */
2127
+ heldBack?: TokenAmount | undefined;
2128
+ /**
2129
+ * Why held_back stays, or why nothing pays: below_minimum,
2130
+ * price_unavailable, no_destination (the rule pays no destination for the
2131
+ * asset), destination_cooling_down (the destination was added to the
2132
+ * vault's external withdraw whitelist less than 24 hours ago; see
2133
+ * payable_from), above_max (the balance above the per-run ceiling stays)
2134
+ * or dust (less than one whole unit of the destination network stays);
2135
+ * empty when the whole balance pays.
2136
+ *
2137
+ * @generated from field: string hold_reason = 7;
2138
+ */
2139
+ holdReason: string;
2140
+ /**
2141
+ * The least one payout of the asset pays: the destination's minimum, or
2142
+ * the least a withdrawal on its network pays now when that is higher.
2143
+ * Unset when the rule has no destination for the asset.
2144
+ *
2145
+ * @generated from field: swap.quickswap.v1.TokenAmount minimum = 8;
2146
+ */
2147
+ minimum?: TokenAmount | undefined;
2148
+ /**
2149
+ * USD value of what the asset would pay before its minimums, at the
2150
+ * current price as of priced_at; unset when no current price values it or
2151
+ * the rule has no destination for it.
2152
+ *
2153
+ * @generated from field: swap.quickswap.v1.TokenAmount value_usd = 9;
2154
+ */
2155
+ valueUsd?: TokenAmount | undefined;
2156
+ /**
2157
+ * When the price behind value_usd was observed; unset with it.
2158
+ *
2159
+ * @generated from field: google.protobuf.Timestamp priced_at = 10;
2160
+ */
2161
+ pricedAt?: Timestamp | undefined;
2162
+ /**
2163
+ * The network fee a payout to the destination is expected to be charged,
2164
+ * from the network's latest sampled fee: an estimate, not the fee charged
2165
+ * (PayoutStep.charged_network_fee). It is taken out of the payout. Unset
2166
+ * when the rule has no destination for the asset or the fee is not known
2167
+ * now.
2168
+ *
2169
+ * @generated from field: swap.quickswap.v1.TokenAmount estimated_network_fee = 11;
2170
+ */
2171
+ estimatedNetworkFee?: TokenAmount | undefined;
2172
+ /**
2173
+ * When estimated_network_fee was sampled; unset with it.
2174
+ *
2175
+ * @generated from field: google.protobuf.Timestamp estimated_network_fee_sampled_at = 12;
2176
+ */
2177
+ estimatedNetworkFeeSampledAt?: Timestamp | undefined;
2178
+ /**
2179
+ * Set only while the destination is cooling down (hold_reason
2180
+ * destination_cooling_down): when it can be paid, 24 hours after it was
2181
+ * added to the vault's external withdraw whitelist. Unset with that hold
2182
+ * reason when the time is not known yet.
2183
+ *
2184
+ * @generated from field: google.protobuf.Timestamp payable_from = 13;
2185
+ */
2186
+ payableFrom?: Timestamp | undefined;
2187
+ };
2188
+ /**
2189
+ * Describes the message swap.quickswap.v1.UpcomingPayoutAsset.
2190
+ * Use `create(UpcomingPayoutAssetSchema)` to create a new message.
2191
+ */
2192
+ declare const UpcomingPayoutAssetSchema: GenMessage<UpcomingPayoutAsset>;
2193
+ /**
2194
+ * UpcomingPayout previews one vault's next payout run from its balances now.
2195
+ * It plans exactly as the run does; balances, prices and fees can change
2196
+ * before the run starts.
2197
+ *
2198
+ * @generated from message swap.quickswap.v1.UpcomingPayout
2199
+ */
2200
+ type UpcomingPayout = Message<"swap.quickswap.v1.UpcomingPayout"> & {
2201
+ /**
2202
+ * Public sub-account ID of the vault.
2203
+ *
2204
+ * @generated from field: fixed64 vault_account_id = 1;
2205
+ */
2206
+ vaultAccountId: bigint;
2207
+ /**
2208
+ * Whether the next run would pay.
2209
+ *
2210
+ * @generated from field: chain.withdraw.v1.AutoWithdrawPreviewStatus status = 2;
2211
+ */
2212
+ status: AutoWithdrawPreviewStatus;
2213
+ /**
2214
+ * When the next run starts: its UTC slot, or, while a due slot waits to
2215
+ * start, that slot. For an hourly rule, the next hourly check. Unset when
2216
+ * the vault has no rule or the rule is paused.
2217
+ *
2218
+ * @generated from field: google.protobuf.Timestamp next_run_at = 3;
2219
+ */
2220
+ nextRunAt?: Timestamp | undefined;
2221
+ /**
2222
+ * The rule's latest version; zero when the vault has no rule.
2223
+ *
2224
+ * @generated from field: uint32 rule_version = 4;
2225
+ */
2226
+ ruleVersion: number;
2227
+ /**
2228
+ * Set when the rule paused itself; a rule paused by a member has none.
2229
+ *
2230
+ * @generated from field: chain.withdraw.v1.AutoWithdrawPause pause = 5;
2231
+ */
2232
+ pause?: AutoWithdrawPause | undefined;
2233
+ /**
2234
+ * The rule's least USD value of one payout, in base units of 18 decimals;
2235
+ * unset when the vault has no rule or the rule has no USD minimum.
2236
+ *
2237
+ * @generated from field: swap.quickswap.v1.TokenAmount min_usd_value = 6;
2238
+ */
2239
+ minUsdValue?: TokenAmount | undefined;
2240
+ /**
2241
+ * One entry per destination of the rule, then per other asset with a
2242
+ * positive balance, in asset_id order. Empty when the vault has no rule or
2243
+ * the rule is paused.
2244
+ *
2245
+ * @generated from field: repeated swap.quickswap.v1.UpcomingPayoutAsset assets = 7;
2246
+ */
2247
+ assets: UpcomingPayoutAsset[];
2248
+ /**
2249
+ * When the balances, prices and fees this preview used were read.
2250
+ *
2251
+ * @generated from field: google.protobuf.Timestamp computed_at = 8;
2252
+ */
2253
+ computedAt?: Timestamp | undefined;
2254
+ };
2255
+ /**
2256
+ * Describes the message swap.quickswap.v1.UpcomingPayout.
2257
+ * Use `create(UpcomingPayoutSchema)` to create a new message.
2258
+ */
2259
+ declare const UpcomingPayoutSchema: GenMessage<UpcomingPayout>;
2260
+ /**
2261
+ * ListUpcomingPayoutsRequest previews the next payout run of the broker's
2262
+ * vaults.
2263
+ *
2264
+ * @generated from message swap.quickswap.v1.ListUpcomingPayoutsRequest
2265
+ */
2266
+ type ListUpcomingPayoutsRequest = Message<"swap.quickswap.v1.ListUpcomingPayoutsRequest"> & {
2267
+ /**
2268
+ * Broker name. A broker API key may name only its own broker.
2269
+ *
2270
+ * @generated from field: string broker = 1;
2271
+ */
2272
+ broker: string;
2273
+ /**
2274
+ * Public vault sub-account ID. Omit to include every vault, including
2275
+ * disabled affiliates. A root account or another broker's vault is
2276
+ * NOT_FOUND.
2277
+ *
2278
+ * @generated from field: fixed64 vault_account_id = 2;
2279
+ */
2280
+ vaultAccountId: bigint;
2281
+ /**
2282
+ * Maximum vaults, default 20, max 200.
2283
+ *
2284
+ * @generated from field: uint32 limit = 3;
2285
+ */
2286
+ limit: number;
2287
+ /**
2288
+ * Opaque exclusive keyset cursor, bound to the broker and vault filter.
2289
+ * Reuse with the same broker and vault_account_id; limit may change.
2290
+ *
2291
+ * @generated from field: string page_token = 4;
2292
+ */
2293
+ pageToken: string;
2294
+ };
2295
+ /**
2296
+ * Describes the message swap.quickswap.v1.ListUpcomingPayoutsRequest.
2297
+ * Use `create(ListUpcomingPayoutsRequestSchema)` to create a new message.
2298
+ */
2299
+ declare const ListUpcomingPayoutsRequestSchema: GenMessage<ListUpcomingPayoutsRequest>;
2300
+ /**
2301
+ * ListUpcomingPayoutsResponse lists vaults in ascending account creation-ID
2302
+ * order, as ListVaultBalances does. A vault whose preview cannot be read
2303
+ * fails the entire page; it is never shown as having nothing to pay.
2304
+ *
2305
+ * @generated from message swap.quickswap.v1.ListUpcomingPayoutsResponse
2306
+ */
2307
+ type ListUpcomingPayoutsResponse = Message<"swap.quickswap.v1.ListUpcomingPayoutsResponse"> & {
2308
+ /**
2309
+ * One preview per vault, at most limit vaults, vaults without a rule
2310
+ * included.
2311
+ *
2312
+ * @generated from field: repeated swap.quickswap.v1.UpcomingPayout upcoming_payouts = 1;
2313
+ */
2314
+ upcomingPayouts: UpcomingPayout[];
2315
+ /**
2316
+ * Opaque exclusive keyset cursor. Empty when no more results exist.
2317
+ *
2318
+ * @generated from field: string next_page_token = 2;
2319
+ */
2320
+ nextPageToken: string;
2321
+ };
2322
+ /**
2323
+ * Describes the message swap.quickswap.v1.ListUpcomingPayoutsResponse.
2324
+ * Use `create(ListUpcomingPayoutsResponseSchema)` to create a new message.
2325
+ */
2326
+ declare const ListUpcomingPayoutsResponseSchema: GenMessage<ListUpcomingPayoutsResponse>;
2327
+ /**
2328
+ * PayoutRuleDestination pays one asset of a vault, in kind, to one address.
2329
+ * Amounts are in base units of 18 decimals.
2330
+ *
2331
+ * @generated from message swap.quickswap.v1.PayoutRuleDestination
2332
+ */
2333
+ type PayoutRuleDestination = Message<"swap.quickswap.v1.PayoutRuleDestination"> & {
2334
+ /**
2335
+ * Asset paid, as an AssetConfig.ledger_id from
2336
+ * GET /v1/chain/deposit-withdraw/config.
2337
+ *
2338
+ * @generated from field: uint32 asset_id = 1;
2339
+ */
2340
+ assetId: number;
2341
+ /**
2342
+ * Destination chain identifier.
1555
2343
  *
1556
- * @generated from field: google.protobuf.Timestamp period_start = 1;
2344
+ * @generated from field: uint64 destination_chain_id = 2;
1557
2345
  */
1558
- periodStart?: Timestamp | undefined;
2346
+ destinationChainId: bigint;
1559
2347
  /**
1560
- * QuickSwaps created in the period, inside the window.
2348
+ * Canonical destination address.
1561
2349
  *
1562
- * @generated from field: uint64 created_count = 2;
2350
+ * @generated from field: string destination_address = 3;
1563
2351
  */
1564
- createdCount: bigint;
2352
+ destinationAddress: string;
1565
2353
  /**
1566
- * Those QuickSwaps by current status, in QuickSwapStatus number order;
1567
- * statuses with none are omitted. The counts total created_count.
2354
+ * A run pays the asset only when the payable amount reaches this minimum.
1568
2355
  *
1569
- * @generated from field: repeated swap.quickswap.v1.StatusCount statuses = 3;
2356
+ * @generated from field: swap.quickswap.v1.TokenAmount min_amount = 4;
1570
2357
  */
1571
- statuses: StatusCount[];
2358
+ minAmount?: TokenAmount | undefined;
1572
2359
  /**
1573
- * Deposits credited to those QuickSwaps and taken in for execution, per
1574
- * asset, in asset_id order: including a deposit later found ineligible
1575
- * and returned, excluding a deposit held for review before credit.
2360
+ * The most one run pays the asset; the rest stays in the vault.
1576
2361
  *
1577
- * @generated from field: repeated swap.quickswap.v1.AssetVolume deposited = 4;
2362
+ * @generated from field: swap.quickswap.v1.TokenAmount max_amount = 5;
1578
2363
  */
1579
- deposited: AssetVolume[];
2364
+ maxAmount?: TokenAmount | undefined;
1580
2365
  /**
1581
- * Paid to the destination of those QuickSwaps whose DESTINATION
1582
- * withdrawal is FINALIZED, per asset, in asset_id order: after service,
1583
- * broker and affiliate fees, before the destination network fee.
2366
+ * The least one payout to this destination can pay now: the network's
2367
+ * withdrawal minimum, and more than its current network fee. It follows
2368
+ * the network fee. Unset when the network or its fee is not known now.
1584
2369
  *
1585
- * @generated from field: repeated swap.quickswap.v1.AssetVolume delivered = 5;
2370
+ * @generated from field: swap.quickswap.v1.TokenAmount min_floor = 6;
1586
2371
  */
1587
- delivered: AssetVolume[];
2372
+ minFloor?: TokenAmount | undefined;
1588
2373
  /**
1589
- * Fees charged to the broker's QuickSwaps in the period, per asset, in
1590
- * asset_id order. broker_fee plus affiliate_fee equals the GetFeeTotals
1591
- * total of the same window, period and asset.
2374
+ * The network fee a payout to this destination is expected to be charged,
2375
+ * from the network's latest sampled fee: an estimate, not the fee charged
2376
+ * (PayoutStep.charged_network_fee). Unset when it is not known now.
1592
2377
  *
1593
- * @generated from field: repeated swap.quickswap.v1.FeeSplit fees = 6;
2378
+ * @generated from field: swap.quickswap.v1.TokenAmount estimated_network_fee = 7;
1594
2379
  */
1595
- fees: FeeSplit[];
2380
+ estimatedNetworkFee?: TokenAmount | undefined;
2381
+ /**
2382
+ * When estimated_network_fee was sampled; unset with it.
2383
+ *
2384
+ * @generated from field: google.protobuf.Timestamp estimated_network_fee_sampled_at = 8;
2385
+ */
2386
+ estimatedNetworkFeeSampledAt?: Timestamp | undefined;
1596
2387
  };
1597
2388
  /**
1598
- * Describes the message swap.quickswap.v1.BrokerStatsPeriod.
1599
- * Use `create(BrokerStatsPeriodSchema)` to create a new message.
2389
+ * Describes the message swap.quickswap.v1.PayoutRuleDestination.
2390
+ * Use `create(PayoutRuleDestinationSchema)` to create a new message.
1600
2391
  */
1601
- declare const BrokerStatsPeriodSchema: GenMessage<BrokerStatsPeriod>;
2392
+ declare const PayoutRuleDestinationSchema: GenMessage<PayoutRuleDestination>;
1602
2393
  /**
1603
- * GetBrokerStatsResponse lists every period of the window with a QuickSwap
1604
- * created or a fee charged, oldest first, complete (the window is bounded).
1605
- * Periods with neither are omitted.
2394
+ * AssetWithoutDestination is an asset a vault holds or was ever credited
2395
+ * in, which its rule pays no destination for, so no run pays it out.
1606
2396
  *
1607
- * @generated from message swap.quickswap.v1.GetBrokerStatsResponse
2397
+ * @generated from message swap.quickswap.v1.AssetWithoutDestination
1608
2398
  */
1609
- type GetBrokerStatsResponse = Message<"swap.quickswap.v1.GetBrokerStatsResponse"> & {
2399
+ type AssetWithoutDestination = Message<"swap.quickswap.v1.AssetWithoutDestination"> & {
1610
2400
  /**
1611
- * The periods.
2401
+ * Asset, as an AssetConfig.ledger_id from
2402
+ * GET /v1/chain/deposit-withdraw/config.
1612
2403
  *
1613
- * @generated from field: repeated swap.quickswap.v1.BrokerStatsPeriod periods = 1;
2404
+ * @generated from field: uint32 asset_id = 1;
1614
2405
  */
1615
- periods: BrokerStatsPeriod[];
2406
+ assetId: number;
2407
+ /**
2408
+ * The vault's settled balance of the asset now, as ListVaultBalances
2409
+ * reports it, in base units of 18 decimals; zero when everything it was
2410
+ * credited has left the vault.
2411
+ *
2412
+ * @generated from field: swap.quickswap.v1.TokenAmount balance = 2;
2413
+ */
2414
+ balance?: TokenAmount | undefined;
1616
2415
  };
1617
2416
  /**
1618
- * Describes the message swap.quickswap.v1.GetBrokerStatsResponse.
1619
- * Use `create(GetBrokerStatsResponseSchema)` to create a new message.
2417
+ * Describes the message swap.quickswap.v1.AssetWithoutDestination.
2418
+ * Use `create(AssetWithoutDestinationSchema)` to create a new message.
1620
2419
  */
1621
- declare const GetBrokerStatsResponseSchema: GenMessage<GetBrokerStatsResponse>;
2420
+ declare const AssetWithoutDestinationSchema: GenMessage<AssetWithoutDestination>;
1622
2421
  /**
1623
- * ListVaultBalancesRequest selects a broker's default and affiliate vaults.
2422
+ * VaultPayoutRule is one broker vault's payout rule and the assets it leaves
2423
+ * in the vault.
1624
2424
  *
1625
- * @generated from message swap.quickswap.v1.ListVaultBalancesRequest
2425
+ * @generated from message swap.quickswap.v1.VaultPayoutRule
1626
2426
  */
1627
- type ListVaultBalancesRequest = Message<"swap.quickswap.v1.ListVaultBalancesRequest"> & {
2427
+ type VaultPayoutRule = Message<"swap.quickswap.v1.VaultPayoutRule"> & {
1628
2428
  /**
1629
- * Broker name.
2429
+ * Public sub-account ID of the vault.
1630
2430
  *
1631
- * @generated from field: string broker = 1;
2431
+ * @generated from field: fixed64 vault_account_id = 1;
1632
2432
  */
1633
- broker: string;
2433
+ vaultAccountId: bigint;
1634
2434
  /**
1635
- * Public vault subaccount ID. Omit to include every vault, including disabled
1636
- * affiliates. A root account or another broker's vault is NOT_FOUND.
2435
+ * The rule's latest version; zero when the vault has no rule, and every
2436
+ * other rule field is then unset.
1637
2437
  *
1638
- * @generated from field: fixed64 vault_account_id = 2;
2438
+ * @generated from field: uint32 rule_version = 2;
1639
2439
  */
1640
- vaultAccountId: bigint;
2440
+ ruleVersion: number;
1641
2441
  /**
1642
- * Maximum vaults, default 20, max 200.
2442
+ * Whether the rule runs: it runs only while enabled and without a pause.
1643
2443
  *
1644
- * @generated from field: uint32 limit = 3;
2444
+ * @generated from field: bool enabled = 3;
1645
2445
  */
1646
- limit: number;
2446
+ enabled: boolean;
1647
2447
  /**
1648
- * Opaque exclusive keyset cursor, bound to the broker and vault filter.
1649
- * Reuse with the same broker and vault_account_id; limit may change.
2448
+ * When the rule runs.
1650
2449
  *
1651
- * @generated from field: string page_token = 4;
2450
+ * @generated from field: chain.withdraw.v1.AutoWithdrawSchedule schedule = 4;
1652
2451
  */
1653
- pageToken: string;
1654
- };
1655
- /**
1656
- * Describes the message swap.quickswap.v1.ListVaultBalancesRequest.
1657
- * Use `create(ListVaultBalancesRequestSchema)` to create a new message.
1658
- */
1659
- declare const ListVaultBalancesRequestSchema: GenMessage<ListVaultBalancesRequest>;
1660
- /**
1661
- * VaultAssetBalance is the current posted balance in one asset.
1662
- *
1663
- * @generated from message swap.quickswap.v1.VaultAssetBalance
1664
- */
1665
- type VaultAssetBalance = Message<"swap.quickswap.v1.VaultAssetBalance"> & {
2452
+ schedule?: AutoWithdrawSchedule | undefined;
1666
2453
  /**
1667
- * Unified asset ID, including assets no longer enabled for new swaps.
2454
+ * One destination per paid asset, in asset_id order.
1668
2455
  *
1669
- * @generated from field: uint32 asset_id = 1;
2456
+ * @generated from field: repeated swap.quickswap.v1.PayoutRuleDestination destinations = 5;
1670
2457
  */
1671
- assetId: number;
2458
+ destinations: PayoutRuleDestination[];
1672
2459
  /**
1673
- * Settled balance of the vault's Funding and Trading accounts, at 18 decimals.
1674
- * Pending credits are excluded. This is not a withdrawability guarantee.
2460
+ * Set when the rule paused itself; an Owner or Finance member resumes it.
1675
2461
  *
1676
- * @generated from field: swap.quickswap.v1.TokenAmount amount = 2;
2462
+ * @generated from field: chain.withdraw.v1.AutoWithdrawPause pause = 6;
1677
2463
  */
1678
- amount?: TokenAmount | undefined;
2464
+ pause?: AutoWithdrawPause | undefined;
1679
2465
  /**
1680
- * Funds committed to pending outgoing transfers, at 18 decimals. amount
1681
- * still counts these funds and has NOT been reduced by pending_outgoing.
1682
- * amount minus pending_outgoing is the balance not yet committed to an
1683
- * outgoing transfer. This excludes order holds and is not a withdrawability guarantee.
2466
+ * Least USD value one payout of the rule pays, in base units of 18
2467
+ * decimals; unset when the rule has no USD minimum.
1684
2468
  *
1685
- * @generated from field: swap.quickswap.v1.TokenAmount pending_outgoing = 3;
2469
+ * @generated from field: swap.quickswap.v1.TokenAmount min_usd_value = 7;
1686
2470
  */
1687
- pendingOutgoing?: TokenAmount | undefined;
2471
+ minUsdValue?: TokenAmount | undefined;
2472
+ /**
2473
+ * When the rule's latest version was set.
2474
+ *
2475
+ * @generated from field: google.protobuf.Timestamp updated_at = 8;
2476
+ */
2477
+ updatedAt?: Timestamp | undefined;
2478
+ /**
2479
+ * Every asset the vault holds or was ever credited in that the rule pays
2480
+ * no destination for, in asset_id order; every such asset when the vault
2481
+ * has no rule.
2482
+ *
2483
+ * @generated from field: repeated swap.quickswap.v1.AssetWithoutDestination assets_without_destination = 9;
2484
+ */
2485
+ assetsWithoutDestination: AssetWithoutDestination[];
1688
2486
  };
1689
2487
  /**
1690
- * Describes the message swap.quickswap.v1.VaultAssetBalance.
1691
- * Use `create(VaultAssetBalanceSchema)` to create a new message.
2488
+ * Describes the message swap.quickswap.v1.VaultPayoutRule.
2489
+ * Use `create(VaultPayoutRuleSchema)` to create a new message.
1692
2490
  */
1693
- declare const VaultAssetBalanceSchema: GenMessage<VaultAssetBalance>;
2491
+ declare const VaultPayoutRuleSchema: GenMessage<VaultPayoutRule>;
1694
2492
  /**
1695
- * VaultBalance is one vault's current balance observation.
2493
+ * ListVaultPayoutRulesRequest reads the payout rules of the broker's vaults.
1696
2494
  *
1697
- * @generated from message swap.quickswap.v1.VaultBalance
2495
+ * @generated from message swap.quickswap.v1.ListVaultPayoutRulesRequest
1698
2496
  */
1699
- type VaultBalance = Message<"swap.quickswap.v1.VaultBalance"> & {
2497
+ type ListVaultPayoutRulesRequest = Message<"swap.quickswap.v1.ListVaultPayoutRulesRequest"> & {
1700
2498
  /**
1701
- * Public vault subaccount ID.
2499
+ * Broker name. A broker API key may name only its own broker.
1702
2500
  *
1703
- * @generated from field: fixed64 vault_account_id = 1;
2501
+ * @generated from field: string broker = 1;
2502
+ */
2503
+ broker: string;
2504
+ /**
2505
+ * Public vault sub-account ID. Omit to include every vault, including
2506
+ * disabled affiliates. A root account or another broker's vault is
2507
+ * NOT_FOUND.
2508
+ *
2509
+ * @generated from field: fixed64 vault_account_id = 2;
1704
2510
  */
1705
2511
  vaultAccountId: bigint;
1706
2512
  /**
1707
- * Asset balances in ascending asset_id order. Empty for an unfunded vault.
2513
+ * Maximum vaults, default 20, max 200.
1708
2514
  *
1709
- * @generated from field: repeated swap.quickswap.v1.VaultAssetBalance assets = 2;
2515
+ * @generated from field: uint32 limit = 3;
1710
2516
  */
1711
- assets: VaultAssetBalance[];
2517
+ limit: number;
1712
2518
  /**
1713
- * UTC time this vault's balance read completed. Vaults are read separately;
1714
- * this does not describe an atomic snapshot across vaults or pages.
2519
+ * Opaque exclusive keyset cursor, bound to the broker and vault filter.
2520
+ * Reuse with the same broker and vault_account_id; limit may change.
1715
2521
  *
1716
- * @generated from field: google.protobuf.Timestamp as_of = 3;
2522
+ * @generated from field: string page_token = 4;
1717
2523
  */
1718
- asOf?: Timestamp | undefined;
2524
+ pageToken: string;
1719
2525
  };
1720
2526
  /**
1721
- * Describes the message swap.quickswap.v1.VaultBalance.
1722
- * Use `create(VaultBalanceSchema)` to create a new message.
2527
+ * Describes the message swap.quickswap.v1.ListVaultPayoutRulesRequest.
2528
+ * Use `create(ListVaultPayoutRulesRequestSchema)` to create a new message.
1723
2529
  */
1724
- declare const VaultBalanceSchema: GenMessage<VaultBalance>;
2530
+ declare const ListVaultPayoutRulesRequestSchema: GenMessage<ListVaultPayoutRulesRequest>;
1725
2531
  /**
1726
- * ListVaultBalancesResponse lists vaults in ascending account creation-ID
1727
- * order, independent of their encoded public IDs. A failed balance read fails
1728
- * the entire page; it is never represented as a zero balance.
2532
+ * ListVaultPayoutRulesResponse lists vaults in ascending account
2533
+ * creation-ID order, as ListVaultBalances does. A failed read fails the
2534
+ * entire page.
1729
2535
  *
1730
- * @generated from message swap.quickswap.v1.ListVaultBalancesResponse
2536
+ * @generated from message swap.quickswap.v1.ListVaultPayoutRulesResponse
1731
2537
  */
1732
- type ListVaultBalancesResponse = Message<"swap.quickswap.v1.ListVaultBalancesResponse"> & {
2538
+ type ListVaultPayoutRulesResponse = Message<"swap.quickswap.v1.ListVaultPayoutRulesResponse"> & {
1733
2539
  /**
1734
- * Default and affiliate vault balances, at most limit vaults.
2540
+ * One entry per vault, at most limit vaults, vaults without a rule
2541
+ * included.
1735
2542
  *
1736
- * @generated from field: repeated swap.quickswap.v1.VaultBalance vaults = 1;
2543
+ * @generated from field: repeated swap.quickswap.v1.VaultPayoutRule rules = 1;
1737
2544
  */
1738
- vaults: VaultBalance[];
2545
+ rules: VaultPayoutRule[];
1739
2546
  /**
1740
2547
  * Opaque exclusive keyset cursor. Empty when no more results exist.
1741
2548
  *
@@ -1744,10 +2551,10 @@ type ListVaultBalancesResponse = Message<"swap.quickswap.v1.ListVaultBalancesRes
1744
2551
  nextPageToken: string;
1745
2552
  };
1746
2553
  /**
1747
- * Describes the message swap.quickswap.v1.ListVaultBalancesResponse.
1748
- * Use `create(ListVaultBalancesResponseSchema)` to create a new message.
2554
+ * Describes the message swap.quickswap.v1.ListVaultPayoutRulesResponse.
2555
+ * Use `create(ListVaultPayoutRulesResponseSchema)` to create a new message.
1749
2556
  */
1750
- declare const ListVaultBalancesResponseSchema: GenMessage<ListVaultBalancesResponse>;
2557
+ declare const ListVaultPayoutRulesResponseSchema: GenMessage<ListVaultPayoutRulesResponse>;
1751
2558
  /**
1752
2559
  * BrokerRole is a person's role in a broker org. A broker has exactly one
1753
2560
  * Owner.
@@ -1762,13 +2569,16 @@ declare enum BrokerRole {
1762
2569
  */
1763
2570
  BROKER_ROLE_UNSPECIFIED = 0,
1764
2571
  /**
1765
- * Everything, including transferring ownership. Exactly one per broker.
2572
+ * Everything, including withdrawals, payout settings and transferring
2573
+ * ownership. Exactly one per broker.
1766
2574
  *
1767
2575
  * @generated from enum value: OWNER = 1;
1768
2576
  */
1769
2577
  OWNER = 1,
1770
2578
  /**
1771
- * Everything except changing the Owner or transferring ownership.
2579
+ * Everything except withdrawals, payout settings, changing the Owner and
2580
+ * transferring ownership: only the Owner and Finance withdraw or change
2581
+ * payout settings.
1772
2582
  *
1773
2583
  * @generated from enum value: ADMIN = 2;
1774
2584
  */
@@ -1890,6 +2700,179 @@ declare enum StatsPeriod {
1890
2700
  * Describes the enum swap.quickswap.v1.StatsPeriod.
1891
2701
  */
1892
2702
  declare const StatsPeriodSchema: GenEnum<StatsPeriod>;
2703
+ /**
2704
+ * PayoutStatus is what one payout run of a broker vault came to, from the
2705
+ * run and the outcome of each of its assets.
2706
+ *
2707
+ * @generated from enum swap.quickswap.v1.PayoutStatus
2708
+ */
2709
+ declare enum PayoutStatus {
2710
+ /**
2711
+ * Never returned; rejected in filters.
2712
+ *
2713
+ * @generated from enum value: PAYOUT_STATUS_UNSPECIFIED = 0;
2714
+ */
2715
+ PAYOUT_STATUS_UNSPECIFIED = 0,
2716
+ /**
2717
+ * The run paid: every asset with a payable amount was withdrawn and its
2718
+ * withdrawal completed on its destination network.
2719
+ *
2720
+ * @generated from enum value: PAYOUT_PAID = 1;
2721
+ */
2722
+ PAYOUT_PAID = 1,
2723
+ /**
2724
+ * Some assets were paid and at least one failed; reason is the first
2725
+ * failed asset's, and each step shows its own outcome.
2726
+ *
2727
+ * @generated from enum value: PAYOUT_PARTIALLY_PAID = 2;
2728
+ */
2729
+ PAYOUT_PARTIALLY_PAID = 2,
2730
+ /**
2731
+ * The run is under way; stage says where.
2732
+ *
2733
+ * @generated from enum value: PAYOUT_IN_PROGRESS = 3;
2734
+ */
2735
+ PAYOUT_IN_PROGRESS = 3,
2736
+ /**
2737
+ * Nothing was paid, and the balance stays in the vault for the next run.
2738
+ * reason is nothing_to_pay (no asset reached its minimum), below_minimum
2739
+ * (an amount was below the least a withdrawal on its network pays),
2740
+ * price_unavailable (the rule has a USD minimum and no current price
2741
+ * valued an asset) or destination_cooling_down (the destination was added
2742
+ * to the vault's external withdraw whitelist less than 24 hours ago). Each
2743
+ * step carries the balance evaluated, its value and the minimum it was
2744
+ * held to.
2745
+ *
2746
+ * @generated from enum value: PAYOUT_ROLLED_OVER = 4;
2747
+ */
2748
+ PAYOUT_ROLLED_OVER = 4,
2749
+ /**
2750
+ * Nothing was paid because the rule stopped paying, and the balance stays
2751
+ * in the vault. reason is rule_superseded (the rule was paused, changed or
2752
+ * replaced before the run paid), or destination_not_whitelisted,
2753
+ * destination_invalid or authority_revoked, with which the rule paused
2754
+ * itself (see VaultPayoutRule.pause); an Owner or Finance member resumes
2755
+ * it.
2756
+ *
2757
+ * @generated from enum value: PAYOUT_HELD = 5;
2758
+ */
2759
+ PAYOUT_HELD = 5,
2760
+ /**
2761
+ * Nothing was paid, and at least one asset's payout failed; reason is the
2762
+ * first failure's: withdrawal_refused (refused before any funds left the
2763
+ * vault), gateway_capacity_insufficient (the funds stay for a later run),
2764
+ * withdrawal_released (released before it was sent; nothing left the
2765
+ * vault) or withdrawal_failed (the withdrawal ended without paying, before
2766
+ * or after it reached the destination network). Where the funds of a
2767
+ * withdrawal_failed payout are now is not shown yet. The step's tx_hash,
2768
+ * when set, is its destination-network transaction.
2769
+ *
2770
+ * @generated from enum value: PAYOUT_FAILED = 6;
2771
+ */
2772
+ PAYOUT_FAILED = 6
2773
+ }
2774
+ /**
2775
+ * Describes the enum swap.quickswap.v1.PayoutStatus.
2776
+ */
2777
+ declare const PayoutStatusSchema: GenEnum<PayoutStatus>;
2778
+ /**
2779
+ * PayoutStage is where an in-progress payout run stands.
2780
+ *
2781
+ * @generated from enum swap.quickswap.v1.PayoutStage
2782
+ */
2783
+ declare enum PayoutStage {
2784
+ /**
2785
+ * Not in progress.
2786
+ *
2787
+ * @generated from enum value: PAYOUT_STAGE_UNSPECIFIED = 0;
2788
+ */
2789
+ PAYOUT_STAGE_UNSPECIFIED = 0,
2790
+ /**
2791
+ * Reading the vault's balances to size the payouts.
2792
+ *
2793
+ * @generated from enum value: STAGE_PLANNING = 1;
2794
+ */
2795
+ STAGE_PLANNING = 1,
2796
+ /**
2797
+ * A payout is waiting to be requested or being requested.
2798
+ *
2799
+ * @generated from enum value: STAGE_REQUESTING = 2;
2800
+ */
2801
+ STAGE_REQUESTING = 2,
2802
+ /**
2803
+ * Every payout due was accepted; no destination-network transaction is
2804
+ * known yet.
2805
+ *
2806
+ * @generated from enum value: STAGE_PROCESSING = 3;
2807
+ */
2808
+ STAGE_PROCESSING = 3,
2809
+ /**
2810
+ * A destination-network transaction is known (PayoutStep.tx_hash); the run
2811
+ * waits for its withdrawals to complete.
2812
+ *
2813
+ * @generated from enum value: STAGE_BROADCAST = 4;
2814
+ */
2815
+ STAGE_BROADCAST = 4
2816
+ }
2817
+ /**
2818
+ * Describes the enum swap.quickswap.v1.PayoutStage.
2819
+ */
2820
+ declare const PayoutStageSchema: GenEnum<PayoutStage>;
2821
+ /**
2822
+ * PayoutStepState is where one asset's payout in a run stands.
2823
+ *
2824
+ * @generated from enum swap.quickswap.v1.PayoutStepState
2825
+ */
2826
+ declare enum PayoutStepState {
2827
+ /**
2828
+ * Never returned.
2829
+ *
2830
+ * @generated from enum value: PAYOUT_STEP_STATE_UNSPECIFIED = 0;
2831
+ */
2832
+ PAYOUT_STEP_STATE_UNSPECIFIED = 0,
2833
+ /**
2834
+ * Planned; not yet requested.
2835
+ *
2836
+ * @generated from enum value: PAYOUT_STEP_PENDING = 1;
2837
+ */
2838
+ PAYOUT_STEP_PENDING = 1,
2839
+ /**
2840
+ * Being requested.
2841
+ *
2842
+ * @generated from enum value: PAYOUT_STEP_REQUESTING = 2;
2843
+ */
2844
+ PAYOUT_STEP_REQUESTING = 2,
2845
+ /**
2846
+ * The withdrawal was accepted and waits to complete on its destination
2847
+ * network.
2848
+ *
2849
+ * @generated from enum value: PAYOUT_STEP_SUBMITTED = 3;
2850
+ */
2851
+ PAYOUT_STEP_SUBMITTED = 3,
2852
+ /**
2853
+ * The withdrawal completed on its destination network.
2854
+ *
2855
+ * @generated from enum value: PAYOUT_STEP_COMPLETED = 4;
2856
+ */
2857
+ PAYOUT_STEP_COMPLETED = 4,
2858
+ /**
2859
+ * The payout failed; reason says why (see PAYOUT_FAILED).
2860
+ *
2861
+ * @generated from enum value: PAYOUT_STEP_FAILED = 5;
2862
+ */
2863
+ PAYOUT_STEP_FAILED = 5,
2864
+ /**
2865
+ * Nothing was paid for this asset in this run; reason says why, and the
2866
+ * balance stays in the vault.
2867
+ *
2868
+ * @generated from enum value: PAYOUT_STEP_SKIPPED = 6;
2869
+ */
2870
+ PAYOUT_STEP_SKIPPED = 6
2871
+ }
2872
+ /**
2873
+ * Describes the enum swap.quickswap.v1.PayoutStepState.
2874
+ */
2875
+ declare const PayoutStepStateSchema: GenEnum<PayoutStepState>;
1893
2876
  /**
1894
2877
  * QuickSwapBrokerService administers a broker org, over ConnectRPC and REST.
1895
2878
  * Every request names its broker. The caller is either the broker's API key,
@@ -1899,7 +2882,7 @@ declare const StatsPeriodSchema: GenEnum<StatsPeriod>;
1899
2882
  *
1900
2883
  * | Action | Owner | Admin | Finance | Affiliate manager | Viewer | API key |
1901
2884
  * | --- | --- | --- | --- | --- | --- | --- |
1902
- * | Read (GetBroker, ListKeys, ListVaults, GetVault, ListMembers, ListQuickSwaps, GetQuickSwap, GetFeeTotals, GetBrokerStats, ListVaultBalances) | yes | yes | yes | yes | yes | yes, except ListMembers |
2885
+ * | Read (GetBroker, ListKeys, ListVaults, GetVault, ListMembers, ListQuickSwaps, GetQuickSwap, GetFeeTotals, GetBrokerStats, ListVaultBalances, ListPayouts, GetPayout, ListUpcomingPayouts, ListVaultPayoutRules) | yes | yes | yes | yes | yes | yes, except ListMembers |
1903
2886
  * | Create vaults (CreateAffiliateVault, SetVaultStatus) | yes | yes | no | yes | no | yes |
1904
2887
  * | Manage keys (CreateKey, RotateKey, RevokeKey) | yes | yes | no | no | no | RotateKey of itself only |
1905
2888
  * | Manage members (InviteMember, SetMemberRole, RemoveMember) | yes | yes, never the Owner | no | no | no | no |
@@ -2229,8 +3212,8 @@ declare const QuickSwapBrokerService: GenService<{
2229
3212
  /**
2230
3213
  * GetBrokerStats reads the broker's QuickSwap activity in a window, per UTC
2231
3214
  * day or month: QuickSwaps created by status, deposits credited and
2232
- * payouts delivered per asset, and the service, broker and affiliate fees
2233
- * charged per asset.
3215
+ * payouts delivered per asset, and the service, broker, affiliate and
3216
+ * referral fees charged per asset.
2234
3217
  *
2235
3218
  * Errors:
2236
3219
  * - NOT_FOUND: BROKER_NOT_FOUND.
@@ -2244,7 +3227,83 @@ declare const QuickSwapBrokerService: GenService<{
2244
3227
  input: typeof GetBrokerStatsRequestSchema;
2245
3228
  output: typeof GetBrokerStatsResponseSchema;
2246
3229
  };
3230
+ /**
3231
+ * ListPayouts lists the payout runs of the broker's vaults, newest first,
3232
+ * filtered by vault, status and scheduled slot. Every broker role and the
3233
+ * broker's API keys can read, without step-up.
3234
+ *
3235
+ * Errors:
3236
+ * - NOT_FOUND: BROKER_NOT_FOUND, or VAULT_NOT_FOUND for a vault that is
3237
+ * not the broker's.
3238
+ * - INVALID_ARGUMENT: a page_token from another broker, other filters or
3239
+ * malformed.
3240
+ * - UNAVAILABLE: the payouts cannot be read; retry the same request.
3241
+ *
3242
+ * @generated from rpc swap.quickswap.v1.QuickSwapBrokerService.ListPayouts
3243
+ */
3244
+ listPayouts: {
3245
+ methodKind: "unary";
3246
+ input: typeof ListPayoutsRequestSchema;
3247
+ output: typeof ListPayoutsResponseSchema;
3248
+ };
3249
+ /**
3250
+ * GetPayout reads one payout run of the broker's vaults, for a detail view
3251
+ * or a link from a ledger entry. Every broker role and the broker's API
3252
+ * keys can read, without step-up.
3253
+ *
3254
+ * Errors:
3255
+ * - NOT_FOUND: BROKER_NOT_FOUND, or PAYOUT_NOT_FOUND, including a run of
3256
+ * another broker's vault.
3257
+ * - UNAVAILABLE: the payout cannot be read; retry the same request.
3258
+ *
3259
+ * @generated from rpc swap.quickswap.v1.QuickSwapBrokerService.GetPayout
3260
+ */
3261
+ getPayout: {
3262
+ methodKind: "unary";
3263
+ input: typeof GetPayoutRequestSchema;
3264
+ output: typeof GetPayoutResponseSchema;
3265
+ };
3266
+ /**
3267
+ * ListUpcomingPayouts previews the next payout run of each of the
3268
+ * broker's vaults from its balances now: when it starts, whether it would
3269
+ * pay, and per asset what it would pay, what would stay and why, and the
3270
+ * expected network fee. Every broker role and the broker's API keys can
3271
+ * read, without step-up.
3272
+ *
3273
+ * Errors:
3274
+ * - NOT_FOUND: BROKER_NOT_FOUND or VAULT_NOT_FOUND.
3275
+ * - INVALID_ARGUMENT: a page_token from another broker or vault filter, or
3276
+ * malformed.
3277
+ * - UNAVAILABLE: a preview cannot be read; no partial page is returned.
3278
+ *
3279
+ * @generated from rpc swap.quickswap.v1.QuickSwapBrokerService.ListUpcomingPayouts
3280
+ */
3281
+ listUpcomingPayouts: {
3282
+ methodKind: "unary";
3283
+ input: typeof ListUpcomingPayoutsRequestSchema;
3284
+ output: typeof ListUpcomingPayoutsResponseSchema;
3285
+ };
3286
+ /**
3287
+ * ListVaultPayoutRules reads the payout rule of each of the broker's
3288
+ * vaults, and the assets each vault holds or was credited in that its rule
3289
+ * pays no destination for. Every broker role and the broker's API keys can
3290
+ * read, without step-up; only Owner and Finance members change rules.
3291
+ *
3292
+ * Errors:
3293
+ * - NOT_FOUND: BROKER_NOT_FOUND or VAULT_NOT_FOUND.
3294
+ * - INVALID_ARGUMENT: a page_token from another broker or vault filter, or
3295
+ * malformed.
3296
+ * - UNAVAILABLE: a rule or balance cannot be read; no partial page is
3297
+ * returned.
3298
+ *
3299
+ * @generated from rpc swap.quickswap.v1.QuickSwapBrokerService.ListVaultPayoutRules
3300
+ */
3301
+ listVaultPayoutRules: {
3302
+ methodKind: "unary";
3303
+ input: typeof ListVaultPayoutRulesRequestSchema;
3304
+ output: typeof ListVaultPayoutRulesResponseSchema;
3305
+ };
2247
3306
  }>;
2248
3307
  //#endregion
2249
- export { AffiliateVault, AffiliateVaultSchema, AssetVolume, AssetVolumeSchema, Broker, BrokerKey, BrokerKeySchema, BrokerRole, BrokerRoleSchema, BrokerSchema, BrokerStatsPeriod, BrokerStatsPeriodSchema, BrokerUsage, BrokerUsageSchema, CreateAffiliateVaultRequest, CreateAffiliateVaultRequestSchema, CreateAffiliateVaultResponse, CreateAffiliateVaultResponseSchema, CreateKeyRequest, CreateKeyRequestSchema, CreateKeyResponse, CreateKeyResponseSchema, FeeSplit, FeeSplitSchema, FeeTotal, FeeTotalSchema, FeeTotalsGrouping, FeeTotalsGroupingSchema, GetBrokerRequest, GetBrokerRequestSchema, GetBrokerResponse, GetBrokerResponseSchema, GetBrokerStatsRequest, GetBrokerStatsRequestSchema, GetBrokerStatsResponse, GetBrokerStatsResponseSchema, GetFeeTotalsRequest, GetFeeTotalsRequestSchema, GetFeeTotalsResponse, GetFeeTotalsResponseSchema, GetVaultRequest, GetVaultRequestSchema, GetVaultResponse, GetVaultResponseSchema, Invite, InviteMemberRequest, InviteMemberRequestSchema, InviteMemberResponse, InviteMemberResponseSchema, InviteSchema, ListKeysRequest, ListKeysRequestSchema, ListKeysResponse, ListKeysResponseSchema, ListMembersRequest, ListMembersRequestSchema, ListMembersResponse, ListMembersResponseSchema, ListMyBrokersRequest, ListMyBrokersRequestSchema, ListMyBrokersResponse, ListMyBrokersResponseSchema, ListQuickSwapsRequest, ListQuickSwapsRequestSchema, ListQuickSwapsResponse, ListQuickSwapsResponseSchema, ListVaultBalancesRequest, ListVaultBalancesRequestSchema, ListVaultBalancesResponse, ListVaultBalancesResponseSchema, ListVaultsRequest, ListVaultsRequestSchema, ListVaultsResponse, ListVaultsResponseSchema, Member, MemberSchema, Membership, MembershipSchema, QuickSwapBrokerService, QuickSwapBrokerServiceGetQuickSwapRequest, QuickSwapBrokerServiceGetQuickSwapRequestSchema, QuickSwapBrokerServiceGetQuickSwapResponse, QuickSwapBrokerServiceGetQuickSwapResponseSchema, QuickSwapSummary, QuickSwapSummarySchema, RemoveMemberRequest, RemoveMemberRequestSchema, RemoveMemberResponse, RemoveMemberResponseSchema, RespondToInviteRequest, RespondToInviteRequestSchema, RespondToInviteResponse, RespondToInviteResponseSchema, RevokeKeyRequest, RevokeKeyRequestSchema, RevokeKeyResponse, RevokeKeyResponseSchema, RotateKeyRequest, RotateKeyRequestSchema, RotateKeyResponse, RotateKeyResponseSchema, SetMemberRoleRequest, SetMemberRoleRequestSchema, SetMemberRoleResponse, SetMemberRoleResponseSchema, SetVaultStatusRequest, SetVaultStatusRequestSchema, SetVaultStatusResponse, SetVaultStatusResponseSchema, StatsPeriod, StatsPeriodSchema, StatusCount, StatusCountSchema, TransferOwnershipRequest, TransferOwnershipRequestSchema, TransferOwnershipResponse, TransferOwnershipResponseSchema, VaultAssetBalance, VaultAssetBalanceSchema, VaultBalance, VaultBalanceSchema, VaultStatus, VaultStatusSchema, file_swap_quickswap_v1_quickswap_broker, quickswap_broker_pb_d_exports };
3308
+ export { AffiliateVault, AffiliateVaultSchema, AssetVolume, AssetVolumeSchema, AssetWithoutDestination, AssetWithoutDestinationSchema, Broker, BrokerKey, BrokerKeySchema, BrokerRole, BrokerRoleSchema, BrokerSchema, BrokerStatsPeriod, BrokerStatsPeriodSchema, BrokerUsage, BrokerUsageSchema, CreateAffiliateVaultRequest, CreateAffiliateVaultRequestSchema, CreateAffiliateVaultResponse, CreateAffiliateVaultResponseSchema, CreateKeyRequest, CreateKeyRequestSchema, CreateKeyResponse, CreateKeyResponseSchema, FeeSplit, FeeSplitSchema, FeeTotal, FeeTotalSchema, FeeTotalsGrouping, FeeTotalsGroupingSchema, GetBrokerRequest, GetBrokerRequestSchema, GetBrokerResponse, GetBrokerResponseSchema, GetBrokerStatsRequest, GetBrokerStatsRequestSchema, GetBrokerStatsResponse, GetBrokerStatsResponseSchema, GetFeeTotalsRequest, GetFeeTotalsRequestSchema, GetFeeTotalsResponse, GetFeeTotalsResponseSchema, GetPayoutRequest, GetPayoutRequestSchema, GetPayoutResponse, GetPayoutResponseSchema, GetVaultRequest, GetVaultRequestSchema, GetVaultResponse, GetVaultResponseSchema, Invite, InviteMemberRequest, InviteMemberRequestSchema, InviteMemberResponse, InviteMemberResponseSchema, InviteSchema, ListKeysRequest, ListKeysRequestSchema, ListKeysResponse, ListKeysResponseSchema, ListMembersRequest, ListMembersRequestSchema, ListMembersResponse, ListMembersResponseSchema, ListMyBrokersRequest, ListMyBrokersRequestSchema, ListMyBrokersResponse, ListMyBrokersResponseSchema, ListPayoutsRequest, ListPayoutsRequestSchema, ListPayoutsResponse, ListPayoutsResponseSchema, ListQuickSwapsRequest, ListQuickSwapsRequestSchema, ListQuickSwapsResponse, ListQuickSwapsResponseSchema, ListUpcomingPayoutsRequest, ListUpcomingPayoutsRequestSchema, ListUpcomingPayoutsResponse, ListUpcomingPayoutsResponseSchema, ListVaultBalancesRequest, ListVaultBalancesRequestSchema, ListVaultBalancesResponse, ListVaultBalancesResponseSchema, ListVaultPayoutRulesRequest, ListVaultPayoutRulesRequestSchema, ListVaultPayoutRulesResponse, ListVaultPayoutRulesResponseSchema, ListVaultsRequest, ListVaultsRequestSchema, ListVaultsResponse, ListVaultsResponseSchema, Member, MemberSchema, Membership, MembershipSchema, Payout, PayoutRuleDestination, PayoutRuleDestinationSchema, PayoutSchema, PayoutStage, PayoutStageSchema, PayoutStatus, PayoutStatusSchema, PayoutStep, PayoutStepSchema, PayoutStepState, PayoutStepStateSchema, QuickSwapBrokerService, QuickSwapBrokerServiceGetQuickSwapRequest, QuickSwapBrokerServiceGetQuickSwapRequestSchema, QuickSwapBrokerServiceGetQuickSwapResponse, QuickSwapBrokerServiceGetQuickSwapResponseSchema, QuickSwapSummary, QuickSwapSummarySchema, RemoveMemberRequest, RemoveMemberRequestSchema, RemoveMemberResponse, RemoveMemberResponseSchema, RespondToInviteRequest, RespondToInviteRequestSchema, RespondToInviteResponse, RespondToInviteResponseSchema, RevokeKeyRequest, RevokeKeyRequestSchema, RevokeKeyResponse, RevokeKeyResponseSchema, RotateKeyRequest, RotateKeyRequestSchema, RotateKeyResponse, RotateKeyResponseSchema, SetMemberRoleRequest, SetMemberRoleRequestSchema, SetMemberRoleResponse, SetMemberRoleResponseSchema, SetVaultStatusRequest, SetVaultStatusRequestSchema, SetVaultStatusResponse, SetVaultStatusResponseSchema, StatsPeriod, StatsPeriodSchema, StatusCount, StatusCountSchema, TransferOwnershipRequest, TransferOwnershipRequestSchema, TransferOwnershipResponse, TransferOwnershipResponseSchema, UpcomingPayout, UpcomingPayoutAsset, UpcomingPayoutAssetSchema, UpcomingPayoutSchema, VaultAssetBalance, VaultAssetBalanceSchema, VaultBalance, VaultBalanceSchema, VaultPayoutRule, VaultPayoutRuleSchema, VaultStatus, VaultStatusSchema, file_swap_quickswap_v1_quickswap_broker, quickswap_broker_pb_d_exports };
2250
3309
  //# sourceMappingURL=quickswap_broker_pb.d.ts.map