@dfns/sdk 0.8.13 → 0.8.14-beta-1

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.
@@ -1,3 +1,795 @@
1
+ export type AbortTransactionParams = {
2
+ /** Wallet id. */
3
+ walletId: string;
4
+ /** Transaction id. */
5
+ transactionId: string;
6
+ };
7
+ export type AbortTransactionResponse = {
8
+ /** Transaction id. */
9
+ id: string;
10
+ /** Wallet id. */
11
+ walletId: string;
12
+ network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Concordium" | "ConcordiumTestnet" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "XrpLedger" | "XrpLedgerTestnet";
13
+ /** The user who initiated the request. */
14
+ requester: {
15
+ /** User id. */
16
+ userId: string;
17
+ /** Token id. */
18
+ tokenId?: string | undefined;
19
+ };
20
+ requestBody: {
21
+ kind: "Transaction";
22
+ /** The unsigned hex encoded transaction or JSON transactions for compatible networks. */
23
+ transaction: string | {};
24
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
25
+ externalId?: string | undefined;
26
+ } | {
27
+ kind: "Psbt";
28
+ /** The hex encoded PSBT. */
29
+ psbt: string;
30
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
31
+ externalId?: string | undefined;
32
+ } | {
33
+ kind: "SignDocDirect";
34
+ signDoc: string;
35
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
36
+ externalId?: string | undefined;
37
+ } | {
38
+ kind: "UserOperations";
39
+ userOperations: {
40
+ /** The destination address or target contract. */
41
+ to: string;
42
+ /** The amount of native tokens to transfer in minimum denomination. */
43
+ value?: string | undefined;
44
+ /** ABI encoded function call data in hex format. */
45
+ data?: string | undefined;
46
+ }[];
47
+ /** A fee sponsor id to sponsor the transaction fee by another wallet. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
48
+ feeSponsorId: string;
49
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
50
+ externalId?: string | undefined;
51
+ } | {
52
+ kind: "FunctionCall";
53
+ /** Function call arguments */
54
+ call: {};
55
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
56
+ externalId?: string | undefined;
57
+ } | {
58
+ kind: "TransferPreapproval";
59
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
60
+ externalId?: string | undefined;
61
+ } | {
62
+ kind: "Evm";
63
+ to?: string | undefined;
64
+ value?: (string | string) | undefined;
65
+ data?: string | undefined;
66
+ /** The current nonce of the signer EOA. */
67
+ nonce?: (number | string | string) | undefined;
68
+ gasLimit?: (string | string) | undefined;
69
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
70
+ externalId?: string | undefined;
71
+ } | {
72
+ kind: "Eip1559";
73
+ to?: string | undefined;
74
+ value?: (string | string) | undefined;
75
+ data?: string | undefined;
76
+ nonce?: (number | string | string) | undefined;
77
+ gasLimit?: (string | string) | undefined;
78
+ maxFeePerGas?: (string | string) | undefined;
79
+ maxPriorityFeePerGas?: (string | string) | undefined;
80
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
81
+ externalId?: string | undefined;
82
+ } | {
83
+ kind: "SettleOffer";
84
+ txHash: string;
85
+ decision: "Accept" | "Reject";
86
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
87
+ externalId?: string | undefined;
88
+ } | {
89
+ kind: "ActivateAccount";
90
+ args?: {} | undefined;
91
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
92
+ externalId?: string | undefined;
93
+ } | {
94
+ kind: "CancelTransaction";
95
+ txHash?: string | undefined;
96
+ signedTx: string;
97
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
98
+ externalId?: string | undefined;
99
+ } | {
100
+ kind: "SpeedUpTransaction";
101
+ txHash: string;
102
+ signedTx: string;
103
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key (read more [here](https://docs.dfns.co/api-reference/idempotency)). */
104
+ externalId?: string | undefined;
105
+ };
106
+ status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected";
107
+ reason?: string | undefined;
108
+ txHash?: string | undefined;
109
+ fee?: string | undefined;
110
+ approvalId?: string | undefined;
111
+ dateRequested: string;
112
+ datePolicyResolved?: string | undefined;
113
+ dateBroadcasted?: string | undefined;
114
+ dateConfirmed?: string | undefined;
115
+ externalId?: string | undefined;
116
+ };
117
+ export type AbortTransactionRequest = AbortTransactionParams;
118
+ export type AbortTransferParams = {
119
+ /** Wallet id. */
120
+ walletId: string;
121
+ /** Transfer id. */
122
+ transferId: string;
123
+ };
124
+ export type AbortTransferResponse = {
125
+ /** Transfer id. */
126
+ id: string;
127
+ /** The source wallet for this tranfer. */
128
+ walletId: string;
129
+ /** The blockchain network this transfer is on. */
130
+ network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "ArcTestnet" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "AdiTestnetAb" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Concordium" | "ConcordiumTestnet" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumClassic" | "EthereumClassicMordor" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "FlowEvm" | "FlowEvmTestnet" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "KusamaAssetHub" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plasma" | "PlasmaTestnet" | "Plume" | "PlumeSepolia" | "Paseo" | "PaseoAssetHub" | "Polkadot" | "PolkadotAssetHub" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Starknet" | "StarknetSepolia" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tezos" | "TezosGhostnet" | "Tempo" | "TempoAndantino" | "TempoModerato" | "Tsc" | "TscTestnet1" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "WestendAssetHub" | "XrpLedger" | "XrpLedgerTestnet";
131
+ /** The user who initiated the request. */
132
+ requester: {
133
+ /** User id. */
134
+ userId: string;
135
+ /** Token id. */
136
+ tokenId?: string | undefined;
137
+ };
138
+ requestBody: {
139
+ kind: "Native";
140
+ /** The destination address. */
141
+ to: string;
142
+ /** The amount of native tokens to transfer in minimum denomination. */
143
+ amount: string;
144
+ /** The memo or destination tag (supported networks only). */
145
+ memo?: (string | "") | undefined;
146
+ /** The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. */
147
+ priority?: ("Slow" | "Standard" | "Fast") | undefined;
148
+ /** Whether to create the destination account on chains that require account creation (e.g., Stellar). Only valid for chains that require the receiver account to exist before transfer. */
149
+ createDestinationAccount?: boolean | undefined;
150
+ /** Optional field for Canton, if true it will create a transfer offer. */
151
+ offer?: boolean | undefined;
152
+ /** Optional field for Canton, especially useful in the context of offers */
153
+ expiresAt?: string | undefined;
154
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
155
+ externalId?: string | undefined;
156
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
157
+ travelRule?: ({
158
+ kind: "Notabene";
159
+ beneficiaryVASPdid?: string | undefined;
160
+ beneficiaryProof?: {
161
+ [x: string]: any;
162
+ } | undefined;
163
+ originator: {
164
+ [x: string]: any;
165
+ };
166
+ beneficiary: {
167
+ [x: string]: any;
168
+ };
169
+ }) | undefined;
170
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
171
+ feeSponsorId?: string | undefined;
172
+ } | {
173
+ kind: "Aip21";
174
+ /** The asset metadata address. */
175
+ metadata: string;
176
+ /** The destination address. */
177
+ to: string;
178
+ /** The amount of tokens to transfer in minimum denomination. */
179
+ amount: string;
180
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
181
+ externalId?: string | undefined;
182
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
183
+ travelRule?: ({
184
+ kind: "Notabene";
185
+ beneficiaryVASPdid?: string | undefined;
186
+ beneficiaryProof?: {
187
+ [x: string]: any;
188
+ } | undefined;
189
+ originator: {
190
+ [x: string]: any;
191
+ };
192
+ beneficiary: {
193
+ [x: string]: any;
194
+ };
195
+ }) | undefined;
196
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
197
+ feeSponsorId?: string | undefined;
198
+ } | {
199
+ kind: "Asa";
200
+ /** The token asset id. */
201
+ assetId: string;
202
+ /** The destination address. */
203
+ to: string;
204
+ /** The amount of tokens to transfer in minimum denomination. */
205
+ amount: string;
206
+ /** The memo or destination tag. */
207
+ memo?: (string | "") | undefined;
208
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
209
+ externalId?: string | undefined;
210
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
211
+ travelRule?: ({
212
+ kind: "Notabene";
213
+ beneficiaryVASPdid?: string | undefined;
214
+ beneficiaryProof?: {
215
+ [x: string]: any;
216
+ } | undefined;
217
+ originator: {
218
+ [x: string]: any;
219
+ };
220
+ beneficiary: {
221
+ [x: string]: any;
222
+ };
223
+ }) | undefined;
224
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
225
+ feeSponsorId?: string | undefined;
226
+ } | {
227
+ kind: "Asset";
228
+ /** The token asset id. */
229
+ assetId: string;
230
+ /** The destination address. */
231
+ to: string;
232
+ /** The amount of tokens to transfer in minimum denomination. */
233
+ amount: string;
234
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
235
+ externalId?: string | undefined;
236
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
237
+ travelRule?: ({
238
+ kind: "Notabene";
239
+ beneficiaryVASPdid?: string | undefined;
240
+ beneficiaryProof?: {
241
+ [x: string]: any;
242
+ } | undefined;
243
+ originator: {
244
+ [x: string]: any;
245
+ };
246
+ beneficiary: {
247
+ [x: string]: any;
248
+ };
249
+ }) | undefined;
250
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
251
+ feeSponsorId?: string | undefined;
252
+ } | {
253
+ kind: "Cip56";
254
+ /** The instrument admin address. */
255
+ instrumentAdmin: string;
256
+ /** The instrument id. */
257
+ instrumentId: string;
258
+ /** The destination address. */
259
+ to: string;
260
+ /** The amount of tokens to transfer in minimum denomination. */
261
+ amount: string;
262
+ /** If true it will create a transfer offer. */
263
+ offer?: boolean | undefined;
264
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
265
+ externalId?: string | undefined;
266
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
267
+ travelRule?: ({
268
+ kind: "Notabene";
269
+ beneficiaryVASPdid?: string | undefined;
270
+ beneficiaryProof?: {
271
+ [x: string]: any;
272
+ } | undefined;
273
+ originator: {
274
+ [x: string]: any;
275
+ };
276
+ beneficiary: {
277
+ [x: string]: any;
278
+ };
279
+ }) | undefined;
280
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
281
+ feeSponsorId?: string | undefined;
282
+ } | {
283
+ kind: "Cis2";
284
+ /** The destination address. */
285
+ to: string;
286
+ /** The amount of tokens to transfer in minimum denomination. */
287
+ amount: string;
288
+ /** The token address following (https://proposals.concordium.com/CIS/cis-2.html#token-address). */
289
+ tokenAddress: string;
290
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
291
+ externalId?: string | undefined;
292
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
293
+ travelRule?: ({
294
+ kind: "Notabene";
295
+ beneficiaryVASPdid?: string | undefined;
296
+ beneficiaryProof?: {
297
+ [x: string]: any;
298
+ } | undefined;
299
+ originator: {
300
+ [x: string]: any;
301
+ };
302
+ beneficiary: {
303
+ [x: string]: any;
304
+ };
305
+ }) | undefined;
306
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
307
+ feeSponsorId?: string | undefined;
308
+ } | {
309
+ kind: "Cis7";
310
+ /** The destination address. */
311
+ to: string;
312
+ /** The amount of tokens to transfer in minimum denomination. */
313
+ amount: string;
314
+ /** The Cis7 token identifier. */
315
+ tokenId: string;
316
+ /** The memo or destination tag. */
317
+ memo?: (string | "") | undefined;
318
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
319
+ externalId?: string | undefined;
320
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
321
+ travelRule?: ({
322
+ kind: "Notabene";
323
+ beneficiaryVASPdid?: string | undefined;
324
+ beneficiaryProof?: {
325
+ [x: string]: any;
326
+ } | undefined;
327
+ originator: {
328
+ [x: string]: any;
329
+ };
330
+ beneficiary: {
331
+ [x: string]: any;
332
+ };
333
+ }) | undefined;
334
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
335
+ feeSponsorId?: string | undefined;
336
+ } | {
337
+ kind: "Coin";
338
+ /** The coin identifier. */
339
+ coin: string;
340
+ /** The destination address. */
341
+ to: string;
342
+ /** The amount of tokens to transfer in minimum denomination. */
343
+ amount: string;
344
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
345
+ externalId?: string | undefined;
346
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
347
+ travelRule?: ({
348
+ kind: "Notabene";
349
+ beneficiaryVASPdid?: string | undefined;
350
+ beneficiaryProof?: {
351
+ [x: string]: any;
352
+ } | undefined;
353
+ originator: {
354
+ [x: string]: any;
355
+ };
356
+ beneficiary: {
357
+ [x: string]: any;
358
+ };
359
+ }) | undefined;
360
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
361
+ feeSponsorId?: string | undefined;
362
+ } | {
363
+ kind: "Erc20";
364
+ /** The ERC-20 contract address. */
365
+ contract: string;
366
+ /** The destination address. */
367
+ to: string;
368
+ /** The amount of tokens to transfer in minimum denomination. */
369
+ amount: string;
370
+ /** The priority that determines the fees paid for the transfer. */
371
+ priority?: ("Slow" | "Standard" | "Fast") | undefined;
372
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
373
+ externalId?: string | undefined;
374
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
375
+ travelRule?: ({
376
+ kind: "Notabene";
377
+ beneficiaryVASPdid?: string | undefined;
378
+ beneficiaryProof?: {
379
+ [x: string]: any;
380
+ } | undefined;
381
+ originator: {
382
+ [x: string]: any;
383
+ };
384
+ beneficiary: {
385
+ [x: string]: any;
386
+ };
387
+ }) | undefined;
388
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
389
+ feeSponsorId?: string | undefined;
390
+ } | {
391
+ kind: "Erc721";
392
+ /** The ERC-721 contract address. */
393
+ contract: string;
394
+ /** The destination address. */
395
+ to: string;
396
+ /** The token to transfer. */
397
+ tokenId: string;
398
+ /** The priority that determines the fees paid for the transfer. */
399
+ priority?: ("Slow" | "Standard" | "Fast") | undefined;
400
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
401
+ externalId?: string | undefined;
402
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
403
+ travelRule?: ({
404
+ kind: "Notabene";
405
+ beneficiaryVASPdid?: string | undefined;
406
+ beneficiaryProof?: {
407
+ [x: string]: any;
408
+ } | undefined;
409
+ originator: {
410
+ [x: string]: any;
411
+ };
412
+ beneficiary: {
413
+ [x: string]: any;
414
+ };
415
+ }) | undefined;
416
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
417
+ feeSponsorId?: string | undefined;
418
+ } | {
419
+ kind: "Hip17";
420
+ /** The token to transfer. */
421
+ tokenId: string;
422
+ serialNumber: string;
423
+ /** The destination address. */
424
+ to: string;
425
+ /** The memo or destination tag. */
426
+ memo?: (string | "") | undefined;
427
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
428
+ externalId?: string | undefined;
429
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
430
+ travelRule?: ({
431
+ kind: "Notabene";
432
+ beneficiaryVASPdid?: string | undefined;
433
+ beneficiaryProof?: {
434
+ [x: string]: any;
435
+ } | undefined;
436
+ originator: {
437
+ [x: string]: any;
438
+ };
439
+ beneficiary: {
440
+ [x: string]: any;
441
+ };
442
+ }) | undefined;
443
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
444
+ feeSponsorId?: string | undefined;
445
+ } | {
446
+ kind: "Hts";
447
+ /** The token to transfer. */
448
+ tokenId: string;
449
+ /** The destination address. */
450
+ to: string;
451
+ /** The amount of tokens to transfer in minimum denomination. */
452
+ amount: string;
453
+ /** The memo. */
454
+ memo?: (string | "") | undefined;
455
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
456
+ externalId?: string | undefined;
457
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
458
+ travelRule?: ({
459
+ kind: "Notabene";
460
+ beneficiaryVASPdid?: string | undefined;
461
+ beneficiaryProof?: {
462
+ [x: string]: any;
463
+ } | undefined;
464
+ originator: {
465
+ [x: string]: any;
466
+ };
467
+ beneficiary: {
468
+ [x: string]: any;
469
+ };
470
+ }) | undefined;
471
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
472
+ feeSponsorId?: string | undefined;
473
+ } | {
474
+ kind: "Iou";
475
+ /** The IOU currency code. */
476
+ currency: string;
477
+ /** The IOU issuer address. */
478
+ issuer: string;
479
+ /** The destination address. */
480
+ to: string;
481
+ /** The amount of tokens to transfer in minimum denomination. */
482
+ amount: string;
483
+ /** The memo or destination tag. */
484
+ memo?: (string | "") | undefined;
485
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
486
+ externalId?: string | undefined;
487
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
488
+ travelRule?: ({
489
+ kind: "Notabene";
490
+ beneficiaryVASPdid?: string | undefined;
491
+ beneficiaryProof?: {
492
+ [x: string]: any;
493
+ } | undefined;
494
+ originator: {
495
+ [x: string]: any;
496
+ };
497
+ beneficiary: {
498
+ [x: string]: any;
499
+ };
500
+ }) | undefined;
501
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
502
+ feeSponsorId?: string | undefined;
503
+ } | {
504
+ kind: "Sep41";
505
+ /** The asset issuer address. */
506
+ issuer: string;
507
+ /** The asset code. */
508
+ assetCode: string;
509
+ /** The destination address. */
510
+ to: string;
511
+ /** The amount of tokens to transfer in minimum denomination. */
512
+ amount: string;
513
+ /** The memo or destination tag. */
514
+ memo?: (string | "") | undefined;
515
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
516
+ externalId?: string | undefined;
517
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
518
+ travelRule?: ({
519
+ kind: "Notabene";
520
+ beneficiaryVASPdid?: string | undefined;
521
+ beneficiaryProof?: {
522
+ [x: string]: any;
523
+ } | undefined;
524
+ originator: {
525
+ [x: string]: any;
526
+ };
527
+ beneficiary: {
528
+ [x: string]: any;
529
+ };
530
+ }) | undefined;
531
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
532
+ feeSponsorId?: string | undefined;
533
+ } | {
534
+ kind: "Snip2";
535
+ /** The SNIP-2 (ERC-20-like) contract address. */
536
+ contract: string;
537
+ /** The destination address. */
538
+ to: string;
539
+ /** The amount of tokens to transfer in minimum denomination. */
540
+ amount: string;
541
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
542
+ externalId?: string | undefined;
543
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
544
+ travelRule?: ({
545
+ kind: "Notabene";
546
+ beneficiaryVASPdid?: string | undefined;
547
+ beneficiaryProof?: {
548
+ [x: string]: any;
549
+ } | undefined;
550
+ originator: {
551
+ [x: string]: any;
552
+ };
553
+ beneficiary: {
554
+ [x: string]: any;
555
+ };
556
+ }) | undefined;
557
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
558
+ feeSponsorId?: string | undefined;
559
+ } | {
560
+ kind: "Snip3";
561
+ /** The SNIP-3 (ERC-721) contract address. */
562
+ contract: string;
563
+ /** The destination address. */
564
+ to: string;
565
+ /** The token to transfer. */
566
+ tokenId: string;
567
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
568
+ externalId?: string | undefined;
569
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
570
+ travelRule?: ({
571
+ kind: "Notabene";
572
+ beneficiaryVASPdid?: string | undefined;
573
+ beneficiaryProof?: {
574
+ [x: string]: any;
575
+ } | undefined;
576
+ originator: {
577
+ [x: string]: any;
578
+ };
579
+ beneficiary: {
580
+ [x: string]: any;
581
+ };
582
+ }) | undefined;
583
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
584
+ feeSponsorId?: string | undefined;
585
+ } | {
586
+ kind: "Spl" | "Spl2022";
587
+ /** The destination address. */
588
+ to: string;
589
+ /** The amount of tokens to transfer in minimum denomination. */
590
+ amount: string;
591
+ /** The mint account address. */
592
+ mint: string;
593
+ /** The memo or destination tag. */
594
+ memo?: (string | "") | undefined;
595
+ /** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
596
+ createDestinationAccount?: boolean | undefined;
597
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
598
+ externalId?: string | undefined;
599
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
600
+ travelRule?: ({
601
+ kind: "Notabene";
602
+ beneficiaryVASPdid?: string | undefined;
603
+ beneficiaryProof?: {
604
+ [x: string]: any;
605
+ } | undefined;
606
+ originator: {
607
+ [x: string]: any;
608
+ };
609
+ beneficiary: {
610
+ [x: string]: any;
611
+ };
612
+ }) | undefined;
613
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
614
+ feeSponsorId?: string | undefined;
615
+ } | {
616
+ kind: "Tep74";
617
+ /** The destination address. */
618
+ to: string;
619
+ /** The Jetton master contract address. */
620
+ master: string;
621
+ /** The amount of tokens to transfer in minimum denomination. */
622
+ amount: string;
623
+ /** The memo or destination tag. */
624
+ memo?: (string | "") | undefined;
625
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
626
+ externalId?: string | undefined;
627
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
628
+ travelRule?: ({
629
+ kind: "Notabene";
630
+ beneficiaryVASPdid?: string | undefined;
631
+ beneficiaryProof?: {
632
+ [x: string]: any;
633
+ } | undefined;
634
+ originator: {
635
+ [x: string]: any;
636
+ };
637
+ beneficiary: {
638
+ [x: string]: any;
639
+ };
640
+ }) | undefined;
641
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
642
+ feeSponsorId?: string | undefined;
643
+ } | {
644
+ kind: "Trc10";
645
+ /** The token ID. */
646
+ tokenId: string;
647
+ /** The destination address. */
648
+ to: string;
649
+ /** The amount of tokens to transfer in minimum denomination. */
650
+ amount: string;
651
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
652
+ externalId?: string | undefined;
653
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
654
+ travelRule?: ({
655
+ kind: "Notabene";
656
+ beneficiaryVASPdid?: string | undefined;
657
+ beneficiaryProof?: {
658
+ [x: string]: any;
659
+ } | undefined;
660
+ originator: {
661
+ [x: string]: any;
662
+ };
663
+ beneficiary: {
664
+ [x: string]: any;
665
+ };
666
+ }) | undefined;
667
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
668
+ feeSponsorId?: string | undefined;
669
+ } | {
670
+ kind: "Trc20";
671
+ /** The smart contract address. */
672
+ contract: string;
673
+ /** The destination address. */
674
+ to: string;
675
+ /** The amount of tokens to transfer in minimum denomination. */
676
+ amount: string;
677
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
678
+ externalId?: string | undefined;
679
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
680
+ travelRule?: ({
681
+ kind: "Notabene";
682
+ beneficiaryVASPdid?: string | undefined;
683
+ beneficiaryProof?: {
684
+ [x: string]: any;
685
+ } | undefined;
686
+ originator: {
687
+ [x: string]: any;
688
+ };
689
+ beneficiary: {
690
+ [x: string]: any;
691
+ };
692
+ }) | undefined;
693
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
694
+ feeSponsorId?: string | undefined;
695
+ } | {
696
+ kind: "Trc721";
697
+ /** The smart contract address. */
698
+ contract: string;
699
+ /** The destination address. */
700
+ to: string;
701
+ /** The token to transfer. */
702
+ tokenId: string;
703
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
704
+ externalId?: string | undefined;
705
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
706
+ travelRule?: ({
707
+ kind: "Notabene";
708
+ beneficiaryVASPdid?: string | undefined;
709
+ beneficiaryProof?: {
710
+ [x: string]: any;
711
+ } | undefined;
712
+ originator: {
713
+ [x: string]: any;
714
+ };
715
+ beneficiary: {
716
+ [x: string]: any;
717
+ };
718
+ }) | undefined;
719
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
720
+ feeSponsorId?: string | undefined;
721
+ } | {
722
+ kind: "Xls33";
723
+ /** The XLS-33 issuance identifier. */
724
+ issuanceId: string;
725
+ /** The destination address. */
726
+ to: string;
727
+ /** The amount of tokens to transfer in minimum denomination. */
728
+ amount: string;
729
+ /** The memo or destination tag. */
730
+ memo?: (string | "") | undefined;
731
+ /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
732
+ externalId?: string | undefined;
733
+ /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
734
+ travelRule?: ({
735
+ kind: "Notabene";
736
+ beneficiaryVASPdid?: string | undefined;
737
+ beneficiaryProof?: {
738
+ [x: string]: any;
739
+ } | undefined;
740
+ originator: {
741
+ [x: string]: any;
742
+ };
743
+ beneficiary: {
744
+ [x: string]: any;
745
+ };
746
+ }) | undefined;
747
+ /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
748
+ feeSponsorId?: string | undefined;
749
+ };
750
+ /** Additional metadata about the transfered asset. */
751
+ metadata: {
752
+ asset: {
753
+ symbol?: string | undefined;
754
+ /** Number of decimals used by the asset, see [this guide](https://docs.dfns.co/guides/developers/displaying-balances) for more details. */
755
+ decimals?: number | undefined;
756
+ /** Whether the asset is verified by DFNS as legitimate. */
757
+ verified?: boolean | undefined;
758
+ /** Corresponding asset price in USD at the time of transfer. */
759
+ quotes?: {
760
+ [x: string]: number;
761
+ } | undefined;
762
+ };
763
+ };
764
+ /** Transfer status.
765
+
766
+ | Status | Definition |
767
+ | --- | --- |
768
+ | `Pending` | The request is pending approval due to a policy applied to the wallet. |
769
+ | `Executing` | The request is approved and is in the process of being executed. note this status is only set for a short time between pending and broadcasted. |
770
+ | `Broadcasted` | The transaction has been successfully written to the mempool. |
771
+ | `Confirmed` | The transaction has been confirmed on-chain by our indexing pipeline. |
772
+ | `Failed` | Indicates either system failure to complete the request or the transaction failed on chain. |
773
+ | `Rejected` | The request has been rejected by a policy approval action. | */
774
+ status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected";
775
+ /** The reason for a failed transfer. */
776
+ reason?: string | undefined;
777
+ /** The blockchain transaction hash for this transfer. */
778
+ txHash?: string | undefined;
779
+ /** The fee paid for this transfer in minimum denomination. */
780
+ fee?: string | undefined;
781
+ dateRequested: string;
782
+ datePolicyResolved?: string | undefined;
783
+ dateBroadcasted?: string | undefined;
784
+ dateConfirmed?: string | undefined;
785
+ /** The id of the approval request if this transfer triggered a policy. */
786
+ approvalId?: string | undefined;
787
+ /** The external id provided at transfer creation time. */
788
+ externalId?: string | undefined;
789
+ /** The fee sponsor id used to pay for the transfer fees. */
790
+ feeSponsorId?: string | undefined;
791
+ };
792
+ export type AbortTransferRequest = AbortTransferParams;
1
793
  export type AcceptOfferParams = {
2
794
  /** Wallet id. */
3
795
  walletId: string;