@coinbase/cdp-api-client 0.0.100 → 0.0.102
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/dist/esm/index.js +50 -49
- package/dist/esm/index10.js +1 -1
- package/dist/esm/index12.js +7 -38
- package/dist/esm/index14.js +366 -67
- package/dist/esm/index15.js +826 -34
- package/dist/esm/index16.js +38 -14
- package/dist/esm/index17.js +2 -8
- package/dist/esm/index18.js +70 -2
- package/dist/esm/index19.js +30 -364
- package/dist/esm/index20.js +14 -826
- package/dist/esm/index21.js +2 -2
- package/dist/esm/index22.js +2 -2
- package/dist/esm/index23.js +2 -2
- package/dist/esm/index3.js +1 -1
- package/dist/esm/index4.js +1 -1
- package/dist/esm/index5.js +37 -25
- package/dist/esm/index6.js +205 -176
- package/dist/esm/index7.js +1 -1
- package/dist/types/index.d.ts +326 -43
- package/package.json +1 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -207,11 +207,11 @@ export declare const configureCdpApiClient: (options: CdpOptions) => void;
|
|
|
207
207
|
* Creates a delegation that allows a developer to sign on behalf of an end user for the specified duration. The end user must be authenticated to authorize this delegation.
|
|
208
208
|
* @summary Create delegation for end user
|
|
209
209
|
*/
|
|
210
|
-
export declare const createDelegationForEndUser: (
|
|
210
|
+
export declare const createDelegationForEndUser: (userId: string, createDelegationForEndUserBody: CreateDelegationForEndUserBody, params?: CreateDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<CreateDelegationForEndUser201>;
|
|
211
211
|
|
|
212
212
|
export declare type CreateDelegationForEndUser201 = {
|
|
213
|
-
/** The
|
|
214
|
-
|
|
213
|
+
/** The date until which the delegation is valid. */
|
|
214
|
+
expiresAt: string;
|
|
215
215
|
};
|
|
216
216
|
|
|
217
217
|
export declare type CreateDelegationForEndUserBody = {
|
|
@@ -224,13 +224,27 @@ export declare type CreateDelegationForEndUserBody = {
|
|
|
224
224
|
walletSecretId: string;
|
|
225
225
|
};
|
|
226
226
|
|
|
227
|
+
export declare type CreateDelegationForEndUserParams = {
|
|
228
|
+
/**
|
|
229
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
230
|
+
*/
|
|
231
|
+
projectID?: ProjectIDOptionalParameter;
|
|
232
|
+
};
|
|
233
|
+
|
|
227
234
|
export declare type CreateDelegationForEndUserResult = NonNullable<Awaited<ReturnType<typeof createDelegationForEndUser>>>;
|
|
228
235
|
|
|
229
236
|
/**
|
|
230
237
|
* Creates an ApplePay onramp order for an end user to purchase cryptocurrency using fiat currency. This endpoint initiates a fiat-to-crypto purchase flow using Apple Pay as the payment method.
|
|
231
238
|
* @summary Create an ApplePay onramp order
|
|
232
239
|
*/
|
|
233
|
-
export declare const createEndUserApplePayOnrampOrder: (
|
|
240
|
+
export declare const createEndUserApplePayOnrampOrder: (userId: string, createEndUserApplePayOnrampOrderRequest: CreateEndUserApplePayOnrampOrderRequest, params?: CreateEndUserApplePayOnrampOrderParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUserApplePayOnrampOrderCreateResponse>;
|
|
241
|
+
|
|
242
|
+
export declare type CreateEndUserApplePayOnrampOrderParams = {
|
|
243
|
+
/**
|
|
244
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
245
|
+
*/
|
|
246
|
+
projectID?: ProjectIDOptionalParameter;
|
|
247
|
+
};
|
|
234
248
|
|
|
235
249
|
/**
|
|
236
250
|
* The request body to create an ApplePay onramp order.
|
|
@@ -251,7 +265,7 @@ export declare type CreateEndUserApplePayOnrampOrderResult = NonNullable<Awaited
|
|
|
251
265
|
* Creates an EVM account for an end user. An end user can have a maximum of 20 EVM accounts.
|
|
252
266
|
* @summary Create end user EVM account
|
|
253
267
|
*/
|
|
254
|
-
export declare const createEndUserEvmAccount: (
|
|
268
|
+
export declare const createEndUserEvmAccount: (userId: string, createEndUserEvmAccountBody: CreateEndUserEvmAccountBody, params?: CreateEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
|
|
255
269
|
|
|
256
270
|
export declare type CreateEndUserEvmAccountBody = {
|
|
257
271
|
/**
|
|
@@ -261,13 +275,20 @@ export declare type CreateEndUserEvmAccountBody = {
|
|
|
261
275
|
walletSecretId: string;
|
|
262
276
|
};
|
|
263
277
|
|
|
278
|
+
export declare type CreateEndUserEvmAccountParams = {
|
|
279
|
+
/**
|
|
280
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
281
|
+
*/
|
|
282
|
+
projectID?: ProjectIDOptionalParameter;
|
|
283
|
+
};
|
|
284
|
+
|
|
264
285
|
export declare type CreateEndUserEvmAccountResult = NonNullable<Awaited<ReturnType<typeof createEndUserEvmAccount>>>;
|
|
265
286
|
|
|
266
287
|
/**
|
|
267
288
|
* Creates a Smart Account for an end user. The Smart Account will be owned by the provided EVM account address. An end user can have one Smart Account per EVM account.
|
|
268
289
|
* @summary Create end user EVM Smart Account
|
|
269
290
|
*/
|
|
270
|
-
export declare const createEndUserEvmSmartAccount: (
|
|
291
|
+
export declare const createEndUserEvmSmartAccount: (userId: string, createEndUserEvmSmartAccountBody: CreateEndUserEvmSmartAccountBody, params?: CreateEndUserEvmSmartAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
|
|
271
292
|
|
|
272
293
|
export declare type CreateEndUserEvmSmartAccountBody = {
|
|
273
294
|
/**
|
|
@@ -281,6 +302,13 @@ export declare type CreateEndUserEvmSmartAccountBody = {
|
|
|
281
302
|
enableSpendPermissions: boolean;
|
|
282
303
|
};
|
|
283
304
|
|
|
305
|
+
export declare type CreateEndUserEvmSmartAccountParams = {
|
|
306
|
+
/**
|
|
307
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
308
|
+
*/
|
|
309
|
+
projectID?: ProjectIDOptionalParameter;
|
|
310
|
+
};
|
|
311
|
+
|
|
284
312
|
export declare type CreateEndUserEvmSmartAccountResult = NonNullable<Awaited<ReturnType<typeof createEndUserEvmSmartAccount>>>;
|
|
285
313
|
|
|
286
314
|
/**
|
|
@@ -289,7 +317,7 @@ export declare type CreateEndUserEvmSmartAccountResult = NonNullable<Awaited<Ret
|
|
|
289
317
|
Use `slippageBps` to control the minimum output floor. If the onchain price moves beyond the tolerance, the transaction reverts and `fromToken` is not deducted.
|
|
290
318
|
* @summary Execute a token swap
|
|
291
319
|
*/
|
|
292
|
-
export declare const createEndUserEvmSwap: (
|
|
320
|
+
export declare const createEndUserEvmSwap: (userId: string, createEndUserEvmSwapBody: CreateEndUserEvmSwapBody, params?: CreateEndUserEvmSwapParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<CreateEndUserEvmSwap200>;
|
|
293
321
|
|
|
294
322
|
/**
|
|
295
323
|
* Swap transaction submitted successfully. Returns immediately — does not wait for onchain confirmation. Exactly one of `transactionHash` or `userOpHash` will be non-null.
|
|
@@ -380,10 +408,10 @@ export declare type CreateEndUserEvmSwap200FeesProtocolFee = TokenFee | null;
|
|
|
380
408
|
*/
|
|
381
409
|
export declare type CreateEndUserEvmSwapBody = {
|
|
382
410
|
/**
|
|
383
|
-
* The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
|
|
411
|
+
* The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header. Required when not using delegated signing.
|
|
384
412
|
* @pattern ^[a-zA-Z0-9-]{1,100}$
|
|
385
413
|
*/
|
|
386
|
-
walletSecretId
|
|
414
|
+
walletSecretId?: string;
|
|
387
415
|
/**
|
|
388
416
|
* The end user's EVM address (EOA or smart account) that will send `fromToken`. Must belong to this end user.
|
|
389
417
|
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
@@ -417,13 +445,20 @@ export declare type CreateEndUserEvmSwapBody = {
|
|
|
417
445
|
paymasterUrl?: Url;
|
|
418
446
|
};
|
|
419
447
|
|
|
448
|
+
export declare type CreateEndUserEvmSwapParams = {
|
|
449
|
+
/**
|
|
450
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
451
|
+
*/
|
|
452
|
+
projectID?: ProjectIDOptionalParameter;
|
|
453
|
+
};
|
|
454
|
+
|
|
420
455
|
export declare type CreateEndUserEvmSwapResult = NonNullable<Awaited<ReturnType<typeof createEndUserEvmSwap>>>;
|
|
421
456
|
|
|
422
457
|
/**
|
|
423
458
|
* Creates a Solana account for an end user. An end user can have a maximum of 20 Solana accounts.
|
|
424
459
|
* @summary Create end user Solana account
|
|
425
460
|
*/
|
|
426
|
-
export declare const createEndUserSolanaAccount: (
|
|
461
|
+
export declare const createEndUserSolanaAccount: (userId: string, createEndUserSolanaAccountBody: CreateEndUserSolanaAccountBody, params?: CreateEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
|
|
427
462
|
|
|
428
463
|
export declare type CreateEndUserSolanaAccountBody = {
|
|
429
464
|
/**
|
|
@@ -433,6 +468,13 @@ export declare type CreateEndUserSolanaAccountBody = {
|
|
|
433
468
|
walletSecretId: string;
|
|
434
469
|
};
|
|
435
470
|
|
|
471
|
+
export declare type CreateEndUserSolanaAccountParams = {
|
|
472
|
+
/**
|
|
473
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
474
|
+
*/
|
|
475
|
+
projectID?: ProjectIDOptionalParameter;
|
|
476
|
+
};
|
|
477
|
+
|
|
436
478
|
export declare type CreateEndUserSolanaAccountResult = NonNullable<Awaited<ReturnType<typeof createEndUserSolanaAccount>>>;
|
|
437
479
|
|
|
438
480
|
/**
|
|
@@ -447,7 +489,7 @@ export declare type CreateEndUserSolanaAccountResult = NonNullable<Awaited<Retur
|
|
|
447
489
|
The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.
|
|
448
490
|
* @summary Create EIP-7702 delegation for end user EVM account
|
|
449
491
|
*/
|
|
450
|
-
export declare const createEvmEip7702DelegationWithEndUserAccount: (
|
|
492
|
+
export declare const createEvmEip7702DelegationWithEndUserAccount: (userId: string, createEvmEip7702DelegationWithEndUserAccountBody: CreateEvmEip7702DelegationWithEndUserAccountBody, params?: CreateEvmEip7702DelegationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<CreateEvmEip7702DelegationWithEndUserAccount201>;
|
|
451
493
|
|
|
452
494
|
export declare type CreateEvmEip7702DelegationWithEndUserAccount201 = {
|
|
453
495
|
/** The unique identifier for the delegation operation. Use this to poll the operation status. */
|
|
@@ -470,6 +512,13 @@ export declare type CreateEvmEip7702DelegationWithEndUserAccountBody = {
|
|
|
470
512
|
walletSecretId?: string;
|
|
471
513
|
};
|
|
472
514
|
|
|
515
|
+
export declare type CreateEvmEip7702DelegationWithEndUserAccountParams = {
|
|
516
|
+
/**
|
|
517
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
518
|
+
*/
|
|
519
|
+
projectID?: ProjectIDOptionalParameter;
|
|
520
|
+
};
|
|
521
|
+
|
|
473
522
|
export declare type CreateEvmEip7702DelegationWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof createEvmEip7702DelegationWithEndUserAccount>>>;
|
|
474
523
|
|
|
475
524
|
/**
|
|
@@ -514,7 +563,14 @@ export declare interface CreateSpendPermissionRequest {
|
|
|
514
563
|
* Creates a spend permission for the given end user smart account.
|
|
515
564
|
* @summary Create a spend permission for an end user smart account
|
|
516
565
|
*/
|
|
517
|
-
export declare const createSpendPermissionWithEndUserAccount: (
|
|
566
|
+
export declare const createSpendPermissionWithEndUserAccount: (userId: string, address: string, createSpendPermissionRequest: CreateSpendPermissionRequest, params?: CreateSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EvmUserOperation>;
|
|
567
|
+
|
|
568
|
+
export declare type CreateSpendPermissionWithEndUserAccountParams = {
|
|
569
|
+
/**
|
|
570
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
571
|
+
*/
|
|
572
|
+
projectID?: ProjectIDOptionalParameter;
|
|
573
|
+
};
|
|
518
574
|
|
|
519
575
|
export declare type CreateSpendPermissionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof createSpendPermissionWithEndUserAccount>>>;
|
|
520
576
|
|
|
@@ -848,7 +904,9 @@ export declare type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
|
|
|
848
904
|
|
|
849
905
|
export declare const ErrorType: {
|
|
850
906
|
readonly already_exists: "already_exists";
|
|
907
|
+
readonly authorization_expired: "authorization_expired";
|
|
851
908
|
readonly bad_gateway: "bad_gateway";
|
|
909
|
+
readonly capture_expired: "capture_expired";
|
|
852
910
|
readonly client_closed_request: "client_closed_request";
|
|
853
911
|
readonly faucet_limit_exceeded: "faucet_limit_exceeded";
|
|
854
912
|
readonly forbidden: "forbidden";
|
|
@@ -879,6 +937,7 @@ export declare const ErrorType: {
|
|
|
879
937
|
readonly document_verification_failed: "document_verification_failed";
|
|
880
938
|
readonly recipient_allowlist_violation: "recipient_allowlist_violation";
|
|
881
939
|
readonly recipient_allowlist_pending: "recipient_allowlist_pending";
|
|
940
|
+
readonly refund_expired: "refund_expired";
|
|
882
941
|
readonly travel_rules_recipient_violation: "travel_rules_recipient_violation";
|
|
883
942
|
readonly source_account_invalid: "source_account_invalid";
|
|
884
943
|
readonly target_account_invalid: "target_account_invalid";
|
|
@@ -1047,7 +1106,7 @@ export declare const EvmUserOperationStatus: {
|
|
|
1047
1106
|
* Export an existing end user EVM account's private key. It is important to store the private key in a secure place after it's exported.
|
|
1048
1107
|
* @summary Export end user EVM account
|
|
1049
1108
|
*/
|
|
1050
|
-
export declare const exportEndUserEvmAccount: (
|
|
1109
|
+
export declare const exportEndUserEvmAccount: (userId: string, exportEndUserEvmAccountBody: ExportEndUserEvmAccountBody, params?: ExportEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<ExportEndUserEvmAccount200>;
|
|
1051
1110
|
|
|
1052
1111
|
export declare type ExportEndUserEvmAccount200 = {
|
|
1053
1112
|
/** The base64-encoded, encrypted private key of the EVM account which is a 32 byte raw private key. The private key is encrypted in transport using the exportEncryptionKey in the request. */
|
|
@@ -1073,13 +1132,20 @@ export declare type ExportEndUserEvmAccountBody = {
|
|
|
1073
1132
|
eject?: boolean;
|
|
1074
1133
|
};
|
|
1075
1134
|
|
|
1135
|
+
export declare type ExportEndUserEvmAccountParams = {
|
|
1136
|
+
/**
|
|
1137
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1138
|
+
*/
|
|
1139
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1140
|
+
};
|
|
1141
|
+
|
|
1076
1142
|
export declare type ExportEndUserEvmAccountResult = NonNullable<Awaited<ReturnType<typeof exportEndUserEvmAccount>>>;
|
|
1077
1143
|
|
|
1078
1144
|
/**
|
|
1079
1145
|
* Export an existing Solana account's private key. It is important to store the private key in a secure place after it's exported.
|
|
1080
1146
|
* @summary Export end user Solana account
|
|
1081
1147
|
*/
|
|
1082
|
-
export declare const exportEndUserSolanaAccount: (
|
|
1148
|
+
export declare const exportEndUserSolanaAccount: (userId: string, exportEndUserSolanaAccountBody: ExportEndUserSolanaAccountBody, params?: ExportEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<ExportEndUserSolanaAccount200>;
|
|
1083
1149
|
|
|
1084
1150
|
export declare type ExportEndUserSolanaAccount200 = {
|
|
1085
1151
|
/** The base64-encoded, encrypted private key of the Solana account which is a 32 byte raw private key. The private key is encrypted in transport using the exportEncryptionKey in the request. */
|
|
@@ -1105,6 +1171,13 @@ export declare type ExportEndUserSolanaAccountBody = {
|
|
|
1105
1171
|
eject?: boolean;
|
|
1106
1172
|
};
|
|
1107
1173
|
|
|
1174
|
+
export declare type ExportEndUserSolanaAccountParams = {
|
|
1175
|
+
/**
|
|
1176
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1177
|
+
*/
|
|
1178
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1179
|
+
};
|
|
1180
|
+
|
|
1108
1181
|
export declare type ExportEndUserSolanaAccountResult = NonNullable<Awaited<ReturnType<typeof exportEndUserSolanaAccount>>>;
|
|
1109
1182
|
|
|
1110
1183
|
/**
|
|
@@ -1133,16 +1206,43 @@ export declare type GenerateAttestationChallengeResult = NonNullable<Awaited<Ret
|
|
|
1133
1206
|
* Gets the currently authenticated end user.
|
|
1134
1207
|
* @summary Get authenticated end user
|
|
1135
1208
|
*/
|
|
1136
|
-
export declare const getAuthenticatedEndUser: (
|
|
1209
|
+
export declare const getAuthenticatedEndUser: (userId: string, params?: GetAuthenticatedEndUserParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
|
|
1210
|
+
|
|
1211
|
+
export declare type GetAuthenticatedEndUserParams = {
|
|
1212
|
+
/**
|
|
1213
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1214
|
+
*/
|
|
1215
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1216
|
+
};
|
|
1137
1217
|
|
|
1138
1218
|
export declare type GetAuthenticatedEndUserResult = NonNullable<Awaited<ReturnType<typeof getAuthenticatedEndUser>>>;
|
|
1139
1219
|
|
|
1220
|
+
/**
|
|
1221
|
+
* Returns the active delegation for the specified end user, if one exists. This operation can be performed by the end user themselves or by a developer using their API key.
|
|
1222
|
+
* @summary Get delegation for end user
|
|
1223
|
+
*/
|
|
1224
|
+
export declare const getDelegationForEndUser: (userId: string, params?: GetDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<GetDelegationForEndUser200>;
|
|
1225
|
+
|
|
1226
|
+
export declare type GetDelegationForEndUser200 = {
|
|
1227
|
+
/** The date until which the delegation is valid. */
|
|
1228
|
+
expiresAt: string;
|
|
1229
|
+
};
|
|
1230
|
+
|
|
1231
|
+
export declare type GetDelegationForEndUserParams = {
|
|
1232
|
+
/**
|
|
1233
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1234
|
+
*/
|
|
1235
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1236
|
+
};
|
|
1237
|
+
|
|
1238
|
+
export declare type GetDelegationForEndUserResult = NonNullable<Awaited<ReturnType<typeof getDelegationForEndUser>>>;
|
|
1239
|
+
|
|
1140
1240
|
/**
|
|
1141
1241
|
* Returns a non-binding indicative price for a token swap.
|
|
1142
1242
|
If `liquidityAvailable` is false in the response, no swap route exists for this pair or amount.
|
|
1143
1243
|
* @summary Get a price estimate for a token swap
|
|
1144
1244
|
*/
|
|
1145
|
-
export declare const getEndUserEvmSwapPrice: (
|
|
1245
|
+
export declare const getEndUserEvmSwapPrice: (userId: string, params: GetEndUserEvmSwapPriceParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<GetEndUserEvmSwapPrice200>;
|
|
1146
1246
|
|
|
1147
1247
|
/**
|
|
1148
1248
|
* Indicative price estimate for a token swap. Not binding. If `liquidityAvailable` is false, all fields other than `liquidityAvailable` are absent.
|
|
@@ -1304,6 +1404,10 @@ export declare type GetEndUserEvmSwapPriceParams = {
|
|
|
1304
1404
|
* Maximum slippage in basis points (100 = 1%). Influences the indicative `minToAmount` in the response. Default is 100 (1%).
|
|
1305
1405
|
*/
|
|
1306
1406
|
slippageBps?: number;
|
|
1407
|
+
/**
|
|
1408
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1409
|
+
*/
|
|
1410
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1307
1411
|
};
|
|
1308
1412
|
|
|
1309
1413
|
export declare type GetEndUserEvmSwapPriceResult = NonNullable<Awaited<ReturnType<typeof getEndUserEvmSwapPrice>>>;
|
|
@@ -1312,7 +1416,14 @@ export declare type GetEndUserEvmSwapPriceResult = NonNullable<Awaited<ReturnTyp
|
|
|
1312
1416
|
* Returns the EIP-7702 delegation operation for an end user's EVM account. Use the delegationOperationId returned by the Create EIP-7702 delegation endpoint to poll for operation completion.
|
|
1313
1417
|
* @summary Get EIP-7702 delegation operation for end user EVM account
|
|
1314
1418
|
*/
|
|
1315
|
-
export declare const getEvmEip7702DelegationOperationByIdWithEndUserAccount: (
|
|
1419
|
+
export declare const getEvmEip7702DelegationOperationByIdWithEndUserAccount: (userId: string, delegationOperationId: string, params?: GetEvmEip7702DelegationOperationByIdWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EvmEip7702DelegationOperation>;
|
|
1420
|
+
|
|
1421
|
+
export declare type GetEvmEip7702DelegationOperationByIdWithEndUserAccountParams = {
|
|
1422
|
+
/**
|
|
1423
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1424
|
+
*/
|
|
1425
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1426
|
+
};
|
|
1316
1427
|
|
|
1317
1428
|
export declare type GetEvmEip7702DelegationOperationByIdWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof getEvmEip7702DelegationOperationByIdWithEndUserAccount>>>;
|
|
1318
1429
|
|
|
@@ -1336,7 +1447,14 @@ export declare type GetProjectConfigResult = NonNullable<Awaited<ReturnType<type
|
|
|
1336
1447
|
* Gets a user operation by its hash for an end user's EVM Smart Account.
|
|
1337
1448
|
* @summary Get a user operation for end user EVM Smart Account
|
|
1338
1449
|
*/
|
|
1339
|
-
export declare const getUserOperationWithEndUserAccount: (
|
|
1450
|
+
export declare const getUserOperationWithEndUserAccount: (userId: string, address: string, userOpHash: string, params?: GetUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EvmUserOperation>;
|
|
1451
|
+
|
|
1452
|
+
export declare type GetUserOperationWithEndUserAccountParams = {
|
|
1453
|
+
/**
|
|
1454
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1455
|
+
*/
|
|
1456
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1457
|
+
};
|
|
1340
1458
|
|
|
1341
1459
|
export declare type GetUserOperationWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof getUserOperationWithEndUserAccount>>>;
|
|
1342
1460
|
|
|
@@ -1445,7 +1563,7 @@ export declare interface InitiateEmailAuthenticationResponse {
|
|
|
1445
1563
|
For TOTP, this endpoint generates a TOTP secret and returns an otpauth:// URL that can be scanned with an authenticator app like Google Authenticator. This endpoint returns both an authUrl (for QR code generation) and the raw secret (for manual entry). The secret must be verified within 5 minutes by calling the submit endpoint.
|
|
1446
1564
|
* @summary Initiate MFA enrollment
|
|
1447
1565
|
*/
|
|
1448
|
-
export declare const initiateMfaEnrollment: (
|
|
1566
|
+
export declare const initiateMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<InitiateMfaEnrollmentResponseWrapper>;
|
|
1449
1567
|
|
|
1450
1568
|
/**
|
|
1451
1569
|
* Initiates MFA enrollment for an end user for given method.
|
|
@@ -1453,10 +1571,24 @@ export declare const initiateMfaEnrollment: (projectId: string, userId: string,
|
|
|
1453
1571
|
For SMS, this endpoint sends a 6-digit OTP code to the provided phone number. You can use any phone number for SMS MFA, even if it differs from your SMS authentication phone number. The OTP code must be verified within 5 minutes.
|
|
1454
1572
|
* @summary Initiate MFA enrollment
|
|
1455
1573
|
*/
|
|
1456
|
-
export declare const initiateMfaEnrollment2: (
|
|
1574
|
+
export declare const initiateMfaEnrollment2: (userId: string, mfaMethod: "totp" | "sms", initiateMfaEnrollmentRequest: InitiateMfaEnrollmentRequest, params?: InitiateMfaEnrollment2Params, options?: SecondParameter<typeof cdpApiClient>) => Promise<InitiateMfaEnrollmentResponseWrapper>;
|
|
1575
|
+
|
|
1576
|
+
export declare type InitiateMfaEnrollment2Params = {
|
|
1577
|
+
/**
|
|
1578
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1579
|
+
*/
|
|
1580
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1581
|
+
};
|
|
1457
1582
|
|
|
1458
1583
|
export declare type InitiateMfaEnrollment2Result = NonNullable<Awaited<ReturnType<typeof initiateMfaEnrollment2>>>;
|
|
1459
1584
|
|
|
1585
|
+
export declare type InitiateMfaEnrollmentParams = {
|
|
1586
|
+
/**
|
|
1587
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1588
|
+
*/
|
|
1589
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1590
|
+
};
|
|
1591
|
+
|
|
1460
1592
|
/**
|
|
1461
1593
|
* Request body for initiating MFA enrollment.
|
|
1462
1594
|
*/
|
|
@@ -1493,7 +1625,14 @@ export declare interface InitiateMfaEnrollmentTotpResponse {
|
|
|
1493
1625
|
The mfaMethod parameter is required to specify which method to use for verification.
|
|
1494
1626
|
* @summary Initiate MFA verification
|
|
1495
1627
|
*/
|
|
1496
|
-
export declare const initiateMfaVerification: (
|
|
1628
|
+
export declare const initiateMfaVerification: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<void>;
|
|
1629
|
+
|
|
1630
|
+
export declare type InitiateMfaVerificationParams = {
|
|
1631
|
+
/**
|
|
1632
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1633
|
+
*/
|
|
1634
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1635
|
+
};
|
|
1497
1636
|
|
|
1498
1637
|
export declare type InitiateMfaVerificationResult = NonNullable<Awaited<ReturnType<typeof initiateMfaVerification>>>;
|
|
1499
1638
|
|
|
@@ -1755,7 +1894,7 @@ export declare interface ListResponse {
|
|
|
1755
1894
|
* Lists spend permission for the given end user smart account.
|
|
1756
1895
|
* @summary List spend permissions for end user smart account
|
|
1757
1896
|
*/
|
|
1758
|
-
export declare const listSpendPermissionsWithEndUserAccount: (
|
|
1897
|
+
export declare const listSpendPermissionsWithEndUserAccount: (userId: string, address: string, params?: ListSpendPermissionsWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<ListSpendPermissionsWithEndUserAccount200>;
|
|
1759
1898
|
|
|
1760
1899
|
export declare type ListSpendPermissionsWithEndUserAccount200 = ListSpendPermissionsWithEndUserAccount200AllOf & ListResponse;
|
|
1761
1900
|
|
|
@@ -1773,6 +1912,10 @@ export declare type ListSpendPermissionsWithEndUserAccountParams = {
|
|
|
1773
1912
|
* The token for the next page of resources, if any.
|
|
1774
1913
|
*/
|
|
1775
1914
|
pageToken?: PageTokenParameter;
|
|
1915
|
+
/**
|
|
1916
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1917
|
+
*/
|
|
1918
|
+
projectID?: ProjectIDOptionalParameter;
|
|
1776
1919
|
};
|
|
1777
1920
|
|
|
1778
1921
|
export declare type ListSpendPermissionsWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof listSpendPermissionsWithEndUserAccount>>>;
|
|
@@ -1884,8 +2027,11 @@ export declare const Network: {
|
|
|
1884
2027
|
readonly solana: "solana";
|
|
1885
2028
|
readonly aptos: "aptos";
|
|
1886
2029
|
readonly arbitrum: "arbitrum";
|
|
2030
|
+
readonly "arbitrum-sepolia": "arbitrum-sepolia";
|
|
1887
2031
|
readonly optimism: "optimism";
|
|
1888
2032
|
readonly polygon: "polygon";
|
|
2033
|
+
readonly world: "world";
|
|
2034
|
+
readonly "world-sepolia": "world-sepolia";
|
|
1889
2035
|
};
|
|
1890
2036
|
|
|
1891
2037
|
/**
|
|
@@ -1952,11 +2098,16 @@ export declare interface ProjectConfig {
|
|
|
1952
2098
|
appAttestation?: AppAttestationProjectConfig;
|
|
1953
2099
|
}
|
|
1954
2100
|
|
|
2101
|
+
/**
|
|
2102
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2103
|
+
*/
|
|
2104
|
+
export declare type ProjectIDOptionalParameter = string;
|
|
2105
|
+
|
|
1955
2106
|
/**
|
|
1956
2107
|
* Records that the end user was prompted for MFA enrollment. This endpoint sets the enrollmentPromptedAt timestamp to the current time, allowing tracking of whether users have been shown the enrollment prompt, regardless of whether they chose to enroll or skip.
|
|
1957
2108
|
* @summary Record MFA enrollment prompt
|
|
1958
2109
|
*/
|
|
1959
|
-
export declare const recordMfaEnrollmentPrompted: (
|
|
2110
|
+
export declare const recordMfaEnrollmentPrompted: (userId: string, params?: RecordMfaEnrollmentPromptedParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<RecordMfaEnrollmentPrompted200>;
|
|
1960
2111
|
|
|
1961
2112
|
/**
|
|
1962
2113
|
* Information about the end user's last MFA enrollment prompt.
|
|
@@ -1966,6 +2117,13 @@ export declare type RecordMfaEnrollmentPrompted200 = {
|
|
|
1966
2117
|
enrollmentPromptedAt: string;
|
|
1967
2118
|
};
|
|
1968
2119
|
|
|
2120
|
+
export declare type RecordMfaEnrollmentPromptedParams = {
|
|
2121
|
+
/**
|
|
2122
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2123
|
+
*/
|
|
2124
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2125
|
+
};
|
|
2126
|
+
|
|
1969
2127
|
export declare type RecordMfaEnrollmentPromptedResult = NonNullable<Awaited<ReturnType<typeof recordMfaEnrollmentPrompted>>>;
|
|
1970
2128
|
|
|
1971
2129
|
/**
|
|
@@ -2107,7 +2265,7 @@ export declare type RegisterAttestationResult = NonNullable<Awaited<ReturnType<t
|
|
|
2107
2265
|
}); ```.
|
|
2108
2266
|
* @summary Register a Temporary Wallet Secret
|
|
2109
2267
|
*/
|
|
2110
|
-
export declare const registerTemporaryWalletSecret: (
|
|
2268
|
+
export declare const registerTemporaryWalletSecret: (userId: string, registerTemporaryWalletSecretBody: RegisterTemporaryWalletSecretBody, params?: RegisterTemporaryWalletSecretParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<RegisterTemporaryWalletSecret200>;
|
|
2111
2269
|
|
|
2112
2270
|
export declare type RegisterTemporaryWalletSecret200 = {
|
|
2113
2271
|
/** A stable, unique identifier for the Temporary Wallet Secret. */
|
|
@@ -2132,13 +2290,20 @@ export declare type RegisterTemporaryWalletSecretBody = {
|
|
|
2132
2290
|
walletSecretId?: string;
|
|
2133
2291
|
};
|
|
2134
2292
|
|
|
2293
|
+
export declare type RegisterTemporaryWalletSecretParams = {
|
|
2294
|
+
/**
|
|
2295
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2296
|
+
*/
|
|
2297
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2298
|
+
};
|
|
2299
|
+
|
|
2135
2300
|
export declare type RegisterTemporaryWalletSecretResult = NonNullable<Awaited<ReturnType<typeof registerTemporaryWalletSecret>>>;
|
|
2136
2301
|
|
|
2137
2302
|
/**
|
|
2138
2303
|
* Revokes all active delegations for the specified end user. This operation can be performed by the end user themselves or by a developer using their API key.
|
|
2139
2304
|
* @summary Revoke delegation for end user
|
|
2140
2305
|
*/
|
|
2141
|
-
export declare const revokeDelegationForEndUser: (
|
|
2306
|
+
export declare const revokeDelegationForEndUser: (userId: string, revokeDelegationForEndUserBody: RevokeDelegationForEndUserBody, params?: RevokeDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<void>;
|
|
2142
2307
|
|
|
2143
2308
|
export declare type RevokeDelegationForEndUserBody = {
|
|
2144
2309
|
/**
|
|
@@ -2148,6 +2313,13 @@ export declare type RevokeDelegationForEndUserBody = {
|
|
|
2148
2313
|
walletSecretId?: string;
|
|
2149
2314
|
};
|
|
2150
2315
|
|
|
2316
|
+
export declare type RevokeDelegationForEndUserParams = {
|
|
2317
|
+
/**
|
|
2318
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2319
|
+
*/
|
|
2320
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2321
|
+
};
|
|
2322
|
+
|
|
2151
2323
|
export declare type RevokeDelegationForEndUserResult = NonNullable<Awaited<ReturnType<typeof revokeDelegationForEndUser>>>;
|
|
2152
2324
|
|
|
2153
2325
|
/**
|
|
@@ -2172,7 +2344,14 @@ export declare interface RevokeSpendPermissionRequest {
|
|
|
2172
2344
|
* Revokes an existing spend permission.
|
|
2173
2345
|
* @summary Revoke a spend permission
|
|
2174
2346
|
*/
|
|
2175
|
-
export declare const revokeSpendPermissionWithEndUserAccount: (
|
|
2347
|
+
export declare const revokeSpendPermissionWithEndUserAccount: (userId: string, address: string, revokeSpendPermissionRequest: RevokeSpendPermissionRequest, params?: RevokeSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EvmUserOperation>;
|
|
2348
|
+
|
|
2349
|
+
export declare type RevokeSpendPermissionWithEndUserAccountParams = {
|
|
2350
|
+
/**
|
|
2351
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2352
|
+
*/
|
|
2353
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2354
|
+
};
|
|
2176
2355
|
|
|
2177
2356
|
export declare type RevokeSpendPermissionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof revokeSpendPermissionWithEndUserAccount>>>;
|
|
2178
2357
|
|
|
@@ -2183,7 +2362,7 @@ declare type SecondParameter<T extends (...args: never) => unknown> = Parameters
|
|
|
2183
2362
|
The `amount` field accepts human-readable amounts as decimal strings (e.g., "1.5", "25.50").
|
|
2184
2363
|
* @summary Send USDC on EVM
|
|
2185
2364
|
*/
|
|
2186
|
-
export declare const sendEvmAssetWithEndUserAccount: (
|
|
2365
|
+
export declare const sendEvmAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendEvmAssetWithEndUserAccountBody: SendEvmAssetWithEndUserAccountBody, params?: SendEvmAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SendEvmAssetWithEndUserAccount200>;
|
|
2187
2366
|
|
|
2188
2367
|
export declare type SendEvmAssetWithEndUserAccount200 = {
|
|
2189
2368
|
/**
|
|
@@ -2237,6 +2416,16 @@ export declare const SendEvmAssetWithEndUserAccountBodyNetwork: {
|
|
|
2237
2416
|
readonly polygon: "polygon";
|
|
2238
2417
|
readonly optimism: "optimism";
|
|
2239
2418
|
readonly arbitrum: "arbitrum";
|
|
2419
|
+
readonly "arbitrum-sepolia": "arbitrum-sepolia";
|
|
2420
|
+
readonly world: "world";
|
|
2421
|
+
readonly "world-sepolia": "world-sepolia";
|
|
2422
|
+
};
|
|
2423
|
+
|
|
2424
|
+
export declare type SendEvmAssetWithEndUserAccountParams = {
|
|
2425
|
+
/**
|
|
2426
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2427
|
+
*/
|
|
2428
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2240
2429
|
};
|
|
2241
2430
|
|
|
2242
2431
|
export declare type SendEvmAssetWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof sendEvmAssetWithEndUserAccount>>>;
|
|
@@ -2270,7 +2459,7 @@ export declare type SendEvmAssetWithEndUserAccountResult = NonNullable<Awaited<R
|
|
|
2270
2459
|
- `accessList` *(Optional)*: The access list to use for the transaction.
|
|
2271
2460
|
* @summary Send a transaction with end user EVM account
|
|
2272
2461
|
*/
|
|
2273
|
-
export declare const sendEvmTransactionWithEndUserAccount: (
|
|
2462
|
+
export declare const sendEvmTransactionWithEndUserAccount: (userId: string, sendEvmTransactionWithEndUserAccountBody: SendEvmTransactionWithEndUserAccountBody, params?: SendEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SendEvmTransactionWithEndUserAccount200>;
|
|
2274
2463
|
|
|
2275
2464
|
export declare type SendEvmTransactionWithEndUserAccount200 = {
|
|
2276
2465
|
/** The hash of the transaction, as a 0x-prefixed hex string. */
|
|
@@ -2308,6 +2497,16 @@ export declare const SendEvmTransactionWithEndUserAccountBodyNetwork: {
|
|
|
2308
2497
|
readonly polygon: "polygon";
|
|
2309
2498
|
readonly optimism: "optimism";
|
|
2310
2499
|
readonly arbitrum: "arbitrum";
|
|
2500
|
+
readonly "arbitrum-sepolia": "arbitrum-sepolia";
|
|
2501
|
+
readonly world: "world";
|
|
2502
|
+
readonly "world-sepolia": "world-sepolia";
|
|
2503
|
+
};
|
|
2504
|
+
|
|
2505
|
+
export declare type SendEvmTransactionWithEndUserAccountParams = {
|
|
2506
|
+
/**
|
|
2507
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2508
|
+
*/
|
|
2509
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2311
2510
|
};
|
|
2312
2511
|
|
|
2313
2512
|
export declare type SendEvmTransactionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof sendEvmTransactionWithEndUserAccount>>>;
|
|
@@ -2318,7 +2517,7 @@ export declare type SendEvmTransactionWithEndUserAccountResult = NonNullable<Awa
|
|
|
2318
2517
|
Use the optional `createRecipientAta` parameter to control whether the sender pays for creating the recipient's Associated Token Account if it doesn't exist.
|
|
2319
2518
|
* @summary Send USDC on Solana
|
|
2320
2519
|
*/
|
|
2321
|
-
export declare const sendSolanaAssetWithEndUserAccount: (
|
|
2520
|
+
export declare const sendSolanaAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendSolanaAssetWithEndUserAccountBody: SendSolanaAssetWithEndUserAccountBody, params?: SendSolanaAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SendSolanaAssetWithEndUserAccount200>;
|
|
2322
2521
|
|
|
2323
2522
|
export declare type SendSolanaAssetWithEndUserAccount200 = {
|
|
2324
2523
|
/** The base58 encoded transaction signature. */
|
|
@@ -2360,6 +2559,13 @@ export declare const SendSolanaAssetWithEndUserAccountBodyNetwork: {
|
|
|
2360
2559
|
readonly "solana-devnet": "solana-devnet";
|
|
2361
2560
|
};
|
|
2362
2561
|
|
|
2562
|
+
export declare type SendSolanaAssetWithEndUserAccountParams = {
|
|
2563
|
+
/**
|
|
2564
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2565
|
+
*/
|
|
2566
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2567
|
+
};
|
|
2568
|
+
|
|
2363
2569
|
export declare type SendSolanaAssetWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof sendSolanaAssetWithEndUserAccount>>>;
|
|
2364
2570
|
|
|
2365
2571
|
/**
|
|
@@ -2379,7 +2585,7 @@ export declare type SendSolanaAssetWithEndUserAccountResult = NonNullable<Awaite
|
|
|
2379
2585
|
The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
|
|
2380
2586
|
* @summary Send a transaction with end user Solana account
|
|
2381
2587
|
*/
|
|
2382
|
-
export declare const sendSolanaTransactionWithEndUserAccount: (
|
|
2588
|
+
export declare const sendSolanaTransactionWithEndUserAccount: (userId: string, sendSolanaTransactionWithEndUserAccountBody: SendSolanaTransactionWithEndUserAccountBody, params?: SendSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SendSolanaTransactionWithEndUserAccount200>;
|
|
2383
2589
|
|
|
2384
2590
|
export declare type SendSolanaTransactionWithEndUserAccount200 = {
|
|
2385
2591
|
/** The base58 encoded transaction signature. */
|
|
@@ -2415,13 +2621,20 @@ export declare const SendSolanaTransactionWithEndUserAccountBodyNetwork: {
|
|
|
2415
2621
|
readonly "solana-devnet": "solana-devnet";
|
|
2416
2622
|
};
|
|
2417
2623
|
|
|
2624
|
+
export declare type SendSolanaTransactionWithEndUserAccountParams = {
|
|
2625
|
+
/**
|
|
2626
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2627
|
+
*/
|
|
2628
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2629
|
+
};
|
|
2630
|
+
|
|
2418
2631
|
export declare type SendSolanaTransactionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof sendSolanaTransactionWithEndUserAccount>>>;
|
|
2419
2632
|
|
|
2420
2633
|
/**
|
|
2421
2634
|
* Prepares, signs, and sends a user operation for an end user's Smart Account.
|
|
2422
2635
|
* @summary Send a user operation for end user Smart Account
|
|
2423
2636
|
*/
|
|
2424
|
-
export declare const sendUserOperationWithEndUserAccount: (
|
|
2637
|
+
export declare const sendUserOperationWithEndUserAccount: (userId: string, address: string, sendUserOperationWithEndUserAccountBody: SendUserOperationWithEndUserAccountBody, params?: SendUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EvmUserOperation>;
|
|
2425
2638
|
|
|
2426
2639
|
export declare type SendUserOperationWithEndUserAccountBody = {
|
|
2427
2640
|
network: EvmUserOperationNetwork;
|
|
@@ -2443,6 +2656,13 @@ export declare type SendUserOperationWithEndUserAccountBody = {
|
|
|
2443
2656
|
dataSuffix?: string;
|
|
2444
2657
|
};
|
|
2445
2658
|
|
|
2659
|
+
export declare type SendUserOperationWithEndUserAccountParams = {
|
|
2660
|
+
/**
|
|
2661
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2662
|
+
*/
|
|
2663
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2664
|
+
};
|
|
2665
|
+
|
|
2446
2666
|
export declare type SendUserOperationWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof sendUserOperationWithEndUserAccount>>>;
|
|
2447
2667
|
|
|
2448
2668
|
/**
|
|
@@ -2461,7 +2681,7 @@ export declare const setAuthManager: (manager: AuthManager) => void;
|
|
|
2461
2681
|
* Signs an arbitrary 32 byte hash with the end user's given EVM account.
|
|
2462
2682
|
* @summary Sign a hash with end user EVM account
|
|
2463
2683
|
*/
|
|
2464
|
-
export declare const signEvmHashWithEndUserAccount: (
|
|
2684
|
+
export declare const signEvmHashWithEndUserAccount: (userId: string, signEvmHashWithEndUserAccountBody: SignEvmHashWithEndUserAccountBody, params?: SignEvmHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignEvmHashWithEndUserAccount200>;
|
|
2465
2685
|
|
|
2466
2686
|
export declare type SignEvmHashWithEndUserAccount200 = {
|
|
2467
2687
|
/** The signature of the hash, as a 0x-prefixed hex string. */
|
|
@@ -2477,10 +2697,17 @@ export declare type SignEvmHashWithEndUserAccountBody = {
|
|
|
2477
2697
|
*/
|
|
2478
2698
|
address: string;
|
|
2479
2699
|
/**
|
|
2480
|
-
*
|
|
2700
|
+
* The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
|
|
2481
2701
|
* @pattern ^[a-zA-Z0-9-]{1,100}$
|
|
2482
2702
|
*/
|
|
2483
|
-
walletSecretId
|
|
2703
|
+
walletSecretId: string;
|
|
2704
|
+
};
|
|
2705
|
+
|
|
2706
|
+
export declare type SignEvmHashWithEndUserAccountParams = {
|
|
2707
|
+
/**
|
|
2708
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2709
|
+
*/
|
|
2710
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2484
2711
|
};
|
|
2485
2712
|
|
|
2486
2713
|
export declare type SignEvmHashWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signEvmHashWithEndUserAccount>>>;
|
|
@@ -2491,7 +2718,7 @@ export declare type SignEvmHashWithEndUserAccountResult = NonNullable<Awaited<Re
|
|
|
2491
2718
|
Per the specification, the message in the request body is prepended with `0x19 <0x45 (E)> <thereum Signed Message:\n" + len(message)>` before being signed.
|
|
2492
2719
|
* @summary Sign an EIP-191 message with end user EVM account
|
|
2493
2720
|
*/
|
|
2494
|
-
export declare const signEvmMessageWithEndUserAccount: (
|
|
2721
|
+
export declare const signEvmMessageWithEndUserAccount: (userId: string, signEvmMessageWithEndUserAccountBody: SignEvmMessageWithEndUserAccountBody, params?: SignEvmMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignEvmMessageWithEndUserAccount200>;
|
|
2495
2722
|
|
|
2496
2723
|
export declare type SignEvmMessageWithEndUserAccount200 = {
|
|
2497
2724
|
/** The signature of the message, as a 0x-prefixed hex string. */
|
|
@@ -2513,6 +2740,13 @@ export declare type SignEvmMessageWithEndUserAccountBody = {
|
|
|
2513
2740
|
walletSecretId?: string;
|
|
2514
2741
|
};
|
|
2515
2742
|
|
|
2743
|
+
export declare type SignEvmMessageWithEndUserAccountParams = {
|
|
2744
|
+
/**
|
|
2745
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2746
|
+
*/
|
|
2747
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2748
|
+
};
|
|
2749
|
+
|
|
2516
2750
|
export declare type SignEvmMessageWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signEvmMessageWithEndUserAccount>>>;
|
|
2517
2751
|
|
|
2518
2752
|
/**
|
|
@@ -2522,7 +2756,7 @@ export declare type SignEvmMessageWithEndUserAccountResult = NonNullable<Awaited
|
|
|
2522
2756
|
The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
|
|
2523
2757
|
* @summary Sign a transaction with end user EVM account
|
|
2524
2758
|
*/
|
|
2525
|
-
export declare const signEvmTransactionWithEndUserAccount: (
|
|
2759
|
+
export declare const signEvmTransactionWithEndUserAccount: (userId: string, signEvmTransactionWithEndUserAccountBody: SignEvmTransactionWithEndUserAccountBody, params?: SignEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignEvmTransactionWithEndUserAccount200>;
|
|
2526
2760
|
|
|
2527
2761
|
export declare type SignEvmTransactionWithEndUserAccount200 = {
|
|
2528
2762
|
/** The RLP-encoded signed transaction, as a 0x-prefixed hex string. */
|
|
@@ -2544,13 +2778,20 @@ export declare type SignEvmTransactionWithEndUserAccountBody = {
|
|
|
2544
2778
|
walletSecretId?: string;
|
|
2545
2779
|
};
|
|
2546
2780
|
|
|
2781
|
+
export declare type SignEvmTransactionWithEndUserAccountParams = {
|
|
2782
|
+
/**
|
|
2783
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2784
|
+
*/
|
|
2785
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2786
|
+
};
|
|
2787
|
+
|
|
2547
2788
|
export declare type SignEvmTransactionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signEvmTransactionWithEndUserAccount>>>;
|
|
2548
2789
|
|
|
2549
2790
|
/**
|
|
2550
2791
|
* Signs [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data with the given end user EVM account.
|
|
2551
2792
|
* @summary Sign EIP-712 typed data with end user EVM account
|
|
2552
2793
|
*/
|
|
2553
|
-
export declare const signEvmTypedDataWithEndUserAccount: (
|
|
2794
|
+
export declare const signEvmTypedDataWithEndUserAccount: (userId: string, signEvmTypedDataWithEndUserAccountBody: SignEvmTypedDataWithEndUserAccountBody, params?: SignEvmTypedDataWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignEvmTypedDataWithEndUserAccount200>;
|
|
2554
2795
|
|
|
2555
2796
|
export declare type SignEvmTypedDataWithEndUserAccount200 = {
|
|
2556
2797
|
/** The signature of the typed data, as a 0x-prefixed hex string. */
|
|
@@ -2571,13 +2812,20 @@ export declare type SignEvmTypedDataWithEndUserAccountBody = {
|
|
|
2571
2812
|
walletSecretId?: string;
|
|
2572
2813
|
};
|
|
2573
2814
|
|
|
2815
|
+
export declare type SignEvmTypedDataWithEndUserAccountParams = {
|
|
2816
|
+
/**
|
|
2817
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2818
|
+
*/
|
|
2819
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2820
|
+
};
|
|
2821
|
+
|
|
2574
2822
|
export declare type SignEvmTypedDataWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signEvmTypedDataWithEndUserAccount>>>;
|
|
2575
2823
|
|
|
2576
2824
|
/**
|
|
2577
2825
|
* Signs an arbitrary 32 byte hash with the end user's given Solana account.
|
|
2578
2826
|
* @summary Sign a hash with end user Solana account
|
|
2579
2827
|
*/
|
|
2580
|
-
export declare const signSolanaHashWithEndUserAccount: (
|
|
2828
|
+
export declare const signSolanaHashWithEndUserAccount: (userId: string, signSolanaHashWithEndUserAccountBody: SignSolanaHashWithEndUserAccountBody, params?: SignSolanaHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignSolanaHashWithEndUserAccount200>;
|
|
2581
2829
|
|
|
2582
2830
|
export declare type SignSolanaHashWithEndUserAccount200 = {
|
|
2583
2831
|
/** The signature of the hash, as a base58 encoded string. */
|
|
@@ -2596,7 +2844,14 @@ export declare type SignSolanaHashWithEndUserAccountBody = {
|
|
|
2596
2844
|
* Required when not using delegated signing. The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
|
|
2597
2845
|
* @pattern ^[a-zA-Z0-9-]{1,100}$
|
|
2598
2846
|
*/
|
|
2599
|
-
walletSecretId
|
|
2847
|
+
walletSecretId: string;
|
|
2848
|
+
};
|
|
2849
|
+
|
|
2850
|
+
export declare type SignSolanaHashWithEndUserAccountParams = {
|
|
2851
|
+
/**
|
|
2852
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2853
|
+
*/
|
|
2854
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2600
2855
|
};
|
|
2601
2856
|
|
|
2602
2857
|
export declare type SignSolanaHashWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signSolanaHashWithEndUserAccount>>>;
|
|
@@ -2606,7 +2861,7 @@ export declare type SignSolanaHashWithEndUserAccountResult = NonNullable<Awaited
|
|
|
2606
2861
|
**WARNING:** Never sign a message that you didn't generate as it may put your funds at risk.
|
|
2607
2862
|
* @summary Sign a Base64 encoded message
|
|
2608
2863
|
*/
|
|
2609
|
-
export declare const signSolanaMessageWithEndUserAccount: (
|
|
2864
|
+
export declare const signSolanaMessageWithEndUserAccount: (userId: string, signSolanaMessageWithEndUserAccountBody: SignSolanaMessageWithEndUserAccountBody, params?: SignSolanaMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignSolanaMessageWithEndUserAccount200>;
|
|
2610
2865
|
|
|
2611
2866
|
export declare type SignSolanaMessageWithEndUserAccount200 = {
|
|
2612
2867
|
/** The signature of the message, as a base58 encoded string. */
|
|
@@ -2628,6 +2883,13 @@ export declare type SignSolanaMessageWithEndUserAccountBody = {
|
|
|
2628
2883
|
walletSecretId?: string;
|
|
2629
2884
|
};
|
|
2630
2885
|
|
|
2886
|
+
export declare type SignSolanaMessageWithEndUserAccountParams = {
|
|
2887
|
+
/**
|
|
2888
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2889
|
+
*/
|
|
2890
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2891
|
+
};
|
|
2892
|
+
|
|
2631
2893
|
export declare type SignSolanaMessageWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signSolanaMessageWithEndUserAccount>>>;
|
|
2632
2894
|
|
|
2633
2895
|
/**
|
|
@@ -2640,7 +2902,7 @@ export declare type SignSolanaMessageWithEndUserAccountResult = NonNullable<Awai
|
|
|
2640
2902
|
The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
|
|
2641
2903
|
* @summary Sign a transaction with end user Solana account
|
|
2642
2904
|
*/
|
|
2643
|
-
export declare const signSolanaTransactionWithEndUserAccount: (
|
|
2905
|
+
export declare const signSolanaTransactionWithEndUserAccount: (userId: string, signSolanaTransactionWithEndUserAccountBody: SignSolanaTransactionWithEndUserAccountBody, params?: SignSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignSolanaTransactionWithEndUserAccount200>;
|
|
2644
2906
|
|
|
2645
2907
|
export declare type SignSolanaTransactionWithEndUserAccount200 = {
|
|
2646
2908
|
/** The base64 encoded signed transaction. */
|
|
@@ -2662,6 +2924,13 @@ export declare type SignSolanaTransactionWithEndUserAccountBody = {
|
|
|
2662
2924
|
walletSecretId?: string;
|
|
2663
2925
|
};
|
|
2664
2926
|
|
|
2927
|
+
export declare type SignSolanaTransactionWithEndUserAccountParams = {
|
|
2928
|
+
/**
|
|
2929
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2930
|
+
*/
|
|
2931
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2932
|
+
};
|
|
2933
|
+
|
|
2665
2934
|
export declare type SignSolanaTransactionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signSolanaTransactionWithEndUserAccount>>>;
|
|
2666
2935
|
|
|
2667
2936
|
/**
|
|
@@ -2779,7 +3048,7 @@ export declare interface SpendPermissionResponseObject {
|
|
|
2779
3048
|
* Submits an MFA code to complete the enrollment process. On success, the MFA configuration is persisted to the end user.
|
|
2780
3049
|
* @summary Submit MFA enrollment
|
|
2781
3050
|
*/
|
|
2782
|
-
export declare const submitMfaEnrollment: (
|
|
3051
|
+
export declare const submitMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", submitMfaEnrollmentBody: SubmitMfaEnrollmentBody, params?: SubmitMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SubmitMfaEnrollment200>;
|
|
2783
3052
|
|
|
2784
3053
|
/**
|
|
2785
3054
|
* Response after successful MFA enrollment with updated end user.
|
|
@@ -2799,13 +3068,20 @@ export declare type SubmitMfaEnrollmentBody = {
|
|
|
2799
3068
|
mfaCode: string;
|
|
2800
3069
|
};
|
|
2801
3070
|
|
|
3071
|
+
export declare type SubmitMfaEnrollmentParams = {
|
|
3072
|
+
/**
|
|
3073
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3074
|
+
*/
|
|
3075
|
+
projectID?: ProjectIDOptionalParameter;
|
|
3076
|
+
};
|
|
3077
|
+
|
|
2802
3078
|
export declare type SubmitMfaEnrollmentResult = NonNullable<Awaited<ReturnType<typeof submitMfaEnrollment>>>;
|
|
2803
3079
|
|
|
2804
3080
|
/**
|
|
2805
3081
|
* Submits an MFA code to complete the verification process.
|
|
2806
3082
|
* @summary Submit MFA verification
|
|
2807
3083
|
*/
|
|
2808
|
-
export declare const submitMfaVerification: (
|
|
3084
|
+
export declare const submitMfaVerification: (userId: string, mfaMethod: "totp" | "sms", submitMfaVerificationBody: SubmitMfaVerificationBody, params?: SubmitMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<void>;
|
|
2809
3085
|
|
|
2810
3086
|
/**
|
|
2811
3087
|
* Request to submit MFA code for verification.
|
|
@@ -2818,6 +3094,13 @@ export declare type SubmitMfaVerificationBody = {
|
|
|
2818
3094
|
mfaCode: string;
|
|
2819
3095
|
};
|
|
2820
3096
|
|
|
3097
|
+
export declare type SubmitMfaVerificationParams = {
|
|
3098
|
+
/**
|
|
3099
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3100
|
+
*/
|
|
3101
|
+
projectID?: ProjectIDOptionalParameter;
|
|
3102
|
+
};
|
|
3103
|
+
|
|
2821
3104
|
export declare type SubmitMfaVerificationResult = NonNullable<Awaited<ReturnType<typeof submitMfaVerification>>>;
|
|
2822
3105
|
|
|
2823
3106
|
/**
|