@privy-io/api-types 0.9.0 → 0.11.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/CHANGELOG.md +46 -0
- package/client.d.mts +40 -43
- package/client.d.mts.map +1 -1
- package/client.d.ts +40 -43
- package/client.d.ts.map +1 -1
- package/client.js +28 -20
- package/client.js.map +1 -1
- package/client.mjs +29 -21
- package/client.mjs.map +1 -1
- package/internal/types.d.mts +6 -6
- package/internal/types.d.mts.map +1 -1
- package/internal/types.d.ts +6 -6
- package/internal/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/accounts.d.mts +128 -86
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +128 -86
- package/resources/accounts.d.ts.map +1 -1
- package/resources/aggregations.d.mts +43 -43
- package/resources/aggregations.d.mts.map +1 -1
- package/resources/aggregations.d.ts +43 -43
- package/resources/aggregations.d.ts.map +1 -1
- package/resources/apps.d.mts +169 -135
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +169 -135
- package/resources/apps.d.ts.map +1 -1
- package/resources/client-auth.d.mts +931 -947
- package/resources/client-auth.d.mts.map +1 -1
- package/resources/client-auth.d.ts +931 -947
- package/resources/client-auth.d.ts.map +1 -1
- package/resources/client-auth.js.map +1 -1
- package/resources/client-auth.mjs.map +1 -1
- package/resources/embedded-wallets.d.mts +122 -122
- package/resources/embedded-wallets.d.mts.map +1 -1
- package/resources/embedded-wallets.d.ts +122 -122
- package/resources/embedded-wallets.d.ts.map +1 -1
- package/resources/fiat.d.mts +110 -0
- package/resources/fiat.d.mts.map +1 -0
- package/resources/fiat.d.ts +110 -0
- package/resources/fiat.d.ts.map +1 -0
- package/resources/fiat.js +9 -0
- package/resources/fiat.js.map +1 -0
- package/resources/fiat.mjs +5 -0
- package/resources/fiat.mjs.map +1 -0
- package/resources/funding.d.mts +86 -86
- package/resources/funding.d.mts.map +1 -1
- package/resources/funding.d.ts +86 -86
- package/resources/funding.d.ts.map +1 -1
- package/resources/index.d.mts +20 -18
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +20 -18
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -1
- package/resources/index.mjs.map +1 -1
- package/resources/intents.d.mts +269 -265
- package/resources/intents.d.mts.map +1 -1
- package/resources/intents.d.ts +269 -265
- package/resources/intents.d.ts.map +1 -1
- package/resources/key-quorums.d.mts +15 -146
- package/resources/key-quorums.d.mts.map +1 -1
- package/resources/key-quorums.d.ts +15 -146
- package/resources/key-quorums.d.ts.map +1 -1
- package/resources/key-quorums.js +0 -92
- package/resources/key-quorums.js.map +1 -1
- package/resources/key-quorums.mjs +0 -92
- package/resources/key-quorums.mjs.map +1 -1
- package/resources/kraken-embed.d.mts +12 -20
- package/resources/kraken-embed.d.mts.map +1 -1
- package/resources/kraken-embed.d.ts +12 -20
- package/resources/kraken-embed.d.ts.map +1 -1
- package/resources/organizations.d.mts +65 -0
- package/resources/organizations.d.mts.map +1 -0
- package/resources/organizations.d.ts +65 -0
- package/resources/organizations.d.ts.map +1 -0
- package/resources/organizations.js +9 -0
- package/resources/organizations.js.map +1 -0
- package/resources/organizations.mjs +5 -0
- package/resources/organizations.mjs.map +1 -0
- package/resources/policies.d.mts +261 -553
- package/resources/policies.d.mts.map +1 -1
- package/resources/policies.d.ts +261 -553
- package/resources/policies.d.ts.map +1 -1
- package/resources/policies.js +0 -229
- package/resources/policies.js.map +1 -1
- package/resources/policies.mjs +0 -229
- package/resources/policies.mjs.map +1 -1
- package/resources/shared.d.mts +28 -28
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +28 -28
- package/resources/shared.d.ts.map +1 -1
- package/resources/swaps.d.mts +6 -9
- package/resources/swaps.d.mts.map +1 -1
- package/resources/swaps.d.ts +6 -9
- package/resources/swaps.d.ts.map +1 -1
- package/resources/swaps.js.map +1 -1
- package/resources/swaps.mjs.map +1 -1
- package/resources/transactions.d.mts +80 -96
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +80 -96
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js +0 -17
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs +0 -17
- package/resources/transactions.mjs.map +1 -1
- package/resources/users.d.mts +480 -815
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +480 -815
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +0 -272
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +0 -272
- package/resources/users.mjs.map +1 -1
- package/resources/wallet-actions.d.mts +302 -145
- package/resources/wallet-actions.d.mts.map +1 -1
- package/resources/wallet-actions.d.ts +302 -145
- package/resources/wallet-actions.d.ts.map +1 -1
- package/resources/wallets/index.d.mts +1 -1
- package/resources/wallets/index.d.mts.map +1 -1
- package/resources/wallets/index.d.ts +1 -1
- package/resources/wallets/index.d.ts.map +1 -1
- package/resources/wallets/index.js.map +1 -1
- package/resources/wallets/index.mjs.map +1 -1
- package/resources/wallets/transactions.d.mts +7 -2
- package/resources/wallets/transactions.d.mts.map +1 -1
- package/resources/wallets/transactions.d.ts +7 -2
- package/resources/wallets/transactions.d.ts.map +1 -1
- package/resources/wallets/transactions.js +1 -1
- package/resources/wallets/transactions.mjs +1 -1
- package/resources/wallets/wallets.d.mts +1592 -1580
- package/resources/wallets/wallets.d.mts.map +1 -1
- package/resources/wallets/wallets.d.ts +1592 -1580
- package/resources/wallets/wallets.d.ts.map +1 -1
- package/resources/wallets/wallets.js +45 -103
- package/resources/wallets/wallets.js.map +1 -1
- package/resources/wallets/wallets.mjs +45 -103
- package/resources/wallets/wallets.mjs.map +1 -1
- package/resources/webhooks.d.mts +935 -877
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +935 -877
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/yield.d.mts +157 -157
- package/resources/yield.d.mts.map +1 -1
- package/resources/yield.d.ts +157 -157
- package/resources/yield.d.ts.map +1 -1
- package/src/client.ts +650 -618
- package/src/internal/types.ts +6 -8
- package/src/resources/accounts.ts +157 -103
- package/src/resources/aggregations.ts +55 -55
- package/src/resources/apps.ts +221 -178
- package/src/resources/client-auth.ts +1271 -1315
- package/src/resources/embedded-wallets.ts +160 -160
- package/src/resources/fiat.ts +177 -0
- package/src/resources/funding.ts +130 -130
- package/src/resources/index.ts +551 -542
- package/src/resources/intents.ts +326 -322
- package/src/resources/key-quorums.ts +16 -218
- package/src/resources/kraken-embed.ts +14 -22
- package/src/resources/organizations.ts +82 -0
- package/src/resources/policies.ts +383 -848
- package/src/resources/shared.ts +34 -34
- package/src/resources/swaps.ts +5 -10
- package/src/resources/transactions.ts +116 -136
- package/src/resources/users.ts +693 -1160
- package/src/resources/wallet-actions.ts +392 -185
- package/src/resources/wallets/index.ts +160 -156
- package/src/resources/wallets/transactions.ts +18 -3
- package/src/resources/wallets/wallets.ts +2123 -2113
- package/src/resources/webhooks.ts +1172 -1100
- package/src/resources/yield.ts +188 -188
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
package/resources/webhooks.d.mts
CHANGED
|
@@ -6,9 +6,217 @@ import * as WalletsAPI from "./wallets/wallets.mjs";
|
|
|
6
6
|
export declare class Webhooks extends APIResource {
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Bridge metadata for a crypto deposit via liquidation address.
|
|
10
10
|
*/
|
|
11
|
-
export interface
|
|
11
|
+
export interface BridgeCryptoDepositMetadata {
|
|
12
|
+
drain_id: string;
|
|
13
|
+
/**
|
|
14
|
+
* The crypto address of the liquidation address that received the deposit.
|
|
15
|
+
*/
|
|
16
|
+
liquidation_address: string;
|
|
17
|
+
liquidation_address_id: string;
|
|
18
|
+
method: 'liquidation_address';
|
|
19
|
+
/**
|
|
20
|
+
* The address that sent the deposit.
|
|
21
|
+
*/
|
|
22
|
+
source_wallet_address: string;
|
|
23
|
+
type: 'crypto_deposit';
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Bridge metadata for a crypto deposit via transfer.
|
|
27
|
+
*/
|
|
28
|
+
export interface BridgeCryptoTransferMetadata {
|
|
29
|
+
method: 'transfer';
|
|
30
|
+
/**
|
|
31
|
+
* The wallet address that sent the transfer.
|
|
32
|
+
*/
|
|
33
|
+
source_wallet_address: string;
|
|
34
|
+
transfer_id: string;
|
|
35
|
+
type: 'crypto_deposit';
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Bridge metadata for a fiat deposit via virtual account.
|
|
39
|
+
*/
|
|
40
|
+
export interface BridgeFiatDepositMetadata {
|
|
41
|
+
activity_id: string;
|
|
42
|
+
method: 'virtual_account';
|
|
43
|
+
type: 'fiat_deposit';
|
|
44
|
+
virtual_account_id: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Bridge metadata for a fiat deposit via transfer.
|
|
48
|
+
*/
|
|
49
|
+
export interface BridgeFiatTransferMetadata {
|
|
50
|
+
method: 'transfer';
|
|
51
|
+
transfer_id: string;
|
|
52
|
+
type: 'fiat_deposit';
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Metadata about a Bridge transaction associated with a wallet event.
|
|
56
|
+
*/
|
|
57
|
+
export type BridgeMetadata = BridgeCryptoDepositMetadata | BridgeRefundMetadata | BridgeFiatDepositMetadata | BridgeCryptoTransferMetadata | BridgeFiatTransferMetadata | BridgeTransferRefundMetadata | BridgeStaticMemoDepositMetadata;
|
|
58
|
+
/**
|
|
59
|
+
* Bridge metadata for a refund via liquidation address.
|
|
60
|
+
*/
|
|
61
|
+
export interface BridgeRefundMetadata {
|
|
62
|
+
drain_id: string;
|
|
63
|
+
liquidation_address_id: string;
|
|
64
|
+
method: 'liquidation_address';
|
|
65
|
+
/**
|
|
66
|
+
* The original deposit transaction hash that triggered the failed drain.
|
|
67
|
+
*/
|
|
68
|
+
original_transaction_hash: string;
|
|
69
|
+
type: 'refund';
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Bridge metadata for a fiat deposit via static memo.
|
|
73
|
+
*/
|
|
74
|
+
export interface BridgeStaticMemoDepositMetadata {
|
|
75
|
+
method: 'static_memo';
|
|
76
|
+
static_memo_event_id: string;
|
|
77
|
+
static_memo_id: string;
|
|
78
|
+
type: 'fiat_deposit';
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Bridge metadata for a transfer refund.
|
|
82
|
+
*/
|
|
83
|
+
export interface BridgeTransferRefundMetadata {
|
|
84
|
+
method: 'transfer';
|
|
85
|
+
transfer_id: string;
|
|
86
|
+
type: 'refund';
|
|
87
|
+
/**
|
|
88
|
+
* The original transfer transaction hash (if available).
|
|
89
|
+
*/
|
|
90
|
+
original_transaction_hash?: string;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Payload for the wallet.funds_deposited webhook event.
|
|
94
|
+
*/
|
|
95
|
+
export interface FundsDepositedWebhookPayload {
|
|
96
|
+
/**
|
|
97
|
+
* The amount transferred, as a stringified bigint.
|
|
98
|
+
*/
|
|
99
|
+
amount: string;
|
|
100
|
+
/**
|
|
101
|
+
* An asset involved in a wallet transfer.
|
|
102
|
+
*/
|
|
103
|
+
asset: WalletFundsAsset;
|
|
104
|
+
block: FundsDepositedWebhookPayload.Block;
|
|
105
|
+
/**
|
|
106
|
+
* The CAIP-2 chain identifier.
|
|
107
|
+
*/
|
|
108
|
+
caip2: string;
|
|
109
|
+
/**
|
|
110
|
+
* A unique key for this event.
|
|
111
|
+
*/
|
|
112
|
+
idempotency_key: string;
|
|
113
|
+
/**
|
|
114
|
+
* The recipient address.
|
|
115
|
+
*/
|
|
116
|
+
recipient: string;
|
|
117
|
+
/**
|
|
118
|
+
* The sender address.
|
|
119
|
+
*/
|
|
120
|
+
sender: string;
|
|
121
|
+
/**
|
|
122
|
+
* The blockchain transaction hash.
|
|
123
|
+
*/
|
|
124
|
+
transaction_hash: string;
|
|
125
|
+
/**
|
|
126
|
+
* The type of webhook event.
|
|
127
|
+
*/
|
|
128
|
+
type: 'wallet.funds_deposited';
|
|
129
|
+
/**
|
|
130
|
+
* The ID of the wallet.
|
|
131
|
+
*/
|
|
132
|
+
wallet_id: string;
|
|
133
|
+
/**
|
|
134
|
+
* Metadata about a Bridge transaction associated with a wallet event.
|
|
135
|
+
*/
|
|
136
|
+
bridge_metadata?: BridgeMetadata;
|
|
137
|
+
/**
|
|
138
|
+
* The transaction fee paid, as a stringified bigint in the chain's native token.
|
|
139
|
+
*/
|
|
140
|
+
transaction_fee?: string;
|
|
141
|
+
}
|
|
142
|
+
export declare namespace FundsDepositedWebhookPayload {
|
|
143
|
+
interface Block {
|
|
144
|
+
/**
|
|
145
|
+
* The block number.
|
|
146
|
+
*/
|
|
147
|
+
number: number;
|
|
148
|
+
/**
|
|
149
|
+
* The block timestamp.
|
|
150
|
+
*/
|
|
151
|
+
timestamp: number;
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Payload for the wallet.funds_withdrawn webhook event.
|
|
156
|
+
*/
|
|
157
|
+
export interface FundsWithdrawnWebhookPayload {
|
|
158
|
+
/**
|
|
159
|
+
* The amount transferred, as a stringified bigint.
|
|
160
|
+
*/
|
|
161
|
+
amount: string;
|
|
162
|
+
/**
|
|
163
|
+
* An asset involved in a wallet transfer.
|
|
164
|
+
*/
|
|
165
|
+
asset: WalletFundsAsset;
|
|
166
|
+
block: FundsWithdrawnWebhookPayload.Block;
|
|
167
|
+
/**
|
|
168
|
+
* The CAIP-2 chain identifier.
|
|
169
|
+
*/
|
|
170
|
+
caip2: string;
|
|
171
|
+
/**
|
|
172
|
+
* A unique key for this event.
|
|
173
|
+
*/
|
|
174
|
+
idempotency_key: string;
|
|
175
|
+
/**
|
|
176
|
+
* The recipient address.
|
|
177
|
+
*/
|
|
178
|
+
recipient: string;
|
|
179
|
+
/**
|
|
180
|
+
* The sender address.
|
|
181
|
+
*/
|
|
182
|
+
sender: string;
|
|
183
|
+
/**
|
|
184
|
+
* The blockchain transaction hash.
|
|
185
|
+
*/
|
|
186
|
+
transaction_hash: string;
|
|
187
|
+
/**
|
|
188
|
+
* The type of webhook event.
|
|
189
|
+
*/
|
|
190
|
+
type: 'wallet.funds_withdrawn';
|
|
191
|
+
/**
|
|
192
|
+
* The ID of the wallet.
|
|
193
|
+
*/
|
|
194
|
+
wallet_id: string;
|
|
195
|
+
/**
|
|
196
|
+
* The transaction fee paid, as a stringified bigint in the chain's native token.
|
|
197
|
+
*/
|
|
198
|
+
transaction_fee?: string;
|
|
199
|
+
}
|
|
200
|
+
export declare namespace FundsWithdrawnWebhookPayload {
|
|
201
|
+
interface Block {
|
|
202
|
+
/**
|
|
203
|
+
* The block number.
|
|
204
|
+
*/
|
|
205
|
+
number: number;
|
|
206
|
+
/**
|
|
207
|
+
* The block timestamp.
|
|
208
|
+
*/
|
|
209
|
+
timestamp: number;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Payload for the intent.authorized webhook event.
|
|
214
|
+
*/
|
|
215
|
+
export interface IntentAuthorizedWebhookPayload {
|
|
216
|
+
/**
|
|
217
|
+
* Unix timestamp when the authorization was recorded.
|
|
218
|
+
*/
|
|
219
|
+
authorized_at: number;
|
|
12
220
|
/**
|
|
13
221
|
* Unix timestamp when the intent was created.
|
|
14
222
|
*/
|
|
@@ -25,6 +233,10 @@ export interface IntentCreatedWebhookPayload {
|
|
|
25
233
|
* Type of intent.
|
|
26
234
|
*/
|
|
27
235
|
intent_type: IntentsAPI.IntentType;
|
|
236
|
+
/**
|
|
237
|
+
* A leaf member (user or key) of a nested key quorum in an intent authorization.
|
|
238
|
+
*/
|
|
239
|
+
member: IntentsAPI.IntentAuthorizationKeyQuorumMember;
|
|
28
240
|
/**
|
|
29
241
|
* The current status of the intent.
|
|
30
242
|
*/
|
|
@@ -32,11 +244,7 @@ export interface IntentCreatedWebhookPayload {
|
|
|
32
244
|
/**
|
|
33
245
|
* The type of webhook event.
|
|
34
246
|
*/
|
|
35
|
-
type: 'intent.
|
|
36
|
-
/**
|
|
37
|
-
* Key quorums that can authorize this intent.
|
|
38
|
-
*/
|
|
39
|
-
authorization_details?: Array<IntentsAPI.IntentAuthorization>;
|
|
247
|
+
type: 'intent.authorized';
|
|
40
248
|
/**
|
|
41
249
|
* Display name of the user who created the intent.
|
|
42
250
|
*/
|
|
@@ -47,13 +255,9 @@ export interface IntentCreatedWebhookPayload {
|
|
|
47
255
|
created_by_id?: string;
|
|
48
256
|
}
|
|
49
257
|
/**
|
|
50
|
-
* Payload for the intent.
|
|
258
|
+
* Payload for the intent.created webhook event.
|
|
51
259
|
*/
|
|
52
|
-
export interface
|
|
53
|
-
/**
|
|
54
|
-
* Unix timestamp when the authorization was recorded.
|
|
55
|
-
*/
|
|
56
|
-
authorized_at: number;
|
|
260
|
+
export interface IntentCreatedWebhookPayload {
|
|
57
261
|
/**
|
|
58
262
|
* Unix timestamp when the intent was created.
|
|
59
263
|
*/
|
|
@@ -70,10 +274,6 @@ export interface IntentAuthorizedWebhookPayload {
|
|
|
70
274
|
* Type of intent.
|
|
71
275
|
*/
|
|
72
276
|
intent_type: IntentsAPI.IntentType;
|
|
73
|
-
/**
|
|
74
|
-
* A leaf member (user or key) of a nested key quorum in an intent authorization.
|
|
75
|
-
*/
|
|
76
|
-
member: IntentsAPI.IntentAuthorizationKeyQuorumMember;
|
|
77
277
|
/**
|
|
78
278
|
* The current status of the intent.
|
|
79
279
|
*/
|
|
@@ -81,7 +281,11 @@ export interface IntentAuthorizedWebhookPayload {
|
|
|
81
281
|
/**
|
|
82
282
|
* The type of webhook event.
|
|
83
283
|
*/
|
|
84
|
-
type: 'intent.
|
|
284
|
+
type: 'intent.created';
|
|
285
|
+
/**
|
|
286
|
+
* Key quorums that can authorize this intent.
|
|
287
|
+
*/
|
|
288
|
+
authorization_details?: Array<IntentsAPI.IntentAuthorization>;
|
|
85
289
|
/**
|
|
86
290
|
* Display name of the user who created the intent.
|
|
87
291
|
*/
|
|
@@ -174,24 +378,131 @@ export interface IntentFailedWebhookPayload {
|
|
|
174
378
|
created_by_id?: string;
|
|
175
379
|
}
|
|
176
380
|
/**
|
|
177
|
-
* Payload for the
|
|
381
|
+
* Payload for the kraken_embed.quote.cancelled webhook event.
|
|
178
382
|
*/
|
|
179
|
-
export interface
|
|
383
|
+
export interface KrakenEmbedQuoteCancelledWebhookPayload {
|
|
180
384
|
/**
|
|
181
|
-
*
|
|
385
|
+
* ISO 8601 timestamp of when the quote was cancelled.
|
|
182
386
|
*/
|
|
183
|
-
|
|
387
|
+
cancelled_at: string;
|
|
388
|
+
/**
|
|
389
|
+
* The ID of the cancelled quote.
|
|
390
|
+
*/
|
|
391
|
+
quote_id: string;
|
|
392
|
+
/**
|
|
393
|
+
* A human-readable description of why the quote was cancelled. Intended for
|
|
394
|
+
* display and logging purposes only.
|
|
395
|
+
*/
|
|
396
|
+
reason: string;
|
|
184
397
|
/**
|
|
185
398
|
* The type of webhook event.
|
|
186
399
|
*/
|
|
187
|
-
type: '
|
|
400
|
+
type: 'kraken_embed.quote.cancelled';
|
|
188
401
|
/**
|
|
189
|
-
* The ID of the user
|
|
402
|
+
* The ID of the user.
|
|
190
403
|
*/
|
|
191
404
|
user_id: string;
|
|
192
405
|
}
|
|
193
406
|
/**
|
|
194
|
-
* Payload for the
|
|
407
|
+
* Payload for the kraken_embed.quote_executed webhook event.
|
|
408
|
+
*/
|
|
409
|
+
export interface KrakenEmbedQuoteExecutedWebhookPayload {
|
|
410
|
+
/**
|
|
411
|
+
* ISO 8601 timestamp of when the quote was executed.
|
|
412
|
+
*/
|
|
413
|
+
executed_at: string;
|
|
414
|
+
/**
|
|
415
|
+
* The ID of the executed quote.
|
|
416
|
+
*/
|
|
417
|
+
quote_id: string;
|
|
418
|
+
/**
|
|
419
|
+
* The type of webhook event.
|
|
420
|
+
*/
|
|
421
|
+
type: 'kraken_embed.quote.executed';
|
|
422
|
+
/**
|
|
423
|
+
* The ID of the user.
|
|
424
|
+
*/
|
|
425
|
+
user_id: string;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* Payload for the kraken_embed.quote.execution_failed webhook event.
|
|
429
|
+
*/
|
|
430
|
+
export interface KrakenEmbedQuoteExecutionFailedWebhookPayload {
|
|
431
|
+
/**
|
|
432
|
+
* ISO 8601 timestamp of when the quote execution failed.
|
|
433
|
+
*/
|
|
434
|
+
failed_at: string;
|
|
435
|
+
/**
|
|
436
|
+
* The ID of the quote that failed to execute.
|
|
437
|
+
*/
|
|
438
|
+
quote_id: string;
|
|
439
|
+
/**
|
|
440
|
+
* A human-readable description of why the quote execution failed. Intended for
|
|
441
|
+
* display and logging purposes only.
|
|
442
|
+
*/
|
|
443
|
+
reason: string;
|
|
444
|
+
/**
|
|
445
|
+
* The type of webhook event.
|
|
446
|
+
*/
|
|
447
|
+
type: 'kraken_embed.quote.execution_failed';
|
|
448
|
+
/**
|
|
449
|
+
* The ID of the user.
|
|
450
|
+
*/
|
|
451
|
+
user_id: string;
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* Payload for the kraken_embed.user.closed webhook event.
|
|
455
|
+
*/
|
|
456
|
+
export interface KrakenEmbedUserClosedWebhookPayload {
|
|
457
|
+
/**
|
|
458
|
+
* ISO 8601 timestamp of when the user was closed.
|
|
459
|
+
*/
|
|
460
|
+
closed_at: string;
|
|
461
|
+
/**
|
|
462
|
+
* The type of webhook event.
|
|
463
|
+
*/
|
|
464
|
+
type: 'kraken_embed.user.closed';
|
|
465
|
+
/**
|
|
466
|
+
* The ID of the user.
|
|
467
|
+
*/
|
|
468
|
+
user_id: string;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* Payload for the kraken_embed.user.disabled webhook event.
|
|
472
|
+
*/
|
|
473
|
+
export interface KrakenEmbedUserDisabledWebhookPayload {
|
|
474
|
+
/**
|
|
475
|
+
* ISO 8601 timestamp of when the user was disabled.
|
|
476
|
+
*/
|
|
477
|
+
disabled_at: string;
|
|
478
|
+
/**
|
|
479
|
+
* The type of webhook event.
|
|
480
|
+
*/
|
|
481
|
+
type: 'kraken_embed.user.disabled';
|
|
482
|
+
/**
|
|
483
|
+
* The ID of the user.
|
|
484
|
+
*/
|
|
485
|
+
user_id: string;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* Payload for the kraken_embed.user.verified webhook event.
|
|
489
|
+
*/
|
|
490
|
+
export interface KrakenEmbedUserVerifiedWebhookPayload {
|
|
491
|
+
/**
|
|
492
|
+
* The type of webhook event.
|
|
493
|
+
*/
|
|
494
|
+
type: 'kraken_embed.user.verified';
|
|
495
|
+
/**
|
|
496
|
+
* The ID of the user.
|
|
497
|
+
*/
|
|
498
|
+
user_id: string;
|
|
499
|
+
/**
|
|
500
|
+
* ISO 8601 timestamp of when the user was verified.
|
|
501
|
+
*/
|
|
502
|
+
verified_at: string;
|
|
503
|
+
}
|
|
504
|
+
/**
|
|
505
|
+
* Payload for the mfa.disabled webhook event.
|
|
195
506
|
*/
|
|
196
507
|
export interface MfaDisabledWebhookPayload {
|
|
197
508
|
/**
|
|
@@ -207,6 +518,67 @@ export interface MfaDisabledWebhookPayload {
|
|
|
207
518
|
*/
|
|
208
519
|
user_id: string;
|
|
209
520
|
}
|
|
521
|
+
/**
|
|
522
|
+
* Payload for the mfa.enabled webhook event.
|
|
523
|
+
*/
|
|
524
|
+
export interface MfaEnabledWebhookPayload {
|
|
525
|
+
/**
|
|
526
|
+
* The MFA method that was enabled.
|
|
527
|
+
*/
|
|
528
|
+
method: 'sms' | 'totp' | 'passkey';
|
|
529
|
+
/**
|
|
530
|
+
* The type of webhook event.
|
|
531
|
+
*/
|
|
532
|
+
type: 'mfa.enabled';
|
|
533
|
+
/**
|
|
534
|
+
* The ID of the user who enabled MFA.
|
|
535
|
+
*/
|
|
536
|
+
user_id: string;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* Payload for the wallet.private_key_export webhook event.
|
|
540
|
+
*/
|
|
541
|
+
export interface PrivateKeyExportWebhookPayload {
|
|
542
|
+
/**
|
|
543
|
+
* The type of webhook event.
|
|
544
|
+
*/
|
|
545
|
+
type: 'wallet.private_key_export';
|
|
546
|
+
/**
|
|
547
|
+
* The ID of the user who exported the key.
|
|
548
|
+
*/
|
|
549
|
+
user_id: string;
|
|
550
|
+
/**
|
|
551
|
+
* The address of the wallet.
|
|
552
|
+
*/
|
|
553
|
+
wallet_address: string;
|
|
554
|
+
/**
|
|
555
|
+
* The ID of the wallet.
|
|
556
|
+
*/
|
|
557
|
+
wallet_id: string;
|
|
558
|
+
export_source?: 'display' | 'client';
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* Payload for the wallet.seed_phrase_export webhook event.
|
|
562
|
+
*/
|
|
563
|
+
export interface SeedPhraseExportWebhookPayload {
|
|
564
|
+
/**
|
|
565
|
+
* The type of webhook event.
|
|
566
|
+
*/
|
|
567
|
+
type: 'wallet.seed_phrase_export';
|
|
568
|
+
/**
|
|
569
|
+
* The ID of the user who exported the seed phrase.
|
|
570
|
+
*/
|
|
571
|
+
user_id: string;
|
|
572
|
+
/**
|
|
573
|
+
* The address of the wallet.
|
|
574
|
+
*/
|
|
575
|
+
wallet_address: string;
|
|
576
|
+
/**
|
|
577
|
+
* The ID of the wallet.
|
|
578
|
+
*/
|
|
579
|
+
wallet_id: string;
|
|
580
|
+
export_source?: 'display' | 'client';
|
|
581
|
+
}
|
|
210
582
|
/**
|
|
211
583
|
* Payload for the transaction.broadcasted webhook event.
|
|
212
584
|
*/
|
|
@@ -298,9 +670,9 @@ export interface TransactionExecutionRevertedWebhookPayload {
|
|
|
298
670
|
reference_id?: string | null;
|
|
299
671
|
}
|
|
300
672
|
/**
|
|
301
|
-
* Payload for the transaction.
|
|
673
|
+
* Payload for the transaction.failed webhook event.
|
|
302
674
|
*/
|
|
303
|
-
export interface
|
|
675
|
+
export interface TransactionFailedWebhookPayload {
|
|
304
676
|
/**
|
|
305
677
|
* The CAIP-2 chain identifier (e.g., eip155:1 for Ethereum mainnet).
|
|
306
678
|
*/
|
|
@@ -313,14 +685,10 @@ export interface TransactionStillPendingWebhookPayload {
|
|
|
313
685
|
* The Privy-assigned ID for this transaction.
|
|
314
686
|
*/
|
|
315
687
|
transaction_id: string;
|
|
316
|
-
/**
|
|
317
|
-
* An unsigned Ethereum transaction object.
|
|
318
|
-
*/
|
|
319
|
-
transaction_request: WalletsAPI.UnsignedEthereumTransaction;
|
|
320
688
|
/**
|
|
321
689
|
* The type of webhook event.
|
|
322
690
|
*/
|
|
323
|
-
type: 'transaction.
|
|
691
|
+
type: 'transaction.failed';
|
|
324
692
|
/**
|
|
325
693
|
* The ID of the wallet that initiated the transaction.
|
|
326
694
|
*/
|
|
@@ -332,9 +700,9 @@ export interface TransactionStillPendingWebhookPayload {
|
|
|
332
700
|
reference_id?: string | null;
|
|
333
701
|
}
|
|
334
702
|
/**
|
|
335
|
-
* Payload for the transaction.
|
|
703
|
+
* Payload for the transaction.provider_error webhook event.
|
|
336
704
|
*/
|
|
337
|
-
export interface
|
|
705
|
+
export interface TransactionProviderErrorWebhookPayload {
|
|
338
706
|
/**
|
|
339
707
|
* The CAIP-2 chain identifier (e.g., eip155:1 for Ethereum mainnet).
|
|
340
708
|
*/
|
|
@@ -350,7 +718,7 @@ export interface TransactionFailedWebhookPayload {
|
|
|
350
718
|
/**
|
|
351
719
|
* The type of webhook event.
|
|
352
720
|
*/
|
|
353
|
-
type: 'transaction.
|
|
721
|
+
type: 'transaction.provider_error';
|
|
354
722
|
/**
|
|
355
723
|
* The ID of the wallet that initiated the transaction.
|
|
356
724
|
*/
|
|
@@ -392,9 +760,9 @@ export interface TransactionReplacedWebhookPayload {
|
|
|
392
760
|
reference_id?: string | null;
|
|
393
761
|
}
|
|
394
762
|
/**
|
|
395
|
-
* Payload for the transaction.
|
|
763
|
+
* Payload for the transaction.still_pending webhook event.
|
|
396
764
|
*/
|
|
397
|
-
export interface
|
|
765
|
+
export interface TransactionStillPendingWebhookPayload {
|
|
398
766
|
/**
|
|
399
767
|
* The CAIP-2 chain identifier (e.g., eip155:1 for Ethereum mainnet).
|
|
400
768
|
*/
|
|
@@ -407,10 +775,15 @@ export interface TransactionProviderErrorWebhookPayload {
|
|
|
407
775
|
* The Privy-assigned ID for this transaction.
|
|
408
776
|
*/
|
|
409
777
|
transaction_id: string;
|
|
778
|
+
/**
|
|
779
|
+
* An unsigned standard Ethereum transaction object. Supports EVM transaction types
|
|
780
|
+
* 0, 1, 2, and 4.
|
|
781
|
+
*/
|
|
782
|
+
transaction_request: WalletsAPI.UnsignedStandardEthereumTransaction;
|
|
410
783
|
/**
|
|
411
784
|
* The type of webhook event.
|
|
412
785
|
*/
|
|
413
|
-
type: 'transaction.
|
|
786
|
+
type: 'transaction.still_pending';
|
|
414
787
|
/**
|
|
415
788
|
* The ID of the wallet that initiated the transaction.
|
|
416
789
|
*/
|
|
@@ -422,24 +795,21 @@ export interface TransactionProviderErrorWebhookPayload {
|
|
|
422
795
|
reference_id?: string | null;
|
|
423
796
|
}
|
|
424
797
|
/**
|
|
425
|
-
* Payload for the
|
|
798
|
+
* Payload for the user.authenticated webhook event.
|
|
426
799
|
*/
|
|
427
|
-
export interface
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
log_index: number;
|
|
433
|
-
nonce: string;
|
|
434
|
-
paymaster: string | null;
|
|
435
|
-
sender: string;
|
|
436
|
-
success: boolean;
|
|
437
|
-
transaction_hash: string;
|
|
800
|
+
export interface UserAuthenticatedWebhookPayload {
|
|
801
|
+
/**
|
|
802
|
+
* A linked account for the user.
|
|
803
|
+
*/
|
|
804
|
+
account: UsersAPI.LinkedAccount;
|
|
438
805
|
/**
|
|
439
806
|
* The type of webhook event.
|
|
440
807
|
*/
|
|
441
|
-
type: '
|
|
442
|
-
|
|
808
|
+
type: 'user.authenticated';
|
|
809
|
+
/**
|
|
810
|
+
* A Privy user object.
|
|
811
|
+
*/
|
|
812
|
+
user: UsersAPI.User;
|
|
443
813
|
}
|
|
444
814
|
/**
|
|
445
815
|
* Payload for the user.created webhook event.
|
|
@@ -455,9 +825,9 @@ export interface UserCreatedWebhookPayload {
|
|
|
455
825
|
user: UsersAPI.User;
|
|
456
826
|
}
|
|
457
827
|
/**
|
|
458
|
-
* Payload for the user.
|
|
828
|
+
* Payload for the user.linked_account webhook event.
|
|
459
829
|
*/
|
|
460
|
-
export interface
|
|
830
|
+
export interface UserLinkedAccountWebhookPayload {
|
|
461
831
|
/**
|
|
462
832
|
* A linked account for the user.
|
|
463
833
|
*/
|
|
@@ -465,28 +835,55 @@ export interface UserAuthenticatedWebhookPayload {
|
|
|
465
835
|
/**
|
|
466
836
|
* The type of webhook event.
|
|
467
837
|
*/
|
|
468
|
-
type: 'user.
|
|
838
|
+
type: 'user.linked_account';
|
|
469
839
|
/**
|
|
470
840
|
* A Privy user object.
|
|
471
841
|
*/
|
|
472
842
|
user: UsersAPI.User;
|
|
473
843
|
}
|
|
474
844
|
/**
|
|
475
|
-
* Payload for the
|
|
845
|
+
* Payload for the user_operation.completed webhook event.
|
|
476
846
|
*/
|
|
477
|
-
export interface
|
|
847
|
+
export interface UserOperationCompletedWebhookPayload {
|
|
848
|
+
actual_gas_cost: string;
|
|
849
|
+
actual_gas_used: string;
|
|
850
|
+
block_number: number;
|
|
851
|
+
caip2: string;
|
|
852
|
+
log_index: number;
|
|
853
|
+
nonce: string;
|
|
854
|
+
paymaster: string | null;
|
|
855
|
+
sender: string;
|
|
856
|
+
success: boolean;
|
|
857
|
+
transaction_hash: string;
|
|
858
|
+
/**
|
|
859
|
+
* The type of webhook event.
|
|
860
|
+
*/
|
|
861
|
+
type: 'user_operation.completed';
|
|
862
|
+
user_op_hash: string;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* Payload for the user.transferred_account webhook event.
|
|
866
|
+
*/
|
|
867
|
+
export interface UserTransferredAccountWebhookPayload {
|
|
478
868
|
/**
|
|
479
869
|
* A linked account for the user.
|
|
480
870
|
*/
|
|
481
871
|
account: UsersAPI.LinkedAccount;
|
|
872
|
+
deletedUser: true;
|
|
873
|
+
fromUser: UserTransferredAccountWebhookPayload.FromUser;
|
|
482
874
|
/**
|
|
483
|
-
*
|
|
875
|
+
* A Privy user object.
|
|
484
876
|
*/
|
|
485
|
-
|
|
877
|
+
toUser: UsersAPI.User;
|
|
486
878
|
/**
|
|
487
|
-
*
|
|
879
|
+
* The type of webhook event.
|
|
488
880
|
*/
|
|
489
|
-
|
|
881
|
+
type: 'user.transferred_account';
|
|
882
|
+
}
|
|
883
|
+
export declare namespace UserTransferredAccountWebhookPayload {
|
|
884
|
+
interface FromUser {
|
|
885
|
+
id: string;
|
|
886
|
+
}
|
|
490
887
|
}
|
|
491
888
|
/**
|
|
492
889
|
* Payload for the user.unlinked_account webhook event.
|
|
@@ -523,33 +920,9 @@ export interface UserUpdatedAccountWebhookPayload {
|
|
|
523
920
|
user: UsersAPI.User;
|
|
524
921
|
}
|
|
525
922
|
/**
|
|
526
|
-
* Payload for the user.
|
|
923
|
+
* Payload for the user.wallet_created webhook event.
|
|
527
924
|
*/
|
|
528
|
-
export interface
|
|
529
|
-
/**
|
|
530
|
-
* A linked account for the user.
|
|
531
|
-
*/
|
|
532
|
-
account: UsersAPI.LinkedAccount;
|
|
533
|
-
deletedUser: true;
|
|
534
|
-
fromUser: UserTransferredAccountWebhookPayload.FromUser;
|
|
535
|
-
/**
|
|
536
|
-
* A Privy user object.
|
|
537
|
-
*/
|
|
538
|
-
toUser: UsersAPI.User;
|
|
539
|
-
/**
|
|
540
|
-
* The type of webhook event.
|
|
541
|
-
*/
|
|
542
|
-
type: 'user.transferred_account';
|
|
543
|
-
}
|
|
544
|
-
export declare namespace UserTransferredAccountWebhookPayload {
|
|
545
|
-
interface FromUser {
|
|
546
|
-
id: string;
|
|
547
|
-
}
|
|
548
|
-
}
|
|
549
|
-
/**
|
|
550
|
-
* Payload for the user.wallet_created webhook event.
|
|
551
|
-
*/
|
|
552
|
-
export interface UserWalletCreatedWebhookPayload {
|
|
925
|
+
export interface UserWalletCreatedWebhookPayload {
|
|
553
926
|
/**
|
|
554
927
|
* The type of webhook event.
|
|
555
928
|
*/
|
|
@@ -564,37 +937,41 @@ export interface UserWalletCreatedWebhookPayload {
|
|
|
564
937
|
wallet: UsersAPI.LinkedAccountBaseWallet;
|
|
565
938
|
}
|
|
566
939
|
/**
|
|
567
|
-
* Payload for the wallet_action.
|
|
940
|
+
* Payload for the wallet_action.earn_deposit.created webhook event.
|
|
568
941
|
*/
|
|
569
|
-
export interface
|
|
942
|
+
export interface WalletActionEarnDepositCreatedWebhookPayload {
|
|
570
943
|
/**
|
|
571
944
|
* Type of wallet action
|
|
572
945
|
*/
|
|
573
946
|
action_type: WalletActionsAPI.WalletActionType;
|
|
574
947
|
/**
|
|
575
|
-
*
|
|
948
|
+
* Underlying asset token address.
|
|
949
|
+
*/
|
|
950
|
+
asset_address: string;
|
|
951
|
+
/**
|
|
952
|
+
* CAIP-2 chain identifier.
|
|
576
953
|
*/
|
|
577
954
|
caip2: string;
|
|
578
955
|
/**
|
|
579
|
-
*
|
|
956
|
+
* Base-unit amount of asset deposited (e.g. "1500000").
|
|
580
957
|
*/
|
|
581
|
-
|
|
958
|
+
raw_amount: string;
|
|
582
959
|
/**
|
|
583
|
-
*
|
|
960
|
+
* The status of the wallet action.
|
|
584
961
|
*/
|
|
585
|
-
|
|
962
|
+
status: 'pending';
|
|
586
963
|
/**
|
|
587
|
-
*
|
|
964
|
+
* The type of webhook event.
|
|
588
965
|
*/
|
|
589
|
-
|
|
966
|
+
type: 'wallet_action.earn_deposit.created';
|
|
590
967
|
/**
|
|
591
|
-
*
|
|
968
|
+
* ERC-4626 vault contract address.
|
|
592
969
|
*/
|
|
593
|
-
|
|
970
|
+
vault_address: string;
|
|
594
971
|
/**
|
|
595
|
-
* The
|
|
972
|
+
* The vault ID.
|
|
596
973
|
*/
|
|
597
|
-
|
|
974
|
+
vault_id: string;
|
|
598
975
|
/**
|
|
599
976
|
* The ID of the wallet action.
|
|
600
977
|
*/
|
|
@@ -603,48 +980,67 @@ export interface WalletActionSwapCreatedWebhookPayload {
|
|
|
603
980
|
* The ID of the wallet involved in the action.
|
|
604
981
|
*/
|
|
605
982
|
wallet_id: string;
|
|
983
|
+
/**
|
|
984
|
+
* Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
|
|
985
|
+
* the token is known in the asset registry.
|
|
986
|
+
*/
|
|
987
|
+
amount?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
990
|
+
* the asset registry.
|
|
991
|
+
*/
|
|
992
|
+
asset?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
995
|
+
* present when the token is known in the asset registry.
|
|
996
|
+
*/
|
|
997
|
+
decimals?: number;
|
|
606
998
|
}
|
|
607
999
|
/**
|
|
608
|
-
* Payload for the wallet_action.
|
|
1000
|
+
* Payload for the wallet_action.earn_deposit.failed webhook event.
|
|
609
1001
|
*/
|
|
610
|
-
export interface
|
|
1002
|
+
export interface WalletActionEarnDepositFailedWebhookPayload {
|
|
611
1003
|
/**
|
|
612
1004
|
* Type of wallet action
|
|
613
1005
|
*/
|
|
614
1006
|
action_type: WalletActionsAPI.WalletActionType;
|
|
615
1007
|
/**
|
|
616
|
-
*
|
|
1008
|
+
* Underlying asset token address.
|
|
1009
|
+
*/
|
|
1010
|
+
asset_address: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* CAIP-2 chain identifier.
|
|
617
1013
|
*/
|
|
618
1014
|
caip2: string;
|
|
619
1015
|
/**
|
|
620
|
-
*
|
|
1016
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
621
1017
|
*/
|
|
622
|
-
|
|
1018
|
+
failure_reason: WalletActionsAPI.FailureReason;
|
|
623
1019
|
/**
|
|
624
|
-
*
|
|
1020
|
+
* Base-unit amount of asset deposited (e.g. "1500000").
|
|
625
1021
|
*/
|
|
626
|
-
|
|
1022
|
+
raw_amount: string;
|
|
627
1023
|
/**
|
|
628
|
-
*
|
|
629
|
-
* confirmation.
|
|
1024
|
+
* The status of the wallet action.
|
|
630
1025
|
*/
|
|
631
|
-
|
|
1026
|
+
status: 'failed';
|
|
632
1027
|
/**
|
|
633
|
-
*
|
|
1028
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
1029
|
+
* the failing step will have a failure_reason.
|
|
634
1030
|
*/
|
|
635
|
-
|
|
1031
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
636
1032
|
/**
|
|
637
|
-
*
|
|
1033
|
+
* The type of webhook event.
|
|
638
1034
|
*/
|
|
639
|
-
|
|
1035
|
+
type: 'wallet_action.earn_deposit.failed';
|
|
640
1036
|
/**
|
|
641
|
-
*
|
|
1037
|
+
* ERC-4626 vault contract address.
|
|
642
1038
|
*/
|
|
643
|
-
|
|
1039
|
+
vault_address: string;
|
|
644
1040
|
/**
|
|
645
|
-
* The
|
|
1041
|
+
* The vault ID.
|
|
646
1042
|
*/
|
|
647
|
-
|
|
1043
|
+
vault_id: string;
|
|
648
1044
|
/**
|
|
649
1045
|
* The ID of the wallet action.
|
|
650
1046
|
*/
|
|
@@ -653,17 +1049,36 @@ export interface WalletActionSwapSucceededWebhookPayload {
|
|
|
653
1049
|
* The ID of the wallet involved in the action.
|
|
654
1050
|
*/
|
|
655
1051
|
wallet_id: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
|
|
1054
|
+
* the token is known in the asset registry.
|
|
1055
|
+
*/
|
|
1056
|
+
amount?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1059
|
+
* the asset registry.
|
|
1060
|
+
*/
|
|
1061
|
+
asset?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1064
|
+
* present when the token is known in the asset registry.
|
|
1065
|
+
*/
|
|
1066
|
+
decimals?: number;
|
|
656
1067
|
}
|
|
657
1068
|
/**
|
|
658
|
-
* Payload for the wallet_action.
|
|
1069
|
+
* Payload for the wallet_action.earn_deposit.rejected webhook event.
|
|
659
1070
|
*/
|
|
660
|
-
export interface
|
|
1071
|
+
export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
661
1072
|
/**
|
|
662
1073
|
* Type of wallet action
|
|
663
1074
|
*/
|
|
664
1075
|
action_type: WalletActionsAPI.WalletActionType;
|
|
665
1076
|
/**
|
|
666
|
-
*
|
|
1077
|
+
* Underlying asset token address.
|
|
1078
|
+
*/
|
|
1079
|
+
asset_address: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* CAIP-2 chain identifier.
|
|
667
1082
|
*/
|
|
668
1083
|
caip2: string;
|
|
669
1084
|
/**
|
|
@@ -671,29 +1086,29 @@ export interface WalletActionSwapRejectedWebhookPayload {
|
|
|
671
1086
|
*/
|
|
672
1087
|
failure_reason: WalletActionsAPI.FailureReason;
|
|
673
1088
|
/**
|
|
674
|
-
*
|
|
1089
|
+
* Base-unit amount of asset deposited (e.g. "1500000").
|
|
675
1090
|
*/
|
|
676
|
-
|
|
1091
|
+
raw_amount: string;
|
|
677
1092
|
/**
|
|
678
|
-
*
|
|
1093
|
+
* The status of the wallet action.
|
|
679
1094
|
*/
|
|
680
|
-
|
|
1095
|
+
status: 'rejected';
|
|
681
1096
|
/**
|
|
682
|
-
*
|
|
1097
|
+
* The steps of the wallet action at the time of rejection.
|
|
683
1098
|
*/
|
|
684
|
-
|
|
1099
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
685
1100
|
/**
|
|
686
|
-
*
|
|
1101
|
+
* The type of webhook event.
|
|
687
1102
|
*/
|
|
688
|
-
|
|
1103
|
+
type: 'wallet_action.earn_deposit.rejected';
|
|
689
1104
|
/**
|
|
690
|
-
*
|
|
1105
|
+
* ERC-4626 vault contract address.
|
|
691
1106
|
*/
|
|
692
|
-
|
|
1107
|
+
vault_address: string;
|
|
693
1108
|
/**
|
|
694
|
-
* The
|
|
1109
|
+
* The vault ID.
|
|
695
1110
|
*/
|
|
696
|
-
|
|
1111
|
+
vault_id: string;
|
|
697
1112
|
/**
|
|
698
1113
|
* The ID of the wallet action.
|
|
699
1114
|
*/
|
|
@@ -702,48 +1117,66 @@ export interface WalletActionSwapRejectedWebhookPayload {
|
|
|
702
1117
|
* The ID of the wallet involved in the action.
|
|
703
1118
|
*/
|
|
704
1119
|
wallet_id: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
|
|
1122
|
+
* the token is known in the asset registry.
|
|
1123
|
+
*/
|
|
1124
|
+
amount?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1127
|
+
* the asset registry.
|
|
1128
|
+
*/
|
|
1129
|
+
asset?: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1132
|
+
* present when the token is known in the asset registry.
|
|
1133
|
+
*/
|
|
1134
|
+
decimals?: number;
|
|
705
1135
|
}
|
|
706
1136
|
/**
|
|
707
|
-
* Payload for the wallet_action.
|
|
1137
|
+
* Payload for the wallet_action.earn_deposit.succeeded webhook event.
|
|
708
1138
|
*/
|
|
709
|
-
export interface
|
|
1139
|
+
export interface WalletActionEarnDepositSucceededWebhookPayload {
|
|
710
1140
|
/**
|
|
711
1141
|
* Type of wallet action
|
|
712
1142
|
*/
|
|
713
1143
|
action_type: WalletActionsAPI.WalletActionType;
|
|
714
1144
|
/**
|
|
715
|
-
*
|
|
1145
|
+
* Underlying asset token address.
|
|
1146
|
+
*/
|
|
1147
|
+
asset_address: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* CAIP-2 chain identifier.
|
|
716
1150
|
*/
|
|
717
1151
|
caip2: string;
|
|
718
1152
|
/**
|
|
719
|
-
*
|
|
1153
|
+
* Base-unit amount of asset deposited (e.g. "1500000").
|
|
720
1154
|
*/
|
|
721
|
-
|
|
1155
|
+
raw_amount: string;
|
|
722
1156
|
/**
|
|
723
|
-
*
|
|
1157
|
+
* Vault shares received in base units.
|
|
724
1158
|
*/
|
|
725
|
-
|
|
1159
|
+
share_amount: string;
|
|
726
1160
|
/**
|
|
727
|
-
*
|
|
1161
|
+
* The status of the wallet action.
|
|
728
1162
|
*/
|
|
729
|
-
|
|
1163
|
+
status: 'succeeded';
|
|
730
1164
|
/**
|
|
731
|
-
*
|
|
1165
|
+
* The steps of the wallet action, including transaction hashes.
|
|
732
1166
|
*/
|
|
733
|
-
|
|
1167
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
734
1168
|
/**
|
|
735
|
-
*
|
|
1169
|
+
* The type of webhook event.
|
|
736
1170
|
*/
|
|
737
|
-
|
|
1171
|
+
type: 'wallet_action.earn_deposit.succeeded';
|
|
738
1172
|
/**
|
|
739
|
-
*
|
|
740
|
-
* the failing step will have a failure_reason.
|
|
1173
|
+
* ERC-4626 vault contract address.
|
|
741
1174
|
*/
|
|
742
|
-
|
|
1175
|
+
vault_address: string;
|
|
743
1176
|
/**
|
|
744
|
-
* The
|
|
1177
|
+
* The vault ID.
|
|
745
1178
|
*/
|
|
746
|
-
|
|
1179
|
+
vault_id: string;
|
|
747
1180
|
/**
|
|
748
1181
|
* The ID of the wallet action.
|
|
749
1182
|
*/
|
|
@@ -752,39 +1185,46 @@ export interface WalletActionSwapFailedWebhookPayload {
|
|
|
752
1185
|
* The ID of the wallet involved in the action.
|
|
753
1186
|
*/
|
|
754
1187
|
wallet_id: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
|
|
1190
|
+
* the token is known in the asset registry.
|
|
1191
|
+
*/
|
|
1192
|
+
amount?: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1195
|
+
* the asset registry.
|
|
1196
|
+
*/
|
|
1197
|
+
asset?: string;
|
|
1198
|
+
/**
|
|
1199
|
+
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1200
|
+
* present when the token is known in the asset registry.
|
|
1201
|
+
*/
|
|
1202
|
+
decimals?: number;
|
|
755
1203
|
}
|
|
756
1204
|
/**
|
|
757
|
-
* Payload for the wallet_action.
|
|
1205
|
+
* Payload for the wallet_action.earn_incentive_claim.created webhook event.
|
|
758
1206
|
*/
|
|
759
|
-
export interface
|
|
1207
|
+
export interface WalletActionEarnIncentiveClaimCreatedWebhookPayload {
|
|
760
1208
|
/**
|
|
761
1209
|
* Type of wallet action
|
|
762
1210
|
*/
|
|
763
1211
|
action_type: WalletActionsAPI.WalletActionType;
|
|
764
1212
|
/**
|
|
765
|
-
*
|
|
766
|
-
*/
|
|
767
|
-
destination_address: string;
|
|
768
|
-
/**
|
|
769
|
-
* Decimal amount as provided by the user (e.g. "1.5").
|
|
770
|
-
*/
|
|
771
|
-
source_amount: string;
|
|
772
|
-
/**
|
|
773
|
-
* Asset identifier (e.g. "usdc", "eth").
|
|
1213
|
+
* EVM chain name (e.g. "base", "ethereum").
|
|
774
1214
|
*/
|
|
775
|
-
|
|
1215
|
+
chain: string;
|
|
776
1216
|
/**
|
|
777
|
-
*
|
|
1217
|
+
* Claimed reward tokens. Populated after the preparation step fetches from Merkl.
|
|
778
1218
|
*/
|
|
779
|
-
|
|
1219
|
+
rewards: Array<WalletActionsAPI.EarnIncetiveClaimRewardEntry> | null;
|
|
780
1220
|
/**
|
|
781
|
-
*
|
|
1221
|
+
* The status of the wallet action.
|
|
782
1222
|
*/
|
|
783
|
-
status:
|
|
1223
|
+
status: 'pending';
|
|
784
1224
|
/**
|
|
785
1225
|
* The type of webhook event.
|
|
786
1226
|
*/
|
|
787
|
-
type: 'wallet_action.
|
|
1227
|
+
type: 'wallet_action.earn_incentive_claim.created';
|
|
788
1228
|
/**
|
|
789
1229
|
* The ID of the wallet action.
|
|
790
1230
|
*/
|
|
@@ -795,41 +1235,38 @@ export interface WalletActionTransferCreatedWebhookPayload {
|
|
|
795
1235
|
wallet_id: string;
|
|
796
1236
|
}
|
|
797
1237
|
/**
|
|
798
|
-
* Payload for the wallet_action.
|
|
1238
|
+
* Payload for the wallet_action.earn_incentive_claim.failed webhook event.
|
|
799
1239
|
*/
|
|
800
|
-
export interface
|
|
1240
|
+
export interface WalletActionEarnIncentiveClaimFailedWebhookPayload {
|
|
801
1241
|
/**
|
|
802
1242
|
* Type of wallet action
|
|
803
1243
|
*/
|
|
804
1244
|
action_type: WalletActionsAPI.WalletActionType;
|
|
805
1245
|
/**
|
|
806
|
-
*
|
|
807
|
-
*/
|
|
808
|
-
destination_address: string;
|
|
809
|
-
/**
|
|
810
|
-
* Decimal amount as provided by the user (e.g. "1.5").
|
|
1246
|
+
* EVM chain name (e.g. "base", "ethereum").
|
|
811
1247
|
*/
|
|
812
|
-
|
|
1248
|
+
chain: string;
|
|
813
1249
|
/**
|
|
814
|
-
*
|
|
1250
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
815
1251
|
*/
|
|
816
|
-
|
|
1252
|
+
failure_reason: WalletActionsAPI.FailureReason;
|
|
817
1253
|
/**
|
|
818
|
-
*
|
|
1254
|
+
* Claimed reward tokens. Populated after the preparation step fetches from Merkl.
|
|
819
1255
|
*/
|
|
820
|
-
|
|
1256
|
+
rewards: Array<WalletActionsAPI.EarnIncetiveClaimRewardEntry> | null;
|
|
821
1257
|
/**
|
|
822
|
-
*
|
|
1258
|
+
* The status of the wallet action.
|
|
823
1259
|
*/
|
|
824
|
-
status:
|
|
1260
|
+
status: 'failed';
|
|
825
1261
|
/**
|
|
826
|
-
* The steps of the wallet action
|
|
1262
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
1263
|
+
* the failing step will have a failure_reason.
|
|
827
1264
|
*/
|
|
828
1265
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
829
1266
|
/**
|
|
830
1267
|
* The type of webhook event.
|
|
831
1268
|
*/
|
|
832
|
-
type: 'wallet_action.
|
|
1269
|
+
type: 'wallet_action.earn_incentive_claim.failed';
|
|
833
1270
|
/**
|
|
834
1271
|
* The ID of the wallet action.
|
|
835
1272
|
*/
|
|
@@ -840,37 +1277,29 @@ export interface WalletActionTransferSucceededWebhookPayload {
|
|
|
840
1277
|
wallet_id: string;
|
|
841
1278
|
}
|
|
842
1279
|
/**
|
|
843
|
-
* Payload for the wallet_action.
|
|
1280
|
+
* Payload for the wallet_action.earn_incentive_claim.rejected webhook event.
|
|
844
1281
|
*/
|
|
845
|
-
export interface
|
|
1282
|
+
export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
|
|
846
1283
|
/**
|
|
847
1284
|
* Type of wallet action
|
|
848
1285
|
*/
|
|
849
1286
|
action_type: WalletActionsAPI.WalletActionType;
|
|
850
1287
|
/**
|
|
851
|
-
*
|
|
1288
|
+
* EVM chain name (e.g. "base", "ethereum").
|
|
852
1289
|
*/
|
|
853
|
-
|
|
1290
|
+
chain: string;
|
|
854
1291
|
/**
|
|
855
1292
|
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
856
1293
|
*/
|
|
857
1294
|
failure_reason: WalletActionsAPI.FailureReason;
|
|
858
1295
|
/**
|
|
859
|
-
*
|
|
860
|
-
*/
|
|
861
|
-
source_amount: string;
|
|
862
|
-
/**
|
|
863
|
-
* Asset identifier (e.g. "usdc", "eth").
|
|
864
|
-
*/
|
|
865
|
-
source_asset: string;
|
|
866
|
-
/**
|
|
867
|
-
* Chain name (e.g. "base", "ethereum").
|
|
1296
|
+
* Claimed reward tokens. Populated after the preparation step fetches from Merkl.
|
|
868
1297
|
*/
|
|
869
|
-
|
|
1298
|
+
rewards: Array<WalletActionsAPI.EarnIncetiveClaimRewardEntry> | null;
|
|
870
1299
|
/**
|
|
871
|
-
*
|
|
1300
|
+
* The status of the wallet action.
|
|
872
1301
|
*/
|
|
873
|
-
status:
|
|
1302
|
+
status: 'rejected';
|
|
874
1303
|
/**
|
|
875
1304
|
* The steps of the wallet action at the time of rejection.
|
|
876
1305
|
*/
|
|
@@ -878,7 +1307,7 @@ export interface WalletActionTransferRejectedWebhookPayload {
|
|
|
878
1307
|
/**
|
|
879
1308
|
* The type of webhook event.
|
|
880
1309
|
*/
|
|
881
|
-
type: 'wallet_action.
|
|
1310
|
+
type: 'wallet_action.earn_incentive_claim.rejected';
|
|
882
1311
|
/**
|
|
883
1312
|
* The ID of the wallet action.
|
|
884
1313
|
*/
|
|
@@ -889,46 +1318,33 @@ export interface WalletActionTransferRejectedWebhookPayload {
|
|
|
889
1318
|
wallet_id: string;
|
|
890
1319
|
}
|
|
891
1320
|
/**
|
|
892
|
-
* Payload for the wallet_action.
|
|
1321
|
+
* Payload for the wallet_action.earn_incentive_claim.succeeded webhook event.
|
|
893
1322
|
*/
|
|
894
|
-
export interface
|
|
1323
|
+
export interface WalletActionEarnIncentiveClaimSucceededWebhookPayload {
|
|
895
1324
|
/**
|
|
896
1325
|
* Type of wallet action
|
|
897
1326
|
*/
|
|
898
1327
|
action_type: WalletActionsAPI.WalletActionType;
|
|
899
1328
|
/**
|
|
900
|
-
*
|
|
901
|
-
*/
|
|
902
|
-
destination_address: string;
|
|
903
|
-
/**
|
|
904
|
-
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
905
|
-
*/
|
|
906
|
-
failure_reason: WalletActionsAPI.FailureReason;
|
|
907
|
-
/**
|
|
908
|
-
* Decimal amount as provided by the user (e.g. "1.5").
|
|
909
|
-
*/
|
|
910
|
-
source_amount: string;
|
|
911
|
-
/**
|
|
912
|
-
* Asset identifier (e.g. "usdc", "eth").
|
|
1329
|
+
* EVM chain name (e.g. "base", "ethereum").
|
|
913
1330
|
*/
|
|
914
|
-
|
|
1331
|
+
chain: string;
|
|
915
1332
|
/**
|
|
916
|
-
*
|
|
1333
|
+
* Claimed reward tokens. Populated after the preparation step fetches from Merkl.
|
|
917
1334
|
*/
|
|
918
|
-
|
|
1335
|
+
rewards: Array<WalletActionsAPI.EarnIncetiveClaimRewardEntry> | null;
|
|
919
1336
|
/**
|
|
920
|
-
*
|
|
1337
|
+
* The status of the wallet action.
|
|
921
1338
|
*/
|
|
922
|
-
status:
|
|
1339
|
+
status: 'succeeded';
|
|
923
1340
|
/**
|
|
924
|
-
* The steps of the wallet action
|
|
925
|
-
* the failing step will have a failure_reason.
|
|
1341
|
+
* The steps of the wallet action, including transaction hashes.
|
|
926
1342
|
*/
|
|
927
1343
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
928
1344
|
/**
|
|
929
1345
|
* The type of webhook event.
|
|
930
1346
|
*/
|
|
931
|
-
type: 'wallet_action.
|
|
1347
|
+
type: 'wallet_action.earn_incentive_claim.succeeded';
|
|
932
1348
|
/**
|
|
933
1349
|
* The ID of the wallet action.
|
|
934
1350
|
*/
|
|
@@ -939,9 +1355,9 @@ export interface WalletActionTransferFailedWebhookPayload {
|
|
|
939
1355
|
wallet_id: string;
|
|
940
1356
|
}
|
|
941
1357
|
/**
|
|
942
|
-
* Payload for the wallet_action.
|
|
1358
|
+
* Payload for the wallet_action.earn_withdraw.created webhook event.
|
|
943
1359
|
*/
|
|
944
|
-
export interface
|
|
1360
|
+
export interface WalletActionEarnWithdrawCreatedWebhookPayload {
|
|
945
1361
|
/**
|
|
946
1362
|
* Type of wallet action
|
|
947
1363
|
*/
|
|
@@ -955,17 +1371,17 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
|
|
|
955
1371
|
*/
|
|
956
1372
|
caip2: string;
|
|
957
1373
|
/**
|
|
958
|
-
* Base-unit amount of asset
|
|
1374
|
+
* Base-unit amount of asset withdrawn (e.g. "1500000").
|
|
959
1375
|
*/
|
|
960
1376
|
raw_amount: string;
|
|
961
1377
|
/**
|
|
962
|
-
*
|
|
1378
|
+
* The status of the wallet action.
|
|
963
1379
|
*/
|
|
964
|
-
status:
|
|
1380
|
+
status: 'pending';
|
|
965
1381
|
/**
|
|
966
1382
|
* The type of webhook event.
|
|
967
1383
|
*/
|
|
968
|
-
type: 'wallet_action.
|
|
1384
|
+
type: 'wallet_action.earn_withdraw.created';
|
|
969
1385
|
/**
|
|
970
1386
|
* ERC-4626 vault contract address.
|
|
971
1387
|
*/
|
|
@@ -983,7 +1399,7 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
|
|
|
983
1399
|
*/
|
|
984
1400
|
wallet_id: string;
|
|
985
1401
|
/**
|
|
986
|
-
* Human-readable decimal amount of asset
|
|
1402
|
+
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
987
1403
|
* the token is known in the asset registry.
|
|
988
1404
|
*/
|
|
989
1405
|
amount?: string;
|
|
@@ -999,9 +1415,9 @@ export interface WalletActionEarnDepositCreatedWebhookPayload {
|
|
|
999
1415
|
decimals?: number;
|
|
1000
1416
|
}
|
|
1001
1417
|
/**
|
|
1002
|
-
* Payload for the wallet_action.
|
|
1418
|
+
* Payload for the wallet_action.earn_withdraw.failed webhook event.
|
|
1003
1419
|
*/
|
|
1004
|
-
export interface
|
|
1420
|
+
export interface WalletActionEarnWithdrawFailedWebhookPayload {
|
|
1005
1421
|
/**
|
|
1006
1422
|
* Type of wallet action
|
|
1007
1423
|
*/
|
|
@@ -1015,25 +1431,26 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
|
|
|
1015
1431
|
*/
|
|
1016
1432
|
caip2: string;
|
|
1017
1433
|
/**
|
|
1018
|
-
*
|
|
1434
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
1019
1435
|
*/
|
|
1020
|
-
|
|
1436
|
+
failure_reason: WalletActionsAPI.FailureReason;
|
|
1021
1437
|
/**
|
|
1022
|
-
*
|
|
1438
|
+
* Base-unit amount of asset withdrawn (e.g. "1500000").
|
|
1023
1439
|
*/
|
|
1024
|
-
|
|
1440
|
+
raw_amount: string;
|
|
1025
1441
|
/**
|
|
1026
|
-
*
|
|
1442
|
+
* The status of the wallet action.
|
|
1027
1443
|
*/
|
|
1028
|
-
status:
|
|
1444
|
+
status: 'failed';
|
|
1029
1445
|
/**
|
|
1030
|
-
* The steps of the wallet action
|
|
1446
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
1447
|
+
* the failing step will have a failure_reason.
|
|
1031
1448
|
*/
|
|
1032
1449
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1033
1450
|
/**
|
|
1034
1451
|
* The type of webhook event.
|
|
1035
1452
|
*/
|
|
1036
|
-
type: 'wallet_action.
|
|
1453
|
+
type: 'wallet_action.earn_withdraw.failed';
|
|
1037
1454
|
/**
|
|
1038
1455
|
* ERC-4626 vault contract address.
|
|
1039
1456
|
*/
|
|
@@ -1051,7 +1468,7 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
|
|
|
1051
1468
|
*/
|
|
1052
1469
|
wallet_id: string;
|
|
1053
1470
|
/**
|
|
1054
|
-
* Human-readable decimal amount of asset
|
|
1471
|
+
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1055
1472
|
* the token is known in the asset registry.
|
|
1056
1473
|
*/
|
|
1057
1474
|
amount?: string;
|
|
@@ -1067,9 +1484,9 @@ export interface WalletActionEarnDepositSucceededWebhookPayload {
|
|
|
1067
1484
|
decimals?: number;
|
|
1068
1485
|
}
|
|
1069
1486
|
/**
|
|
1070
|
-
* Payload for the wallet_action.
|
|
1487
|
+
* Payload for the wallet_action.earn_withdraw.rejected webhook event.
|
|
1071
1488
|
*/
|
|
1072
|
-
export interface
|
|
1489
|
+
export interface WalletActionEarnWithdrawRejectedWebhookPayload {
|
|
1073
1490
|
/**
|
|
1074
1491
|
* Type of wallet action
|
|
1075
1492
|
*/
|
|
@@ -1087,13 +1504,13 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
|
1087
1504
|
*/
|
|
1088
1505
|
failure_reason: WalletActionsAPI.FailureReason;
|
|
1089
1506
|
/**
|
|
1090
|
-
* Base-unit amount of asset
|
|
1507
|
+
* Base-unit amount of asset withdrawn (e.g. "1500000").
|
|
1091
1508
|
*/
|
|
1092
1509
|
raw_amount: string;
|
|
1093
1510
|
/**
|
|
1094
|
-
*
|
|
1511
|
+
* The status of the wallet action.
|
|
1095
1512
|
*/
|
|
1096
|
-
status:
|
|
1513
|
+
status: 'rejected';
|
|
1097
1514
|
/**
|
|
1098
1515
|
* The steps of the wallet action at the time of rejection.
|
|
1099
1516
|
*/
|
|
@@ -1101,7 +1518,7 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
|
1101
1518
|
/**
|
|
1102
1519
|
* The type of webhook event.
|
|
1103
1520
|
*/
|
|
1104
|
-
type: 'wallet_action.
|
|
1521
|
+
type: 'wallet_action.earn_withdraw.rejected';
|
|
1105
1522
|
/**
|
|
1106
1523
|
* ERC-4626 vault contract address.
|
|
1107
1524
|
*/
|
|
@@ -1119,7 +1536,7 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
|
1119
1536
|
*/
|
|
1120
1537
|
wallet_id: string;
|
|
1121
1538
|
/**
|
|
1122
|
-
* Human-readable decimal amount of asset
|
|
1539
|
+
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1123
1540
|
* the token is known in the asset registry.
|
|
1124
1541
|
*/
|
|
1125
1542
|
amount?: string;
|
|
@@ -1135,9 +1552,9 @@ export interface WalletActionEarnDepositRejectedWebhookPayload {
|
|
|
1135
1552
|
decimals?: number;
|
|
1136
1553
|
}
|
|
1137
1554
|
/**
|
|
1138
|
-
* Payload for the wallet_action.
|
|
1555
|
+
* Payload for the wallet_action.earn_withdraw.succeeded webhook event.
|
|
1139
1556
|
*/
|
|
1140
|
-
export interface
|
|
1557
|
+
export interface WalletActionEarnWithdrawSucceededWebhookPayload {
|
|
1141
1558
|
/**
|
|
1142
1559
|
* Type of wallet action
|
|
1143
1560
|
*/
|
|
@@ -1151,26 +1568,25 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
|
|
|
1151
1568
|
*/
|
|
1152
1569
|
caip2: string;
|
|
1153
1570
|
/**
|
|
1154
|
-
*
|
|
1571
|
+
* Base-unit amount of asset withdrawn (e.g. "1500000").
|
|
1155
1572
|
*/
|
|
1156
|
-
|
|
1573
|
+
raw_amount: string;
|
|
1157
1574
|
/**
|
|
1158
|
-
*
|
|
1575
|
+
* Vault shares burned in base units.
|
|
1159
1576
|
*/
|
|
1160
|
-
|
|
1577
|
+
share_amount: string;
|
|
1161
1578
|
/**
|
|
1162
|
-
*
|
|
1579
|
+
* The status of the wallet action.
|
|
1163
1580
|
*/
|
|
1164
|
-
status:
|
|
1581
|
+
status: 'succeeded';
|
|
1165
1582
|
/**
|
|
1166
|
-
* The steps of the wallet action
|
|
1167
|
-
* the failing step will have a failure_reason.
|
|
1583
|
+
* The steps of the wallet action, including transaction hashes.
|
|
1168
1584
|
*/
|
|
1169
1585
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1170
1586
|
/**
|
|
1171
1587
|
* The type of webhook event.
|
|
1172
1588
|
*/
|
|
1173
|
-
type: 'wallet_action.
|
|
1589
|
+
type: 'wallet_action.earn_withdraw.succeeded';
|
|
1174
1590
|
/**
|
|
1175
1591
|
* ERC-4626 vault contract address.
|
|
1176
1592
|
*/
|
|
@@ -1188,7 +1604,7 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
|
|
|
1188
1604
|
*/
|
|
1189
1605
|
wallet_id: string;
|
|
1190
1606
|
/**
|
|
1191
|
-
* Human-readable decimal amount of asset
|
|
1607
|
+
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1192
1608
|
* the token is known in the asset registry.
|
|
1193
1609
|
*/
|
|
1194
1610
|
amount?: string;
|
|
@@ -1204,41 +1620,37 @@ export interface WalletActionEarnDepositFailedWebhookPayload {
|
|
|
1204
1620
|
decimals?: number;
|
|
1205
1621
|
}
|
|
1206
1622
|
/**
|
|
1207
|
-
* Payload for the wallet_action.
|
|
1623
|
+
* Payload for the wallet_action.swap.created webhook event.
|
|
1208
1624
|
*/
|
|
1209
|
-
export interface
|
|
1625
|
+
export interface WalletActionSwapCreatedWebhookPayload {
|
|
1210
1626
|
/**
|
|
1211
1627
|
* Type of wallet action
|
|
1212
1628
|
*/
|
|
1213
1629
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1214
1630
|
/**
|
|
1215
|
-
*
|
|
1216
|
-
*/
|
|
1217
|
-
asset_address: string;
|
|
1218
|
-
/**
|
|
1219
|
-
* CAIP-2 chain identifier.
|
|
1631
|
+
* Chain identifier.
|
|
1220
1632
|
*/
|
|
1221
1633
|
caip2: string;
|
|
1222
1634
|
/**
|
|
1223
|
-
*
|
|
1635
|
+
* Amount of input token in base units. Populated after on-chain confirmation.
|
|
1224
1636
|
*/
|
|
1225
|
-
|
|
1637
|
+
input_amount: string | null;
|
|
1226
1638
|
/**
|
|
1227
|
-
*
|
|
1639
|
+
* Token address being sold.
|
|
1228
1640
|
*/
|
|
1229
|
-
|
|
1641
|
+
input_token: string;
|
|
1230
1642
|
/**
|
|
1231
|
-
*
|
|
1643
|
+
* Token address being bought.
|
|
1232
1644
|
*/
|
|
1233
|
-
|
|
1645
|
+
output_token: string;
|
|
1234
1646
|
/**
|
|
1235
|
-
*
|
|
1647
|
+
* The status of the wallet action.
|
|
1236
1648
|
*/
|
|
1237
|
-
|
|
1649
|
+
status: 'pending';
|
|
1238
1650
|
/**
|
|
1239
|
-
* The
|
|
1651
|
+
* The type of webhook event.
|
|
1240
1652
|
*/
|
|
1241
|
-
|
|
1653
|
+
type: 'wallet_action.swap.created';
|
|
1242
1654
|
/**
|
|
1243
1655
|
* The ID of the wallet action.
|
|
1244
1656
|
*/
|
|
@@ -1247,66 +1659,48 @@ export interface WalletActionEarnWithdrawCreatedWebhookPayload {
|
|
|
1247
1659
|
* The ID of the wallet involved in the action.
|
|
1248
1660
|
*/
|
|
1249
1661
|
wallet_id: string;
|
|
1250
|
-
/**
|
|
1251
|
-
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1252
|
-
* the token is known in the asset registry.
|
|
1253
|
-
*/
|
|
1254
|
-
amount?: string;
|
|
1255
|
-
/**
|
|
1256
|
-
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1257
|
-
* the asset registry.
|
|
1258
|
-
*/
|
|
1259
|
-
asset?: string;
|
|
1260
|
-
/**
|
|
1261
|
-
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1262
|
-
* present when the token is known in the asset registry.
|
|
1263
|
-
*/
|
|
1264
|
-
decimals?: number;
|
|
1265
1662
|
}
|
|
1266
1663
|
/**
|
|
1267
|
-
* Payload for the wallet_action.
|
|
1664
|
+
* Payload for the wallet_action.swap.failed webhook event.
|
|
1268
1665
|
*/
|
|
1269
|
-
export interface
|
|
1666
|
+
export interface WalletActionSwapFailedWebhookPayload {
|
|
1270
1667
|
/**
|
|
1271
1668
|
* Type of wallet action
|
|
1272
1669
|
*/
|
|
1273
1670
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1274
1671
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
*/
|
|
1277
|
-
asset_address: string;
|
|
1278
|
-
/**
|
|
1279
|
-
* CAIP-2 chain identifier.
|
|
1672
|
+
* Chain identifier.
|
|
1280
1673
|
*/
|
|
1281
1674
|
caip2: string;
|
|
1282
1675
|
/**
|
|
1283
|
-
*
|
|
1676
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
1284
1677
|
*/
|
|
1285
|
-
|
|
1678
|
+
failure_reason: WalletActionsAPI.FailureReason;
|
|
1286
1679
|
/**
|
|
1287
|
-
*
|
|
1680
|
+
* Amount of input token in base units. Populated after on-chain confirmation.
|
|
1288
1681
|
*/
|
|
1289
|
-
|
|
1682
|
+
input_amount: string | null;
|
|
1290
1683
|
/**
|
|
1291
|
-
*
|
|
1684
|
+
* Token address being sold.
|
|
1292
1685
|
*/
|
|
1293
|
-
|
|
1686
|
+
input_token: string;
|
|
1294
1687
|
/**
|
|
1295
|
-
*
|
|
1688
|
+
* Token address being bought.
|
|
1296
1689
|
*/
|
|
1297
|
-
|
|
1690
|
+
output_token: string;
|
|
1298
1691
|
/**
|
|
1299
|
-
* The
|
|
1692
|
+
* The status of the wallet action.
|
|
1300
1693
|
*/
|
|
1301
|
-
|
|
1694
|
+
status: 'failed';
|
|
1302
1695
|
/**
|
|
1303
|
-
*
|
|
1696
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
1697
|
+
* the failing step will have a failure_reason.
|
|
1304
1698
|
*/
|
|
1305
|
-
|
|
1699
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1306
1700
|
/**
|
|
1307
|
-
* The
|
|
1701
|
+
* The type of webhook event.
|
|
1308
1702
|
*/
|
|
1309
|
-
|
|
1703
|
+
type: 'wallet_action.swap.failed';
|
|
1310
1704
|
/**
|
|
1311
1705
|
* The ID of the wallet action.
|
|
1312
1706
|
*/
|
|
@@ -1315,36 +1709,17 @@ export interface WalletActionEarnWithdrawSucceededWebhookPayload {
|
|
|
1315
1709
|
* The ID of the wallet involved in the action.
|
|
1316
1710
|
*/
|
|
1317
1711
|
wallet_id: string;
|
|
1318
|
-
/**
|
|
1319
|
-
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1320
|
-
* the token is known in the asset registry.
|
|
1321
|
-
*/
|
|
1322
|
-
amount?: string;
|
|
1323
|
-
/**
|
|
1324
|
-
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1325
|
-
* the asset registry.
|
|
1326
|
-
*/
|
|
1327
|
-
asset?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1330
|
-
* present when the token is known in the asset registry.
|
|
1331
|
-
*/
|
|
1332
|
-
decimals?: number;
|
|
1333
1712
|
}
|
|
1334
1713
|
/**
|
|
1335
|
-
* Payload for the wallet_action.
|
|
1714
|
+
* Payload for the wallet_action.swap.rejected webhook event.
|
|
1336
1715
|
*/
|
|
1337
|
-
export interface
|
|
1716
|
+
export interface WalletActionSwapRejectedWebhookPayload {
|
|
1338
1717
|
/**
|
|
1339
1718
|
* Type of wallet action
|
|
1340
1719
|
*/
|
|
1341
1720
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1342
1721
|
/**
|
|
1343
|
-
*
|
|
1344
|
-
*/
|
|
1345
|
-
asset_address: string;
|
|
1346
|
-
/**
|
|
1347
|
-
* CAIP-2 chain identifier.
|
|
1722
|
+
* Chain identifier.
|
|
1348
1723
|
*/
|
|
1349
1724
|
caip2: string;
|
|
1350
1725
|
/**
|
|
@@ -1352,29 +1727,29 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
|
|
|
1352
1727
|
*/
|
|
1353
1728
|
failure_reason: WalletActionsAPI.FailureReason;
|
|
1354
1729
|
/**
|
|
1355
|
-
*
|
|
1730
|
+
* Amount of input token in base units. Populated after on-chain confirmation.
|
|
1356
1731
|
*/
|
|
1357
|
-
|
|
1732
|
+
input_amount: string | null;
|
|
1358
1733
|
/**
|
|
1359
|
-
*
|
|
1734
|
+
* Token address being sold.
|
|
1360
1735
|
*/
|
|
1361
|
-
|
|
1736
|
+
input_token: string;
|
|
1362
1737
|
/**
|
|
1363
|
-
*
|
|
1738
|
+
* Token address being bought.
|
|
1364
1739
|
*/
|
|
1365
|
-
|
|
1740
|
+
output_token: string;
|
|
1366
1741
|
/**
|
|
1367
|
-
* The
|
|
1742
|
+
* The status of the wallet action.
|
|
1368
1743
|
*/
|
|
1369
|
-
|
|
1744
|
+
status: 'rejected';
|
|
1370
1745
|
/**
|
|
1371
|
-
*
|
|
1746
|
+
* The steps of the wallet action at the time of rejection.
|
|
1372
1747
|
*/
|
|
1373
|
-
|
|
1748
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1374
1749
|
/**
|
|
1375
|
-
* The
|
|
1750
|
+
* The type of webhook event.
|
|
1376
1751
|
*/
|
|
1377
|
-
|
|
1752
|
+
type: 'wallet_action.swap.rejected';
|
|
1378
1753
|
/**
|
|
1379
1754
|
* The ID of the wallet action.
|
|
1380
1755
|
*/
|
|
@@ -1383,67 +1758,48 @@ export interface WalletActionEarnWithdrawRejectedWebhookPayload {
|
|
|
1383
1758
|
* The ID of the wallet involved in the action.
|
|
1384
1759
|
*/
|
|
1385
1760
|
wallet_id: string;
|
|
1386
|
-
/**
|
|
1387
|
-
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1388
|
-
* the token is known in the asset registry.
|
|
1389
|
-
*/
|
|
1390
|
-
amount?: string;
|
|
1391
|
-
/**
|
|
1392
|
-
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1393
|
-
* the asset registry.
|
|
1394
|
-
*/
|
|
1395
|
-
asset?: string;
|
|
1396
|
-
/**
|
|
1397
|
-
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1398
|
-
* present when the token is known in the asset registry.
|
|
1399
|
-
*/
|
|
1400
|
-
decimals?: number;
|
|
1401
1761
|
}
|
|
1402
1762
|
/**
|
|
1403
|
-
* Payload for the wallet_action.
|
|
1763
|
+
* Payload for the wallet_action.swap.succeeded webhook event.
|
|
1404
1764
|
*/
|
|
1405
|
-
export interface
|
|
1765
|
+
export interface WalletActionSwapSucceededWebhookPayload {
|
|
1406
1766
|
/**
|
|
1407
1767
|
* Type of wallet action
|
|
1408
1768
|
*/
|
|
1409
1769
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1410
1770
|
/**
|
|
1411
|
-
*
|
|
1771
|
+
* Chain identifier.
|
|
1412
1772
|
*/
|
|
1413
|
-
|
|
1773
|
+
caip2: string;
|
|
1414
1774
|
/**
|
|
1415
|
-
*
|
|
1775
|
+
* Amount of input token in base units. Populated after on-chain confirmation.
|
|
1416
1776
|
*/
|
|
1417
|
-
|
|
1777
|
+
input_amount: string | null;
|
|
1418
1778
|
/**
|
|
1419
|
-
*
|
|
1779
|
+
* Token address being sold.
|
|
1420
1780
|
*/
|
|
1421
|
-
|
|
1781
|
+
input_token: string;
|
|
1422
1782
|
/**
|
|
1423
|
-
*
|
|
1783
|
+
* Amount of output token received, in base units. Populated after on-chain
|
|
1784
|
+
* confirmation.
|
|
1424
1785
|
*/
|
|
1425
|
-
|
|
1786
|
+
output_amount: string | null;
|
|
1426
1787
|
/**
|
|
1427
|
-
*
|
|
1788
|
+
* Token address being bought.
|
|
1428
1789
|
*/
|
|
1429
|
-
|
|
1790
|
+
output_token: string;
|
|
1430
1791
|
/**
|
|
1431
|
-
* The
|
|
1432
|
-
* the failing step will have a failure_reason.
|
|
1792
|
+
* The status of the wallet action.
|
|
1433
1793
|
*/
|
|
1434
|
-
|
|
1435
|
-
/**
|
|
1436
|
-
* The type of webhook event.
|
|
1437
|
-
*/
|
|
1438
|
-
type: 'wallet_action.earn_withdraw.failed';
|
|
1794
|
+
status: 'succeeded';
|
|
1439
1795
|
/**
|
|
1440
|
-
*
|
|
1796
|
+
* The steps of the wallet action, including transaction hashes.
|
|
1441
1797
|
*/
|
|
1442
|
-
|
|
1798
|
+
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1443
1799
|
/**
|
|
1444
|
-
* The
|
|
1800
|
+
* The type of webhook event.
|
|
1445
1801
|
*/
|
|
1446
|
-
|
|
1802
|
+
type: 'wallet_action.swap.succeeded';
|
|
1447
1803
|
/**
|
|
1448
1804
|
* The ID of the wallet action.
|
|
1449
1805
|
*/
|
|
@@ -1452,46 +1808,31 @@ export interface WalletActionEarnWithdrawFailedWebhookPayload {
|
|
|
1452
1808
|
* The ID of the wallet involved in the action.
|
|
1453
1809
|
*/
|
|
1454
1810
|
wallet_id: string;
|
|
1455
|
-
/**
|
|
1456
|
-
* Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
|
|
1457
|
-
* the token is known in the asset registry.
|
|
1458
|
-
*/
|
|
1459
|
-
amount?: string;
|
|
1460
|
-
/**
|
|
1461
|
-
* Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
|
|
1462
|
-
* the asset registry.
|
|
1463
|
-
*/
|
|
1464
|
-
asset?: string;
|
|
1465
|
-
/**
|
|
1466
|
-
* Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
|
|
1467
|
-
* present when the token is known in the asset registry.
|
|
1468
|
-
*/
|
|
1469
|
-
decimals?: number;
|
|
1470
1811
|
}
|
|
1471
1812
|
/**
|
|
1472
|
-
* Payload for the wallet_action.
|
|
1813
|
+
* Payload for the wallet_action.transfer.created webhook event.
|
|
1473
1814
|
*/
|
|
1474
|
-
export interface
|
|
1815
|
+
export interface WalletActionTransferCreatedWebhookPayload {
|
|
1475
1816
|
/**
|
|
1476
1817
|
* Type of wallet action
|
|
1477
1818
|
*/
|
|
1478
1819
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1479
1820
|
/**
|
|
1480
|
-
*
|
|
1821
|
+
* Recipient address.
|
|
1481
1822
|
*/
|
|
1482
|
-
|
|
1823
|
+
destination_address: string;
|
|
1483
1824
|
/**
|
|
1484
|
-
*
|
|
1825
|
+
* Chain name (e.g. "base", "ethereum").
|
|
1485
1826
|
*/
|
|
1486
|
-
|
|
1827
|
+
source_chain: string;
|
|
1487
1828
|
/**
|
|
1488
|
-
*
|
|
1829
|
+
* The status of the wallet action.
|
|
1489
1830
|
*/
|
|
1490
|
-
status:
|
|
1831
|
+
status: 'pending';
|
|
1491
1832
|
/**
|
|
1492
1833
|
* The type of webhook event.
|
|
1493
1834
|
*/
|
|
1494
|
-
type: 'wallet_action.
|
|
1835
|
+
type: 'wallet_action.transfer.created';
|
|
1495
1836
|
/**
|
|
1496
1837
|
* The ID of the wallet action.
|
|
1497
1838
|
*/
|
|
@@ -1500,35 +1841,60 @@ export interface WalletActionEarnIncentiveClaimCreatedWebhookPayload {
|
|
|
1500
1841
|
* The ID of the wallet involved in the action.
|
|
1501
1842
|
*/
|
|
1502
1843
|
wallet_id: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
1846
|
+
* cross-chain transfers until the source amount is determined.
|
|
1847
|
+
*/
|
|
1848
|
+
source_amount?: string;
|
|
1849
|
+
/**
|
|
1850
|
+
* Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
|
|
1851
|
+
* with a named asset; omitted for custom-token transfers.
|
|
1852
|
+
*/
|
|
1853
|
+
source_asset?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* Token contract address (EVM) or mint address (Solana). Present when the transfer
|
|
1856
|
+
* was initiated with `asset_address`.
|
|
1857
|
+
*/
|
|
1858
|
+
source_asset_address?: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* Number of decimals for the transferred token. Present when the transfer was
|
|
1861
|
+
* initiated with `asset_address` and the decimals were resolved on-chain.
|
|
1862
|
+
*/
|
|
1863
|
+
source_asset_decimals?: number;
|
|
1503
1864
|
}
|
|
1504
1865
|
/**
|
|
1505
|
-
* Payload for the wallet_action.
|
|
1866
|
+
* Payload for the wallet_action.transfer.failed webhook event.
|
|
1506
1867
|
*/
|
|
1507
|
-
export interface
|
|
1868
|
+
export interface WalletActionTransferFailedWebhookPayload {
|
|
1508
1869
|
/**
|
|
1509
1870
|
* Type of wallet action
|
|
1510
1871
|
*/
|
|
1511
1872
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1512
1873
|
/**
|
|
1513
|
-
*
|
|
1874
|
+
* Recipient address.
|
|
1514
1875
|
*/
|
|
1515
|
-
|
|
1876
|
+
destination_address: string;
|
|
1516
1877
|
/**
|
|
1517
|
-
*
|
|
1878
|
+
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
1518
1879
|
*/
|
|
1519
|
-
|
|
1880
|
+
failure_reason: WalletActionsAPI.FailureReason;
|
|
1881
|
+
/**
|
|
1882
|
+
* Chain name (e.g. "base", "ethereum").
|
|
1883
|
+
*/
|
|
1884
|
+
source_chain: string;
|
|
1520
1885
|
/**
|
|
1521
|
-
*
|
|
1886
|
+
* The status of the wallet action.
|
|
1522
1887
|
*/
|
|
1523
|
-
status:
|
|
1888
|
+
status: 'failed';
|
|
1524
1889
|
/**
|
|
1525
|
-
* The steps of the wallet action
|
|
1890
|
+
* The steps of the wallet action. Completed steps will have transaction hashes;
|
|
1891
|
+
* the failing step will have a failure_reason.
|
|
1526
1892
|
*/
|
|
1527
1893
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1528
1894
|
/**
|
|
1529
1895
|
* The type of webhook event.
|
|
1530
1896
|
*/
|
|
1531
|
-
type: 'wallet_action.
|
|
1897
|
+
type: 'wallet_action.transfer.failed';
|
|
1532
1898
|
/**
|
|
1533
1899
|
* The ID of the wallet action.
|
|
1534
1900
|
*/
|
|
@@ -1537,31 +1903,51 @@ export interface WalletActionEarnIncentiveClaimSucceededWebhookPayload {
|
|
|
1537
1903
|
* The ID of the wallet involved in the action.
|
|
1538
1904
|
*/
|
|
1539
1905
|
wallet_id: string;
|
|
1906
|
+
/**
|
|
1907
|
+
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
1908
|
+
* cross-chain transfers until the source amount is determined.
|
|
1909
|
+
*/
|
|
1910
|
+
source_amount?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
|
|
1913
|
+
* with a named asset; omitted for custom-token transfers.
|
|
1914
|
+
*/
|
|
1915
|
+
source_asset?: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* Token contract address (EVM) or mint address (Solana). Present when the transfer
|
|
1918
|
+
* was initiated with `asset_address`.
|
|
1919
|
+
*/
|
|
1920
|
+
source_asset_address?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* Number of decimals for the transferred token. Present when the transfer was
|
|
1923
|
+
* initiated with `asset_address` and the decimals were resolved on-chain.
|
|
1924
|
+
*/
|
|
1925
|
+
source_asset_decimals?: number;
|
|
1540
1926
|
}
|
|
1541
1927
|
/**
|
|
1542
|
-
* Payload for the wallet_action.
|
|
1928
|
+
* Payload for the wallet_action.transfer.rejected webhook event.
|
|
1543
1929
|
*/
|
|
1544
|
-
export interface
|
|
1930
|
+
export interface WalletActionTransferRejectedWebhookPayload {
|
|
1545
1931
|
/**
|
|
1546
1932
|
* Type of wallet action
|
|
1547
1933
|
*/
|
|
1548
1934
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1549
1935
|
/**
|
|
1550
|
-
*
|
|
1936
|
+
* Recipient address.
|
|
1551
1937
|
*/
|
|
1552
|
-
|
|
1938
|
+
destination_address: string;
|
|
1553
1939
|
/**
|
|
1554
1940
|
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
1555
1941
|
*/
|
|
1556
1942
|
failure_reason: WalletActionsAPI.FailureReason;
|
|
1557
1943
|
/**
|
|
1558
|
-
*
|
|
1944
|
+
* Chain name (e.g. "base", "ethereum").
|
|
1559
1945
|
*/
|
|
1560
|
-
|
|
1946
|
+
source_chain: string;
|
|
1561
1947
|
/**
|
|
1562
|
-
*
|
|
1948
|
+
* The status of the wallet action.
|
|
1563
1949
|
*/
|
|
1564
|
-
status:
|
|
1950
|
+
status: 'rejected';
|
|
1565
1951
|
/**
|
|
1566
1952
|
* The steps of the wallet action at the time of rejection.
|
|
1567
1953
|
*/
|
|
@@ -1569,7 +1955,7 @@ export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
|
|
|
1569
1955
|
/**
|
|
1570
1956
|
* The type of webhook event.
|
|
1571
1957
|
*/
|
|
1572
|
-
type: 'wallet_action.
|
|
1958
|
+
type: 'wallet_action.transfer.rejected';
|
|
1573
1959
|
/**
|
|
1574
1960
|
* The ID of the wallet action.
|
|
1575
1961
|
*/
|
|
@@ -1578,40 +1964,55 @@ export interface WalletActionEarnIncentiveClaimRejectedWebhookPayload {
|
|
|
1578
1964
|
* The ID of the wallet involved in the action.
|
|
1579
1965
|
*/
|
|
1580
1966
|
wallet_id: string;
|
|
1967
|
+
/**
|
|
1968
|
+
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
1969
|
+
* cross-chain transfers until the source amount is determined.
|
|
1970
|
+
*/
|
|
1971
|
+
source_amount?: string;
|
|
1972
|
+
/**
|
|
1973
|
+
* Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
|
|
1974
|
+
* with a named asset; omitted for custom-token transfers.
|
|
1975
|
+
*/
|
|
1976
|
+
source_asset?: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Token contract address (EVM) or mint address (Solana). Present when the transfer
|
|
1979
|
+
* was initiated with `asset_address`.
|
|
1980
|
+
*/
|
|
1981
|
+
source_asset_address?: string;
|
|
1982
|
+
/**
|
|
1983
|
+
* Number of decimals for the transferred token. Present when the transfer was
|
|
1984
|
+
* initiated with `asset_address` and the decimals were resolved on-chain.
|
|
1985
|
+
*/
|
|
1986
|
+
source_asset_decimals?: number;
|
|
1581
1987
|
}
|
|
1582
1988
|
/**
|
|
1583
|
-
* Payload for the wallet_action.
|
|
1989
|
+
* Payload for the wallet_action.transfer.succeeded webhook event.
|
|
1584
1990
|
*/
|
|
1585
|
-
export interface
|
|
1991
|
+
export interface WalletActionTransferSucceededWebhookPayload {
|
|
1586
1992
|
/**
|
|
1587
1993
|
* Type of wallet action
|
|
1588
1994
|
*/
|
|
1589
1995
|
action_type: WalletActionsAPI.WalletActionType;
|
|
1590
1996
|
/**
|
|
1591
|
-
*
|
|
1592
|
-
*/
|
|
1593
|
-
chain: string;
|
|
1594
|
-
/**
|
|
1595
|
-
* A description of why a wallet action (or a step within a wallet action) failed.
|
|
1997
|
+
* Recipient address.
|
|
1596
1998
|
*/
|
|
1597
|
-
|
|
1999
|
+
destination_address: string;
|
|
1598
2000
|
/**
|
|
1599
|
-
*
|
|
2001
|
+
* Chain name (e.g. "base", "ethereum").
|
|
1600
2002
|
*/
|
|
1601
|
-
|
|
2003
|
+
source_chain: string;
|
|
1602
2004
|
/**
|
|
1603
|
-
*
|
|
2005
|
+
* The status of the wallet action.
|
|
1604
2006
|
*/
|
|
1605
|
-
status:
|
|
2007
|
+
status: 'succeeded';
|
|
1606
2008
|
/**
|
|
1607
|
-
* The steps of the wallet action
|
|
1608
|
-
* the failing step will have a failure_reason.
|
|
2009
|
+
* The steps of the wallet action, including transaction hashes.
|
|
1609
2010
|
*/
|
|
1610
2011
|
steps: Array<WalletActionsAPI.WalletActionStep>;
|
|
1611
2012
|
/**
|
|
1612
2013
|
* The type of webhook event.
|
|
1613
2014
|
*/
|
|
1614
|
-
type: 'wallet_action.
|
|
2015
|
+
type: 'wallet_action.transfer.succeeded';
|
|
1615
2016
|
/**
|
|
1616
2017
|
* The ID of the wallet action.
|
|
1617
2018
|
*/
|
|
@@ -1620,14 +2021,31 @@ export interface WalletActionEarnIncentiveClaimFailedWebhookPayload {
|
|
|
1620
2021
|
* The ID of the wallet involved in the action.
|
|
1621
2022
|
*/
|
|
1622
2023
|
wallet_id: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
|
|
2026
|
+
* cross-chain transfers until the source amount is determined.
|
|
2027
|
+
*/
|
|
2028
|
+
source_amount?: string;
|
|
2029
|
+
/**
|
|
2030
|
+
* Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
|
|
2031
|
+
* with a named asset; omitted for custom-token transfers.
|
|
2032
|
+
*/
|
|
2033
|
+
source_asset?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* Token contract address (EVM) or mint address (Solana). Present when the transfer
|
|
2036
|
+
* was initiated with `asset_address`.
|
|
2037
|
+
*/
|
|
2038
|
+
source_asset_address?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* Number of decimals for the transferred token. Present when the transfer was
|
|
2041
|
+
* initiated with `asset_address` and the decimals were resolved on-chain.
|
|
2042
|
+
*/
|
|
2043
|
+
source_asset_decimals?: number;
|
|
1623
2044
|
}
|
|
1624
2045
|
/**
|
|
1625
|
-
*
|
|
2046
|
+
* An asset involved in a wallet transfer.
|
|
1626
2047
|
*/
|
|
1627
|
-
export
|
|
1628
|
-
address: null;
|
|
1629
|
-
type: 'native-token';
|
|
1630
|
-
}
|
|
2048
|
+
export type WalletFundsAsset = WalletFundsNativeTokenAsset | WalletFundsErc20Asset | WalletFundsSplAsset | WalletFundsSacAsset;
|
|
1631
2049
|
/**
|
|
1632
2050
|
* An ERC-20 token asset.
|
|
1633
2051
|
*/
|
|
@@ -1636,11 +2054,11 @@ export interface WalletFundsErc20Asset {
|
|
|
1636
2054
|
type: 'erc20';
|
|
1637
2055
|
}
|
|
1638
2056
|
/**
|
|
1639
|
-
* A
|
|
2057
|
+
* A native token asset (e.g. ETH, SOL).
|
|
1640
2058
|
*/
|
|
1641
|
-
export interface
|
|
1642
|
-
|
|
1643
|
-
type: '
|
|
2059
|
+
export interface WalletFundsNativeTokenAsset {
|
|
2060
|
+
address: null;
|
|
2061
|
+
type: 'native-token';
|
|
1644
2062
|
}
|
|
1645
2063
|
/**
|
|
1646
2064
|
* A Stellar Asset Contract (SAC) asset.
|
|
@@ -1650,305 +2068,93 @@ export interface WalletFundsSacAsset {
|
|
|
1650
2068
|
type: 'sac';
|
|
1651
2069
|
}
|
|
1652
2070
|
/**
|
|
1653
|
-
*
|
|
2071
|
+
* A Solana SPL token asset.
|
|
1654
2072
|
*/
|
|
1655
|
-
export
|
|
2073
|
+
export interface WalletFundsSplAsset {
|
|
2074
|
+
mint: string;
|
|
2075
|
+
type: 'spl';
|
|
2076
|
+
}
|
|
1656
2077
|
/**
|
|
1657
|
-
*
|
|
2078
|
+
* Payload for the wallet.recovered webhook event.
|
|
1658
2079
|
*/
|
|
1659
|
-
export interface
|
|
1660
|
-
drain_id: string;
|
|
2080
|
+
export interface WalletRecoveredWebhookPayload {
|
|
1661
2081
|
/**
|
|
1662
|
-
* The
|
|
2082
|
+
* The type of webhook event.
|
|
1663
2083
|
*/
|
|
1664
|
-
|
|
1665
|
-
liquidation_address_id: string;
|
|
1666
|
-
method: 'liquidation_address';
|
|
2084
|
+
type: 'wallet.recovered';
|
|
1667
2085
|
/**
|
|
1668
|
-
* The
|
|
2086
|
+
* The ID of the user.
|
|
1669
2087
|
*/
|
|
1670
|
-
|
|
1671
|
-
|
|
2088
|
+
user_id: string;
|
|
2089
|
+
/**
|
|
2090
|
+
* The address of the wallet.
|
|
2091
|
+
*/
|
|
2092
|
+
wallet_address: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* The ID of the wallet.
|
|
2095
|
+
*/
|
|
2096
|
+
wallet_id: string;
|
|
1672
2097
|
}
|
|
1673
2098
|
/**
|
|
1674
|
-
*
|
|
2099
|
+
* Payload for the wallet.recovery_setup webhook event.
|
|
1675
2100
|
*/
|
|
1676
|
-
export interface
|
|
1677
|
-
drain_id: string;
|
|
1678
|
-
liquidation_address_id: string;
|
|
1679
|
-
method: 'liquidation_address';
|
|
2101
|
+
export interface WalletRecoverySetupWebhookPayload {
|
|
1680
2102
|
/**
|
|
1681
|
-
* The
|
|
2103
|
+
* The recovery method that was set up.
|
|
1682
2104
|
*/
|
|
1683
|
-
|
|
1684
|
-
|
|
2105
|
+
method: 'user_passcode_derived_recovery_key' | 'privy_passcode_derived_recovery_key' | 'privy_generated_recovery_key' | 'google_drive_recovery_secret' | 'icloud_recovery_secret' | 'recovery_encryption_key';
|
|
2106
|
+
/**
|
|
2107
|
+
* The type of webhook event.
|
|
2108
|
+
*/
|
|
2109
|
+
type: 'wallet.recovery_setup';
|
|
2110
|
+
/**
|
|
2111
|
+
* The ID of the user.
|
|
2112
|
+
*/
|
|
2113
|
+
user_id: string;
|
|
2114
|
+
/**
|
|
2115
|
+
* The address of the wallet.
|
|
2116
|
+
*/
|
|
2117
|
+
wallet_address: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* The ID of the wallet.
|
|
2120
|
+
*/
|
|
2121
|
+
wallet_id: string;
|
|
1685
2122
|
}
|
|
1686
2123
|
/**
|
|
1687
|
-
*
|
|
2124
|
+
* Union of all webhook payload schemas.
|
|
1688
2125
|
*/
|
|
1689
|
-
export
|
|
1690
|
-
activity_id: string;
|
|
1691
|
-
method: 'virtual_account';
|
|
1692
|
-
type: 'fiat_deposit';
|
|
1693
|
-
virtual_account_id: string;
|
|
1694
|
-
}
|
|
2126
|
+
export type WebhookPayload = UserCreatedWebhookPayload | UserAuthenticatedWebhookPayload | UserLinkedAccountWebhookPayload | UserUnlinkedAccountWebhookPayload | UserUpdatedAccountWebhookPayload | UserTransferredAccountWebhookPayload | UserWalletCreatedWebhookPayload | TransactionBroadcastedWebhookPayload | TransactionConfirmedWebhookPayload | TransactionExecutionRevertedWebhookPayload | TransactionStillPendingWebhookPayload | TransactionFailedWebhookPayload | TransactionReplacedWebhookPayload | TransactionProviderErrorWebhookPayload | FundsDepositedWebhookPayload | FundsWithdrawnWebhookPayload | PrivateKeyExportWebhookPayload | SeedPhraseExportWebhookPayload | WalletRecoverySetupWebhookPayload | WalletRecoveredWebhookPayload | MfaEnabledWebhookPayload | MfaDisabledWebhookPayload | YieldDepositConfirmedWebhookPayload | YieldWithdrawConfirmedWebhookPayload | YieldClaimConfirmedWebhookPayload | UserOperationCompletedWebhookPayload | IntentCreatedWebhookPayload | IntentAuthorizedWebhookPayload | IntentExecutedWebhookPayload | IntentFailedWebhookPayload | WalletActionSwapCreatedWebhookPayload | WalletActionSwapSucceededWebhookPayload | WalletActionSwapRejectedWebhookPayload | WalletActionSwapFailedWebhookPayload | WalletActionTransferCreatedWebhookPayload | WalletActionTransferSucceededWebhookPayload | WalletActionTransferRejectedWebhookPayload | WalletActionTransferFailedWebhookPayload | WalletActionEarnDepositCreatedWebhookPayload | WalletActionEarnDepositSucceededWebhookPayload | WalletActionEarnDepositRejectedWebhookPayload | WalletActionEarnDepositFailedWebhookPayload | WalletActionEarnWithdrawCreatedWebhookPayload | WalletActionEarnWithdrawSucceededWebhookPayload | WalletActionEarnWithdrawRejectedWebhookPayload | WalletActionEarnWithdrawFailedWebhookPayload | WalletActionEarnIncentiveClaimCreatedWebhookPayload | WalletActionEarnIncentiveClaimSucceededWebhookPayload | WalletActionEarnIncentiveClaimRejectedWebhookPayload | WalletActionEarnIncentiveClaimFailedWebhookPayload;
|
|
1695
2127
|
/**
|
|
1696
|
-
*
|
|
2128
|
+
* Payload for the yield.claim.confirmed webhook event.
|
|
1697
2129
|
*/
|
|
1698
|
-
export interface
|
|
1699
|
-
|
|
2130
|
+
export interface YieldClaimConfirmedWebhookPayload {
|
|
2131
|
+
caip2: string;
|
|
2132
|
+
rewards: Array<YieldClaimConfirmedWebhookPayload.Reward>;
|
|
2133
|
+
transaction_id: string;
|
|
1700
2134
|
/**
|
|
1701
|
-
* The
|
|
2135
|
+
* The type of webhook event.
|
|
1702
2136
|
*/
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
type: 'crypto_deposit';
|
|
2137
|
+
type: 'yield.claim.confirmed';
|
|
2138
|
+
wallet_id: string;
|
|
1706
2139
|
}
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
type: 'fiat_deposit';
|
|
2140
|
+
export declare namespace YieldClaimConfirmedWebhookPayload {
|
|
2141
|
+
interface Reward {
|
|
2142
|
+
amount: string;
|
|
2143
|
+
token_address: string;
|
|
2144
|
+
token_symbol: string;
|
|
2145
|
+
}
|
|
1714
2146
|
}
|
|
1715
2147
|
/**
|
|
1716
|
-
*
|
|
2148
|
+
* Payload for the yield.deposit.confirmed webhook event.
|
|
1717
2149
|
*/
|
|
1718
|
-
export interface
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
2150
|
+
export interface YieldDepositConfirmedWebhookPayload {
|
|
2151
|
+
assets: string;
|
|
2152
|
+
caip2: string;
|
|
2153
|
+
owner: string;
|
|
2154
|
+
sender: string;
|
|
2155
|
+
shares: string;
|
|
1722
2156
|
/**
|
|
1723
|
-
* The
|
|
1724
|
-
*/
|
|
1725
|
-
original_transaction_hash?: string;
|
|
1726
|
-
}
|
|
1727
|
-
/**
|
|
1728
|
-
* Metadata about a Bridge transaction associated with a wallet event.
|
|
1729
|
-
*/
|
|
1730
|
-
export type BridgeMetadata = BridgeCryptoDepositMetadata | BridgeRefundMetadata | BridgeFiatDepositMetadata | BridgeCryptoTransferMetadata | BridgeFiatTransferMetadata | BridgeTransferRefundMetadata;
|
|
1731
|
-
/**
|
|
1732
|
-
* Payload for the wallet.funds_deposited webhook event.
|
|
1733
|
-
*/
|
|
1734
|
-
export interface FundsDepositedWebhookPayload {
|
|
1735
|
-
/**
|
|
1736
|
-
* The amount transferred, as a stringified bigint.
|
|
1737
|
-
*/
|
|
1738
|
-
amount: string;
|
|
1739
|
-
/**
|
|
1740
|
-
* An asset involved in a wallet transfer.
|
|
1741
|
-
*/
|
|
1742
|
-
asset: WalletFundsAsset;
|
|
1743
|
-
block: FundsDepositedWebhookPayload.Block;
|
|
1744
|
-
/**
|
|
1745
|
-
* The CAIP-2 chain identifier.
|
|
1746
|
-
*/
|
|
1747
|
-
caip2: string;
|
|
1748
|
-
/**
|
|
1749
|
-
* A unique key for this event.
|
|
1750
|
-
*/
|
|
1751
|
-
idempotency_key: string;
|
|
1752
|
-
/**
|
|
1753
|
-
* The recipient address.
|
|
1754
|
-
*/
|
|
1755
|
-
recipient: string;
|
|
1756
|
-
/**
|
|
1757
|
-
* The sender address.
|
|
1758
|
-
*/
|
|
1759
|
-
sender: string;
|
|
1760
|
-
/**
|
|
1761
|
-
* The blockchain transaction hash.
|
|
1762
|
-
*/
|
|
1763
|
-
transaction_hash: string;
|
|
1764
|
-
/**
|
|
1765
|
-
* The type of webhook event.
|
|
1766
|
-
*/
|
|
1767
|
-
type: 'wallet.funds_deposited';
|
|
1768
|
-
/**
|
|
1769
|
-
* The ID of the wallet.
|
|
1770
|
-
*/
|
|
1771
|
-
wallet_id: string;
|
|
1772
|
-
/**
|
|
1773
|
-
* Metadata about a Bridge transaction associated with a wallet event.
|
|
1774
|
-
*/
|
|
1775
|
-
bridge_metadata?: BridgeMetadata;
|
|
1776
|
-
/**
|
|
1777
|
-
* The transaction fee paid, as a stringified bigint in the chain's native token.
|
|
1778
|
-
*/
|
|
1779
|
-
transaction_fee?: string;
|
|
1780
|
-
}
|
|
1781
|
-
export declare namespace FundsDepositedWebhookPayload {
|
|
1782
|
-
interface Block {
|
|
1783
|
-
/**
|
|
1784
|
-
* The block number.
|
|
1785
|
-
*/
|
|
1786
|
-
number: number;
|
|
1787
|
-
/**
|
|
1788
|
-
* The block timestamp.
|
|
1789
|
-
*/
|
|
1790
|
-
timestamp: number;
|
|
1791
|
-
}
|
|
1792
|
-
}
|
|
1793
|
-
/**
|
|
1794
|
-
* Payload for the wallet.funds_withdrawn webhook event.
|
|
1795
|
-
*/
|
|
1796
|
-
export interface FundsWithdrawnWebhookPayload {
|
|
1797
|
-
/**
|
|
1798
|
-
* The amount transferred, as a stringified bigint.
|
|
1799
|
-
*/
|
|
1800
|
-
amount: string;
|
|
1801
|
-
/**
|
|
1802
|
-
* An asset involved in a wallet transfer.
|
|
1803
|
-
*/
|
|
1804
|
-
asset: WalletFundsAsset;
|
|
1805
|
-
block: FundsWithdrawnWebhookPayload.Block;
|
|
1806
|
-
/**
|
|
1807
|
-
* The CAIP-2 chain identifier.
|
|
1808
|
-
*/
|
|
1809
|
-
caip2: string;
|
|
1810
|
-
/**
|
|
1811
|
-
* A unique key for this event.
|
|
1812
|
-
*/
|
|
1813
|
-
idempotency_key: string;
|
|
1814
|
-
/**
|
|
1815
|
-
* The recipient address.
|
|
1816
|
-
*/
|
|
1817
|
-
recipient: string;
|
|
1818
|
-
/**
|
|
1819
|
-
* The sender address.
|
|
1820
|
-
*/
|
|
1821
|
-
sender: string;
|
|
1822
|
-
/**
|
|
1823
|
-
* The blockchain transaction hash.
|
|
1824
|
-
*/
|
|
1825
|
-
transaction_hash: string;
|
|
1826
|
-
/**
|
|
1827
|
-
* The type of webhook event.
|
|
1828
|
-
*/
|
|
1829
|
-
type: 'wallet.funds_withdrawn';
|
|
1830
|
-
/**
|
|
1831
|
-
* The ID of the wallet.
|
|
1832
|
-
*/
|
|
1833
|
-
wallet_id: string;
|
|
1834
|
-
/**
|
|
1835
|
-
* The transaction fee paid, as a stringified bigint in the chain's native token.
|
|
1836
|
-
*/
|
|
1837
|
-
transaction_fee?: string;
|
|
1838
|
-
}
|
|
1839
|
-
export declare namespace FundsWithdrawnWebhookPayload {
|
|
1840
|
-
interface Block {
|
|
1841
|
-
/**
|
|
1842
|
-
* The block number.
|
|
1843
|
-
*/
|
|
1844
|
-
number: number;
|
|
1845
|
-
/**
|
|
1846
|
-
* The block timestamp.
|
|
1847
|
-
*/
|
|
1848
|
-
timestamp: number;
|
|
1849
|
-
}
|
|
1850
|
-
}
|
|
1851
|
-
/**
|
|
1852
|
-
* Payload for the wallet.private_key_export webhook event.
|
|
1853
|
-
*/
|
|
1854
|
-
export interface PrivateKeyExportWebhookPayload {
|
|
1855
|
-
/**
|
|
1856
|
-
* The type of webhook event.
|
|
1857
|
-
*/
|
|
1858
|
-
type: 'wallet.private_key_export';
|
|
1859
|
-
/**
|
|
1860
|
-
* The ID of the user who exported the key.
|
|
1861
|
-
*/
|
|
1862
|
-
user_id: string;
|
|
1863
|
-
/**
|
|
1864
|
-
* The address of the wallet.
|
|
1865
|
-
*/
|
|
1866
|
-
wallet_address: string;
|
|
1867
|
-
/**
|
|
1868
|
-
* The ID of the wallet.
|
|
1869
|
-
*/
|
|
1870
|
-
wallet_id: string;
|
|
1871
|
-
export_source?: 'display' | 'client';
|
|
1872
|
-
}
|
|
1873
|
-
/**
|
|
1874
|
-
* Payload for the wallet.seed_phrase_export webhook event.
|
|
1875
|
-
*/
|
|
1876
|
-
export interface SeedPhraseExportWebhookPayload {
|
|
1877
|
-
/**
|
|
1878
|
-
* The type of webhook event.
|
|
1879
|
-
*/
|
|
1880
|
-
type: 'wallet.seed_phrase_export';
|
|
1881
|
-
/**
|
|
1882
|
-
* The ID of the user who exported the seed phrase.
|
|
1883
|
-
*/
|
|
1884
|
-
user_id: string;
|
|
1885
|
-
/**
|
|
1886
|
-
* The address of the wallet.
|
|
1887
|
-
*/
|
|
1888
|
-
wallet_address: string;
|
|
1889
|
-
/**
|
|
1890
|
-
* The ID of the wallet.
|
|
1891
|
-
*/
|
|
1892
|
-
wallet_id: string;
|
|
1893
|
-
export_source?: 'display' | 'client';
|
|
1894
|
-
}
|
|
1895
|
-
/**
|
|
1896
|
-
* Payload for the wallet.recovery_setup webhook event.
|
|
1897
|
-
*/
|
|
1898
|
-
export interface WalletRecoverySetupWebhookPayload {
|
|
1899
|
-
/**
|
|
1900
|
-
* The recovery method that was set up.
|
|
1901
|
-
*/
|
|
1902
|
-
method: 'user_passcode_derived_recovery_key' | 'privy_passcode_derived_recovery_key' | 'privy_generated_recovery_key' | 'google_drive_recovery_secret' | 'icloud_recovery_secret' | 'recovery_encryption_key';
|
|
1903
|
-
/**
|
|
1904
|
-
* The type of webhook event.
|
|
1905
|
-
*/
|
|
1906
|
-
type: 'wallet.recovery_setup';
|
|
1907
|
-
/**
|
|
1908
|
-
* The ID of the user.
|
|
1909
|
-
*/
|
|
1910
|
-
user_id: string;
|
|
1911
|
-
/**
|
|
1912
|
-
* The address of the wallet.
|
|
1913
|
-
*/
|
|
1914
|
-
wallet_address: string;
|
|
1915
|
-
/**
|
|
1916
|
-
* The ID of the wallet.
|
|
1917
|
-
*/
|
|
1918
|
-
wallet_id: string;
|
|
1919
|
-
}
|
|
1920
|
-
/**
|
|
1921
|
-
* Payload for the wallet.recovered webhook event.
|
|
1922
|
-
*/
|
|
1923
|
-
export interface WalletRecoveredWebhookPayload {
|
|
1924
|
-
/**
|
|
1925
|
-
* The type of webhook event.
|
|
1926
|
-
*/
|
|
1927
|
-
type: 'wallet.recovered';
|
|
1928
|
-
/**
|
|
1929
|
-
* The ID of the user.
|
|
1930
|
-
*/
|
|
1931
|
-
user_id: string;
|
|
1932
|
-
/**
|
|
1933
|
-
* The address of the wallet.
|
|
1934
|
-
*/
|
|
1935
|
-
wallet_address: string;
|
|
1936
|
-
/**
|
|
1937
|
-
* The ID of the wallet.
|
|
1938
|
-
*/
|
|
1939
|
-
wallet_id: string;
|
|
1940
|
-
}
|
|
1941
|
-
/**
|
|
1942
|
-
* Payload for the yield.deposit.confirmed webhook event.
|
|
1943
|
-
*/
|
|
1944
|
-
export interface YieldDepositConfirmedWebhookPayload {
|
|
1945
|
-
assets: string;
|
|
1946
|
-
caip2: string;
|
|
1947
|
-
owner: string;
|
|
1948
|
-
sender: string;
|
|
1949
|
-
shares: string;
|
|
1950
|
-
/**
|
|
1951
|
-
* The type of webhook event.
|
|
2157
|
+
* The type of webhook event.
|
|
1952
2158
|
*/
|
|
1953
2159
|
type: 'yield.deposit.confirmed';
|
|
1954
2160
|
vault_address: string;
|
|
@@ -1969,155 +2175,7 @@ export interface YieldWithdrawConfirmedWebhookPayload {
|
|
|
1969
2175
|
type: 'yield.withdraw.confirmed';
|
|
1970
2176
|
vault_address: string;
|
|
1971
2177
|
}
|
|
1972
|
-
/**
|
|
1973
|
-
* Payload for the yield.claim.confirmed webhook event.
|
|
1974
|
-
*/
|
|
1975
|
-
export interface YieldClaimConfirmedWebhookPayload {
|
|
1976
|
-
caip2: string;
|
|
1977
|
-
rewards: Array<YieldClaimConfirmedWebhookPayload.Reward>;
|
|
1978
|
-
transaction_id: string;
|
|
1979
|
-
/**
|
|
1980
|
-
* The type of webhook event.
|
|
1981
|
-
*/
|
|
1982
|
-
type: 'yield.claim.confirmed';
|
|
1983
|
-
wallet_id: string;
|
|
1984
|
-
}
|
|
1985
|
-
export declare namespace YieldClaimConfirmedWebhookPayload {
|
|
1986
|
-
interface Reward {
|
|
1987
|
-
amount: string;
|
|
1988
|
-
token_address: string;
|
|
1989
|
-
token_symbol: string;
|
|
1990
|
-
}
|
|
1991
|
-
}
|
|
1992
|
-
/**
|
|
1993
|
-
* Union of all webhook payload schemas.
|
|
1994
|
-
*/
|
|
1995
|
-
export type WebhookPayload = UserCreatedWebhookPayload | UserAuthenticatedWebhookPayload | UserLinkedAccountWebhookPayload | UserUnlinkedAccountWebhookPayload | UserUpdatedAccountWebhookPayload | UserTransferredAccountWebhookPayload | UserWalletCreatedWebhookPayload | TransactionBroadcastedWebhookPayload | TransactionConfirmedWebhookPayload | TransactionExecutionRevertedWebhookPayload | TransactionStillPendingWebhookPayload | TransactionFailedWebhookPayload | TransactionReplacedWebhookPayload | TransactionProviderErrorWebhookPayload | FundsDepositedWebhookPayload | FundsWithdrawnWebhookPayload | PrivateKeyExportWebhookPayload | SeedPhraseExportWebhookPayload | WalletRecoverySetupWebhookPayload | WalletRecoveredWebhookPayload | MfaEnabledWebhookPayload | MfaDisabledWebhookPayload | YieldDepositConfirmedWebhookPayload | YieldWithdrawConfirmedWebhookPayload | YieldClaimConfirmedWebhookPayload | UserOperationCompletedWebhookPayload | IntentCreatedWebhookPayload | IntentAuthorizedWebhookPayload | IntentExecutedWebhookPayload | IntentFailedWebhookPayload | WalletActionSwapCreatedWebhookPayload | WalletActionSwapSucceededWebhookPayload | WalletActionSwapRejectedWebhookPayload | WalletActionSwapFailedWebhookPayload | WalletActionTransferCreatedWebhookPayload | WalletActionTransferSucceededWebhookPayload | WalletActionTransferRejectedWebhookPayload | WalletActionTransferFailedWebhookPayload | WalletActionEarnDepositCreatedWebhookPayload | WalletActionEarnDepositSucceededWebhookPayload | WalletActionEarnDepositRejectedWebhookPayload | WalletActionEarnDepositFailedWebhookPayload | WalletActionEarnWithdrawCreatedWebhookPayload | WalletActionEarnWithdrawSucceededWebhookPayload | WalletActionEarnWithdrawRejectedWebhookPayload | WalletActionEarnWithdrawFailedWebhookPayload | WalletActionEarnIncentiveClaimCreatedWebhookPayload | WalletActionEarnIncentiveClaimSucceededWebhookPayload | WalletActionEarnIncentiveClaimRejectedWebhookPayload | WalletActionEarnIncentiveClaimFailedWebhookPayload;
|
|
1996
|
-
/**
|
|
1997
|
-
* Payload for the kraken_embed.quote_executed webhook event.
|
|
1998
|
-
*/
|
|
1999
|
-
export interface KrakenEmbedQuoteExecutedWebhookPayload {
|
|
2000
|
-
/**
|
|
2001
|
-
* ISO 8601 timestamp of when the quote was executed.
|
|
2002
|
-
*/
|
|
2003
|
-
executed_at: string;
|
|
2004
|
-
/**
|
|
2005
|
-
* The ID of the executed quote.
|
|
2006
|
-
*/
|
|
2007
|
-
quote_id: string;
|
|
2008
|
-
/**
|
|
2009
|
-
* The type of webhook event.
|
|
2010
|
-
*/
|
|
2011
|
-
type: 'kraken_embed.quote.executed';
|
|
2012
|
-
/**
|
|
2013
|
-
* The ID of the user.
|
|
2014
|
-
*/
|
|
2015
|
-
user_id: string;
|
|
2016
|
-
}
|
|
2017
|
-
/**
|
|
2018
|
-
* Payload for the kraken_embed.quote.execution_failed webhook event.
|
|
2019
|
-
*/
|
|
2020
|
-
export interface KrakenEmbedQuoteExecutionFailedWebhookPayload {
|
|
2021
|
-
/**
|
|
2022
|
-
* ISO 8601 timestamp of when the quote execution failed.
|
|
2023
|
-
*/
|
|
2024
|
-
failed_at: string;
|
|
2025
|
-
/**
|
|
2026
|
-
* The ID of the quote that failed to execute.
|
|
2027
|
-
*/
|
|
2028
|
-
quote_id: string;
|
|
2029
|
-
/**
|
|
2030
|
-
* A human-readable description of why the quote execution failed. Intended for
|
|
2031
|
-
* display and logging purposes only.
|
|
2032
|
-
*/
|
|
2033
|
-
reason: string;
|
|
2034
|
-
/**
|
|
2035
|
-
* The type of webhook event.
|
|
2036
|
-
*/
|
|
2037
|
-
type: 'kraken_embed.quote.execution_failed';
|
|
2038
|
-
/**
|
|
2039
|
-
* The ID of the user.
|
|
2040
|
-
*/
|
|
2041
|
-
user_id: string;
|
|
2042
|
-
}
|
|
2043
|
-
/**
|
|
2044
|
-
* Payload for the kraken_embed.quote.cancelled webhook event.
|
|
2045
|
-
*/
|
|
2046
|
-
export interface KrakenEmbedQuoteCancelledWebhookPayload {
|
|
2047
|
-
/**
|
|
2048
|
-
* ISO 8601 timestamp of when the quote was cancelled.
|
|
2049
|
-
*/
|
|
2050
|
-
cancelled_at: string;
|
|
2051
|
-
/**
|
|
2052
|
-
* The ID of the cancelled quote.
|
|
2053
|
-
*/
|
|
2054
|
-
quote_id: string;
|
|
2055
|
-
/**
|
|
2056
|
-
* A human-readable description of why the quote was cancelled. Intended for
|
|
2057
|
-
* display and logging purposes only.
|
|
2058
|
-
*/
|
|
2059
|
-
reason: string;
|
|
2060
|
-
/**
|
|
2061
|
-
* The type of webhook event.
|
|
2062
|
-
*/
|
|
2063
|
-
type: 'kraken_embed.quote.cancelled';
|
|
2064
|
-
/**
|
|
2065
|
-
* The ID of the user.
|
|
2066
|
-
*/
|
|
2067
|
-
user_id: string;
|
|
2068
|
-
}
|
|
2069
|
-
/**
|
|
2070
|
-
* Payload for the kraken_embed.user.verified webhook event.
|
|
2071
|
-
*/
|
|
2072
|
-
export interface KrakenEmbedUserVerifiedWebhookPayload {
|
|
2073
|
-
/**
|
|
2074
|
-
* The type of webhook event.
|
|
2075
|
-
*/
|
|
2076
|
-
type: 'kraken_embed.user.verified';
|
|
2077
|
-
/**
|
|
2078
|
-
* The ID of the user.
|
|
2079
|
-
*/
|
|
2080
|
-
user_id: string;
|
|
2081
|
-
/**
|
|
2082
|
-
* ISO 8601 timestamp of when the user was verified.
|
|
2083
|
-
*/
|
|
2084
|
-
verified_at: string;
|
|
2085
|
-
}
|
|
2086
|
-
/**
|
|
2087
|
-
* Payload for the kraken_embed.user.disabled webhook event.
|
|
2088
|
-
*/
|
|
2089
|
-
export interface KrakenEmbedUserDisabledWebhookPayload {
|
|
2090
|
-
/**
|
|
2091
|
-
* ISO 8601 timestamp of when the user was disabled.
|
|
2092
|
-
*/
|
|
2093
|
-
disabled_at: string;
|
|
2094
|
-
/**
|
|
2095
|
-
* The type of webhook event.
|
|
2096
|
-
*/
|
|
2097
|
-
type: 'kraken_embed.user.disabled';
|
|
2098
|
-
/**
|
|
2099
|
-
* The ID of the user.
|
|
2100
|
-
*/
|
|
2101
|
-
user_id: string;
|
|
2102
|
-
}
|
|
2103
|
-
/**
|
|
2104
|
-
* Payload for the kraken_embed.user.closed webhook event.
|
|
2105
|
-
*/
|
|
2106
|
-
export interface KrakenEmbedUserClosedWebhookPayload {
|
|
2107
|
-
/**
|
|
2108
|
-
* ISO 8601 timestamp of when the user was closed.
|
|
2109
|
-
*/
|
|
2110
|
-
closed_at: string;
|
|
2111
|
-
/**
|
|
2112
|
-
* The type of webhook event.
|
|
2113
|
-
*/
|
|
2114
|
-
type: 'kraken_embed.user.closed';
|
|
2115
|
-
/**
|
|
2116
|
-
* The ID of the user.
|
|
2117
|
-
*/
|
|
2118
|
-
user_id: string;
|
|
2119
|
-
}
|
|
2120
2178
|
export declare namespace Webhooks {
|
|
2121
|
-
export { type
|
|
2179
|
+
export { type BridgeCryptoDepositMetadata as BridgeCryptoDepositMetadata, type BridgeCryptoTransferMetadata as BridgeCryptoTransferMetadata, type BridgeFiatDepositMetadata as BridgeFiatDepositMetadata, type BridgeFiatTransferMetadata as BridgeFiatTransferMetadata, type BridgeMetadata as BridgeMetadata, type BridgeRefundMetadata as BridgeRefundMetadata, type BridgeStaticMemoDepositMetadata as BridgeStaticMemoDepositMetadata, type BridgeTransferRefundMetadata as BridgeTransferRefundMetadata, type FundsDepositedWebhookPayload as FundsDepositedWebhookPayload, type FundsWithdrawnWebhookPayload as FundsWithdrawnWebhookPayload, type IntentAuthorizedWebhookPayload as IntentAuthorizedWebhookPayload, type IntentCreatedWebhookPayload as IntentCreatedWebhookPayload, type IntentExecutedWebhookPayload as IntentExecutedWebhookPayload, type IntentFailedWebhookPayload as IntentFailedWebhookPayload, type KrakenEmbedQuoteCancelledWebhookPayload as KrakenEmbedQuoteCancelledWebhookPayload, type KrakenEmbedQuoteExecutedWebhookPayload as KrakenEmbedQuoteExecutedWebhookPayload, type KrakenEmbedQuoteExecutionFailedWebhookPayload as KrakenEmbedQuoteExecutionFailedWebhookPayload, type KrakenEmbedUserClosedWebhookPayload as KrakenEmbedUserClosedWebhookPayload, type KrakenEmbedUserDisabledWebhookPayload as KrakenEmbedUserDisabledWebhookPayload, type KrakenEmbedUserVerifiedWebhookPayload as KrakenEmbedUserVerifiedWebhookPayload, type MfaDisabledWebhookPayload as MfaDisabledWebhookPayload, type MfaEnabledWebhookPayload as MfaEnabledWebhookPayload, type PrivateKeyExportWebhookPayload as PrivateKeyExportWebhookPayload, type SeedPhraseExportWebhookPayload as SeedPhraseExportWebhookPayload, type TransactionBroadcastedWebhookPayload as TransactionBroadcastedWebhookPayload, type TransactionConfirmedWebhookPayload as TransactionConfirmedWebhookPayload, type TransactionExecutionRevertedWebhookPayload as TransactionExecutionRevertedWebhookPayload, type TransactionFailedWebhookPayload as TransactionFailedWebhookPayload, type TransactionProviderErrorWebhookPayload as TransactionProviderErrorWebhookPayload, type TransactionReplacedWebhookPayload as TransactionReplacedWebhookPayload, type TransactionStillPendingWebhookPayload as TransactionStillPendingWebhookPayload, type UserAuthenticatedWebhookPayload as UserAuthenticatedWebhookPayload, type UserCreatedWebhookPayload as UserCreatedWebhookPayload, type UserLinkedAccountWebhookPayload as UserLinkedAccountWebhookPayload, type UserOperationCompletedWebhookPayload as UserOperationCompletedWebhookPayload, type UserTransferredAccountWebhookPayload as UserTransferredAccountWebhookPayload, type UserUnlinkedAccountWebhookPayload as UserUnlinkedAccountWebhookPayload, type UserUpdatedAccountWebhookPayload as UserUpdatedAccountWebhookPayload, type UserWalletCreatedWebhookPayload as UserWalletCreatedWebhookPayload, type WalletActionEarnDepositCreatedWebhookPayload as WalletActionEarnDepositCreatedWebhookPayload, type WalletActionEarnDepositFailedWebhookPayload as WalletActionEarnDepositFailedWebhookPayload, type WalletActionEarnDepositRejectedWebhookPayload as WalletActionEarnDepositRejectedWebhookPayload, type WalletActionEarnDepositSucceededWebhookPayload as WalletActionEarnDepositSucceededWebhookPayload, type WalletActionEarnIncentiveClaimCreatedWebhookPayload as WalletActionEarnIncentiveClaimCreatedWebhookPayload, type WalletActionEarnIncentiveClaimFailedWebhookPayload as WalletActionEarnIncentiveClaimFailedWebhookPayload, type WalletActionEarnIncentiveClaimRejectedWebhookPayload as WalletActionEarnIncentiveClaimRejectedWebhookPayload, type WalletActionEarnIncentiveClaimSucceededWebhookPayload as WalletActionEarnIncentiveClaimSucceededWebhookPayload, type WalletActionEarnWithdrawCreatedWebhookPayload as WalletActionEarnWithdrawCreatedWebhookPayload, type WalletActionEarnWithdrawFailedWebhookPayload as WalletActionEarnWithdrawFailedWebhookPayload, type WalletActionEarnWithdrawRejectedWebhookPayload as WalletActionEarnWithdrawRejectedWebhookPayload, type WalletActionEarnWithdrawSucceededWebhookPayload as WalletActionEarnWithdrawSucceededWebhookPayload, type WalletActionSwapCreatedWebhookPayload as WalletActionSwapCreatedWebhookPayload, type WalletActionSwapFailedWebhookPayload as WalletActionSwapFailedWebhookPayload, type WalletActionSwapRejectedWebhookPayload as WalletActionSwapRejectedWebhookPayload, type WalletActionSwapSucceededWebhookPayload as WalletActionSwapSucceededWebhookPayload, type WalletActionTransferCreatedWebhookPayload as WalletActionTransferCreatedWebhookPayload, type WalletActionTransferFailedWebhookPayload as WalletActionTransferFailedWebhookPayload, type WalletActionTransferRejectedWebhookPayload as WalletActionTransferRejectedWebhookPayload, type WalletActionTransferSucceededWebhookPayload as WalletActionTransferSucceededWebhookPayload, type WalletFundsAsset as WalletFundsAsset, type WalletFundsErc20Asset as WalletFundsErc20Asset, type WalletFundsNativeTokenAsset as WalletFundsNativeTokenAsset, type WalletFundsSacAsset as WalletFundsSacAsset, type WalletFundsSplAsset as WalletFundsSplAsset, type WalletRecoveredWebhookPayload as WalletRecoveredWebhookPayload, type WalletRecoverySetupWebhookPayload as WalletRecoverySetupWebhookPayload, type WebhookPayload as WebhookPayload, type YieldClaimConfirmedWebhookPayload as YieldClaimConfirmedWebhookPayload, type YieldDepositConfirmedWebhookPayload as YieldDepositConfirmedWebhookPayload, type YieldWithdrawConfirmedWebhookPayload as YieldWithdrawConfirmedWebhookPayload, };
|
|
2122
2180
|
}
|
|
2123
2181
|
//# sourceMappingURL=webhooks.d.mts.map
|