@dfns/sdk 0.7.12-rc.1 → 0.7.13-rc.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.
- package/dfnsError.d.ts +2 -2
- package/generated/auth/client.d.ts +1 -0
- package/generated/auth/client.js +12 -0
- package/generated/auth/delegatedClient.d.ts +1 -0
- package/generated/auth/delegatedClient.js +12 -0
- package/generated/auth/types.d.ts +115 -61
- package/generated/exchanges/types.d.ts +188 -36
- package/generated/keys/types.d.ts +300 -0
- package/generated/networks/types.d.ts +44 -21
- package/generated/policies/types.d.ts +903 -51
- package/generated/staking/types.d.ts +136 -0
- package/generated/swaps/types.d.ts +110 -10
- package/generated/wallets/types.d.ts +845 -84
- package/package.json +3 -3
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
export type AcceptOfferParams = {
|
|
2
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
3
2
|
walletId: string;
|
|
4
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
5
3
|
offerId: string;
|
|
6
4
|
};
|
|
7
5
|
export type AcceptOfferResponse = {
|
|
8
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
9
6
|
id: string;
|
|
10
|
-
/** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
|
|
11
7
|
orgId: string;
|
|
12
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
13
8
|
walletId: string;
|
|
14
9
|
network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
|
|
15
10
|
kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
|
|
@@ -34,15 +29,19 @@ export type AcceptOfferResponse = {
|
|
|
34
29
|
export type AcceptOfferRequest = AcceptOfferParams;
|
|
35
30
|
export type BroadcastTransactionBody = {
|
|
36
31
|
kind: "Transaction";
|
|
32
|
+
/** The unsigned hex encoded transaction. EVM transactions also accept JSON objects. */
|
|
37
33
|
transaction: string | {};
|
|
34
|
+
/** 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)). */
|
|
38
35
|
externalId?: string | undefined;
|
|
39
36
|
} | {
|
|
40
37
|
kind: "Evm";
|
|
41
38
|
to?: string | undefined;
|
|
42
39
|
value?: (string | string) | undefined;
|
|
43
40
|
data?: string | undefined;
|
|
41
|
+
/** The current nonce of the signer EOA. */
|
|
44
42
|
nonce?: (number | string | string) | undefined;
|
|
45
43
|
gasLimit?: (string | string) | undefined;
|
|
44
|
+
/** 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)). */
|
|
46
45
|
externalId?: string | undefined;
|
|
47
46
|
} | {
|
|
48
47
|
kind: "Eip1559";
|
|
@@ -53,32 +52,43 @@ export type BroadcastTransactionBody = {
|
|
|
53
52
|
gasLimit?: (string | string) | undefined;
|
|
54
53
|
maxFeePerGas?: (string | string) | undefined;
|
|
55
54
|
maxPriorityFeePerGas?: (string | string) | undefined;
|
|
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
56
|
externalId?: string | undefined;
|
|
57
57
|
} | {
|
|
58
58
|
kind: "Psbt";
|
|
59
|
+
/** The hex encoded PSBT. */
|
|
59
60
|
psbt: string;
|
|
61
|
+
/** 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
62
|
externalId?: string | undefined;
|
|
61
63
|
} | {
|
|
62
64
|
kind: "Json";
|
|
63
65
|
transaction: {};
|
|
66
|
+
/** 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)). */
|
|
64
67
|
externalId?: string | undefined;
|
|
65
68
|
} | {
|
|
66
69
|
kind: "SignDocDirect";
|
|
67
70
|
signDoc: string;
|
|
71
|
+
/** 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)). */
|
|
68
72
|
externalId?: string | undefined;
|
|
69
73
|
} | {
|
|
70
74
|
kind: "UserOperations";
|
|
71
75
|
userOperations: {
|
|
76
|
+
/** The destination address or target contract. */
|
|
72
77
|
to: string;
|
|
78
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
73
79
|
value?: string | undefined;
|
|
80
|
+
/** ABI encoded function call data in hex format. */
|
|
74
81
|
data?: string | undefined;
|
|
75
82
|
}[];
|
|
83
|
+
/** A fee sponsor id to sponsor the transaction fee by another wallet. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
|
|
76
84
|
feeSponsorId: string;
|
|
85
|
+
/** 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)). */
|
|
77
86
|
externalId?: string | undefined;
|
|
78
87
|
} | {
|
|
79
88
|
kind: "SettleOffer";
|
|
80
89
|
txHash: string;
|
|
81
90
|
decision: "Accept" | "Reject";
|
|
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)). */
|
|
82
92
|
externalId?: string | undefined;
|
|
83
93
|
};
|
|
84
94
|
export type BroadcastTransactionParams = {
|
|
@@ -94,15 +104,19 @@ export type BroadcastTransactionResponse = {
|
|
|
94
104
|
};
|
|
95
105
|
requestBody: {
|
|
96
106
|
kind: "Transaction";
|
|
107
|
+
/** The unsigned hex encoded transaction. EVM transactions also accept JSON objects. */
|
|
97
108
|
transaction: string | {};
|
|
109
|
+
/** 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
110
|
externalId?: string | undefined;
|
|
99
111
|
} | {
|
|
100
112
|
kind: "Evm";
|
|
101
113
|
to?: string | undefined;
|
|
102
114
|
value?: (string | string) | undefined;
|
|
103
115
|
data?: string | undefined;
|
|
116
|
+
/** The current nonce of the signer EOA. */
|
|
104
117
|
nonce?: (number | string | string) | undefined;
|
|
105
118
|
gasLimit?: (string | string) | undefined;
|
|
119
|
+
/** 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)). */
|
|
106
120
|
externalId?: string | undefined;
|
|
107
121
|
} | {
|
|
108
122
|
kind: "Eip1559";
|
|
@@ -113,32 +127,43 @@ export type BroadcastTransactionResponse = {
|
|
|
113
127
|
gasLimit?: (string | string) | undefined;
|
|
114
128
|
maxFeePerGas?: (string | string) | undefined;
|
|
115
129
|
maxPriorityFeePerGas?: (string | string) | undefined;
|
|
130
|
+
/** 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)). */
|
|
116
131
|
externalId?: string | undefined;
|
|
117
132
|
} | {
|
|
118
133
|
kind: "Psbt";
|
|
134
|
+
/** The hex encoded PSBT. */
|
|
119
135
|
psbt: string;
|
|
136
|
+
/** 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)). */
|
|
120
137
|
externalId?: string | undefined;
|
|
121
138
|
} | {
|
|
122
139
|
kind: "Json";
|
|
123
140
|
transaction: {};
|
|
141
|
+
/** 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)). */
|
|
124
142
|
externalId?: string | undefined;
|
|
125
143
|
} | {
|
|
126
144
|
kind: "SignDocDirect";
|
|
127
145
|
signDoc: string;
|
|
146
|
+
/** 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)). */
|
|
128
147
|
externalId?: string | undefined;
|
|
129
148
|
} | {
|
|
130
149
|
kind: "UserOperations";
|
|
131
150
|
userOperations: {
|
|
151
|
+
/** The destination address or target contract. */
|
|
132
152
|
to: string;
|
|
153
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
133
154
|
value?: string | undefined;
|
|
155
|
+
/** ABI encoded function call data in hex format. */
|
|
134
156
|
data?: string | undefined;
|
|
135
157
|
}[];
|
|
158
|
+
/** A fee sponsor id to sponsor the transaction fee by another wallet. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
|
|
136
159
|
feeSponsorId: string;
|
|
160
|
+
/** 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)). */
|
|
137
161
|
externalId?: string | undefined;
|
|
138
162
|
} | {
|
|
139
163
|
kind: "SettleOffer";
|
|
140
164
|
txHash: string;
|
|
141
165
|
decision: "Accept" | "Reject";
|
|
166
|
+
/** 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)). */
|
|
142
167
|
externalId?: string | undefined;
|
|
143
168
|
};
|
|
144
169
|
status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -156,36 +181,59 @@ export type BroadcastTransactionRequest = BroadcastTransactionParams & {
|
|
|
156
181
|
body: BroadcastTransactionBody;
|
|
157
182
|
};
|
|
158
183
|
export type CreateWalletBody = {
|
|
184
|
+
/** Network used for the wallet. */
|
|
159
185
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
186
|
+
/** Wallet nickname. */
|
|
160
187
|
name?: string | undefined;
|
|
188
|
+
/** Options for the wallet's underlying key */
|
|
161
189
|
signingKey?: {
|
|
190
|
+
/** Use this parameter to create a wallet from an existing key. This enables one key to be used across multiple networks and have the same address if networks share the same address format, ex. `Ethereum` and `Polygon`. If specified, requires the `Keys:Reuse` permission. If the key is delegated to an end user, then the new wallet will be automatically delegated to the same end user. */
|
|
162
191
|
id?: string | undefined;
|
|
163
|
-
scheme
|
|
192
|
+
/** Use this to specify the new key scheme for networks that support multiple key formats. ex. use `Schnorr` to create a `Bitcoin Taproot` wallet. */
|
|
193
|
+
scheme?: ("DH" | "ECDSA" | "EdDSA" | "Schnorr") | undefined;
|
|
194
|
+
/** Use this to specify the new key curve for networks that support multiple key formats. */
|
|
164
195
|
curve?: ("ed25519" | "secp256k1" | "stark") | undefined;
|
|
165
196
|
} | undefined;
|
|
197
|
+
/** ID of the end user to delegate this wallet to. The wallet will only be usable by the end user. More info [here](https://docs.dfns.co/advanced/delegated-signing). */
|
|
166
198
|
delegateTo?: string | undefined;
|
|
199
|
+
/** Specify if you want to create the wallet from a service account and later [delegate it](/api-reference/keys/delegate-key) to an end user. */
|
|
167
200
|
delayDelegation?: boolean | undefined;
|
|
201
|
+
/** User-defined value that can be used to correlate the entity with an external system */
|
|
168
202
|
externalId?: string | undefined;
|
|
203
|
+
/** List of tags to be created for this wallet. If specified, requires the `Wallets:Tags:Add` permission, like the [Tag Wallet](https://docs.dfns.co/api-reference/wallets/tag-wallet) endpoint. */
|
|
169
204
|
tags?: string[] | undefined;
|
|
170
205
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
171
206
|
validatorId?: string | undefined;
|
|
172
207
|
};
|
|
173
208
|
export type CreateWalletResponse = {
|
|
209
|
+
/** ID of the wallet. */
|
|
174
210
|
id: string;
|
|
211
|
+
/** Network this wallet is bound to. */
|
|
175
212
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
213
|
+
/** Wallet address on its corresponding network. */
|
|
176
214
|
address?: string | undefined;
|
|
215
|
+
/** Details about the key underlying the wallet. */
|
|
177
216
|
signingKey: {
|
|
178
217
|
id: string;
|
|
218
|
+
/** Key scheme. */
|
|
179
219
|
scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
|
|
180
220
|
curve: "ed25519" | "secp256k1" | "stark";
|
|
221
|
+
/** Hex-encoded value of the public key. */
|
|
181
222
|
publicKey: string;
|
|
223
|
+
/** The end user ID the key (and wallet) is delegated to. */
|
|
182
224
|
delegatedTo?: string | undefined;
|
|
183
225
|
};
|
|
226
|
+
/** Wallet status. */
|
|
184
227
|
status: "Active" | "Archived";
|
|
228
|
+
/** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
|
|
185
229
|
dateCreated: string;
|
|
230
|
+
/** Wallet nickname. */
|
|
186
231
|
name?: string | undefined;
|
|
232
|
+
/** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
|
|
187
233
|
custodial: boolean;
|
|
234
|
+
/** User-defined value that can be used to correlate the entity with an external system. */
|
|
188
235
|
externalId?: string | undefined;
|
|
236
|
+
/** List of tags. */
|
|
189
237
|
tags: string[];
|
|
190
238
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
191
239
|
validatorId?: string | undefined;
|
|
@@ -235,90 +283,165 @@ export type ExportWalletRequest = ExportWalletParams & {
|
|
|
235
283
|
};
|
|
236
284
|
export type GenerateSignatureBody = {
|
|
237
285
|
kind: "Hash";
|
|
286
|
+
/** 32-byte hash in hex encoded format. */
|
|
238
287
|
hash: string;
|
|
288
|
+
/** Required when signing with a Schnorr key. Specify the merkle root for tweaking the signing key, or the empty string "" to tweak with the default merkle root. */
|
|
239
289
|
taprootMerkleRoot?: string | undefined;
|
|
240
290
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
241
291
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
292
|
+
/** 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)). */
|
|
242
293
|
externalId?: string | undefined;
|
|
243
294
|
} | {
|
|
244
295
|
kind: "Message";
|
|
296
|
+
/** An arbitrary hex encoded message. */
|
|
245
297
|
message: string;
|
|
246
298
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
247
299
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
300
|
+
/** 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)). */
|
|
248
301
|
externalId?: string | undefined;
|
|
249
302
|
} | {
|
|
250
303
|
kind: "Eip7702";
|
|
304
|
+
/** The address of the contract the signer's EOA will be delegated to. */
|
|
251
305
|
address: string;
|
|
306
|
+
/** The current nonce of the signer EOA. */
|
|
252
307
|
nonce: number;
|
|
308
|
+
/** Chain ID. */
|
|
253
309
|
chainId: number;
|
|
254
310
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
255
311
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
312
|
+
/** 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)). */
|
|
256
313
|
externalId?: string | undefined;
|
|
257
314
|
} | {
|
|
258
315
|
kind: "Transaction";
|
|
316
|
+
/** The unsigned hex-encoded transaction. */
|
|
259
317
|
transaction: string;
|
|
260
318
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
261
319
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
320
|
+
/** 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)). */
|
|
262
321
|
externalId?: string | undefined;
|
|
263
322
|
} | {
|
|
264
323
|
kind: "Eip712";
|
|
324
|
+
/** Type definitions. */
|
|
265
325
|
types: {
|
|
266
326
|
[x: string]: {
|
|
267
327
|
name: string;
|
|
268
328
|
type: string;
|
|
269
329
|
}[];
|
|
270
330
|
};
|
|
331
|
+
/** Domain separator. */
|
|
271
332
|
domain: {
|
|
333
|
+
/** Name of the signing domain. */
|
|
272
334
|
name?: string | undefined;
|
|
335
|
+
/** Current major version of the signing domain. */
|
|
273
336
|
version?: string | undefined;
|
|
337
|
+
/** Chain ID. */
|
|
274
338
|
chainId?: (number | string) | undefined;
|
|
339
|
+
/** The address of the contract that will verify the signature. */
|
|
275
340
|
verifyingContract?: string | undefined;
|
|
341
|
+
/** 32-byte value as a last-resort domain separator. */
|
|
276
342
|
salt?: string | undefined;
|
|
277
343
|
};
|
|
344
|
+
/** Structured message to sign. */
|
|
278
345
|
message: {
|
|
279
346
|
[x: string]: unknown;
|
|
280
347
|
};
|
|
281
348
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
282
349
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
350
|
+
/** 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)). */
|
|
283
351
|
externalId?: string | undefined;
|
|
284
352
|
} | {
|
|
285
353
|
kind: "Psbt";
|
|
354
|
+
/** The hex encoded PSBT. */
|
|
286
355
|
psbt: string;
|
|
287
356
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
288
357
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
358
|
+
/** 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)). */
|
|
289
359
|
externalId?: string | undefined;
|
|
290
360
|
} | {
|
|
291
361
|
kind: "Bip322";
|
|
362
|
+
/** The generic message hex encoded. */
|
|
292
363
|
message: string;
|
|
364
|
+
/** Defaults to Simple if not present. The formatted signature is returned in the `signedData` field in the response. */
|
|
293
365
|
format?: ("Simple" | "Full") | undefined;
|
|
294
366
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
295
367
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
368
|
+
/** 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)). */
|
|
296
369
|
externalId?: string | undefined;
|
|
297
370
|
} | {
|
|
298
371
|
kind: "PactCommand";
|
|
372
|
+
/** The Pact command JSON, serialized into a string. */
|
|
299
373
|
command: string;
|
|
300
374
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
301
375
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
376
|
+
/** 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)). */
|
|
302
377
|
externalId?: string | undefined;
|
|
303
378
|
} | {
|
|
304
379
|
kind: "SignDocDirect";
|
|
380
|
+
/** The hex encoded `SignDoc` Protobuf. */
|
|
305
381
|
signDoc: string;
|
|
306
382
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
307
383
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
384
|
+
/** 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)). */
|
|
308
385
|
externalId?: string | undefined;
|
|
309
386
|
} | {
|
|
310
387
|
kind: "SignerPayload";
|
|
388
|
+
/** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
|
|
389
|
+
|
|
390
|
+
Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
|
|
391
|
+
|
|
392
|
+
| Field | Description | Type - Optional |
|
|
393
|
+
| -------------------- | ---------------------------------------------------------------------------------------- | -------------------- |
|
|
394
|
+
| `address` | ss58-encoded address of the sending account. | String |
|
|
395
|
+
| `blockHash` | The hash of the checkpoint block, hex encoded. | String |
|
|
396
|
+
| `blockNumber` | The checkpoint block number, hex encoded. | String |
|
|
397
|
+
| `era` | The number of blocks after the checkpoint for which a transaction is valid, hex encoded. | String |
|
|
398
|
+
| `genesisHash` | The genesis hash of the chain, hex encoded. | String |
|
|
399
|
+
| `metadataHash` | The metadataHash for the CheckMetadataHash SignedExtension, hex encoded. | String *(optional)* |
|
|
400
|
+
| `mode` | flag indicating whether to verify the metadata hash or not. | Integer *(optional)* |
|
|
401
|
+
| `method` | The encoded method with arguments, hex encoded. | String |
|
|
402
|
+
| `nonce` | The nonce for the transaction, hex encoded. | String |
|
|
403
|
+
| `tip` | The tip to increase transaction priority, hex encoded. | String |
|
|
404
|
+
| `version` | The version of the extrinsic. | Integer |
|
|
405
|
+
| `specVersion` | The current spec version for the runtime, hex encoded. | String |
|
|
406
|
+
| `transactionVersion` | The current transaction version for the runtime, hex encoded. | String |
|
|
407
|
+
| `signedExtensions` | The applicable signed extensions for this runtime. | Array<String> |
|
|
408
|
+
|
|
409
|
+
```json
|
|
410
|
+
{
|
|
411
|
+
"network": "Polymesh",
|
|
412
|
+
"kind": "SignerPayload",
|
|
413
|
+
"payload": {
|
|
414
|
+
"address": "5H5tTnmLUqRgvTZvTwCdBKYjKLBm2gkp7u38Q9UUdJa8m6rX",
|
|
415
|
+
"blockHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
416
|
+
"blockNumber": "0x00000000",
|
|
417
|
+
"era": "0x00",
|
|
418
|
+
"genesisHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
419
|
+
"method": "0x07141f3da32e72ac6eb6cb40d9e757594363a617b2c3964a2b6ec6895c6648f48d500000",
|
|
420
|
+
"nonce": "0x00000000",
|
|
421
|
+
"tip": "0x00000000000000000000000000000000",
|
|
422
|
+
"version": 4,
|
|
423
|
+
"specVersion": "0x006adb7a",
|
|
424
|
+
"transactionVersion": "0x00000007",
|
|
425
|
+
"signedExtensions": []
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
```
|
|
429
|
+
*/
|
|
311
430
|
payload: string | {};
|
|
312
431
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
313
432
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
433
|
+
/** 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)). */
|
|
314
434
|
externalId?: string | undefined;
|
|
315
435
|
} | {
|
|
316
436
|
kind: "Cip8";
|
|
437
|
+
/** The generic message hex encoded. */
|
|
317
438
|
payload?: string | undefined;
|
|
439
|
+
/** Allows an application to ask the user to sign some extra data but NOT put it inside the COSE structure (only as part of the data to sign). */
|
|
318
440
|
externalAad?: string | undefined;
|
|
319
441
|
context: "Signature1";
|
|
320
442
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
321
443
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
444
|
+
/** 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)). */
|
|
322
445
|
externalId?: string | undefined;
|
|
323
446
|
};
|
|
324
447
|
export type GenerateSignatureParams = {
|
|
@@ -333,90 +456,165 @@ export type GenerateSignatureResponse = {
|
|
|
333
456
|
};
|
|
334
457
|
requestBody: {
|
|
335
458
|
kind: "Hash";
|
|
459
|
+
/** 32-byte hash in hex encoded format. */
|
|
336
460
|
hash: string;
|
|
461
|
+
/** Required when signing with a Schnorr key. Specify the merkle root for tweaking the signing key, or the empty string "" to tweak with the default merkle root. */
|
|
337
462
|
taprootMerkleRoot?: string | undefined;
|
|
338
463
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
339
464
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
465
|
+
/** 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)). */
|
|
340
466
|
externalId?: string | undefined;
|
|
341
467
|
} | {
|
|
342
468
|
kind: "Message";
|
|
469
|
+
/** An arbitrary hex encoded message. */
|
|
343
470
|
message: string;
|
|
344
471
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
345
472
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
473
|
+
/** 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)). */
|
|
346
474
|
externalId?: string | undefined;
|
|
347
475
|
} | {
|
|
348
476
|
kind: "Eip7702";
|
|
477
|
+
/** The address of the contract the signer's EOA will be delegated to. */
|
|
349
478
|
address: string;
|
|
479
|
+
/** The current nonce of the signer EOA. */
|
|
350
480
|
nonce: number;
|
|
481
|
+
/** Chain ID. */
|
|
351
482
|
chainId: number;
|
|
352
483
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
353
484
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | 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)). */
|
|
354
486
|
externalId?: string | undefined;
|
|
355
487
|
} | {
|
|
356
488
|
kind: "Transaction";
|
|
489
|
+
/** The unsigned hex-encoded transaction. */
|
|
357
490
|
transaction: string;
|
|
358
491
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
359
492
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
493
|
+
/** 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)). */
|
|
360
494
|
externalId?: string | undefined;
|
|
361
495
|
} | {
|
|
362
496
|
kind: "Eip712";
|
|
497
|
+
/** Type definitions. */
|
|
363
498
|
types: {
|
|
364
499
|
[x: string]: {
|
|
365
500
|
name: string;
|
|
366
501
|
type: string;
|
|
367
502
|
}[];
|
|
368
503
|
};
|
|
504
|
+
/** Domain separator. */
|
|
369
505
|
domain: {
|
|
506
|
+
/** Name of the signing domain. */
|
|
370
507
|
name?: string | undefined;
|
|
508
|
+
/** Current major version of the signing domain. */
|
|
371
509
|
version?: string | undefined;
|
|
510
|
+
/** Chain ID. */
|
|
372
511
|
chainId?: (number | string) | undefined;
|
|
512
|
+
/** The address of the contract that will verify the signature. */
|
|
373
513
|
verifyingContract?: string | undefined;
|
|
514
|
+
/** 32-byte value as a last-resort domain separator. */
|
|
374
515
|
salt?: string | undefined;
|
|
375
516
|
};
|
|
517
|
+
/** Structured message to sign. */
|
|
376
518
|
message: {
|
|
377
519
|
[x: string]: unknown;
|
|
378
520
|
};
|
|
379
521
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
380
522
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
523
|
+
/** 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)). */
|
|
381
524
|
externalId?: string | undefined;
|
|
382
525
|
} | {
|
|
383
526
|
kind: "Psbt";
|
|
527
|
+
/** The hex encoded PSBT. */
|
|
384
528
|
psbt: string;
|
|
385
529
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
386
530
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
531
|
+
/** 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)). */
|
|
387
532
|
externalId?: string | undefined;
|
|
388
533
|
} | {
|
|
389
534
|
kind: "Bip322";
|
|
535
|
+
/** The generic message hex encoded. */
|
|
390
536
|
message: string;
|
|
537
|
+
/** Defaults to Simple if not present. The formatted signature is returned in the `signedData` field in the response. */
|
|
391
538
|
format?: ("Simple" | "Full") | undefined;
|
|
392
539
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
393
540
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
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)). */
|
|
394
542
|
externalId?: string | undefined;
|
|
395
543
|
} | {
|
|
396
544
|
kind: "PactCommand";
|
|
545
|
+
/** The Pact command JSON, serialized into a string. */
|
|
397
546
|
command: string;
|
|
398
547
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
399
548
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
549
|
+
/** 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)). */
|
|
400
550
|
externalId?: string | undefined;
|
|
401
551
|
} | {
|
|
402
552
|
kind: "SignDocDirect";
|
|
553
|
+
/** The hex encoded `SignDoc` Protobuf. */
|
|
403
554
|
signDoc: string;
|
|
404
555
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
405
556
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
557
|
+
/** 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)). */
|
|
406
558
|
externalId?: string | undefined;
|
|
407
559
|
} | {
|
|
408
560
|
kind: "SignerPayload";
|
|
561
|
+
/** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
|
|
562
|
+
|
|
563
|
+
Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
|
|
564
|
+
|
|
565
|
+
| Field | Description | Type - Optional |
|
|
566
|
+
| -------------------- | ---------------------------------------------------------------------------------------- | -------------------- |
|
|
567
|
+
| `address` | ss58-encoded address of the sending account. | String |
|
|
568
|
+
| `blockHash` | The hash of the checkpoint block, hex encoded. | String |
|
|
569
|
+
| `blockNumber` | The checkpoint block number, hex encoded. | String |
|
|
570
|
+
| `era` | The number of blocks after the checkpoint for which a transaction is valid, hex encoded. | String |
|
|
571
|
+
| `genesisHash` | The genesis hash of the chain, hex encoded. | String |
|
|
572
|
+
| `metadataHash` | The metadataHash for the CheckMetadataHash SignedExtension, hex encoded. | String *(optional)* |
|
|
573
|
+
| `mode` | flag indicating whether to verify the metadata hash or not. | Integer *(optional)* |
|
|
574
|
+
| `method` | The encoded method with arguments, hex encoded. | String |
|
|
575
|
+
| `nonce` | The nonce for the transaction, hex encoded. | String |
|
|
576
|
+
| `tip` | The tip to increase transaction priority, hex encoded. | String |
|
|
577
|
+
| `version` | The version of the extrinsic. | Integer |
|
|
578
|
+
| `specVersion` | The current spec version for the runtime, hex encoded. | String |
|
|
579
|
+
| `transactionVersion` | The current transaction version for the runtime, hex encoded. | String |
|
|
580
|
+
| `signedExtensions` | The applicable signed extensions for this runtime. | Array<String> |
|
|
581
|
+
|
|
582
|
+
```json
|
|
583
|
+
{
|
|
584
|
+
"network": "Polymesh",
|
|
585
|
+
"kind": "SignerPayload",
|
|
586
|
+
"payload": {
|
|
587
|
+
"address": "5H5tTnmLUqRgvTZvTwCdBKYjKLBm2gkp7u38Q9UUdJa8m6rX",
|
|
588
|
+
"blockHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
589
|
+
"blockNumber": "0x00000000",
|
|
590
|
+
"era": "0x00",
|
|
591
|
+
"genesisHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
592
|
+
"method": "0x07141f3da32e72ac6eb6cb40d9e757594363a617b2c3964a2b6ec6895c6648f48d500000",
|
|
593
|
+
"nonce": "0x00000000",
|
|
594
|
+
"tip": "0x00000000000000000000000000000000",
|
|
595
|
+
"version": 4,
|
|
596
|
+
"specVersion": "0x006adb7a",
|
|
597
|
+
"transactionVersion": "0x00000007",
|
|
598
|
+
"signedExtensions": []
|
|
599
|
+
}
|
|
600
|
+
}
|
|
601
|
+
```
|
|
602
|
+
*/
|
|
409
603
|
payload: string | {};
|
|
410
604
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
411
605
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
606
|
+
/** 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)). */
|
|
412
607
|
externalId?: string | undefined;
|
|
413
608
|
} | {
|
|
414
609
|
kind: "Cip8";
|
|
610
|
+
/** The generic message hex encoded. */
|
|
415
611
|
payload?: string | undefined;
|
|
612
|
+
/** Allows an application to ask the user to sign some extra data but NOT put it inside the COSE structure (only as part of the data to sign). */
|
|
416
613
|
externalAad?: string | undefined;
|
|
417
614
|
context: "Signature1";
|
|
418
615
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
419
616
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
617
|
+
/** 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)). */
|
|
420
618
|
externalId?: string | undefined;
|
|
421
619
|
};
|
|
422
620
|
status: "Pending" | "Executing" | "Signed" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -449,17 +647,12 @@ export type GenerateSignatureRequest = GenerateSignatureParams & {
|
|
|
449
647
|
body: GenerateSignatureBody;
|
|
450
648
|
};
|
|
451
649
|
export type GetOfferParams = {
|
|
452
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
453
650
|
walletId: string;
|
|
454
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
455
651
|
offerId: string;
|
|
456
652
|
};
|
|
457
653
|
export type GetOfferResponse = {
|
|
458
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
459
654
|
id: string;
|
|
460
|
-
/** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
|
|
461
655
|
orgId: string;
|
|
462
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
463
656
|
walletId: string;
|
|
464
657
|
network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
|
|
465
658
|
kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
|
|
@@ -495,90 +688,165 @@ export type GetSignatureResponse = {
|
|
|
495
688
|
};
|
|
496
689
|
requestBody: {
|
|
497
690
|
kind: "Hash";
|
|
691
|
+
/** 32-byte hash in hex encoded format. */
|
|
498
692
|
hash: string;
|
|
693
|
+
/** Required when signing with a Schnorr key. Specify the merkle root for tweaking the signing key, or the empty string "" to tweak with the default merkle root. */
|
|
499
694
|
taprootMerkleRoot?: string | undefined;
|
|
500
695
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
501
696
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
697
|
+
/** 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)). */
|
|
502
698
|
externalId?: string | undefined;
|
|
503
699
|
} | {
|
|
504
700
|
kind: "Message";
|
|
701
|
+
/** An arbitrary hex encoded message. */
|
|
505
702
|
message: string;
|
|
506
703
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
507
704
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
705
|
+
/** 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)). */
|
|
508
706
|
externalId?: string | undefined;
|
|
509
707
|
} | {
|
|
510
708
|
kind: "Eip7702";
|
|
709
|
+
/** The address of the contract the signer's EOA will be delegated to. */
|
|
511
710
|
address: string;
|
|
711
|
+
/** The current nonce of the signer EOA. */
|
|
512
712
|
nonce: number;
|
|
713
|
+
/** Chain ID. */
|
|
513
714
|
chainId: number;
|
|
514
715
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
515
716
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
717
|
+
/** 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
718
|
externalId?: string | undefined;
|
|
517
719
|
} | {
|
|
518
720
|
kind: "Transaction";
|
|
721
|
+
/** The unsigned hex-encoded transaction. */
|
|
519
722
|
transaction: string;
|
|
520
723
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
521
724
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
725
|
+
/** 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)). */
|
|
522
726
|
externalId?: string | undefined;
|
|
523
727
|
} | {
|
|
524
728
|
kind: "Eip712";
|
|
729
|
+
/** Type definitions. */
|
|
525
730
|
types: {
|
|
526
731
|
[x: string]: {
|
|
527
732
|
name: string;
|
|
528
733
|
type: string;
|
|
529
734
|
}[];
|
|
530
735
|
};
|
|
736
|
+
/** Domain separator. */
|
|
531
737
|
domain: {
|
|
738
|
+
/** Name of the signing domain. */
|
|
532
739
|
name?: string | undefined;
|
|
740
|
+
/** Current major version of the signing domain. */
|
|
533
741
|
version?: string | undefined;
|
|
742
|
+
/** Chain ID. */
|
|
534
743
|
chainId?: (number | string) | undefined;
|
|
744
|
+
/** The address of the contract that will verify the signature. */
|
|
535
745
|
verifyingContract?: string | undefined;
|
|
746
|
+
/** 32-byte value as a last-resort domain separator. */
|
|
536
747
|
salt?: string | undefined;
|
|
537
748
|
};
|
|
749
|
+
/** Structured message to sign. */
|
|
538
750
|
message: {
|
|
539
751
|
[x: string]: unknown;
|
|
540
752
|
};
|
|
541
753
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
542
754
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
755
|
+
/** 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)). */
|
|
543
756
|
externalId?: string | undefined;
|
|
544
757
|
} | {
|
|
545
758
|
kind: "Psbt";
|
|
759
|
+
/** The hex encoded PSBT. */
|
|
546
760
|
psbt: string;
|
|
547
761
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
548
762
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
763
|
+
/** 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)). */
|
|
549
764
|
externalId?: string | undefined;
|
|
550
765
|
} | {
|
|
551
766
|
kind: "Bip322";
|
|
767
|
+
/** The generic message hex encoded. */
|
|
552
768
|
message: string;
|
|
769
|
+
/** Defaults to Simple if not present. The formatted signature is returned in the `signedData` field in the response. */
|
|
553
770
|
format?: ("Simple" | "Full") | undefined;
|
|
554
771
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
555
772
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
773
|
+
/** 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)). */
|
|
556
774
|
externalId?: string | undefined;
|
|
557
775
|
} | {
|
|
558
776
|
kind: "PactCommand";
|
|
777
|
+
/** The Pact command JSON, serialized into a string. */
|
|
559
778
|
command: string;
|
|
560
779
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
561
780
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
781
|
+
/** 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)). */
|
|
562
782
|
externalId?: string | undefined;
|
|
563
783
|
} | {
|
|
564
784
|
kind: "SignDocDirect";
|
|
785
|
+
/** The hex encoded `SignDoc` Protobuf. */
|
|
565
786
|
signDoc: string;
|
|
566
787
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
567
788
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
789
|
+
/** 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
790
|
externalId?: string | undefined;
|
|
569
791
|
} | {
|
|
570
792
|
kind: "SignerPayload";
|
|
793
|
+
/** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
|
|
794
|
+
|
|
795
|
+
Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
|
|
796
|
+
|
|
797
|
+
| Field | Description | Type - Optional |
|
|
798
|
+
| -------------------- | ---------------------------------------------------------------------------------------- | -------------------- |
|
|
799
|
+
| `address` | ss58-encoded address of the sending account. | String |
|
|
800
|
+
| `blockHash` | The hash of the checkpoint block, hex encoded. | String |
|
|
801
|
+
| `blockNumber` | The checkpoint block number, hex encoded. | String |
|
|
802
|
+
| `era` | The number of blocks after the checkpoint for which a transaction is valid, hex encoded. | String |
|
|
803
|
+
| `genesisHash` | The genesis hash of the chain, hex encoded. | String |
|
|
804
|
+
| `metadataHash` | The metadataHash for the CheckMetadataHash SignedExtension, hex encoded. | String *(optional)* |
|
|
805
|
+
| `mode` | flag indicating whether to verify the metadata hash or not. | Integer *(optional)* |
|
|
806
|
+
| `method` | The encoded method with arguments, hex encoded. | String |
|
|
807
|
+
| `nonce` | The nonce for the transaction, hex encoded. | String |
|
|
808
|
+
| `tip` | The tip to increase transaction priority, hex encoded. | String |
|
|
809
|
+
| `version` | The version of the extrinsic. | Integer |
|
|
810
|
+
| `specVersion` | The current spec version for the runtime, hex encoded. | String |
|
|
811
|
+
| `transactionVersion` | The current transaction version for the runtime, hex encoded. | String |
|
|
812
|
+
| `signedExtensions` | The applicable signed extensions for this runtime. | Array<String> |
|
|
813
|
+
|
|
814
|
+
```json
|
|
815
|
+
{
|
|
816
|
+
"network": "Polymesh",
|
|
817
|
+
"kind": "SignerPayload",
|
|
818
|
+
"payload": {
|
|
819
|
+
"address": "5H5tTnmLUqRgvTZvTwCdBKYjKLBm2gkp7u38Q9UUdJa8m6rX",
|
|
820
|
+
"blockHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
821
|
+
"blockNumber": "0x00000000",
|
|
822
|
+
"era": "0x00",
|
|
823
|
+
"genesisHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
824
|
+
"method": "0x07141f3da32e72ac6eb6cb40d9e757594363a617b2c3964a2b6ec6895c6648f48d500000",
|
|
825
|
+
"nonce": "0x00000000",
|
|
826
|
+
"tip": "0x00000000000000000000000000000000",
|
|
827
|
+
"version": 4,
|
|
828
|
+
"specVersion": "0x006adb7a",
|
|
829
|
+
"transactionVersion": "0x00000007",
|
|
830
|
+
"signedExtensions": []
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
```
|
|
834
|
+
*/
|
|
571
835
|
payload: string | {};
|
|
572
836
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
573
837
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
838
|
+
/** 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)). */
|
|
574
839
|
externalId?: string | undefined;
|
|
575
840
|
} | {
|
|
576
841
|
kind: "Cip8";
|
|
842
|
+
/** The generic message hex encoded. */
|
|
577
843
|
payload?: string | undefined;
|
|
844
|
+
/** Allows an application to ask the user to sign some extra data but NOT put it inside the COSE structure (only as part of the data to sign). */
|
|
578
845
|
externalAad?: string | undefined;
|
|
579
846
|
context: "Signature1";
|
|
580
847
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
581
848
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
849
|
+
/** 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)). */
|
|
582
850
|
externalId?: string | undefined;
|
|
583
851
|
};
|
|
584
852
|
status: "Pending" | "Executing" | "Signed" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -621,15 +889,19 @@ export type GetTransactionResponse = {
|
|
|
621
889
|
};
|
|
622
890
|
requestBody: {
|
|
623
891
|
kind: "Transaction";
|
|
892
|
+
/** The unsigned hex encoded transaction. EVM transactions also accept JSON objects. */
|
|
624
893
|
transaction: string | {};
|
|
894
|
+
/** 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)). */
|
|
625
895
|
externalId?: string | undefined;
|
|
626
896
|
} | {
|
|
627
897
|
kind: "Evm";
|
|
628
898
|
to?: string | undefined;
|
|
629
899
|
value?: (string | string) | undefined;
|
|
630
900
|
data?: string | undefined;
|
|
901
|
+
/** The current nonce of the signer EOA. */
|
|
631
902
|
nonce?: (number | string | string) | undefined;
|
|
632
903
|
gasLimit?: (string | string) | undefined;
|
|
904
|
+
/** 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)). */
|
|
633
905
|
externalId?: string | undefined;
|
|
634
906
|
} | {
|
|
635
907
|
kind: "Eip1559";
|
|
@@ -640,32 +912,43 @@ export type GetTransactionResponse = {
|
|
|
640
912
|
gasLimit?: (string | string) | undefined;
|
|
641
913
|
maxFeePerGas?: (string | string) | undefined;
|
|
642
914
|
maxPriorityFeePerGas?: (string | string) | undefined;
|
|
915
|
+
/** 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)). */
|
|
643
916
|
externalId?: string | undefined;
|
|
644
917
|
} | {
|
|
645
918
|
kind: "Psbt";
|
|
919
|
+
/** The hex encoded PSBT. */
|
|
646
920
|
psbt: string;
|
|
921
|
+
/** 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)). */
|
|
647
922
|
externalId?: string | undefined;
|
|
648
923
|
} | {
|
|
649
924
|
kind: "Json";
|
|
650
925
|
transaction: {};
|
|
926
|
+
/** 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)). */
|
|
651
927
|
externalId?: string | undefined;
|
|
652
928
|
} | {
|
|
653
929
|
kind: "SignDocDirect";
|
|
654
930
|
signDoc: string;
|
|
931
|
+
/** 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)). */
|
|
655
932
|
externalId?: string | undefined;
|
|
656
933
|
} | {
|
|
657
934
|
kind: "UserOperations";
|
|
658
935
|
userOperations: {
|
|
936
|
+
/** The destination address or target contract. */
|
|
659
937
|
to: string;
|
|
938
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
660
939
|
value?: string | undefined;
|
|
940
|
+
/** ABI encoded function call data in hex format. */
|
|
661
941
|
data?: string | undefined;
|
|
662
942
|
}[];
|
|
943
|
+
/** A fee sponsor id to sponsor the transaction fee by another wallet. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
|
|
663
944
|
feeSponsorId: string;
|
|
945
|
+
/** 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)). */
|
|
664
946
|
externalId?: string | undefined;
|
|
665
947
|
} | {
|
|
666
948
|
kind: "SettleOffer";
|
|
667
949
|
txHash: string;
|
|
668
950
|
decision: "Accept" | "Reject";
|
|
951
|
+
/** 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)). */
|
|
669
952
|
externalId?: string | undefined;
|
|
670
953
|
};
|
|
671
954
|
status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -694,17 +977,25 @@ export type GetTransferResponse = {
|
|
|
694
977
|
};
|
|
695
978
|
requestBody: {
|
|
696
979
|
kind: "Native";
|
|
980
|
+
/** The destination address. */
|
|
697
981
|
to: string;
|
|
982
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
698
983
|
amount: string;
|
|
984
|
+
/** The memo or destination tag. `Stellar`, `TON` and `XrpLedger` support `memo`. Not valid for other networks. */
|
|
699
985
|
memo?: string | undefined;
|
|
986
|
+
/** 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. */
|
|
700
987
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
988
|
+
/** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
|
|
701
989
|
createDestinationAccount?: boolean | undefined;
|
|
702
|
-
/** Optional field for Canton, if true it will create a transfer offer */
|
|
990
|
+
/** Optional field for Canton, if true it will create a transfer offer. */
|
|
703
991
|
offer?: boolean | undefined;
|
|
704
992
|
/** Optional field for Canton, especially useful in the context of offers */
|
|
705
993
|
expiresAt?: string | undefined;
|
|
994
|
+
/** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
|
|
706
995
|
targetChain?: string | undefined;
|
|
996
|
+
/** 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)) */
|
|
707
997
|
externalId?: string | undefined;
|
|
998
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
708
999
|
travelRule?: ({
|
|
709
1000
|
kind: "Notabene";
|
|
710
1001
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -718,14 +1009,19 @@ export type GetTransferResponse = {
|
|
|
718
1009
|
[x: string]: any;
|
|
719
1010
|
};
|
|
720
1011
|
}) | undefined;
|
|
721
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1012
|
+
/** 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)) */
|
|
722
1013
|
feeSponsorId?: string | undefined;
|
|
723
1014
|
} | {
|
|
724
1015
|
kind: "Asa";
|
|
1016
|
+
/** The token asset id. */
|
|
725
1017
|
assetId: string;
|
|
1018
|
+
/** The destination address. */
|
|
726
1019
|
to: string;
|
|
1020
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
727
1021
|
amount: string;
|
|
1022
|
+
/** 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)) */
|
|
728
1023
|
externalId?: string | undefined;
|
|
1024
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
729
1025
|
travelRule?: ({
|
|
730
1026
|
kind: "Notabene";
|
|
731
1027
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -739,14 +1035,19 @@ export type GetTransferResponse = {
|
|
|
739
1035
|
[x: string]: any;
|
|
740
1036
|
};
|
|
741
1037
|
}) | undefined;
|
|
742
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1038
|
+
/** 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)) */
|
|
743
1039
|
feeSponsorId?: string | undefined;
|
|
744
1040
|
} | {
|
|
745
1041
|
kind: "Aip21";
|
|
1042
|
+
/** The asset metadata address. */
|
|
746
1043
|
metadata: string;
|
|
1044
|
+
/** The destination address. */
|
|
747
1045
|
to: string;
|
|
1046
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
748
1047
|
amount: string;
|
|
1048
|
+
/** 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)) */
|
|
749
1049
|
externalId?: string | undefined;
|
|
1050
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
750
1051
|
travelRule?: ({
|
|
751
1052
|
kind: "Notabene";
|
|
752
1053
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -760,14 +1061,19 @@ export type GetTransferResponse = {
|
|
|
760
1061
|
[x: string]: any;
|
|
761
1062
|
};
|
|
762
1063
|
}) | undefined;
|
|
763
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1064
|
+
/** 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)) */
|
|
764
1065
|
feeSponsorId?: string | undefined;
|
|
765
1066
|
} | {
|
|
766
1067
|
kind: "Asset";
|
|
1068
|
+
/** The token asset id. */
|
|
767
1069
|
assetId: string;
|
|
1070
|
+
/** The destination address. */
|
|
768
1071
|
to: string;
|
|
1072
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
769
1073
|
amount: string;
|
|
1074
|
+
/** 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)) */
|
|
770
1075
|
externalId?: string | undefined;
|
|
1076
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
771
1077
|
travelRule?: ({
|
|
772
1078
|
kind: "Notabene";
|
|
773
1079
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -781,14 +1087,19 @@ export type GetTransferResponse = {
|
|
|
781
1087
|
[x: string]: any;
|
|
782
1088
|
};
|
|
783
1089
|
}) | undefined;
|
|
784
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1090
|
+
/** 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)) */
|
|
785
1091
|
feeSponsorId?: string | undefined;
|
|
786
1092
|
} | {
|
|
787
1093
|
kind: "Coin";
|
|
1094
|
+
/** The coin identifier. */
|
|
788
1095
|
coin: string;
|
|
1096
|
+
/** The destination address. */
|
|
789
1097
|
to: string;
|
|
1098
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
790
1099
|
amount: string;
|
|
1100
|
+
/** 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)) */
|
|
791
1101
|
externalId?: string | undefined;
|
|
1102
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
792
1103
|
travelRule?: ({
|
|
793
1104
|
kind: "Notabene";
|
|
794
1105
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -802,15 +1113,21 @@ export type GetTransferResponse = {
|
|
|
802
1113
|
[x: string]: any;
|
|
803
1114
|
};
|
|
804
1115
|
}) | undefined;
|
|
805
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1116
|
+
/** 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)) */
|
|
806
1117
|
feeSponsorId?: string | undefined;
|
|
807
1118
|
} | {
|
|
808
1119
|
kind: "Erc20";
|
|
1120
|
+
/** The ERC-20 contract address. */
|
|
809
1121
|
contract: string;
|
|
1122
|
+
/** The destination address. */
|
|
810
1123
|
to: string;
|
|
1124
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
811
1125
|
amount: string;
|
|
1126
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
812
1127
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
1128
|
+
/** 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)) */
|
|
813
1129
|
externalId?: string | undefined;
|
|
1130
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
814
1131
|
travelRule?: ({
|
|
815
1132
|
kind: "Notabene";
|
|
816
1133
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -824,15 +1141,21 @@ export type GetTransferResponse = {
|
|
|
824
1141
|
[x: string]: any;
|
|
825
1142
|
};
|
|
826
1143
|
}) | undefined;
|
|
827
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1144
|
+
/** 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)) */
|
|
828
1145
|
feeSponsorId?: string | undefined;
|
|
829
1146
|
} | {
|
|
830
1147
|
kind: "Erc721";
|
|
1148
|
+
/** The ERC-721 contract address. */
|
|
831
1149
|
contract: string;
|
|
1150
|
+
/** The destination address. */
|
|
832
1151
|
to: string;
|
|
1152
|
+
/** The token to transfer. */
|
|
833
1153
|
tokenId: string;
|
|
1154
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
834
1155
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
1156
|
+
/** 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)) */
|
|
835
1157
|
externalId?: string | undefined;
|
|
1158
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
836
1159
|
travelRule?: ({
|
|
837
1160
|
kind: "Notabene";
|
|
838
1161
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -846,14 +1169,18 @@ export type GetTransferResponse = {
|
|
|
846
1169
|
[x: string]: any;
|
|
847
1170
|
};
|
|
848
1171
|
}) | undefined;
|
|
849
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1172
|
+
/** 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)) */
|
|
850
1173
|
feeSponsorId?: string | undefined;
|
|
851
1174
|
} | {
|
|
852
1175
|
kind: "Hip17";
|
|
1176
|
+
/** The token to transfer. */
|
|
853
1177
|
tokenId: string;
|
|
854
1178
|
serialNumber: string;
|
|
1179
|
+
/** The destination address. */
|
|
855
1180
|
to: string;
|
|
1181
|
+
/** 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)) */
|
|
856
1182
|
externalId?: string | undefined;
|
|
1183
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
857
1184
|
travelRule?: ({
|
|
858
1185
|
kind: "Notabene";
|
|
859
1186
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -867,14 +1194,19 @@ export type GetTransferResponse = {
|
|
|
867
1194
|
[x: string]: any;
|
|
868
1195
|
};
|
|
869
1196
|
}) | undefined;
|
|
870
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1197
|
+
/** 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)) */
|
|
871
1198
|
feeSponsorId?: string | undefined;
|
|
872
1199
|
} | {
|
|
873
1200
|
kind: "Hts";
|
|
1201
|
+
/** The token to transfer. */
|
|
874
1202
|
tokenId: string;
|
|
1203
|
+
/** The destination address. */
|
|
875
1204
|
to: string;
|
|
1205
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
876
1206
|
amount: string;
|
|
1207
|
+
/** 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)) */
|
|
877
1208
|
externalId?: string | undefined;
|
|
1209
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
878
1210
|
travelRule?: ({
|
|
879
1211
|
kind: "Notabene";
|
|
880
1212
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -888,16 +1220,23 @@ export type GetTransferResponse = {
|
|
|
888
1220
|
[x: string]: any;
|
|
889
1221
|
};
|
|
890
1222
|
}) | undefined;
|
|
891
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1223
|
+
/** 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)) */
|
|
892
1224
|
feeSponsorId?: string | undefined;
|
|
893
1225
|
} | {
|
|
894
1226
|
kind: "Sep41";
|
|
1227
|
+
/** The asset issuer address. */
|
|
895
1228
|
issuer: string;
|
|
1229
|
+
/** The asset code. */
|
|
896
1230
|
assetCode: string;
|
|
1231
|
+
/** The destination address. */
|
|
897
1232
|
to: string;
|
|
1233
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
898
1234
|
amount: string;
|
|
1235
|
+
/** The memo or destination tag. */
|
|
899
1236
|
memo?: string | undefined;
|
|
1237
|
+
/** 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)) */
|
|
900
1238
|
externalId?: string | undefined;
|
|
1239
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
901
1240
|
travelRule?: ({
|
|
902
1241
|
kind: "Notabene";
|
|
903
1242
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -911,15 +1250,21 @@ export type GetTransferResponse = {
|
|
|
911
1250
|
[x: string]: any;
|
|
912
1251
|
};
|
|
913
1252
|
}) | undefined;
|
|
914
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1253
|
+
/** 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)) */
|
|
915
1254
|
feeSponsorId?: string | undefined;
|
|
916
1255
|
} | {
|
|
917
1256
|
kind: "Spl" | "Spl2022";
|
|
1257
|
+
/** The destination address. */
|
|
918
1258
|
to: string;
|
|
1259
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
919
1260
|
amount: string;
|
|
1261
|
+
/** The mint account address. */
|
|
920
1262
|
mint: string;
|
|
1263
|
+
/** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
|
|
921
1264
|
createDestinationAccount?: boolean | undefined;
|
|
1265
|
+
/** 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)) */
|
|
922
1266
|
externalId?: string | undefined;
|
|
1267
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
923
1268
|
travelRule?: ({
|
|
924
1269
|
kind: "Notabene";
|
|
925
1270
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -933,15 +1278,21 @@ export type GetTransferResponse = {
|
|
|
933
1278
|
[x: string]: any;
|
|
934
1279
|
};
|
|
935
1280
|
}) | undefined;
|
|
936
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1281
|
+
/** 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)) */
|
|
937
1282
|
feeSponsorId?: string | undefined;
|
|
938
1283
|
} | {
|
|
939
1284
|
kind: "Tep74";
|
|
1285
|
+
/** The destination address. */
|
|
940
1286
|
to: string;
|
|
1287
|
+
/** The Jetton master contract address. */
|
|
941
1288
|
master: string;
|
|
1289
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
942
1290
|
amount: string;
|
|
1291
|
+
/** The memo or destination tag. */
|
|
943
1292
|
memo?: string | undefined;
|
|
1293
|
+
/** 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)) */
|
|
944
1294
|
externalId?: string | undefined;
|
|
1295
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
945
1296
|
travelRule?: ({
|
|
946
1297
|
kind: "Notabene";
|
|
947
1298
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -955,14 +1306,19 @@ export type GetTransferResponse = {
|
|
|
955
1306
|
[x: string]: any;
|
|
956
1307
|
};
|
|
957
1308
|
}) | undefined;
|
|
958
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1309
|
+
/** 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)) */
|
|
959
1310
|
feeSponsorId?: string | undefined;
|
|
960
1311
|
} | {
|
|
961
1312
|
kind: "Trc10";
|
|
1313
|
+
/** The token ID. */
|
|
962
1314
|
tokenId: string;
|
|
1315
|
+
/** The destination address. */
|
|
963
1316
|
to: string;
|
|
1317
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
964
1318
|
amount: string;
|
|
1319
|
+
/** 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)) */
|
|
965
1320
|
externalId?: string | undefined;
|
|
1321
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
966
1322
|
travelRule?: ({
|
|
967
1323
|
kind: "Notabene";
|
|
968
1324
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -976,14 +1332,19 @@ export type GetTransferResponse = {
|
|
|
976
1332
|
[x: string]: any;
|
|
977
1333
|
};
|
|
978
1334
|
}) | undefined;
|
|
979
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1335
|
+
/** 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)) */
|
|
980
1336
|
feeSponsorId?: string | undefined;
|
|
981
1337
|
} | {
|
|
982
1338
|
kind: "Trc20";
|
|
1339
|
+
/** The smart contract address. */
|
|
983
1340
|
contract: string;
|
|
1341
|
+
/** The destination address. */
|
|
984
1342
|
to: string;
|
|
1343
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
985
1344
|
amount: string;
|
|
1345
|
+
/** 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)) */
|
|
986
1346
|
externalId?: string | undefined;
|
|
1347
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
987
1348
|
travelRule?: ({
|
|
988
1349
|
kind: "Notabene";
|
|
989
1350
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -997,14 +1358,19 @@ export type GetTransferResponse = {
|
|
|
997
1358
|
[x: string]: any;
|
|
998
1359
|
};
|
|
999
1360
|
}) | undefined;
|
|
1000
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1361
|
+
/** 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)) */
|
|
1001
1362
|
feeSponsorId?: string | undefined;
|
|
1002
1363
|
} | {
|
|
1003
1364
|
kind: "Trc721";
|
|
1365
|
+
/** The smart contract address. */
|
|
1004
1366
|
contract: string;
|
|
1367
|
+
/** The destination address. */
|
|
1005
1368
|
to: string;
|
|
1369
|
+
/** The token to transfer. */
|
|
1006
1370
|
tokenId: string;
|
|
1371
|
+
/** 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)) */
|
|
1007
1372
|
externalId?: string | undefined;
|
|
1373
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
1008
1374
|
travelRule?: ({
|
|
1009
1375
|
kind: "Notabene";
|
|
1010
1376
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -1018,7 +1384,7 @@ export type GetTransferResponse = {
|
|
|
1018
1384
|
[x: string]: any;
|
|
1019
1385
|
};
|
|
1020
1386
|
}) | undefined;
|
|
1021
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
1387
|
+
/** 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)) */
|
|
1022
1388
|
feeSponsorId?: string | undefined;
|
|
1023
1389
|
};
|
|
1024
1390
|
metadata: {
|
|
@@ -1048,21 +1414,34 @@ export type GetWalletParams = {
|
|
|
1048
1414
|
walletId: string;
|
|
1049
1415
|
};
|
|
1050
1416
|
export type GetWalletResponse = {
|
|
1417
|
+
/** ID of the wallet. */
|
|
1051
1418
|
id: string;
|
|
1419
|
+
/** Network this wallet is bound to. */
|
|
1052
1420
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
1421
|
+
/** Wallet address on its corresponding network. */
|
|
1053
1422
|
address?: string | undefined;
|
|
1423
|
+
/** Details about the key underlying the wallet. */
|
|
1054
1424
|
signingKey: {
|
|
1055
1425
|
id: string;
|
|
1426
|
+
/** Key scheme. */
|
|
1056
1427
|
scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
|
|
1057
1428
|
curve: "ed25519" | "secp256k1" | "stark";
|
|
1429
|
+
/** Hex-encoded value of the public key. */
|
|
1058
1430
|
publicKey: string;
|
|
1431
|
+
/** The end user ID the key (and wallet) is delegated to. */
|
|
1059
1432
|
delegatedTo?: string | undefined;
|
|
1060
1433
|
};
|
|
1434
|
+
/** Wallet status. */
|
|
1061
1435
|
status: "Active" | "Archived";
|
|
1436
|
+
/** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
|
|
1062
1437
|
dateCreated: string;
|
|
1438
|
+
/** Wallet nickname. */
|
|
1063
1439
|
name?: string | undefined;
|
|
1440
|
+
/** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
|
|
1064
1441
|
custodial: boolean;
|
|
1442
|
+
/** User-defined value that can be used to correlate the entity with an external system. */
|
|
1065
1443
|
externalId?: string | undefined;
|
|
1444
|
+
/** List of tags. */
|
|
1066
1445
|
tags: string[];
|
|
1067
1446
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
1068
1447
|
validatorId?: string | undefined;
|
|
@@ -1755,20 +2134,31 @@ export type GetWalletNftsResponse = {
|
|
|
1755
2134
|
network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
|
|
1756
2135
|
nfts: ({
|
|
1757
2136
|
kind: "Asa";
|
|
2137
|
+
/** The NFT id. */
|
|
1758
2138
|
assetId: string;
|
|
2139
|
+
/** The NFT symbol. */
|
|
1759
2140
|
symbol?: string | undefined;
|
|
2141
|
+
/** The NFT metadata URI. */
|
|
1760
2142
|
tokenUri?: string | undefined;
|
|
1761
2143
|
} | {
|
|
1762
2144
|
kind: "Erc721" | "Trc721";
|
|
2145
|
+
/** contract address. */
|
|
1763
2146
|
contract: string;
|
|
2147
|
+
/** The NFT id. */
|
|
1764
2148
|
tokenId: string;
|
|
2149
|
+
/** The NFT symbol. */
|
|
1765
2150
|
symbol?: string | undefined;
|
|
2151
|
+
/** The NFT metadata URI. */
|
|
1766
2152
|
tokenUri?: string | undefined;
|
|
1767
2153
|
} | {
|
|
1768
2154
|
kind: "Hip17";
|
|
2155
|
+
/** The NFT id. */
|
|
1769
2156
|
tokenId: string;
|
|
2157
|
+
/** The NFT serial number. */
|
|
1770
2158
|
serialNumber: string;
|
|
2159
|
+
/** The NFT symbol. */
|
|
1771
2160
|
symbol?: string | undefined;
|
|
2161
|
+
/** The NFT metadata URI. */
|
|
1772
2162
|
tokenUri?: string | undefined;
|
|
1773
2163
|
})[];
|
|
1774
2164
|
};
|
|
@@ -1788,21 +2178,34 @@ export type ImportWalletBody = {
|
|
|
1788
2178
|
validatorId?: string | undefined;
|
|
1789
2179
|
};
|
|
1790
2180
|
export type ImportWalletResponse = {
|
|
2181
|
+
/** ID of the wallet. */
|
|
1791
2182
|
id: string;
|
|
2183
|
+
/** Network this wallet is bound to. */
|
|
1792
2184
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
2185
|
+
/** Wallet address on its corresponding network. */
|
|
1793
2186
|
address?: string | undefined;
|
|
2187
|
+
/** Details about the key underlying the wallet. */
|
|
1794
2188
|
signingKey: {
|
|
1795
2189
|
id: string;
|
|
2190
|
+
/** Key scheme. */
|
|
1796
2191
|
scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
|
|
1797
2192
|
curve: "ed25519" | "secp256k1" | "stark";
|
|
2193
|
+
/** Hex-encoded value of the public key. */
|
|
1798
2194
|
publicKey: string;
|
|
2195
|
+
/** The end user ID the key (and wallet) is delegated to. */
|
|
1799
2196
|
delegatedTo?: string | undefined;
|
|
1800
2197
|
};
|
|
2198
|
+
/** Wallet status. */
|
|
1801
2199
|
status: "Active" | "Archived";
|
|
2200
|
+
/** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
|
|
1802
2201
|
dateCreated: string;
|
|
2202
|
+
/** Wallet nickname. */
|
|
1803
2203
|
name?: string | undefined;
|
|
2204
|
+
/** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
|
|
1804
2205
|
custodial: boolean;
|
|
2206
|
+
/** User-defined value that can be used to correlate the entity with an external system. */
|
|
1805
2207
|
externalId?: string | undefined;
|
|
2208
|
+
/** List of tags. */
|
|
1806
2209
|
tags: string[];
|
|
1807
2210
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
1808
2211
|
validatorId?: string | undefined;
|
|
@@ -1811,7 +2214,6 @@ export type ImportWalletRequest = {
|
|
|
1811
2214
|
body: ImportWalletBody;
|
|
1812
2215
|
};
|
|
1813
2216
|
export type ListOffersParams = {
|
|
1814
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
1815
2217
|
walletId: string;
|
|
1816
2218
|
};
|
|
1817
2219
|
export type ListOffersQuery = {
|
|
@@ -1820,11 +2222,8 @@ export type ListOffersQuery = {
|
|
|
1820
2222
|
};
|
|
1821
2223
|
export type ListOffersResponse = {
|
|
1822
2224
|
items: {
|
|
1823
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
1824
2225
|
id: string;
|
|
1825
|
-
/** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
|
|
1826
2226
|
orgId: string;
|
|
1827
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
1828
2227
|
walletId: string;
|
|
1829
2228
|
network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
|
|
1830
2229
|
kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
|
|
@@ -1899,90 +2298,165 @@ export type ListSignaturesResponse = {
|
|
|
1899
2298
|
};
|
|
1900
2299
|
requestBody: {
|
|
1901
2300
|
kind: "Hash";
|
|
2301
|
+
/** 32-byte hash in hex encoded format. */
|
|
1902
2302
|
hash: string;
|
|
2303
|
+
/** Required when signing with a Schnorr key. Specify the merkle root for tweaking the signing key, or the empty string "" to tweak with the default merkle root. */
|
|
1903
2304
|
taprootMerkleRoot?: string | undefined;
|
|
1904
2305
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1905
2306
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2307
|
+
/** 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)). */
|
|
1906
2308
|
externalId?: string | undefined;
|
|
1907
2309
|
} | {
|
|
1908
2310
|
kind: "Message";
|
|
2311
|
+
/** An arbitrary hex encoded message. */
|
|
1909
2312
|
message: string;
|
|
1910
2313
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1911
2314
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2315
|
+
/** 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)). */
|
|
1912
2316
|
externalId?: string | undefined;
|
|
1913
2317
|
} | {
|
|
1914
2318
|
kind: "Eip7702";
|
|
2319
|
+
/** The address of the contract the signer's EOA will be delegated to. */
|
|
1915
2320
|
address: string;
|
|
2321
|
+
/** The current nonce of the signer EOA. */
|
|
1916
2322
|
nonce: number;
|
|
2323
|
+
/** Chain ID. */
|
|
1917
2324
|
chainId: number;
|
|
1918
2325
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1919
2326
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2327
|
+
/** 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)). */
|
|
1920
2328
|
externalId?: string | undefined;
|
|
1921
2329
|
} | {
|
|
1922
2330
|
kind: "Transaction";
|
|
2331
|
+
/** The unsigned hex-encoded transaction. */
|
|
1923
2332
|
transaction: string;
|
|
1924
2333
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1925
2334
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2335
|
+
/** 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)). */
|
|
1926
2336
|
externalId?: string | undefined;
|
|
1927
2337
|
} | {
|
|
1928
2338
|
kind: "Eip712";
|
|
2339
|
+
/** Type definitions. */
|
|
1929
2340
|
types: {
|
|
1930
2341
|
[x: string]: {
|
|
1931
2342
|
name: string;
|
|
1932
2343
|
type: string;
|
|
1933
2344
|
}[];
|
|
1934
2345
|
};
|
|
2346
|
+
/** Domain separator. */
|
|
1935
2347
|
domain: {
|
|
2348
|
+
/** Name of the signing domain. */
|
|
1936
2349
|
name?: string | undefined;
|
|
2350
|
+
/** Current major version of the signing domain. */
|
|
1937
2351
|
version?: string | undefined;
|
|
2352
|
+
/** Chain ID. */
|
|
1938
2353
|
chainId?: (number | string) | undefined;
|
|
2354
|
+
/** The address of the contract that will verify the signature. */
|
|
1939
2355
|
verifyingContract?: string | undefined;
|
|
2356
|
+
/** 32-byte value as a last-resort domain separator. */
|
|
1940
2357
|
salt?: string | undefined;
|
|
1941
2358
|
};
|
|
2359
|
+
/** Structured message to sign. */
|
|
1942
2360
|
message: {
|
|
1943
2361
|
[x: string]: unknown;
|
|
1944
2362
|
};
|
|
1945
2363
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1946
2364
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2365
|
+
/** 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)). */
|
|
1947
2366
|
externalId?: string | undefined;
|
|
1948
2367
|
} | {
|
|
1949
2368
|
kind: "Psbt";
|
|
2369
|
+
/** The hex encoded PSBT. */
|
|
1950
2370
|
psbt: string;
|
|
1951
2371
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1952
2372
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2373
|
+
/** 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)). */
|
|
1953
2374
|
externalId?: string | undefined;
|
|
1954
2375
|
} | {
|
|
1955
2376
|
kind: "Bip322";
|
|
2377
|
+
/** The generic message hex encoded. */
|
|
1956
2378
|
message: string;
|
|
2379
|
+
/** Defaults to Simple if not present. The formatted signature is returned in the `signedData` field in the response. */
|
|
1957
2380
|
format?: ("Simple" | "Full") | undefined;
|
|
1958
2381
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1959
2382
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2383
|
+
/** 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)). */
|
|
1960
2384
|
externalId?: string | undefined;
|
|
1961
2385
|
} | {
|
|
1962
2386
|
kind: "PactCommand";
|
|
2387
|
+
/** The Pact command JSON, serialized into a string. */
|
|
1963
2388
|
command: string;
|
|
1964
2389
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1965
2390
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2391
|
+
/** 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)). */
|
|
1966
2392
|
externalId?: string | undefined;
|
|
1967
2393
|
} | {
|
|
1968
2394
|
kind: "SignDocDirect";
|
|
2395
|
+
/** The hex encoded `SignDoc` Protobuf. */
|
|
1969
2396
|
signDoc: string;
|
|
1970
2397
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1971
2398
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2399
|
+
/** 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)). */
|
|
1972
2400
|
externalId?: string | undefined;
|
|
1973
2401
|
} | {
|
|
1974
2402
|
kind: "SignerPayload";
|
|
2403
|
+
/** The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.
|
|
2404
|
+
|
|
2405
|
+
Please refer to the original Polkadot definition for more details: [SignerPayloadJson](https://github.com/polkadot-js/api/blob/v16.2.2/packages/types/src/types/extrinsic.ts#L32). Note that additional fields will be rejected.
|
|
2406
|
+
|
|
2407
|
+
| Field | Description | Type - Optional |
|
|
2408
|
+
| -------------------- | ---------------------------------------------------------------------------------------- | -------------------- |
|
|
2409
|
+
| `address` | ss58-encoded address of the sending account. | String |
|
|
2410
|
+
| `blockHash` | The hash of the checkpoint block, hex encoded. | String |
|
|
2411
|
+
| `blockNumber` | The checkpoint block number, hex encoded. | String |
|
|
2412
|
+
| `era` | The number of blocks after the checkpoint for which a transaction is valid, hex encoded. | String |
|
|
2413
|
+
| `genesisHash` | The genesis hash of the chain, hex encoded. | String |
|
|
2414
|
+
| `metadataHash` | The metadataHash for the CheckMetadataHash SignedExtension, hex encoded. | String *(optional)* |
|
|
2415
|
+
| `mode` | flag indicating whether to verify the metadata hash or not. | Integer *(optional)* |
|
|
2416
|
+
| `method` | The encoded method with arguments, hex encoded. | String |
|
|
2417
|
+
| `nonce` | The nonce for the transaction, hex encoded. | String |
|
|
2418
|
+
| `tip` | The tip to increase transaction priority, hex encoded. | String |
|
|
2419
|
+
| `version` | The version of the extrinsic. | Integer |
|
|
2420
|
+
| `specVersion` | The current spec version for the runtime, hex encoded. | String |
|
|
2421
|
+
| `transactionVersion` | The current transaction version for the runtime, hex encoded. | String |
|
|
2422
|
+
| `signedExtensions` | The applicable signed extensions for this runtime. | Array<String> |
|
|
2423
|
+
|
|
2424
|
+
```json
|
|
2425
|
+
{
|
|
2426
|
+
"network": "Polymesh",
|
|
2427
|
+
"kind": "SignerPayload",
|
|
2428
|
+
"payload": {
|
|
2429
|
+
"address": "5H5tTnmLUqRgvTZvTwCdBKYjKLBm2gkp7u38Q9UUdJa8m6rX",
|
|
2430
|
+
"blockHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
2431
|
+
"blockNumber": "0x00000000",
|
|
2432
|
+
"era": "0x00",
|
|
2433
|
+
"genesisHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
|
|
2434
|
+
"method": "0x07141f3da32e72ac6eb6cb40d9e757594363a617b2c3964a2b6ec6895c6648f48d500000",
|
|
2435
|
+
"nonce": "0x00000000",
|
|
2436
|
+
"tip": "0x00000000000000000000000000000000",
|
|
2437
|
+
"version": 4,
|
|
2438
|
+
"specVersion": "0x006adb7a",
|
|
2439
|
+
"transactionVersion": "0x00000007",
|
|
2440
|
+
"signedExtensions": []
|
|
2441
|
+
}
|
|
2442
|
+
}
|
|
2443
|
+
```
|
|
2444
|
+
*/
|
|
1975
2445
|
payload: string | {};
|
|
1976
2446
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1977
2447
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2448
|
+
/** 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)). */
|
|
1978
2449
|
externalId?: string | undefined;
|
|
1979
2450
|
} | {
|
|
1980
2451
|
kind: "Cip8";
|
|
2452
|
+
/** The generic message hex encoded. */
|
|
1981
2453
|
payload?: string | undefined;
|
|
2454
|
+
/** Allows an application to ask the user to sign some extra data but NOT put it inside the COSE structure (only as part of the data to sign). */
|
|
1982
2455
|
externalAad?: string | undefined;
|
|
1983
2456
|
context: "Signature1";
|
|
1984
2457
|
network?: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | undefined;
|
|
1985
2458
|
blockchainKind?: ("Algorand" | "Aptos" | "Bitcoin" | "BitcoinCash" | "Canton" | "Cardano" | "Cosmos" | "Evm" | "Hedera" | "Icp" | "Iota" | "Kadena" | "Kaspa" | "Near" | "Polymesh" | "Solana" | "Stellar" | "Substrate" | "Sui" | "Tezos" | "Ton" | "Tron" | "Xrpl") | undefined;
|
|
2459
|
+
/** 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)). */
|
|
1986
2460
|
externalId?: string | undefined;
|
|
1987
2461
|
};
|
|
1988
2462
|
status: "Pending" | "Executing" | "Signed" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -2034,15 +2508,19 @@ export type ListTransactionsResponse = {
|
|
|
2034
2508
|
};
|
|
2035
2509
|
requestBody: {
|
|
2036
2510
|
kind: "Transaction";
|
|
2511
|
+
/** The unsigned hex encoded transaction. EVM transactions also accept JSON objects. */
|
|
2037
2512
|
transaction: string | {};
|
|
2513
|
+
/** 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)). */
|
|
2038
2514
|
externalId?: string | undefined;
|
|
2039
2515
|
} | {
|
|
2040
2516
|
kind: "Evm";
|
|
2041
2517
|
to?: string | undefined;
|
|
2042
2518
|
value?: (string | string) | undefined;
|
|
2043
2519
|
data?: string | undefined;
|
|
2520
|
+
/** The current nonce of the signer EOA. */
|
|
2044
2521
|
nonce?: (number | string | string) | undefined;
|
|
2045
2522
|
gasLimit?: (string | string) | undefined;
|
|
2523
|
+
/** 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)). */
|
|
2046
2524
|
externalId?: string | undefined;
|
|
2047
2525
|
} | {
|
|
2048
2526
|
kind: "Eip1559";
|
|
@@ -2053,32 +2531,43 @@ export type ListTransactionsResponse = {
|
|
|
2053
2531
|
gasLimit?: (string | string) | undefined;
|
|
2054
2532
|
maxFeePerGas?: (string | string) | undefined;
|
|
2055
2533
|
maxPriorityFeePerGas?: (string | string) | undefined;
|
|
2534
|
+
/** 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)). */
|
|
2056
2535
|
externalId?: string | undefined;
|
|
2057
2536
|
} | {
|
|
2058
2537
|
kind: "Psbt";
|
|
2538
|
+
/** The hex encoded PSBT. */
|
|
2059
2539
|
psbt: string;
|
|
2540
|
+
/** 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)). */
|
|
2060
2541
|
externalId?: string | undefined;
|
|
2061
2542
|
} | {
|
|
2062
2543
|
kind: "Json";
|
|
2063
2544
|
transaction: {};
|
|
2545
|
+
/** 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)). */
|
|
2064
2546
|
externalId?: string | undefined;
|
|
2065
2547
|
} | {
|
|
2066
2548
|
kind: "SignDocDirect";
|
|
2067
2549
|
signDoc: string;
|
|
2550
|
+
/** 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)). */
|
|
2068
2551
|
externalId?: string | undefined;
|
|
2069
2552
|
} | {
|
|
2070
2553
|
kind: "UserOperations";
|
|
2071
2554
|
userOperations: {
|
|
2555
|
+
/** The destination address or target contract. */
|
|
2072
2556
|
to: string;
|
|
2557
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
2073
2558
|
value?: string | undefined;
|
|
2559
|
+
/** ABI encoded function call data in hex format. */
|
|
2074
2560
|
data?: string | undefined;
|
|
2075
2561
|
}[];
|
|
2562
|
+
/** A fee sponsor id to sponsor the transaction fee by another wallet. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
|
|
2076
2563
|
feeSponsorId: string;
|
|
2564
|
+
/** 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)). */
|
|
2077
2565
|
externalId?: string | undefined;
|
|
2078
2566
|
} | {
|
|
2079
2567
|
kind: "SettleOffer";
|
|
2080
2568
|
txHash: string;
|
|
2081
2569
|
decision: "Accept" | "Reject";
|
|
2570
|
+
/** 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)). */
|
|
2082
2571
|
externalId?: string | undefined;
|
|
2083
2572
|
};
|
|
2084
2573
|
status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected";
|
|
@@ -2116,17 +2605,25 @@ export type ListTransfersResponse = {
|
|
|
2116
2605
|
};
|
|
2117
2606
|
requestBody: {
|
|
2118
2607
|
kind: "Native";
|
|
2608
|
+
/** The destination address. */
|
|
2119
2609
|
to: string;
|
|
2610
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
2120
2611
|
amount: string;
|
|
2612
|
+
/** The memo or destination tag. `Stellar`, `TON` and `XrpLedger` support `memo`. Not valid for other networks. */
|
|
2121
2613
|
memo?: string | undefined;
|
|
2614
|
+
/** 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. */
|
|
2122
2615
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
2616
|
+
/** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
|
|
2123
2617
|
createDestinationAccount?: boolean | undefined;
|
|
2124
|
-
/** Optional field for Canton, if true it will create a transfer offer */
|
|
2618
|
+
/** Optional field for Canton, if true it will create a transfer offer. */
|
|
2125
2619
|
offer?: boolean | undefined;
|
|
2126
2620
|
/** Optional field for Canton, especially useful in the context of offers */
|
|
2127
2621
|
expiresAt?: string | undefined;
|
|
2622
|
+
/** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
|
|
2128
2623
|
targetChain?: string | undefined;
|
|
2624
|
+
/** 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)) */
|
|
2129
2625
|
externalId?: string | undefined;
|
|
2626
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2130
2627
|
travelRule?: ({
|
|
2131
2628
|
kind: "Notabene";
|
|
2132
2629
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2140,14 +2637,19 @@ export type ListTransfersResponse = {
|
|
|
2140
2637
|
[x: string]: any;
|
|
2141
2638
|
};
|
|
2142
2639
|
}) | undefined;
|
|
2143
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2640
|
+
/** 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)) */
|
|
2144
2641
|
feeSponsorId?: string | undefined;
|
|
2145
2642
|
} | {
|
|
2146
2643
|
kind: "Asa";
|
|
2644
|
+
/** The token asset id. */
|
|
2147
2645
|
assetId: string;
|
|
2646
|
+
/** The destination address. */
|
|
2148
2647
|
to: string;
|
|
2648
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2149
2649
|
amount: string;
|
|
2650
|
+
/** 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)) */
|
|
2150
2651
|
externalId?: string | undefined;
|
|
2652
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2151
2653
|
travelRule?: ({
|
|
2152
2654
|
kind: "Notabene";
|
|
2153
2655
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2161,14 +2663,19 @@ export type ListTransfersResponse = {
|
|
|
2161
2663
|
[x: string]: any;
|
|
2162
2664
|
};
|
|
2163
2665
|
}) | undefined;
|
|
2164
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2666
|
+
/** 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)) */
|
|
2165
2667
|
feeSponsorId?: string | undefined;
|
|
2166
2668
|
} | {
|
|
2167
2669
|
kind: "Aip21";
|
|
2670
|
+
/** The asset metadata address. */
|
|
2168
2671
|
metadata: string;
|
|
2672
|
+
/** The destination address. */
|
|
2169
2673
|
to: string;
|
|
2674
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2170
2675
|
amount: string;
|
|
2676
|
+
/** 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)) */
|
|
2171
2677
|
externalId?: string | undefined;
|
|
2678
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2172
2679
|
travelRule?: ({
|
|
2173
2680
|
kind: "Notabene";
|
|
2174
2681
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2182,14 +2689,19 @@ export type ListTransfersResponse = {
|
|
|
2182
2689
|
[x: string]: any;
|
|
2183
2690
|
};
|
|
2184
2691
|
}) | undefined;
|
|
2185
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2692
|
+
/** 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)) */
|
|
2186
2693
|
feeSponsorId?: string | undefined;
|
|
2187
2694
|
} | {
|
|
2188
2695
|
kind: "Asset";
|
|
2696
|
+
/** The token asset id. */
|
|
2189
2697
|
assetId: string;
|
|
2698
|
+
/** The destination address. */
|
|
2190
2699
|
to: string;
|
|
2700
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2191
2701
|
amount: string;
|
|
2702
|
+
/** 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)) */
|
|
2192
2703
|
externalId?: string | undefined;
|
|
2704
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2193
2705
|
travelRule?: ({
|
|
2194
2706
|
kind: "Notabene";
|
|
2195
2707
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2203,14 +2715,19 @@ export type ListTransfersResponse = {
|
|
|
2203
2715
|
[x: string]: any;
|
|
2204
2716
|
};
|
|
2205
2717
|
}) | undefined;
|
|
2206
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2718
|
+
/** 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)) */
|
|
2207
2719
|
feeSponsorId?: string | undefined;
|
|
2208
2720
|
} | {
|
|
2209
2721
|
kind: "Coin";
|
|
2722
|
+
/** The coin identifier. */
|
|
2210
2723
|
coin: string;
|
|
2724
|
+
/** The destination address. */
|
|
2211
2725
|
to: string;
|
|
2726
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2212
2727
|
amount: string;
|
|
2728
|
+
/** 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)) */
|
|
2213
2729
|
externalId?: string | undefined;
|
|
2730
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2214
2731
|
travelRule?: ({
|
|
2215
2732
|
kind: "Notabene";
|
|
2216
2733
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2224,15 +2741,21 @@ export type ListTransfersResponse = {
|
|
|
2224
2741
|
[x: string]: any;
|
|
2225
2742
|
};
|
|
2226
2743
|
}) | undefined;
|
|
2227
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2744
|
+
/** 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)) */
|
|
2228
2745
|
feeSponsorId?: string | undefined;
|
|
2229
2746
|
} | {
|
|
2230
2747
|
kind: "Erc20";
|
|
2748
|
+
/** The ERC-20 contract address. */
|
|
2231
2749
|
contract: string;
|
|
2750
|
+
/** The destination address. */
|
|
2232
2751
|
to: string;
|
|
2752
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2233
2753
|
amount: string;
|
|
2754
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
2234
2755
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
2756
|
+
/** 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)) */
|
|
2235
2757
|
externalId?: string | undefined;
|
|
2758
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2236
2759
|
travelRule?: ({
|
|
2237
2760
|
kind: "Notabene";
|
|
2238
2761
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2246,15 +2769,21 @@ export type ListTransfersResponse = {
|
|
|
2246
2769
|
[x: string]: any;
|
|
2247
2770
|
};
|
|
2248
2771
|
}) | undefined;
|
|
2249
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2772
|
+
/** 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)) */
|
|
2250
2773
|
feeSponsorId?: string | undefined;
|
|
2251
2774
|
} | {
|
|
2252
2775
|
kind: "Erc721";
|
|
2776
|
+
/** The ERC-721 contract address. */
|
|
2253
2777
|
contract: string;
|
|
2778
|
+
/** The destination address. */
|
|
2254
2779
|
to: string;
|
|
2780
|
+
/** The token to transfer. */
|
|
2255
2781
|
tokenId: string;
|
|
2782
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
2256
2783
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
2784
|
+
/** 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)) */
|
|
2257
2785
|
externalId?: string | undefined;
|
|
2786
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2258
2787
|
travelRule?: ({
|
|
2259
2788
|
kind: "Notabene";
|
|
2260
2789
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2268,14 +2797,18 @@ export type ListTransfersResponse = {
|
|
|
2268
2797
|
[x: string]: any;
|
|
2269
2798
|
};
|
|
2270
2799
|
}) | undefined;
|
|
2271
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2800
|
+
/** 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)) */
|
|
2272
2801
|
feeSponsorId?: string | undefined;
|
|
2273
2802
|
} | {
|
|
2274
2803
|
kind: "Hip17";
|
|
2804
|
+
/** The token to transfer. */
|
|
2275
2805
|
tokenId: string;
|
|
2276
2806
|
serialNumber: string;
|
|
2807
|
+
/** The destination address. */
|
|
2277
2808
|
to: string;
|
|
2809
|
+
/** 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)) */
|
|
2278
2810
|
externalId?: string | undefined;
|
|
2811
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2279
2812
|
travelRule?: ({
|
|
2280
2813
|
kind: "Notabene";
|
|
2281
2814
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2289,14 +2822,19 @@ export type ListTransfersResponse = {
|
|
|
2289
2822
|
[x: string]: any;
|
|
2290
2823
|
};
|
|
2291
2824
|
}) | undefined;
|
|
2292
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2825
|
+
/** 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)) */
|
|
2293
2826
|
feeSponsorId?: string | undefined;
|
|
2294
2827
|
} | {
|
|
2295
2828
|
kind: "Hts";
|
|
2829
|
+
/** The token to transfer. */
|
|
2296
2830
|
tokenId: string;
|
|
2831
|
+
/** The destination address. */
|
|
2297
2832
|
to: string;
|
|
2833
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2298
2834
|
amount: string;
|
|
2835
|
+
/** 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)) */
|
|
2299
2836
|
externalId?: string | undefined;
|
|
2837
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2300
2838
|
travelRule?: ({
|
|
2301
2839
|
kind: "Notabene";
|
|
2302
2840
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2310,16 +2848,23 @@ export type ListTransfersResponse = {
|
|
|
2310
2848
|
[x: string]: any;
|
|
2311
2849
|
};
|
|
2312
2850
|
}) | undefined;
|
|
2313
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2851
|
+
/** 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)) */
|
|
2314
2852
|
feeSponsorId?: string | undefined;
|
|
2315
2853
|
} | {
|
|
2316
2854
|
kind: "Sep41";
|
|
2855
|
+
/** The asset issuer address. */
|
|
2317
2856
|
issuer: string;
|
|
2857
|
+
/** The asset code. */
|
|
2318
2858
|
assetCode: string;
|
|
2859
|
+
/** The destination address. */
|
|
2319
2860
|
to: string;
|
|
2861
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2320
2862
|
amount: string;
|
|
2863
|
+
/** The memo or destination tag. */
|
|
2321
2864
|
memo?: string | undefined;
|
|
2865
|
+
/** 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)) */
|
|
2322
2866
|
externalId?: string | undefined;
|
|
2867
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2323
2868
|
travelRule?: ({
|
|
2324
2869
|
kind: "Notabene";
|
|
2325
2870
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2333,15 +2878,21 @@ export type ListTransfersResponse = {
|
|
|
2333
2878
|
[x: string]: any;
|
|
2334
2879
|
};
|
|
2335
2880
|
}) | undefined;
|
|
2336
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2881
|
+
/** 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)) */
|
|
2337
2882
|
feeSponsorId?: string | undefined;
|
|
2338
2883
|
} | {
|
|
2339
2884
|
kind: "Spl" | "Spl2022";
|
|
2885
|
+
/** The destination address. */
|
|
2340
2886
|
to: string;
|
|
2887
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2341
2888
|
amount: string;
|
|
2889
|
+
/** The mint account address. */
|
|
2342
2890
|
mint: string;
|
|
2891
|
+
/** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
|
|
2343
2892
|
createDestinationAccount?: boolean | undefined;
|
|
2893
|
+
/** 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)) */
|
|
2344
2894
|
externalId?: string | undefined;
|
|
2895
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2345
2896
|
travelRule?: ({
|
|
2346
2897
|
kind: "Notabene";
|
|
2347
2898
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2355,15 +2906,21 @@ export type ListTransfersResponse = {
|
|
|
2355
2906
|
[x: string]: any;
|
|
2356
2907
|
};
|
|
2357
2908
|
}) | undefined;
|
|
2358
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2909
|
+
/** 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)) */
|
|
2359
2910
|
feeSponsorId?: string | undefined;
|
|
2360
2911
|
} | {
|
|
2361
2912
|
kind: "Tep74";
|
|
2913
|
+
/** The destination address. */
|
|
2362
2914
|
to: string;
|
|
2915
|
+
/** The Jetton master contract address. */
|
|
2363
2916
|
master: string;
|
|
2917
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2364
2918
|
amount: string;
|
|
2919
|
+
/** The memo or destination tag. */
|
|
2365
2920
|
memo?: string | undefined;
|
|
2921
|
+
/** 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)) */
|
|
2366
2922
|
externalId?: string | undefined;
|
|
2923
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2367
2924
|
travelRule?: ({
|
|
2368
2925
|
kind: "Notabene";
|
|
2369
2926
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2377,14 +2934,19 @@ export type ListTransfersResponse = {
|
|
|
2377
2934
|
[x: string]: any;
|
|
2378
2935
|
};
|
|
2379
2936
|
}) | undefined;
|
|
2380
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2937
|
+
/** 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)) */
|
|
2381
2938
|
feeSponsorId?: string | undefined;
|
|
2382
2939
|
} | {
|
|
2383
2940
|
kind: "Trc10";
|
|
2941
|
+
/** The token ID. */
|
|
2384
2942
|
tokenId: string;
|
|
2943
|
+
/** The destination address. */
|
|
2385
2944
|
to: string;
|
|
2945
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2386
2946
|
amount: string;
|
|
2947
|
+
/** 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)) */
|
|
2387
2948
|
externalId?: string | undefined;
|
|
2949
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2388
2950
|
travelRule?: ({
|
|
2389
2951
|
kind: "Notabene";
|
|
2390
2952
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2398,14 +2960,19 @@ export type ListTransfersResponse = {
|
|
|
2398
2960
|
[x: string]: any;
|
|
2399
2961
|
};
|
|
2400
2962
|
}) | undefined;
|
|
2401
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2963
|
+
/** 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)) */
|
|
2402
2964
|
feeSponsorId?: string | undefined;
|
|
2403
2965
|
} | {
|
|
2404
2966
|
kind: "Trc20";
|
|
2967
|
+
/** The smart contract address. */
|
|
2405
2968
|
contract: string;
|
|
2969
|
+
/** The destination address. */
|
|
2406
2970
|
to: string;
|
|
2971
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2407
2972
|
amount: string;
|
|
2973
|
+
/** 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)) */
|
|
2408
2974
|
externalId?: string | undefined;
|
|
2975
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2409
2976
|
travelRule?: ({
|
|
2410
2977
|
kind: "Notabene";
|
|
2411
2978
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2419,14 +2986,19 @@ export type ListTransfersResponse = {
|
|
|
2419
2986
|
[x: string]: any;
|
|
2420
2987
|
};
|
|
2421
2988
|
}) | undefined;
|
|
2422
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
2989
|
+
/** 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)) */
|
|
2423
2990
|
feeSponsorId?: string | undefined;
|
|
2424
2991
|
} | {
|
|
2425
2992
|
kind: "Trc721";
|
|
2993
|
+
/** The smart contract address. */
|
|
2426
2994
|
contract: string;
|
|
2995
|
+
/** The destination address. */
|
|
2427
2996
|
to: string;
|
|
2997
|
+
/** The token to transfer. */
|
|
2428
2998
|
tokenId: string;
|
|
2999
|
+
/** 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)) */
|
|
2429
3000
|
externalId?: string | undefined;
|
|
3001
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2430
3002
|
travelRule?: ({
|
|
2431
3003
|
kind: "Notabene";
|
|
2432
3004
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2440,7 +3012,7 @@ export type ListTransfersResponse = {
|
|
|
2440
3012
|
[x: string]: any;
|
|
2441
3013
|
};
|
|
2442
3014
|
}) | undefined;
|
|
2443
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3015
|
+
/** 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)) */
|
|
2444
3016
|
feeSponsorId?: string | undefined;
|
|
2445
3017
|
};
|
|
2446
3018
|
metadata: {
|
|
@@ -2481,21 +3053,34 @@ export type ListWalletsQuery = {
|
|
|
2481
3053
|
};
|
|
2482
3054
|
export type ListWalletsResponse = {
|
|
2483
3055
|
items: {
|
|
3056
|
+
/** ID of the wallet. */
|
|
2484
3057
|
id: string;
|
|
3058
|
+
/** Network this wallet is bound to. */
|
|
2485
3059
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
3060
|
+
/** Wallet address on its corresponding network. */
|
|
2486
3061
|
address?: string | undefined;
|
|
3062
|
+
/** Details about the key underlying the wallet. */
|
|
2487
3063
|
signingKey: {
|
|
2488
3064
|
id: string;
|
|
3065
|
+
/** Key scheme. */
|
|
2489
3066
|
scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
|
|
2490
3067
|
curve: "ed25519" | "secp256k1" | "stark";
|
|
3068
|
+
/** Hex-encoded value of the public key. */
|
|
2491
3069
|
publicKey: string;
|
|
3070
|
+
/** The end user ID the key (and wallet) is delegated to. */
|
|
2492
3071
|
delegatedTo?: string | undefined;
|
|
2493
3072
|
};
|
|
3073
|
+
/** Wallet status. */
|
|
2494
3074
|
status: "Active" | "Archived";
|
|
3075
|
+
/** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
|
|
2495
3076
|
dateCreated: string;
|
|
3077
|
+
/** Wallet nickname. */
|
|
2496
3078
|
name?: string | undefined;
|
|
3079
|
+
/** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
|
|
2497
3080
|
custodial: boolean;
|
|
3081
|
+
/** User-defined value that can be used to correlate the entity with an external system. */
|
|
2498
3082
|
externalId?: string | undefined;
|
|
3083
|
+
/** List of tags. */
|
|
2499
3084
|
tags: string[];
|
|
2500
3085
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
2501
3086
|
validatorId?: string | undefined;
|
|
@@ -2506,17 +3091,12 @@ export type ListWalletsRequest = {
|
|
|
2506
3091
|
query?: ListWalletsQuery;
|
|
2507
3092
|
};
|
|
2508
3093
|
export type RejectOfferParams = {
|
|
2509
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
2510
3094
|
walletId: string;
|
|
2511
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
2512
3095
|
offerId: string;
|
|
2513
3096
|
};
|
|
2514
3097
|
export type RejectOfferResponse = {
|
|
2515
|
-
/** e.g. 'offer-3ugfu-o8duj-vqu770ckmg7ilhp4' */
|
|
2516
3098
|
id: string;
|
|
2517
|
-
/** e.g. 'or-30tnh-itmjs-s235s5ontr3r23h2' */
|
|
2518
3099
|
orgId: string;
|
|
2519
|
-
/** e.g. 'wa-5pfuu-9euek-h0odgb6snva8ph3k' */
|
|
2520
3100
|
walletId: string;
|
|
2521
3101
|
network: "Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet";
|
|
2522
3102
|
kind: "Native" | "Aip21" | "Asa" | "Coin" | "Erc20" | "Erc721" | "Asset" | "Hip17" | "Hts" | "Sep41" | "Spl" | "Spl2022" | "Tep74" | "Trc10" | "Trc20" | "Trc721";
|
|
@@ -2551,17 +3131,25 @@ export type TagWalletRequest = TagWalletParams & {
|
|
|
2551
3131
|
};
|
|
2552
3132
|
export type TransferAssetBody = {
|
|
2553
3133
|
kind: "Native";
|
|
3134
|
+
/** The destination address. */
|
|
2554
3135
|
to: string;
|
|
3136
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
2555
3137
|
amount: string;
|
|
3138
|
+
/** The memo or destination tag. `Stellar`, `TON` and `XrpLedger` support `memo`. Not valid for other networks. */
|
|
2556
3139
|
memo?: string | undefined;
|
|
3140
|
+
/** 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. */
|
|
2557
3141
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3142
|
+
/** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
|
|
2558
3143
|
createDestinationAccount?: boolean | undefined;
|
|
2559
|
-
/** Optional field for Canton, if true it will create a transfer offer */
|
|
3144
|
+
/** Optional field for Canton, if true it will create a transfer offer. */
|
|
2560
3145
|
offer?: boolean | undefined;
|
|
2561
3146
|
/** Optional field for Canton, especially useful in the context of offers */
|
|
2562
3147
|
expiresAt?: string | undefined;
|
|
3148
|
+
/** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
|
|
2563
3149
|
targetChain?: string | undefined;
|
|
3150
|
+
/** 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)) */
|
|
2564
3151
|
externalId?: string | undefined;
|
|
3152
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2565
3153
|
travelRule?: ({
|
|
2566
3154
|
kind: "Notabene";
|
|
2567
3155
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2575,14 +3163,19 @@ export type TransferAssetBody = {
|
|
|
2575
3163
|
[x: string]: any;
|
|
2576
3164
|
};
|
|
2577
3165
|
}) | undefined;
|
|
2578
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3166
|
+
/** 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)) */
|
|
2579
3167
|
feeSponsorId?: string | undefined;
|
|
2580
3168
|
} | {
|
|
2581
3169
|
kind: "Asa";
|
|
3170
|
+
/** The token asset id. */
|
|
2582
3171
|
assetId: string;
|
|
3172
|
+
/** The destination address. */
|
|
2583
3173
|
to: string;
|
|
3174
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2584
3175
|
amount: string;
|
|
3176
|
+
/** 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)) */
|
|
2585
3177
|
externalId?: string | undefined;
|
|
3178
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2586
3179
|
travelRule?: ({
|
|
2587
3180
|
kind: "Notabene";
|
|
2588
3181
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2596,14 +3189,19 @@ export type TransferAssetBody = {
|
|
|
2596
3189
|
[x: string]: any;
|
|
2597
3190
|
};
|
|
2598
3191
|
}) | undefined;
|
|
2599
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3192
|
+
/** 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)) */
|
|
2600
3193
|
feeSponsorId?: string | undefined;
|
|
2601
3194
|
} | {
|
|
2602
3195
|
kind: "Aip21";
|
|
3196
|
+
/** The asset metadata address. */
|
|
2603
3197
|
metadata: string;
|
|
3198
|
+
/** The destination address. */
|
|
2604
3199
|
to: string;
|
|
3200
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2605
3201
|
amount: string;
|
|
3202
|
+
/** 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)) */
|
|
2606
3203
|
externalId?: string | undefined;
|
|
3204
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2607
3205
|
travelRule?: ({
|
|
2608
3206
|
kind: "Notabene";
|
|
2609
3207
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2617,14 +3215,19 @@ export type TransferAssetBody = {
|
|
|
2617
3215
|
[x: string]: any;
|
|
2618
3216
|
};
|
|
2619
3217
|
}) | undefined;
|
|
2620
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3218
|
+
/** 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)) */
|
|
2621
3219
|
feeSponsorId?: string | undefined;
|
|
2622
3220
|
} | {
|
|
2623
3221
|
kind: "Asset";
|
|
3222
|
+
/** The token asset id. */
|
|
2624
3223
|
assetId: string;
|
|
3224
|
+
/** The destination address. */
|
|
2625
3225
|
to: string;
|
|
3226
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2626
3227
|
amount: string;
|
|
3228
|
+
/** 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)) */
|
|
2627
3229
|
externalId?: string | undefined;
|
|
3230
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2628
3231
|
travelRule?: ({
|
|
2629
3232
|
kind: "Notabene";
|
|
2630
3233
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2638,14 +3241,19 @@ export type TransferAssetBody = {
|
|
|
2638
3241
|
[x: string]: any;
|
|
2639
3242
|
};
|
|
2640
3243
|
}) | undefined;
|
|
2641
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3244
|
+
/** 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)) */
|
|
2642
3245
|
feeSponsorId?: string | undefined;
|
|
2643
3246
|
} | {
|
|
2644
3247
|
kind: "Coin";
|
|
3248
|
+
/** The coin identifier. */
|
|
2645
3249
|
coin: string;
|
|
3250
|
+
/** The destination address. */
|
|
2646
3251
|
to: string;
|
|
3252
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2647
3253
|
amount: string;
|
|
3254
|
+
/** 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)) */
|
|
2648
3255
|
externalId?: string | undefined;
|
|
3256
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2649
3257
|
travelRule?: ({
|
|
2650
3258
|
kind: "Notabene";
|
|
2651
3259
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2659,15 +3267,21 @@ export type TransferAssetBody = {
|
|
|
2659
3267
|
[x: string]: any;
|
|
2660
3268
|
};
|
|
2661
3269
|
}) | undefined;
|
|
2662
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3270
|
+
/** 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)) */
|
|
2663
3271
|
feeSponsorId?: string | undefined;
|
|
2664
3272
|
} | {
|
|
2665
3273
|
kind: "Erc20";
|
|
3274
|
+
/** The ERC-20 contract address. */
|
|
2666
3275
|
contract: string;
|
|
3276
|
+
/** The destination address. */
|
|
2667
3277
|
to: string;
|
|
3278
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2668
3279
|
amount: string;
|
|
3280
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
2669
3281
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3282
|
+
/** 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)) */
|
|
2670
3283
|
externalId?: string | undefined;
|
|
3284
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2671
3285
|
travelRule?: ({
|
|
2672
3286
|
kind: "Notabene";
|
|
2673
3287
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2681,15 +3295,21 @@ export type TransferAssetBody = {
|
|
|
2681
3295
|
[x: string]: any;
|
|
2682
3296
|
};
|
|
2683
3297
|
}) | undefined;
|
|
2684
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3298
|
+
/** 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)) */
|
|
2685
3299
|
feeSponsorId?: string | undefined;
|
|
2686
3300
|
} | {
|
|
2687
3301
|
kind: "Erc721";
|
|
3302
|
+
/** The ERC-721 contract address. */
|
|
2688
3303
|
contract: string;
|
|
3304
|
+
/** The destination address. */
|
|
2689
3305
|
to: string;
|
|
3306
|
+
/** The token to transfer. */
|
|
2690
3307
|
tokenId: string;
|
|
3308
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
2691
3309
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3310
|
+
/** 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)) */
|
|
2692
3311
|
externalId?: string | undefined;
|
|
3312
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2693
3313
|
travelRule?: ({
|
|
2694
3314
|
kind: "Notabene";
|
|
2695
3315
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2703,14 +3323,18 @@ export type TransferAssetBody = {
|
|
|
2703
3323
|
[x: string]: any;
|
|
2704
3324
|
};
|
|
2705
3325
|
}) | undefined;
|
|
2706
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3326
|
+
/** 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)) */
|
|
2707
3327
|
feeSponsorId?: string | undefined;
|
|
2708
3328
|
} | {
|
|
2709
3329
|
kind: "Hip17";
|
|
3330
|
+
/** The token to transfer. */
|
|
2710
3331
|
tokenId: string;
|
|
2711
3332
|
serialNumber: string;
|
|
3333
|
+
/** The destination address. */
|
|
2712
3334
|
to: string;
|
|
3335
|
+
/** 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)) */
|
|
2713
3336
|
externalId?: string | undefined;
|
|
3337
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2714
3338
|
travelRule?: ({
|
|
2715
3339
|
kind: "Notabene";
|
|
2716
3340
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2724,14 +3348,19 @@ export type TransferAssetBody = {
|
|
|
2724
3348
|
[x: string]: any;
|
|
2725
3349
|
};
|
|
2726
3350
|
}) | undefined;
|
|
2727
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3351
|
+
/** 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)) */
|
|
2728
3352
|
feeSponsorId?: string | undefined;
|
|
2729
3353
|
} | {
|
|
2730
3354
|
kind: "Hts";
|
|
3355
|
+
/** The token to transfer. */
|
|
2731
3356
|
tokenId: string;
|
|
3357
|
+
/** The destination address. */
|
|
2732
3358
|
to: string;
|
|
3359
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2733
3360
|
amount: string;
|
|
3361
|
+
/** 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)) */
|
|
2734
3362
|
externalId?: string | undefined;
|
|
3363
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2735
3364
|
travelRule?: ({
|
|
2736
3365
|
kind: "Notabene";
|
|
2737
3366
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2745,16 +3374,23 @@ export type TransferAssetBody = {
|
|
|
2745
3374
|
[x: string]: any;
|
|
2746
3375
|
};
|
|
2747
3376
|
}) | undefined;
|
|
2748
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3377
|
+
/** 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)) */
|
|
2749
3378
|
feeSponsorId?: string | undefined;
|
|
2750
3379
|
} | {
|
|
2751
3380
|
kind: "Sep41";
|
|
3381
|
+
/** The asset issuer address. */
|
|
2752
3382
|
issuer: string;
|
|
3383
|
+
/** The asset code. */
|
|
2753
3384
|
assetCode: string;
|
|
3385
|
+
/** The destination address. */
|
|
2754
3386
|
to: string;
|
|
3387
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2755
3388
|
amount: string;
|
|
3389
|
+
/** The memo or destination tag. */
|
|
2756
3390
|
memo?: string | undefined;
|
|
3391
|
+
/** 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)) */
|
|
2757
3392
|
externalId?: string | undefined;
|
|
3393
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2758
3394
|
travelRule?: ({
|
|
2759
3395
|
kind: "Notabene";
|
|
2760
3396
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2768,15 +3404,21 @@ export type TransferAssetBody = {
|
|
|
2768
3404
|
[x: string]: any;
|
|
2769
3405
|
};
|
|
2770
3406
|
}) | undefined;
|
|
2771
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3407
|
+
/** 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)) */
|
|
2772
3408
|
feeSponsorId?: string | undefined;
|
|
2773
3409
|
} | {
|
|
2774
3410
|
kind: "Spl" | "Spl2022";
|
|
3411
|
+
/** The destination address. */
|
|
2775
3412
|
to: string;
|
|
3413
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2776
3414
|
amount: string;
|
|
3415
|
+
/** The mint account address. */
|
|
2777
3416
|
mint: string;
|
|
3417
|
+
/** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
|
|
2778
3418
|
createDestinationAccount?: boolean | undefined;
|
|
3419
|
+
/** 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)) */
|
|
2779
3420
|
externalId?: string | undefined;
|
|
3421
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2780
3422
|
travelRule?: ({
|
|
2781
3423
|
kind: "Notabene";
|
|
2782
3424
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2790,15 +3432,21 @@ export type TransferAssetBody = {
|
|
|
2790
3432
|
[x: string]: any;
|
|
2791
3433
|
};
|
|
2792
3434
|
}) | undefined;
|
|
2793
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3435
|
+
/** 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)) */
|
|
2794
3436
|
feeSponsorId?: string | undefined;
|
|
2795
3437
|
} | {
|
|
2796
3438
|
kind: "Tep74";
|
|
3439
|
+
/** The destination address. */
|
|
2797
3440
|
to: string;
|
|
3441
|
+
/** The Jetton master contract address. */
|
|
2798
3442
|
master: string;
|
|
3443
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2799
3444
|
amount: string;
|
|
3445
|
+
/** The memo or destination tag. */
|
|
2800
3446
|
memo?: string | undefined;
|
|
3447
|
+
/** 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)) */
|
|
2801
3448
|
externalId?: string | undefined;
|
|
3449
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2802
3450
|
travelRule?: ({
|
|
2803
3451
|
kind: "Notabene";
|
|
2804
3452
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2812,14 +3460,19 @@ export type TransferAssetBody = {
|
|
|
2812
3460
|
[x: string]: any;
|
|
2813
3461
|
};
|
|
2814
3462
|
}) | undefined;
|
|
2815
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3463
|
+
/** 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)) */
|
|
2816
3464
|
feeSponsorId?: string | undefined;
|
|
2817
3465
|
} | {
|
|
2818
3466
|
kind: "Trc10";
|
|
3467
|
+
/** The token ID. */
|
|
2819
3468
|
tokenId: string;
|
|
3469
|
+
/** The destination address. */
|
|
2820
3470
|
to: string;
|
|
3471
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2821
3472
|
amount: string;
|
|
3473
|
+
/** 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)) */
|
|
2822
3474
|
externalId?: string | undefined;
|
|
3475
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2823
3476
|
travelRule?: ({
|
|
2824
3477
|
kind: "Notabene";
|
|
2825
3478
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2833,14 +3486,19 @@ export type TransferAssetBody = {
|
|
|
2833
3486
|
[x: string]: any;
|
|
2834
3487
|
};
|
|
2835
3488
|
}) | undefined;
|
|
2836
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3489
|
+
/** 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)) */
|
|
2837
3490
|
feeSponsorId?: string | undefined;
|
|
2838
3491
|
} | {
|
|
2839
3492
|
kind: "Trc20";
|
|
3493
|
+
/** The smart contract address. */
|
|
2840
3494
|
contract: string;
|
|
3495
|
+
/** The destination address. */
|
|
2841
3496
|
to: string;
|
|
3497
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2842
3498
|
amount: string;
|
|
3499
|
+
/** 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)) */
|
|
2843
3500
|
externalId?: string | undefined;
|
|
3501
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2844
3502
|
travelRule?: ({
|
|
2845
3503
|
kind: "Notabene";
|
|
2846
3504
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2854,14 +3512,19 @@ export type TransferAssetBody = {
|
|
|
2854
3512
|
[x: string]: any;
|
|
2855
3513
|
};
|
|
2856
3514
|
}) | undefined;
|
|
2857
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3515
|
+
/** 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)) */
|
|
2858
3516
|
feeSponsorId?: string | undefined;
|
|
2859
3517
|
} | {
|
|
2860
3518
|
kind: "Trc721";
|
|
3519
|
+
/** The smart contract address. */
|
|
2861
3520
|
contract: string;
|
|
3521
|
+
/** The destination address. */
|
|
2862
3522
|
to: string;
|
|
3523
|
+
/** The token to transfer. */
|
|
2863
3524
|
tokenId: string;
|
|
3525
|
+
/** 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)) */
|
|
2864
3526
|
externalId?: string | undefined;
|
|
3527
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2865
3528
|
travelRule?: ({
|
|
2866
3529
|
kind: "Notabene";
|
|
2867
3530
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2875,10 +3538,11 @@ export type TransferAssetBody = {
|
|
|
2875
3538
|
[x: string]: any;
|
|
2876
3539
|
};
|
|
2877
3540
|
}) | undefined;
|
|
2878
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3541
|
+
/** 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)) */
|
|
2879
3542
|
feeSponsorId?: string | undefined;
|
|
2880
3543
|
};
|
|
2881
3544
|
export type TransferAssetParams = {
|
|
3545
|
+
/** The source wallet id (`wa-...`). */
|
|
2882
3546
|
walletId: string;
|
|
2883
3547
|
};
|
|
2884
3548
|
export type TransferAssetResponse = {
|
|
@@ -2891,17 +3555,25 @@ export type TransferAssetResponse = {
|
|
|
2891
3555
|
};
|
|
2892
3556
|
requestBody: {
|
|
2893
3557
|
kind: "Native";
|
|
3558
|
+
/** The destination address. */
|
|
2894
3559
|
to: string;
|
|
3560
|
+
/** The amount of native tokens to transfer in minimum denomination. */
|
|
2895
3561
|
amount: string;
|
|
3562
|
+
/** The memo or destination tag. `Stellar`, `TON` and `XrpLedger` support `memo`. Not valid for other networks. */
|
|
2896
3563
|
memo?: string | undefined;
|
|
3564
|
+
/** 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. */
|
|
2897
3565
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3566
|
+
/** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
|
|
2898
3567
|
createDestinationAccount?: boolean | undefined;
|
|
2899
|
-
/** Optional field for Canton, if true it will create a transfer offer */
|
|
3568
|
+
/** Optional field for Canton, if true it will create a transfer offer. */
|
|
2900
3569
|
offer?: boolean | undefined;
|
|
2901
3570
|
/** Optional field for Canton, especially useful in the context of offers */
|
|
2902
3571
|
expiresAt?: string | undefined;
|
|
3572
|
+
/** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
|
|
2903
3573
|
targetChain?: string | undefined;
|
|
3574
|
+
/** 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)) */
|
|
2904
3575
|
externalId?: string | undefined;
|
|
3576
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2905
3577
|
travelRule?: ({
|
|
2906
3578
|
kind: "Notabene";
|
|
2907
3579
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2915,14 +3587,19 @@ export type TransferAssetResponse = {
|
|
|
2915
3587
|
[x: string]: any;
|
|
2916
3588
|
};
|
|
2917
3589
|
}) | undefined;
|
|
2918
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3590
|
+
/** 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)) */
|
|
2919
3591
|
feeSponsorId?: string | undefined;
|
|
2920
3592
|
} | {
|
|
2921
3593
|
kind: "Asa";
|
|
3594
|
+
/** The token asset id. */
|
|
2922
3595
|
assetId: string;
|
|
3596
|
+
/** The destination address. */
|
|
2923
3597
|
to: string;
|
|
3598
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2924
3599
|
amount: string;
|
|
3600
|
+
/** 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)) */
|
|
2925
3601
|
externalId?: string | undefined;
|
|
3602
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2926
3603
|
travelRule?: ({
|
|
2927
3604
|
kind: "Notabene";
|
|
2928
3605
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2936,14 +3613,19 @@ export type TransferAssetResponse = {
|
|
|
2936
3613
|
[x: string]: any;
|
|
2937
3614
|
};
|
|
2938
3615
|
}) | undefined;
|
|
2939
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3616
|
+
/** 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)) */
|
|
2940
3617
|
feeSponsorId?: string | undefined;
|
|
2941
3618
|
} | {
|
|
2942
3619
|
kind: "Aip21";
|
|
3620
|
+
/** The asset metadata address. */
|
|
2943
3621
|
metadata: string;
|
|
3622
|
+
/** The destination address. */
|
|
2944
3623
|
to: string;
|
|
3624
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2945
3625
|
amount: string;
|
|
3626
|
+
/** 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)) */
|
|
2946
3627
|
externalId?: string | undefined;
|
|
3628
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2947
3629
|
travelRule?: ({
|
|
2948
3630
|
kind: "Notabene";
|
|
2949
3631
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2957,14 +3639,19 @@ export type TransferAssetResponse = {
|
|
|
2957
3639
|
[x: string]: any;
|
|
2958
3640
|
};
|
|
2959
3641
|
}) | undefined;
|
|
2960
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3642
|
+
/** 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)) */
|
|
2961
3643
|
feeSponsorId?: string | undefined;
|
|
2962
3644
|
} | {
|
|
2963
3645
|
kind: "Asset";
|
|
3646
|
+
/** The token asset id. */
|
|
2964
3647
|
assetId: string;
|
|
3648
|
+
/** The destination address. */
|
|
2965
3649
|
to: string;
|
|
3650
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2966
3651
|
amount: string;
|
|
3652
|
+
/** 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)) */
|
|
2967
3653
|
externalId?: string | undefined;
|
|
3654
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2968
3655
|
travelRule?: ({
|
|
2969
3656
|
kind: "Notabene";
|
|
2970
3657
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2978,14 +3665,19 @@ export type TransferAssetResponse = {
|
|
|
2978
3665
|
[x: string]: any;
|
|
2979
3666
|
};
|
|
2980
3667
|
}) | undefined;
|
|
2981
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3668
|
+
/** 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)) */
|
|
2982
3669
|
feeSponsorId?: string | undefined;
|
|
2983
3670
|
} | {
|
|
2984
3671
|
kind: "Coin";
|
|
3672
|
+
/** The coin identifier. */
|
|
2985
3673
|
coin: string;
|
|
3674
|
+
/** The destination address. */
|
|
2986
3675
|
to: string;
|
|
3676
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
2987
3677
|
amount: string;
|
|
3678
|
+
/** 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)) */
|
|
2988
3679
|
externalId?: string | undefined;
|
|
3680
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
2989
3681
|
travelRule?: ({
|
|
2990
3682
|
kind: "Notabene";
|
|
2991
3683
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -2999,15 +3691,21 @@ export type TransferAssetResponse = {
|
|
|
2999
3691
|
[x: string]: any;
|
|
3000
3692
|
};
|
|
3001
3693
|
}) | undefined;
|
|
3002
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3694
|
+
/** 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)) */
|
|
3003
3695
|
feeSponsorId?: string | undefined;
|
|
3004
3696
|
} | {
|
|
3005
3697
|
kind: "Erc20";
|
|
3698
|
+
/** The ERC-20 contract address. */
|
|
3006
3699
|
contract: string;
|
|
3700
|
+
/** The destination address. */
|
|
3007
3701
|
to: string;
|
|
3702
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3008
3703
|
amount: string;
|
|
3704
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
3009
3705
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3706
|
+
/** 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)) */
|
|
3010
3707
|
externalId?: string | undefined;
|
|
3708
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3011
3709
|
travelRule?: ({
|
|
3012
3710
|
kind: "Notabene";
|
|
3013
3711
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3021,15 +3719,21 @@ export type TransferAssetResponse = {
|
|
|
3021
3719
|
[x: string]: any;
|
|
3022
3720
|
};
|
|
3023
3721
|
}) | undefined;
|
|
3024
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3722
|
+
/** 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)) */
|
|
3025
3723
|
feeSponsorId?: string | undefined;
|
|
3026
3724
|
} | {
|
|
3027
3725
|
kind: "Erc721";
|
|
3726
|
+
/** The ERC-721 contract address. */
|
|
3028
3727
|
contract: string;
|
|
3728
|
+
/** The destination address. */
|
|
3029
3729
|
to: string;
|
|
3730
|
+
/** The token to transfer. */
|
|
3030
3731
|
tokenId: string;
|
|
3732
|
+
/** The priority that determines the fees paid for the transfer. */
|
|
3031
3733
|
priority?: ("Slow" | "Standard" | "Fast") | undefined;
|
|
3734
|
+
/** 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)) */
|
|
3032
3735
|
externalId?: string | undefined;
|
|
3736
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3033
3737
|
travelRule?: ({
|
|
3034
3738
|
kind: "Notabene";
|
|
3035
3739
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3043,14 +3747,18 @@ export type TransferAssetResponse = {
|
|
|
3043
3747
|
[x: string]: any;
|
|
3044
3748
|
};
|
|
3045
3749
|
}) | undefined;
|
|
3046
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3750
|
+
/** 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)) */
|
|
3047
3751
|
feeSponsorId?: string | undefined;
|
|
3048
3752
|
} | {
|
|
3049
3753
|
kind: "Hip17";
|
|
3754
|
+
/** The token to transfer. */
|
|
3050
3755
|
tokenId: string;
|
|
3051
3756
|
serialNumber: string;
|
|
3757
|
+
/** The destination address. */
|
|
3052
3758
|
to: string;
|
|
3759
|
+
/** 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)) */
|
|
3053
3760
|
externalId?: string | undefined;
|
|
3761
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3054
3762
|
travelRule?: ({
|
|
3055
3763
|
kind: "Notabene";
|
|
3056
3764
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3064,14 +3772,19 @@ export type TransferAssetResponse = {
|
|
|
3064
3772
|
[x: string]: any;
|
|
3065
3773
|
};
|
|
3066
3774
|
}) | undefined;
|
|
3067
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3775
|
+
/** 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)) */
|
|
3068
3776
|
feeSponsorId?: string | undefined;
|
|
3069
3777
|
} | {
|
|
3070
3778
|
kind: "Hts";
|
|
3779
|
+
/** The token to transfer. */
|
|
3071
3780
|
tokenId: string;
|
|
3781
|
+
/** The destination address. */
|
|
3072
3782
|
to: string;
|
|
3783
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3073
3784
|
amount: string;
|
|
3785
|
+
/** 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)) */
|
|
3074
3786
|
externalId?: string | undefined;
|
|
3787
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3075
3788
|
travelRule?: ({
|
|
3076
3789
|
kind: "Notabene";
|
|
3077
3790
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3085,16 +3798,23 @@ export type TransferAssetResponse = {
|
|
|
3085
3798
|
[x: string]: any;
|
|
3086
3799
|
};
|
|
3087
3800
|
}) | undefined;
|
|
3088
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3801
|
+
/** 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)) */
|
|
3089
3802
|
feeSponsorId?: string | undefined;
|
|
3090
3803
|
} | {
|
|
3091
3804
|
kind: "Sep41";
|
|
3805
|
+
/** The asset issuer address. */
|
|
3092
3806
|
issuer: string;
|
|
3807
|
+
/** The asset code. */
|
|
3093
3808
|
assetCode: string;
|
|
3809
|
+
/** The destination address. */
|
|
3094
3810
|
to: string;
|
|
3811
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3095
3812
|
amount: string;
|
|
3813
|
+
/** The memo or destination tag. */
|
|
3096
3814
|
memo?: string | undefined;
|
|
3815
|
+
/** 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)) */
|
|
3097
3816
|
externalId?: string | undefined;
|
|
3817
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3098
3818
|
travelRule?: ({
|
|
3099
3819
|
kind: "Notabene";
|
|
3100
3820
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3108,15 +3828,21 @@ export type TransferAssetResponse = {
|
|
|
3108
3828
|
[x: string]: any;
|
|
3109
3829
|
};
|
|
3110
3830
|
}) | undefined;
|
|
3111
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3831
|
+
/** 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)) */
|
|
3112
3832
|
feeSponsorId?: string | undefined;
|
|
3113
3833
|
} | {
|
|
3114
3834
|
kind: "Spl" | "Spl2022";
|
|
3835
|
+
/** The destination address. */
|
|
3115
3836
|
to: string;
|
|
3837
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3116
3838
|
amount: string;
|
|
3839
|
+
/** The mint account address. */
|
|
3117
3840
|
mint: string;
|
|
3841
|
+
/** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
|
|
3118
3842
|
createDestinationAccount?: boolean | undefined;
|
|
3843
|
+
/** 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)) */
|
|
3119
3844
|
externalId?: string | undefined;
|
|
3845
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3120
3846
|
travelRule?: ({
|
|
3121
3847
|
kind: "Notabene";
|
|
3122
3848
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3130,15 +3856,21 @@ export type TransferAssetResponse = {
|
|
|
3130
3856
|
[x: string]: any;
|
|
3131
3857
|
};
|
|
3132
3858
|
}) | undefined;
|
|
3133
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3859
|
+
/** 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)) */
|
|
3134
3860
|
feeSponsorId?: string | undefined;
|
|
3135
3861
|
} | {
|
|
3136
3862
|
kind: "Tep74";
|
|
3863
|
+
/** The destination address. */
|
|
3137
3864
|
to: string;
|
|
3865
|
+
/** The Jetton master contract address. */
|
|
3138
3866
|
master: string;
|
|
3867
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3139
3868
|
amount: string;
|
|
3869
|
+
/** The memo or destination tag. */
|
|
3140
3870
|
memo?: string | undefined;
|
|
3871
|
+
/** 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)) */
|
|
3141
3872
|
externalId?: string | undefined;
|
|
3873
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3142
3874
|
travelRule?: ({
|
|
3143
3875
|
kind: "Notabene";
|
|
3144
3876
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3152,14 +3884,19 @@ export type TransferAssetResponse = {
|
|
|
3152
3884
|
[x: string]: any;
|
|
3153
3885
|
};
|
|
3154
3886
|
}) | undefined;
|
|
3155
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3887
|
+
/** 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)) */
|
|
3156
3888
|
feeSponsorId?: string | undefined;
|
|
3157
3889
|
} | {
|
|
3158
3890
|
kind: "Trc10";
|
|
3891
|
+
/** The token ID. */
|
|
3159
3892
|
tokenId: string;
|
|
3893
|
+
/** The destination address. */
|
|
3160
3894
|
to: string;
|
|
3895
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3161
3896
|
amount: string;
|
|
3897
|
+
/** 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)) */
|
|
3162
3898
|
externalId?: string | undefined;
|
|
3899
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3163
3900
|
travelRule?: ({
|
|
3164
3901
|
kind: "Notabene";
|
|
3165
3902
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3173,14 +3910,19 @@ export type TransferAssetResponse = {
|
|
|
3173
3910
|
[x: string]: any;
|
|
3174
3911
|
};
|
|
3175
3912
|
}) | undefined;
|
|
3176
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3913
|
+
/** 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)) */
|
|
3177
3914
|
feeSponsorId?: string | undefined;
|
|
3178
3915
|
} | {
|
|
3179
3916
|
kind: "Trc20";
|
|
3917
|
+
/** The smart contract address. */
|
|
3180
3918
|
contract: string;
|
|
3919
|
+
/** The destination address. */
|
|
3181
3920
|
to: string;
|
|
3921
|
+
/** The amount of tokens to transfer in minimum denomination. */
|
|
3182
3922
|
amount: string;
|
|
3923
|
+
/** 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)) */
|
|
3183
3924
|
externalId?: string | undefined;
|
|
3925
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3184
3926
|
travelRule?: ({
|
|
3185
3927
|
kind: "Notabene";
|
|
3186
3928
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3194,14 +3936,19 @@ export type TransferAssetResponse = {
|
|
|
3194
3936
|
[x: string]: any;
|
|
3195
3937
|
};
|
|
3196
3938
|
}) | undefined;
|
|
3197
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3939
|
+
/** 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)) */
|
|
3198
3940
|
feeSponsorId?: string | undefined;
|
|
3199
3941
|
} | {
|
|
3200
3942
|
kind: "Trc721";
|
|
3943
|
+
/** The smart contract address. */
|
|
3201
3944
|
contract: string;
|
|
3945
|
+
/** The destination address. */
|
|
3202
3946
|
to: string;
|
|
3947
|
+
/** The token to transfer. */
|
|
3203
3948
|
tokenId: string;
|
|
3949
|
+
/** 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)) */
|
|
3204
3950
|
externalId?: string | undefined;
|
|
3951
|
+
/** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
|
|
3205
3952
|
travelRule?: ({
|
|
3206
3953
|
kind: "Notabene";
|
|
3207
3954
|
beneficiaryVASPdid?: string | undefined;
|
|
@@ -3215,7 +3962,7 @@ export type TransferAssetResponse = {
|
|
|
3215
3962
|
[x: string]: any;
|
|
3216
3963
|
};
|
|
3217
3964
|
}) | undefined;
|
|
3218
|
-
/** Id of the fee sponsor that will be used to pay for your transfer
|
|
3965
|
+
/** 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)) */
|
|
3219
3966
|
feeSponsorId?: string | undefined;
|
|
3220
3967
|
};
|
|
3221
3968
|
metadata: {
|
|
@@ -3244,6 +3991,7 @@ export type TransferAssetRequest = TransferAssetParams & {
|
|
|
3244
3991
|
body: TransferAssetBody;
|
|
3245
3992
|
};
|
|
3246
3993
|
export type UntagWalletBody = {
|
|
3994
|
+
/** List of tags. */
|
|
3247
3995
|
tags: string[];
|
|
3248
3996
|
};
|
|
3249
3997
|
export type UntagWalletParams = {
|
|
@@ -3261,21 +4009,34 @@ export type UpdateWalletParams = {
|
|
|
3261
4009
|
walletId: string;
|
|
3262
4010
|
};
|
|
3263
4011
|
export type UpdateWalletResponse = {
|
|
4012
|
+
/** ID of the wallet. */
|
|
3264
4013
|
id: string;
|
|
4014
|
+
/** Network this wallet is bound to. */
|
|
3265
4015
|
network: ("Algorand" | "AlgorandTestnet" | "Aptos" | "AptosTestnet" | "ArbitrumOne" | "ArbitrumGoerli" | "ArbitrumSepolia" | "AvalancheC" | "AvalancheCFuji" | "Adi" | "AdiTestnet" | "BabylonGenesis" | "BabylonTestnet5" | "Base" | "BaseGoerli" | "BaseSepolia" | "Berachain" | "BerachainBArtio" | "BerachainBepolia" | "Bitcoin" | "BitcoinSignet" | "BitcoinTestnet3" | "BitcoinCash" | "BitcoinCashTestnet" | "Bob" | "BobSepolia" | "Bsc" | "BscTestnet" | "Canton" | "CantonDevnet" | "CantonTestnet" | "Cardano" | "CardanoPreprod" | "Celo" | "CeloAlfajores" | "Codex" | "CodexSepolia" | "CosmosHub4" | "CosmosIcsTestnet" | "Dogecoin" | "DogecoinTestnet" | "Ethereum" | "EthereumGoerli" | "EthereumSepolia" | "EthereumHolesky" | "EthereumHoodi" | "FantomOpera" | "FantomTestnet" | "FlareC" | "FlareCCoston2" | "Hedera" | "HederaTestnet" | "Ink" | "InkSepolia" | "InternetComputer" | "Ion" | "IonTestnet" | "Iota" | "IotaTestnet" | "IotaZodianet" | "KadenaTestnet4" | "KadenaTestnet4:1" | "KadenaTestnet4:2" | "KadenaTestnet4:3" | "KadenaTestnet4:4" | "KadenaTestnet4:5" | "KadenaTestnet4:6" | "KadenaTestnet4:7" | "KadenaTestnet4:8" | "KadenaTestnet4:9" | "KadenaTestnet4:10" | "KadenaTestnet4:11" | "KadenaTestnet4:12" | "KadenaTestnet4:13" | "KadenaTestnet4:14" | "KadenaTestnet4:15" | "KadenaTestnet4:16" | "KadenaTestnet4:17" | "KadenaTestnet4:18" | "KadenaTestnet4:19" | "Kadena" | "Kadena:1" | "Kadena:2" | "Kadena:3" | "Kadena:4" | "Kadena:5" | "Kadena:6" | "Kadena:7" | "Kadena:8" | "Kadena:9" | "Kadena:10" | "Kadena:11" | "Kadena:12" | "Kadena:13" | "Kadena:14" | "Kadena:15" | "Kadena:16" | "Kadena:17" | "Kadena:18" | "Kadena:19" | "Kaspa" | "KaspaTestnet11" | "Kusama" | "Litecoin" | "LitecoinTestnet" | "Near" | "NearTestnet" | "Optimism" | "OptimismGoerli" | "OptimismSepolia" | "Origyn" | "Plume" | "PlumeSepolia" | "Polkadot" | "Polygon" | "PolygonAmoy" | "PolygonMumbai" | "Polymesh" | "PolymeshTestnet" | "Race" | "RaceSepolia" | "SeiAtlantic2" | "SeiPacific1" | "Solana" | "SolanaDevnet" | "Sonic" | "SonicTestnet" | "Stellar" | "StellarTestnet" | "Sui" | "SuiTestnet" | "Tsc" | "TscTestnet1" | "Tezos" | "TezosGhostnet" | "Ton" | "TonTestnet" | "Tron" | "TronNile" | "Westend" | "XrpLedger" | "XrpLedgerTestnet") | ("KeyECDSA" | "KeyEdDSA" | "KeyECDSAStark");
|
|
4016
|
+
/** Wallet address on its corresponding network. */
|
|
3266
4017
|
address?: string | undefined;
|
|
4018
|
+
/** Details about the key underlying the wallet. */
|
|
3267
4019
|
signingKey: {
|
|
3268
4020
|
id: string;
|
|
4021
|
+
/** Key scheme. */
|
|
3269
4022
|
scheme: "DH" | "ECDSA" | "EdDSA" | "Schnorr";
|
|
3270
4023
|
curve: "ed25519" | "secp256k1" | "stark";
|
|
4024
|
+
/** Hex-encoded value of the public key. */
|
|
3271
4025
|
publicKey: string;
|
|
4026
|
+
/** The end user ID the key (and wallet) is delegated to. */
|
|
3272
4027
|
delegatedTo?: string | undefined;
|
|
3273
4028
|
};
|
|
4029
|
+
/** Wallet status. */
|
|
3274
4030
|
status: "Active" | "Archived";
|
|
4031
|
+
/** [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date string when wallet was created. */
|
|
3275
4032
|
dateCreated: string;
|
|
4033
|
+
/** Wallet nickname. */
|
|
3276
4034
|
name?: string | undefined;
|
|
4035
|
+
/** Whether the wallet is owned by an end user (non-custodial), or by your organization (custodial). */
|
|
3277
4036
|
custodial: boolean;
|
|
4037
|
+
/** User-defined value that can be used to correlate the entity with an external system. */
|
|
3278
4038
|
externalId?: string | undefined;
|
|
4039
|
+
/** List of tags. */
|
|
3279
4040
|
tags: string[];
|
|
3280
4041
|
/** Id of the validator on which the wallet is created for Canton networks */
|
|
3281
4042
|
validatorId?: string | undefined;
|