wapi-client 0.4.3 → 0.5.0

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 (235) hide show
  1. package/dist/api/auth/auth.enums.d.ts +4 -4
  2. package/dist/api/base-client.d.ts +354 -335
  3. package/dist/api/connection/connection.enums.d.ts +19 -7
  4. package/dist/api/http-client.d.ts +15 -0
  5. package/dist/api/index.d.ts +22 -16
  6. package/dist/api/jsonrpc/jsonrpc.enums.d.ts +53 -25
  7. package/dist/api/ws-client.d.ts +26 -25
  8. package/dist/client.d.ts +1715 -1714
  9. package/dist/db/consts.enums.d.ts +274 -272
  10. package/dist/db/index.d.ts +31 -31
  11. package/dist/db/token/token.enums.d.ts +148 -148
  12. package/dist/db/transfer/transfer.enums.d.ts +236 -236
  13. package/dist/db/transfer-group/transfer-group.enums.d.ts +160 -160
  14. package/dist/db/transfer-log/transfer-log.enums.d.ts +193 -193
  15. package/dist/db/wallet/wallet.enums.d.ts +148 -148
  16. package/dist/db/wallet-token-setting/wallet-token-setting.enums.d.ts +96 -96
  17. package/dist/db/wapi-setting/wapi-setting.enums.d.ts +88 -88
  18. package/dist/fns/aggregate-transfers/aggregate-transfers.d.ts +18 -18
  19. package/dist/fns/aggregate-transfers/aggregate-transfers.enums.d.ts +52 -52
  20. package/dist/fns/aggregate-transfers/aggregate-transfers.guards.d.ts +4 -4
  21. package/dist/fns/create-contract/create-contract.d.ts +8 -8
  22. package/dist/fns/create-contract/create-contract.enums.d.ts +63 -63
  23. package/dist/fns/create-contract/create-contract.guards.d.ts +4 -4
  24. package/dist/fns/create-deposit/create-deposit.d.ts +9 -9
  25. package/dist/fns/create-deposit/create-deposit.enums.d.ts +63 -63
  26. package/dist/fns/create-deposit/create-deposit.guards.d.ts +4 -4
  27. package/dist/fns/create-exchange/create-exchange.d.ts +10 -10
  28. package/dist/fns/create-exchange/create-exchange.enums.d.ts +133 -133
  29. package/dist/fns/create-exchange/create-exchange.guards.d.ts +4 -4
  30. package/dist/fns/create-token/create-token.d.ts +9 -9
  31. package/dist/fns/create-token/create-token.enums.d.ts +46 -46
  32. package/dist/fns/create-token/create-token.guards.d.ts +4 -4
  33. package/dist/fns/create-transfer/create-transfer.d.ts +11 -11
  34. package/dist/fns/create-transfer/create-transfer.enums.d.ts +145 -145
  35. package/dist/fns/create-transfer/create-transfer.guards.d.ts +4 -4
  36. package/dist/fns/create-transfer-group/create-transfer-group.d.ts +12 -12
  37. package/dist/fns/create-transfer-group/create-transfer-group.enums.d.ts +142 -142
  38. package/dist/fns/create-transfer-group/create-transfer-group.guards.d.ts +4 -4
  39. package/dist/fns/create-transfers/create-transfers.d.ts +10 -10
  40. package/dist/fns/create-transfers/create-transfers.enums.d.ts +19 -19
  41. package/dist/fns/create-transfers/create-transfers.guards.d.ts +4 -4
  42. package/dist/fns/create-wallet/create-wallet.d.ts +9 -9
  43. package/dist/fns/create-wallet/create-wallet.enums.d.ts +41 -41
  44. package/dist/fns/create-wallet/create-wallet.guards.d.ts +4 -4
  45. package/dist/fns/create-withdrawal/create-withdrawal.d.ts +10 -10
  46. package/dist/fns/create-withdrawal/create-withdrawal.enums.d.ts +63 -63
  47. package/dist/fns/create-withdrawal/create-withdrawal.guards.d.ts +4 -4
  48. package/dist/fns/find-balances/find-balances.d.ts +17 -17
  49. package/dist/fns/find-balances/find-balances.enums.d.ts +30 -30
  50. package/dist/fns/find-balances/find-balances.guards.d.ts +4 -4
  51. package/dist/fns/find-tokens/find-tokens.d.ts +18 -18
  52. package/dist/fns/find-tokens/find-tokens.enums.d.ts +39 -39
  53. package/dist/fns/find-tokens/find-tokens.guards.d.ts +4 -4
  54. package/dist/fns/find-transfer-groups/find-transfer-groups.d.ts +17 -17
  55. package/dist/fns/find-transfer-groups/find-transfer-groups.enums.d.ts +52 -52
  56. package/dist/fns/find-transfer-groups/find-transfer-groups.guards.d.ts +4 -4
  57. package/dist/fns/find-transfers/find-transfers.d.ts +18 -18
  58. package/dist/fns/find-transfers/find-transfers.enums.d.ts +72 -72
  59. package/dist/fns/find-transfers/find-transfers.guards.d.ts +4 -4
  60. package/dist/fns/find-wallets/find-wallets.d.ts +18 -18
  61. package/dist/fns/find-wallets/find-wallets.enums.d.ts +48 -48
  62. package/dist/fns/find-wallets/find-wallets.guards.d.ts +4 -4
  63. package/dist/fns/fn-consts.enums.d.ts +14 -14
  64. package/dist/fns/get-balance/get-balance.d.ts +9 -9
  65. package/dist/fns/get-balance/get-balance.enums.d.ts +30 -30
  66. package/dist/fns/get-balance/get-balance.guards.d.ts +4 -4
  67. package/dist/fns/get-balance-history/get-balance-history.d.ts +9 -9
  68. package/dist/fns/get-balance-history/get-balance-history.enums.d.ts +29 -29
  69. package/dist/fns/get-balance-history/get-balance-history.guards.d.ts +4 -4
  70. package/dist/fns/get-flags/get-flags.d.ts +9 -9
  71. package/dist/fns/get-flags/get-flags.enums.d.ts +17 -17
  72. package/dist/fns/get-flags/get-flags.guards.d.ts +4 -4
  73. package/dist/fns/get-statistics/get-statistics.d.ts +9 -9
  74. package/dist/fns/get-statistics/get-statistics.enums.d.ts +24 -24
  75. package/dist/fns/get-statistics/get-statistics.guards.d.ts +4 -4
  76. package/dist/fns/get-token/get-token.d.ts +9 -9
  77. package/dist/fns/get-token/get-token.enums.d.ts +21 -21
  78. package/dist/fns/get-token/get-token.guards.d.ts +4 -4
  79. package/dist/fns/get-transfer/get-transfer.d.ts +9 -9
  80. package/dist/fns/get-transfer/get-transfer.enums.d.ts +25 -25
  81. package/dist/fns/get-transfer/get-transfer.guards.d.ts +4 -4
  82. package/dist/fns/get-transfer-group/get-transfer-group.d.ts +9 -9
  83. package/dist/fns/get-transfer-group/get-transfer-group.enums.d.ts +25 -25
  84. package/dist/fns/get-transfer-group/get-transfer-group.guards.d.ts +4 -4
  85. package/dist/fns/get-wallet/get-wallet.d.ts +9 -9
  86. package/dist/fns/get-wallet/get-wallet.enums.d.ts +25 -25
  87. package/dist/fns/get-wallet/get-wallet.guards.d.ts +4 -4
  88. package/dist/fns/import-data/import-data.d.ts +11 -11
  89. package/dist/fns/import-data/import-data.enums.d.ts +230 -230
  90. package/dist/fns/import-data/import-data.guards.d.ts +8 -8
  91. package/dist/fns/import-data/import-data.node.d.ts +11 -11
  92. package/dist/fns/index.d.ts +273 -273
  93. package/dist/fns/reverse-transfer/reverse-transfer.d.ts +10 -10
  94. package/dist/fns/reverse-transfer/reverse-transfer.enums.d.ts +48 -48
  95. package/dist/fns/reverse-transfer/reverse-transfer.guards.d.ts +4 -4
  96. package/dist/fns/reverse-transfer-group/reverse-transfer-group.d.ts +10 -10
  97. package/dist/fns/reverse-transfer-group/reverse-transfer-group.enums.d.ts +64 -64
  98. package/dist/fns/reverse-transfer-group/reverse-transfer-group.guards.d.ts +4 -4
  99. package/dist/fns/reverse-transfers/reverse-transfers.d.ts +16 -16
  100. package/dist/fns/reverse-transfers/reverse-transfers.enums.d.ts +55 -55
  101. package/dist/fns/reverse-transfers/reverse-transfers.guards.d.ts +4 -4
  102. package/dist/fns/set-flags/set-flags.d.ts +10 -10
  103. package/dist/fns/set-flags/set-flags.enums.d.ts +21 -21
  104. package/dist/fns/set-flags/set-flags.guards.d.ts +4 -4
  105. package/dist/fns/update-token/update-token.d.ts +8 -8
  106. package/dist/fns/update-token/update-token.enums.d.ts +43 -43
  107. package/dist/fns/update-token/update-token.guards.d.ts +4 -4
  108. package/dist/fns/update-transfer/update-transfer.d.ts +9 -9
  109. package/dist/fns/update-transfer/update-transfer.enums.d.ts +32 -32
  110. package/dist/fns/update-transfer/update-transfer.guards.d.ts +4 -4
  111. package/dist/fns/update-transfer-group/update-transfer-group.d.ts +9 -9
  112. package/dist/fns/update-transfer-group/update-transfer-group.enums.d.ts +46 -46
  113. package/dist/fns/update-transfer-group/update-transfer-group.guards.d.ts +4 -4
  114. package/dist/fns/update-transfer-groups/update-transfer-groups.d.ts +15 -15
  115. package/dist/fns/update-transfer-groups/update-transfer-groups.enums.d.ts +44 -44
  116. package/dist/fns/update-transfer-groups/update-transfer-groups.guards.d.ts +4 -4
  117. package/dist/fns/update-transfers/update-transfers.d.ts +15 -15
  118. package/dist/fns/update-transfers/update-transfers.enums.d.ts +52 -52
  119. package/dist/fns/update-transfers/update-transfers.guards.d.ts +4 -4
  120. package/dist/fns/update-wallet/update-wallet.d.ts +8 -8
  121. package/dist/fns/update-wallet/update-wallet.enums.d.ts +43 -43
  122. package/dist/fns/update-wallet/update-wallet.guards.d.ts +4 -4
  123. package/dist/index.d.ts +80 -73
  124. package/dist/lib/debug.d.ts +1 -1
  125. package/dist/lib/errors.d.ts +317 -310
  126. package/dist/lib/isomorphic/node/get-random-hex.d.ts +1 -1
  127. package/dist/lib/isomorphic/node/streams.d.ts +28 -29
  128. package/dist/lib/isomorphic/node/ws.d.ts +2 -2
  129. package/dist/lib/query-builder.d.ts +252 -252
  130. package/dist/lib/stream-promise-input.d.ts +33 -33
  131. package/dist/lib/stream-promise.d.ts +40 -40
  132. package/dist/lib/utils.d.ts +48 -48
  133. package/dist/lib/validator.d.ts +257 -253
  134. package/dist/txs/aggregate-transfer-many/aggregate-transfer-many.enums.d.ts +64 -64
  135. package/dist/txs/aggregate-transfer-many/aggregate-transfer-many.guards.d.ts +4 -4
  136. package/dist/txs/authentication-check/authentication-check.enums.d.ts +22 -0
  137. package/dist/txs/authentication-check/authentication-check.guards.d.ts +4 -0
  138. package/dist/txs/create-access-token/create-access-token.enums.d.ts +50 -0
  139. package/dist/txs/create-access-token/create-access-token.guards.d.ts +4 -0
  140. package/dist/txs/create-contract/create-contract.enums.d.ts +79 -79
  141. package/dist/txs/create-contract/create-contract.guards.d.ts +4 -4
  142. package/dist/txs/create-deposit/create-deposit.enums.d.ts +19 -19
  143. package/dist/txs/create-deposit/create-deposit.guards.d.ts +4 -4
  144. package/dist/txs/create-distribution/create-distribution.enums.d.ts +107 -104
  145. package/dist/txs/create-distribution/create-distribution.guards.d.ts +4 -4
  146. package/dist/txs/create-token/create-token.enums.d.ts +54 -54
  147. package/dist/txs/create-token/create-token.guards.d.ts +4 -4
  148. package/dist/txs/create-transfer/create-transfer.enums.d.ts +209 -209
  149. package/dist/txs/create-transfer/create-transfer.guards.d.ts +4 -4
  150. package/dist/txs/create-transfer-group/create-transfer-group.enums.d.ts +200 -200
  151. package/dist/txs/create-transfer-group/create-transfer-group.guards.d.ts +4 -4
  152. package/dist/txs/create-transfer-many/create-transfer-many.enums.d.ts +53 -53
  153. package/dist/txs/create-transfer-many/create-transfer-many.guards.d.ts +4 -4
  154. package/dist/txs/create-wallet/create-wallet.enums.d.ts +20 -20
  155. package/dist/txs/create-wallet/create-wallet.guards.d.ts +4 -4
  156. package/dist/txs/create-withdrawal/create-withdrawal.enums.d.ts +19 -19
  157. package/dist/txs/create-withdrawal/create-withdrawal.guards.d.ts +4 -4
  158. package/dist/txs/find-balance-many/find-balance-many.enums.d.ts +97 -97
  159. package/dist/txs/find-balance-many/find-balance-many.guards.d.ts +4 -4
  160. package/dist/txs/find-token-many/find-token-many.enums.d.ts +81 -81
  161. package/dist/txs/find-token-many/find-token-many.guards.d.ts +4 -4
  162. package/dist/txs/find-transfer-group-many/find-transfer-group-many.enums.d.ts +90 -90
  163. package/dist/txs/find-transfer-group-many/find-transfer-group-many.guards.d.ts +4 -4
  164. package/dist/txs/find-transfer-many/find-transfer-many.enums.d.ts +93 -93
  165. package/dist/txs/find-transfer-many/find-transfer-many.guards.d.ts +4 -4
  166. package/dist/txs/find-wallet-many/find-wallet-many.enums.d.ts +181 -179
  167. package/dist/txs/find-wallet-many/find-wallet-many.guards.d.ts +4 -4
  168. package/dist/txs/finish-transaction/finish-transaction.enums.d.ts +33 -29
  169. package/dist/txs/finish-transaction/finish-transaction.guards.d.ts +4 -4
  170. package/dist/txs/get-balance/get-balance.enums.d.ts +107 -107
  171. package/dist/txs/get-balance/get-balance.guards.d.ts +4 -4
  172. package/dist/txs/get-balance-history/get-balance-history.enums.d.ts +188 -188
  173. package/dist/txs/get-balance-history/get-balance-history.guards.d.ts +4 -4
  174. package/dist/txs/get-flags/get-flags.enums.d.ts +19 -19
  175. package/dist/txs/get-flags/get-flags.guards.d.ts +4 -4
  176. package/dist/txs/get-statistics/get-statistics.enums.d.ts +58 -58
  177. package/dist/txs/get-statistics/get-statistics.guards.d.ts +4 -4
  178. package/dist/txs/get-token/get-token.enums.d.ts +114 -114
  179. package/dist/txs/get-token/get-token.guards.d.ts +4 -4
  180. package/dist/txs/get-token-many/get-token-many.enums.d.ts +36 -36
  181. package/dist/txs/get-token-many/get-token-many.guards.d.ts +4 -4
  182. package/dist/txs/get-transfer/get-transfer.enums.d.ts +283 -283
  183. package/dist/txs/get-transfer/get-transfer.guards.d.ts +4 -4
  184. package/dist/txs/get-transfer-group/get-transfer-group.enums.d.ts +121 -121
  185. package/dist/txs/get-transfer-group/get-transfer-group.guards.d.ts +4 -4
  186. package/dist/txs/get-wallet/get-wallet.enums.d.ts +67 -67
  187. package/dist/txs/get-wallet/get-wallet.guards.d.ts +4 -4
  188. package/dist/txs/get-wallet-many/get-wallet-many.enums.d.ts +36 -36
  189. package/dist/txs/get-wallet-many/get-wallet-many.guards.d.ts +4 -4
  190. package/dist/txs/import-actions/import-actions.enums.d.ts +179 -206
  191. package/dist/txs/import-actions/import-actions.guards.d.ts +8 -8
  192. package/dist/txs/index.d.ts +271 -259
  193. package/dist/txs/query/query.enums.d.ts +30 -30
  194. package/dist/txs/query/query.guards.d.ts +4 -4
  195. package/dist/txs/query-logs/query-logs.enums.d.ts +54 -54
  196. package/dist/txs/query-logs/query-logs.guards.d.ts +4 -4
  197. package/dist/txs/reset-database/reset-database.enums.d.ts +34 -34
  198. package/dist/txs/reset-database/reset-database.guards.d.ts +4 -4
  199. package/dist/txs/reverse-transfer/reverse-transfer.enums.d.ts +72 -72
  200. package/dist/txs/reverse-transfer/reverse-transfer.guards.d.ts +4 -4
  201. package/dist/txs/reverse-transfer-group/reverse-transfer-group.enums.d.ts +95 -95
  202. package/dist/txs/reverse-transfer-group/reverse-transfer-group.guards.d.ts +4 -4
  203. package/dist/txs/reverse-transfer-group-many/reverse-transfer-group-many.enums.d.ts +77 -77
  204. package/dist/txs/reverse-transfer-group-many/reverse-transfer-group-many.guards.d.ts +4 -4
  205. package/dist/txs/reverse-transfer-many/reverse-transfer-many.enums.d.ts +58 -58
  206. package/dist/txs/reverse-transfer-many/reverse-transfer-many.guards.d.ts +4 -4
  207. package/dist/txs/set-flags/set-flags.enums.d.ts +24 -24
  208. package/dist/txs/set-flags/set-flags.guards.d.ts +4 -4
  209. package/dist/txs/start-transaction/start-transaction.enums.d.ts +18 -18
  210. package/dist/txs/start-transaction/start-transaction.guards.d.ts +4 -4
  211. package/dist/txs/tx-consts.enums.d.ts +236 -236
  212. package/dist/txs/update-token/update-token.enums.d.ts +51 -51
  213. package/dist/txs/update-token/update-token.guards.d.ts +4 -4
  214. package/dist/txs/update-transfer/update-transfer.enums.d.ts +78 -78
  215. package/dist/txs/update-transfer/update-transfer.guards.d.ts +4 -4
  216. package/dist/txs/update-transfer-group/update-transfer-group.enums.d.ts +91 -91
  217. package/dist/txs/update-transfer-group/update-transfer-group.guards.d.ts +4 -4
  218. package/dist/txs/update-transfer-group-many/update-transfer-group-many.enums.d.ts +40 -40
  219. package/dist/txs/update-transfer-group-many/update-transfer-group-many.guards.d.ts +4 -4
  220. package/dist/txs/update-transfer-many/update-transfer-many.enums.d.ts +36 -36
  221. package/dist/txs/update-transfer-many/update-transfer-many.guards.d.ts +4 -4
  222. package/dist/txs/update-wallet/update-wallet.enums.d.ts +54 -54
  223. package/dist/txs/update-wallet/update-wallet.guards.d.ts +4 -4
  224. package/dist/wapi-client.cjs.development.js +30083 -21458
  225. package/dist/wapi-client.cjs.js +17 -7
  226. package/package.json +9 -5
  227. package/dist/fns/import-data/import-data.web.d.ts +0 -11
  228. package/dist/lib/isomorphic/web/get-random-hex.d.ts +0 -1
  229. package/dist/lib/isomorphic/web/streams.d.ts +0 -26
  230. package/dist/lib/isomorphic/web/ws.d.ts +0 -18
  231. package/dist/wapi-client.cjs.development.js.map +0 -1
  232. package/dist/wapi-client.cjs.production.js +0 -2
  233. package/dist/wapi-client.cjs.production.js.map +0 -1
  234. package/dist/wapi-client.esm.js +0 -21336
  235. package/dist/wapi-client.esm.js.map +0 -1
@@ -1,209 +1,209 @@
1
- import { ITxGeneralOptions } from '../tx-consts.enums';
2
- import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
3
- import { UniqueTokenFilter } from '../get-token/get-token.enums';
4
- import { UniqueTransferGroupFilter } from '../get-transfer-group/get-transfer-group.enums';
5
- import { Transfer } from '../get-transfer/get-transfer.enums';
6
- import { Balance } from '../get-balance/get-balance.enums';
7
- export declare type CreateTransferTxOptions = ITxGeneralOptions & CreateTransferAdditionalOptions;
8
- /**
9
- * Additional flags to determine the return
10
- */
11
- export interface CreateTransferAdditionalOptions {
12
- /**
13
- * Whether the request should also return from wallet balance
14
- */
15
- return_from_balance?: boolean;
16
- /**
17
- * Whether the request should also return to wallet balance
18
- */
19
- return_to_balance?: boolean;
20
- /**
21
- * If true then the wallet will be created if not found. Only valid with 'foreign'
22
- */
23
- create_to_wallet_if_not_exists?: boolean;
24
- }
25
- export declare type TransferData = TransferDataRegular | TransferDataDeposit | TransferDataWithdrawal;
26
- export interface TransferDataRegular {
27
- /**
28
- * Identifier for this transfer. Must be unique
29
- */
30
- identifier?: string;
31
- /**
32
- * Latest control_hash on the from_wallet
33
- */
34
- latest_control_hash?: (string | null) | null;
35
- /**
36
- * Wallet where funds are debited
37
- */
38
- from_wallet: UniqueWalletFilter;
39
- /**
40
- * Wallet where funds are credited
41
- */
42
- to_wallet: UniqueWalletFilter;
43
- /**
44
- * Token that is moved
45
- */
46
- token: UniqueTokenFilter;
47
- /**
48
- * The transfer amount
49
- */
50
- amount: number;
51
- /**
52
- * Type of transfer
53
- */
54
- type: 'transfer';
55
- /**
56
- * Status of the transfer
57
- */
58
- status?: 'pending' | 'finished';
59
- /**
60
- * Set to true to force transfer without checking for negative balance constraints
61
- */
62
- force?: boolean;
63
- /**
64
- * Key/value object describing this transfer
65
- */
66
- metadata?: {
67
- [k: string]: any;
68
- } | null;
69
- /**
70
- * TransferGroup the transfer belongs to
71
- */
72
- transfer_group?: UniqueTransferGroupFilter;
73
- /**
74
- * Datetime when this transfer was created - can only be latest
75
- */
76
- created_at?: string;
77
- }
78
- export interface TransferDataDeposit {
79
- /**
80
- * Identifier for this transfer. Must be unique
81
- */
82
- identifier?: string;
83
- /**
84
- * Latest control_hash on the from_wallet
85
- */
86
- latest_control_hash?: (string | null) | null;
87
- /**
88
- * Wallet where funds are debited
89
- */
90
- from_wallet?: UniqueWalletFilter;
91
- /**
92
- * Wallet where funds are credited
93
- */
94
- to_wallet: UniqueWalletFilter;
95
- /**
96
- * Token that is moved
97
- */
98
- token: UniqueTokenFilter;
99
- /**
100
- * The transfer amount
101
- */
102
- amount: number;
103
- /**
104
- * Type of transfer
105
- */
106
- type?: 'deposit';
107
- /**
108
- * Status of the transfer
109
- */
110
- status?: 'pending' | 'finished';
111
- /**
112
- * Set to true to force transfer without checking for negative balance constraints
113
- */
114
- force?: boolean;
115
- /**
116
- * Key/value object describing this transfer
117
- */
118
- metadata?: {
119
- [k: string]: any;
120
- } | null;
121
- /**
122
- * TransferGroup the transfer belongs to
123
- */
124
- transfer_group?: UniqueTransferGroupFilter;
125
- /**
126
- * Datetime when this transfer was created - can only be latest
127
- */
128
- created_at?: string;
129
- }
130
- export interface TransferDataWithdrawal {
131
- /**
132
- * Identifier for this transfer. Must be unique
133
- */
134
- identifier?: string;
135
- /**
136
- * Latest control_hash on the from_wallet
137
- */
138
- latest_control_hash?: (string | null) | null;
139
- /**
140
- * Wallet where funds are debited
141
- */
142
- from_wallet: UniqueWalletFilter;
143
- /**
144
- * Wallet where funds are credited
145
- */
146
- to_wallet?: UniqueWalletFilter;
147
- /**
148
- * Token that is moved
149
- */
150
- token: UniqueTokenFilter;
151
- /**
152
- * The transfer amount
153
- */
154
- amount: number;
155
- /**
156
- * Type of transfer
157
- */
158
- type?: 'withdrawal';
159
- /**
160
- * Status of the transfer
161
- */
162
- status?: 'pending' | 'finished';
163
- /**
164
- * Set to true to force transfer without checking for negative balance constraints
165
- */
166
- force?: boolean;
167
- /**
168
- * Key/value object describing this transfer
169
- */
170
- metadata?: {
171
- [k: string]: any;
172
- } | null;
173
- /**
174
- * TransferGroup the transfer belongs to
175
- */
176
- transfer_group?: UniqueTransferGroupFilter;
177
- /**
178
- * Datetime when this transfer was created - can only be latest
179
- */
180
- created_at?: string;
181
- }
182
- /**
183
- * Input for createTransfer
184
- *
185
- * @category Input
186
- */
187
- export interface CreateTransferTxInput {
188
- transfer: TransferData;
189
- options?: CreateTransferTxOptions;
190
- }
191
- /**
192
- * Output of createTransfer
193
- *
194
- * @category Output
195
- */
196
- export interface CreateTransferTxOutput {
197
- /**
198
- * Created transfer object
199
- */
200
- transfer: Transfer;
201
- /**
202
- * Debited wallet balance
203
- */
204
- from_balance?: Balance;
205
- /**
206
- * Credited wallet balance
207
- */
208
- to_balance?: Balance;
209
- }
1
+ import { ITxGeneralOptions } from '../tx-consts.enums';
2
+ import { UniqueWalletFilter } from '../get-wallet/get-wallet.enums';
3
+ import { UniqueTokenFilter } from '../get-token/get-token.enums';
4
+ import { UniqueTransferGroupFilter } from '../get-transfer-group/get-transfer-group.enums';
5
+ import { Transfer } from '../get-transfer/get-transfer.enums';
6
+ import { Balance } from '../get-balance/get-balance.enums';
7
+ /**
8
+ * Additional flags to determine the return
9
+ */
10
+ export interface CreateTransferAdditionalOptions {
11
+ /**
12
+ * Whether the request should also return from wallet balance
13
+ */
14
+ return_from_balance?: boolean;
15
+ /**
16
+ * Whether the request should also return to wallet balance
17
+ */
18
+ return_to_balance?: boolean;
19
+ /**
20
+ * If true then the wallet will be created if not found. Only valid with 'foreign'
21
+ */
22
+ create_to_wallet_if_not_exists?: boolean;
23
+ }
24
+ export interface TransferDataRegular {
25
+ /**
26
+ * Identifier for this transfer. Must be unique
27
+ */
28
+ identifier?: string;
29
+ /**
30
+ * Latest control_hash on the from_wallet
31
+ */
32
+ latest_control_hash?: (string | null) | null;
33
+ /**
34
+ * The transfer amount
35
+ */
36
+ amount: number;
37
+ /**
38
+ * Type of transfer
39
+ */
40
+ type: 'transfer';
41
+ /**
42
+ * Status of the transfer
43
+ */
44
+ status?: 'pending' | 'finished';
45
+ /**
46
+ * Set to true to force transfer without checking for negative balance constraints
47
+ */
48
+ force?: boolean;
49
+ /**
50
+ * Key/value object describing this transfer
51
+ */
52
+ metadata?: {
53
+ [k: string]: unknown;
54
+ } | null;
55
+ /**
56
+ * Datetime when this transfer was created - can only be latest
57
+ */
58
+ created_at?: string;
59
+ /**
60
+ * Wallet where funds are debited
61
+ */
62
+ from_wallet: UniqueWalletFilter;
63
+ /**
64
+ * Wallet where funds are credited
65
+ */
66
+ to_wallet: UniqueWalletFilter;
67
+ /**
68
+ * Token that is moved
69
+ */
70
+ token: UniqueTokenFilter;
71
+ /**
72
+ * TransferGroup the transfer belongs to
73
+ */
74
+ transfer_group?: UniqueTransferGroupFilter;
75
+ }
76
+ export interface TransferDataDeposit {
77
+ /**
78
+ * Identifier for this transfer. Must be unique
79
+ */
80
+ identifier?: string;
81
+ /**
82
+ * Latest control_hash on the from_wallet
83
+ */
84
+ latest_control_hash?: (string | null) | null;
85
+ /**
86
+ * The transfer amount
87
+ */
88
+ amount: number;
89
+ /**
90
+ * Type of transfer
91
+ */
92
+ type?: 'deposit';
93
+ /**
94
+ * Status of the transfer
95
+ */
96
+ status?: 'pending' | 'finished';
97
+ /**
98
+ * Set to true to force transfer without checking for negative balance constraints
99
+ */
100
+ force?: boolean;
101
+ /**
102
+ * Key/value object describing this transfer
103
+ */
104
+ metadata?: {
105
+ [k: string]: unknown;
106
+ } | null;
107
+ /**
108
+ * Datetime when this transfer was created - can only be latest
109
+ */
110
+ created_at?: string;
111
+ /**
112
+ * Wallet where funds are debited
113
+ */
114
+ from_wallet?: UniqueWalletFilter;
115
+ /**
116
+ * Wallet where funds are credited
117
+ */
118
+ to_wallet: UniqueWalletFilter;
119
+ /**
120
+ * Token that is moved
121
+ */
122
+ token: UniqueTokenFilter;
123
+ /**
124
+ * TransferGroup the transfer belongs to
125
+ */
126
+ transfer_group?: UniqueTransferGroupFilter;
127
+ }
128
+ export interface TransferDataWithdrawal {
129
+ /**
130
+ * Identifier for this transfer. Must be unique
131
+ */
132
+ identifier?: string;
133
+ /**
134
+ * Latest control_hash on the from_wallet
135
+ */
136
+ latest_control_hash?: (string | null) | null;
137
+ /**
138
+ * The transfer amount
139
+ */
140
+ amount: number;
141
+ /**
142
+ * Type of transfer
143
+ */
144
+ type?: 'withdrawal';
145
+ /**
146
+ * Status of the transfer
147
+ */
148
+ status?: 'pending' | 'finished';
149
+ /**
150
+ * Set to true to force transfer without checking for negative balance constraints
151
+ */
152
+ force?: boolean;
153
+ /**
154
+ * Key/value object describing this transfer
155
+ */
156
+ metadata?: {
157
+ [k: string]: unknown;
158
+ } | null;
159
+ /**
160
+ * Datetime when this transfer was created - can only be latest
161
+ */
162
+ created_at?: string;
163
+ /**
164
+ * Wallet where funds are debited
165
+ */
166
+ from_wallet: UniqueWalletFilter;
167
+ /**
168
+ * Wallet where funds are credited
169
+ */
170
+ to_wallet?: UniqueWalletFilter;
171
+ /**
172
+ * Token that is moved
173
+ */
174
+ token: UniqueTokenFilter;
175
+ /**
176
+ * TransferGroup the transfer belongs to
177
+ */
178
+ transfer_group?: UniqueTransferGroupFilter;
179
+ }
180
+ export declare type CreateTransferTxOptions = ITxGeneralOptions & CreateTransferAdditionalOptions;
181
+ export declare type TransferData = TransferDataRegular | TransferDataDeposit | TransferDataWithdrawal;
182
+ /**
183
+ * Input for createTransfer
184
+ *
185
+ * @category Input
186
+ */
187
+ export interface CreateTransferTxInput {
188
+ transfer: TransferData;
189
+ options?: CreateTransferTxOptions;
190
+ }
191
+ /**
192
+ * Output of createTransfer
193
+ *
194
+ * @category Output
195
+ */
196
+ export interface CreateTransferTxOutput {
197
+ /**
198
+ * Created transfer object
199
+ */
200
+ transfer: Transfer;
201
+ /**
202
+ * Debited wallet balance
203
+ */
204
+ from_balance?: Balance;
205
+ /**
206
+ * Credited wallet balance
207
+ */
208
+ to_balance?: Balance;
209
+ }
@@ -1,4 +1,4 @@
1
- import { CreateTransferTxInput } from './create-transfer.enums';
2
- export declare function isCreateTransferTxInput(input: unknown): input is CreateTransferTxInput;
3
- import { CreateTransferTxOutput } from './create-transfer.enums';
4
- export declare function isCreateTransferTxOutput(input: unknown): input is CreateTransferTxOutput;
1
+ import { CreateTransferTxInput } from './create-transfer.enums';
2
+ export declare function isCreateTransferTxInput(input: unknown): input is CreateTransferTxInput;
3
+ import { CreateTransferTxOutput } from './create-transfer.enums';
4
+ export declare function isCreateTransferTxOutput(input: unknown): input is CreateTransferTxOutput;