@coinbase/cdp-api-client 0.0.105 → 0.0.107
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 +102 -93
- package/dist/esm/index10.js +1 -1
- package/dist/esm/index12.js +38 -7
- package/dist/esm/index14.js +67 -366
- package/dist/esm/index15.js +34 -826
- package/dist/esm/index16.js +14 -38
- package/dist/esm/index17.js +8 -2
- package/dist/esm/index18.js +2 -70
- package/dist/esm/index19.js +364 -30
- package/dist/esm/index2.js +1 -1
- package/dist/esm/index20.js +826 -14
- package/dist/esm/index3.js +1 -1
- package/dist/esm/index4.js +1 -1
- package/dist/esm/index5.js +73 -40
- package/dist/esm/index6.js +51 -31
- package/dist/types/index.d.ts +283 -66
- package/package.json +5 -5
package/dist/types/index.d.ts
CHANGED
|
@@ -107,7 +107,7 @@ export declare type Asset = string;
|
|
|
107
107
|
Custom authentication differs from Coinbase-managed methods such as Email, SMS, or OAuth, as it allows future requests to be made using developer-provided JWT, subject to the expiration defined in its claims.
|
|
108
108
|
* @summary Authenticate end user via custom auth JWT
|
|
109
109
|
*/
|
|
110
|
-
export declare const authenticateUserWithCustomAuth: (projectId: string, options?: SecondParameter<typeof cdpApiClient
|
|
110
|
+
export declare const authenticateUserWithCustomAuth: (projectId: string, options?: SecondParameter<typeof cdpApiClient<AuthenticateUserWithCustomAuth200>>) => Promise<AuthenticateUserWithCustomAuth200>;
|
|
111
111
|
|
|
112
112
|
export declare type AuthenticateUserWithCustomAuth200 = {
|
|
113
113
|
endUser: EndUser;
|
|
@@ -207,7 +207,7 @@ 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: (userId: string, createDelegationForEndUserBody: CreateDelegationForEndUserBody, params?: CreateDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient
|
|
210
|
+
export declare const createDelegationForEndUser: (userId: string, createDelegationForEndUserBody: CreateDelegationForEndUserBody, params?: CreateDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient<CreateDelegationForEndUser201>>) => Promise<CreateDelegationForEndUser201>;
|
|
211
211
|
|
|
212
212
|
export declare type CreateDelegationForEndUser201 = {
|
|
213
213
|
/** The date until which the delegation is valid. */
|
|
@@ -218,9 +218,9 @@ export declare type CreateDelegationForEndUser201 = {
|
|
|
218
218
|
* Creates an account-scoped delegation that allows a developer to sign on behalf of an end user for a single blockchain account (identified by its address) for the specified duration. The end user must be authenticated to authorize this delegation.
|
|
219
219
|
Multiple account-scoped delegations may exist concurrently for a single end user (one per canonical account address). Account-scoped and user-scoped delegations cannot coexist for the same user.
|
|
220
220
|
When the address corresponds to an EVM Smart Account, the delegation is scoped to the Smart Account's owner EOA rather than the Smart Account address itself. This means `/address/{smartAccountAddress}/delegation` and `/address/{ownerEoaAddress}/delegation` resolve to the same delegation, and the 409 `account_scoped_delegation_active` error may be returned when creating via either address if one already exists for the canonical owner.
|
|
221
|
-
* @summary Create account-scoped delegation for
|
|
221
|
+
* @summary Create account-scoped delegation for end user
|
|
222
222
|
*/
|
|
223
|
-
export declare const createDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, createDelegationForEndUserAccountBody: CreateDelegationForEndUserAccountBody, params?: CreateDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
223
|
+
export declare const createDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, createDelegationForEndUserAccountBody: CreateDelegationForEndUserAccountBody, params?: CreateDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<CreateDelegationForEndUserAccount201>>) => Promise<CreateDelegationForEndUserAccount201>;
|
|
224
224
|
|
|
225
225
|
export declare type CreateDelegationForEndUserAccount201 = {
|
|
226
226
|
/** The date until which the delegation is valid. */
|
|
@@ -240,6 +240,7 @@ export declare type CreateDelegationForEndUserAccountBody = {
|
|
|
240
240
|
export declare type CreateDelegationForEndUserAccountParams = {
|
|
241
241
|
/**
|
|
242
242
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
243
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
243
244
|
*/
|
|
244
245
|
projectID?: ProjectIDOptionalParameter;
|
|
245
246
|
};
|
|
@@ -259,6 +260,7 @@ export declare type CreateDelegationForEndUserBody = {
|
|
|
259
260
|
export declare type CreateDelegationForEndUserParams = {
|
|
260
261
|
/**
|
|
261
262
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
263
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
262
264
|
*/
|
|
263
265
|
projectID?: ProjectIDOptionalParameter;
|
|
264
266
|
};
|
|
@@ -269,11 +271,12 @@ export declare type CreateDelegationForEndUserResult = NonNullable<Awaited<Retur
|
|
|
269
271
|
* 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.
|
|
270
272
|
* @summary Create an ApplePay onramp order
|
|
271
273
|
*/
|
|
272
|
-
export declare const createEndUserApplePayOnrampOrder: (userId: string, createEndUserApplePayOnrampOrderRequest: CreateEndUserApplePayOnrampOrderRequest, params?: CreateEndUserApplePayOnrampOrderParams, options?: SecondParameter<typeof cdpApiClient
|
|
274
|
+
export declare const createEndUserApplePayOnrampOrder: (userId: string, createEndUserApplePayOnrampOrderRequest: CreateEndUserApplePayOnrampOrderRequest, params?: CreateEndUserApplePayOnrampOrderParams, options?: SecondParameter<typeof cdpApiClient<EndUserApplePayOnrampOrderCreateResponse>>) => Promise<EndUserApplePayOnrampOrderCreateResponse>;
|
|
273
275
|
|
|
274
276
|
export declare type CreateEndUserApplePayOnrampOrderParams = {
|
|
275
277
|
/**
|
|
276
278
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
279
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
277
280
|
*/
|
|
278
281
|
projectID?: ProjectIDOptionalParameter;
|
|
279
282
|
};
|
|
@@ -293,11 +296,57 @@ export declare interface CreateEndUserApplePayOnrampOrderRequest {
|
|
|
293
296
|
|
|
294
297
|
export declare type CreateEndUserApplePayOnrampOrderResult = NonNullable<Awaited<ReturnType<typeof createEndUserApplePayOnrampOrder>>>;
|
|
295
298
|
|
|
299
|
+
/**
|
|
300
|
+
* Creates a Bitcoin HD (Hierarchical Deterministic) account for an end user at the given address type and network. Returns the full end user resource including the extended public key (xpub) which can be used to derive child addresses for UTXO discovery. An end user can have one Bitcoin account per address type and network combination.
|
|
301
|
+
* @summary Create end user Bitcoin HD (Hierarchical Deterministic) account
|
|
302
|
+
*/
|
|
303
|
+
export declare const createEndUserBtcAccount: (userId: string, createEndUserBtcAccountBody: CreateEndUserBtcAccountBody, params?: CreateEndUserBtcAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<EndUser>;
|
|
304
|
+
|
|
305
|
+
export declare type CreateEndUserBtcAccountBody = {
|
|
306
|
+
/**
|
|
307
|
+
* The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
|
|
308
|
+
* @pattern ^[a-zA-Z0-9-]{1,100}$
|
|
309
|
+
*/
|
|
310
|
+
walletSecretId: string;
|
|
311
|
+
/** The Bitcoin address type, which determines the BIP-32 derivation path. segwit uses BIP-84 (m/84'/coin_type'/0') and produces bc1q.../tb1q... addresses. */
|
|
312
|
+
addressType: CreateEndUserBtcAccountBodyAddressType;
|
|
313
|
+
/** The Bitcoin network. */
|
|
314
|
+
network: CreateEndUserBtcAccountBodyNetwork;
|
|
315
|
+
};
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* The Bitcoin address type, which determines the BIP-32 derivation path. segwit uses BIP-84 (m/84'/coin_type'/0') and produces bc1q.../tb1q... addresses.
|
|
319
|
+
*/
|
|
320
|
+
export declare type CreateEndUserBtcAccountBodyAddressType = (typeof CreateEndUserBtcAccountBodyAddressType)[keyof typeof CreateEndUserBtcAccountBodyAddressType];
|
|
321
|
+
|
|
322
|
+
export declare const CreateEndUserBtcAccountBodyAddressType: {
|
|
323
|
+
readonly segwit: "segwit";
|
|
324
|
+
};
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* The Bitcoin network.
|
|
328
|
+
*/
|
|
329
|
+
export declare type CreateEndUserBtcAccountBodyNetwork = (typeof CreateEndUserBtcAccountBodyNetwork)[keyof typeof CreateEndUserBtcAccountBodyNetwork];
|
|
330
|
+
|
|
331
|
+
export declare const CreateEndUserBtcAccountBodyNetwork: {
|
|
332
|
+
readonly bitcoin: "bitcoin";
|
|
333
|
+
readonly "bitcoin-testnet": "bitcoin-testnet";
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
export declare type CreateEndUserBtcAccountParams = {
|
|
337
|
+
/**
|
|
338
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
339
|
+
*/
|
|
340
|
+
projectID?: ProjectIDOptionalParameter;
|
|
341
|
+
};
|
|
342
|
+
|
|
343
|
+
export declare type CreateEndUserBtcAccountResult = NonNullable<Awaited<ReturnType<typeof createEndUserBtcAccount>>>;
|
|
344
|
+
|
|
296
345
|
/**
|
|
297
346
|
* Creates an EVM account for an end user. An end user can have a maximum of 20 EVM accounts.
|
|
298
347
|
* @summary Create end user EVM account
|
|
299
348
|
*/
|
|
300
|
-
export declare const createEndUserEvmAccount: (userId: string, createEndUserEvmAccountBody: CreateEndUserEvmAccountBody, params?: CreateEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
349
|
+
export declare const createEndUserEvmAccount: (userId: string, createEndUserEvmAccountBody: CreateEndUserEvmAccountBody, params?: CreateEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient<EndUser>>) => Promise<EndUser>;
|
|
301
350
|
|
|
302
351
|
export declare type CreateEndUserEvmAccountBody = {
|
|
303
352
|
/**
|
|
@@ -310,6 +359,7 @@ export declare type CreateEndUserEvmAccountBody = {
|
|
|
310
359
|
export declare type CreateEndUserEvmAccountParams = {
|
|
311
360
|
/**
|
|
312
361
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
362
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
313
363
|
*/
|
|
314
364
|
projectID?: ProjectIDOptionalParameter;
|
|
315
365
|
};
|
|
@@ -320,7 +370,7 @@ export declare type CreateEndUserEvmAccountResult = NonNullable<Awaited<ReturnTy
|
|
|
320
370
|
* 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.
|
|
321
371
|
* @summary Create end user EVM Smart Account
|
|
322
372
|
*/
|
|
323
|
-
export declare const createEndUserEvmSmartAccount: (userId: string, createEndUserEvmSmartAccountBody: CreateEndUserEvmSmartAccountBody, params?: CreateEndUserEvmSmartAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
373
|
+
export declare const createEndUserEvmSmartAccount: (userId: string, createEndUserEvmSmartAccountBody: CreateEndUserEvmSmartAccountBody, params?: CreateEndUserEvmSmartAccountParams, options?: SecondParameter<typeof cdpApiClient<EndUser>>) => Promise<EndUser>;
|
|
324
374
|
|
|
325
375
|
export declare type CreateEndUserEvmSmartAccountBody = {
|
|
326
376
|
/**
|
|
@@ -337,6 +387,7 @@ export declare type CreateEndUserEvmSmartAccountBody = {
|
|
|
337
387
|
export declare type CreateEndUserEvmSmartAccountParams = {
|
|
338
388
|
/**
|
|
339
389
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
390
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
340
391
|
*/
|
|
341
392
|
projectID?: ProjectIDOptionalParameter;
|
|
342
393
|
};
|
|
@@ -349,7 +400,7 @@ export declare type CreateEndUserEvmSmartAccountResult = NonNullable<Awaited<Ret
|
|
|
349
400
|
Use `slippageBps` to control the minimum output floor. If the onchain price moves beyond the tolerance, the transaction reverts and `fromToken` is not deducted.
|
|
350
401
|
* @summary Execute a token swap
|
|
351
402
|
*/
|
|
352
|
-
export declare const createEndUserEvmSwap: (userId: string, createEndUserEvmSwapBody: CreateEndUserEvmSwapBody, params?: CreateEndUserEvmSwapParams, options?: SecondParameter<typeof cdpApiClient
|
|
403
|
+
export declare const createEndUserEvmSwap: (userId: string, createEndUserEvmSwapBody: CreateEndUserEvmSwapBody, params?: CreateEndUserEvmSwapParams, options?: SecondParameter<typeof cdpApiClient<CreateEndUserEvmSwap200>>) => Promise<CreateEndUserEvmSwap200>;
|
|
353
404
|
|
|
354
405
|
/**
|
|
355
406
|
* Swap transaction submitted successfully. Returns immediately — does not wait for onchain confirmation. Exactly one of `transactionHash` or `userOpHash` will be non-null.
|
|
@@ -480,6 +531,7 @@ export declare type CreateEndUserEvmSwapBody = {
|
|
|
480
531
|
export declare type CreateEndUserEvmSwapParams = {
|
|
481
532
|
/**
|
|
482
533
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
534
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
483
535
|
*/
|
|
484
536
|
projectID?: ProjectIDOptionalParameter;
|
|
485
537
|
};
|
|
@@ -490,7 +542,7 @@ export declare type CreateEndUserEvmSwapResult = NonNullable<Awaited<ReturnType<
|
|
|
490
542
|
* Creates a Solana account for an end user. An end user can have a maximum of 20 Solana accounts.
|
|
491
543
|
* @summary Create end user Solana account
|
|
492
544
|
*/
|
|
493
|
-
export declare const createEndUserSolanaAccount: (userId: string, createEndUserSolanaAccountBody: CreateEndUserSolanaAccountBody, params?: CreateEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
545
|
+
export declare const createEndUserSolanaAccount: (userId: string, createEndUserSolanaAccountBody: CreateEndUserSolanaAccountBody, params?: CreateEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient<EndUser>>) => Promise<EndUser>;
|
|
494
546
|
|
|
495
547
|
export declare type CreateEndUserSolanaAccountBody = {
|
|
496
548
|
/**
|
|
@@ -503,6 +555,7 @@ export declare type CreateEndUserSolanaAccountBody = {
|
|
|
503
555
|
export declare type CreateEndUserSolanaAccountParams = {
|
|
504
556
|
/**
|
|
505
557
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
558
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
506
559
|
*/
|
|
507
560
|
projectID?: ProjectIDOptionalParameter;
|
|
508
561
|
};
|
|
@@ -521,7 +574,7 @@ export declare type CreateEndUserSolanaAccountResult = NonNullable<Awaited<Retur
|
|
|
521
574
|
The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.
|
|
522
575
|
* @summary Create EIP-7702 delegation for end user EVM account
|
|
523
576
|
*/
|
|
524
|
-
export declare const createEvmEip7702DelegationWithEndUserAccount: (userId: string, createEvmEip7702DelegationWithEndUserAccountBody: CreateEvmEip7702DelegationWithEndUserAccountBody, params?: CreateEvmEip7702DelegationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
577
|
+
export declare const createEvmEip7702DelegationWithEndUserAccount: (userId: string, createEvmEip7702DelegationWithEndUserAccountBody: CreateEvmEip7702DelegationWithEndUserAccountBody, params?: CreateEvmEip7702DelegationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<CreateEvmEip7702DelegationWithEndUserAccount201>>) => Promise<CreateEvmEip7702DelegationWithEndUserAccount201>;
|
|
525
578
|
|
|
526
579
|
export declare type CreateEvmEip7702DelegationWithEndUserAccount201 = {
|
|
527
580
|
/** The unique identifier for the delegation operation. Use this to poll the operation status. */
|
|
@@ -547,6 +600,7 @@ export declare type CreateEvmEip7702DelegationWithEndUserAccountBody = {
|
|
|
547
600
|
export declare type CreateEvmEip7702DelegationWithEndUserAccountParams = {
|
|
548
601
|
/**
|
|
549
602
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
603
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
550
604
|
*/
|
|
551
605
|
projectID?: ProjectIDOptionalParameter;
|
|
552
606
|
};
|
|
@@ -595,17 +649,23 @@ export declare interface CreateSpendPermissionRequest {
|
|
|
595
649
|
* Creates a spend permission for the given end user smart account.
|
|
596
650
|
* @summary Create a spend permission for an end user smart account
|
|
597
651
|
*/
|
|
598
|
-
export declare const createSpendPermissionWithEndUserAccount: (userId: string, address: string, createSpendPermissionRequest: CreateSpendPermissionRequest, params?: CreateSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
652
|
+
export declare const createSpendPermissionWithEndUserAccount: (userId: string, address: string, createSpendPermissionRequest: CreateSpendPermissionRequest, params?: CreateSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<EvmUserOperation>>) => Promise<EvmUserOperation>;
|
|
599
653
|
|
|
600
654
|
export declare type CreateSpendPermissionWithEndUserAccountParams = {
|
|
601
655
|
/**
|
|
602
656
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
657
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
603
658
|
*/
|
|
604
659
|
projectID?: ProjectIDOptionalParameter;
|
|
605
660
|
};
|
|
606
661
|
|
|
607
662
|
export declare type CreateSpendPermissionWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof createSpendPermissionWithEndUserAccount>>>;
|
|
608
663
|
|
|
664
|
+
/**
|
|
665
|
+
* The request was rejected due to a delegation issue. The errorType field indicates the specific reason.
|
|
666
|
+
*/
|
|
667
|
+
export declare type DelegationForbiddenErrorResponse = Error_2;
|
|
668
|
+
|
|
609
669
|
/**
|
|
610
670
|
* Information about an end user who authenticates using a JWT issued by the developer.
|
|
611
671
|
*/
|
|
@@ -728,6 +788,8 @@ export declare interface EndUser {
|
|
|
728
788
|
solanaAccounts: string[];
|
|
729
789
|
/** The list of Solana accounts associated with the end user. End users can have up to 10 Solana accounts. */
|
|
730
790
|
solanaAccountObjects: EndUserSolanaAccount[];
|
|
791
|
+
/** The list of Bitcoin HD (Hierarchical Deterministic) accounts associated with the end user. An end user can have one Bitcoin account per address type and network combination. */
|
|
792
|
+
btcAccountObjects?: EndUserBtcAccount[];
|
|
731
793
|
/** The date and time when the end user was created, in ISO 8601 format. */
|
|
732
794
|
createdAt: string;
|
|
733
795
|
/** The date and time when the end user last successfully authenticated using any authentication method, in ISO 8601 format. */
|
|
@@ -742,6 +804,39 @@ export declare interface EndUserApplePayOnrampOrderCreateResponse {
|
|
|
742
804
|
paymentLink: EndUserOnrampPaymentLink;
|
|
743
805
|
}
|
|
744
806
|
|
|
807
|
+
/**
|
|
808
|
+
* Information about a Bitcoin HD (Hierarchical Deterministic) account associated with an end user. Unlike EVM and Solana accounts, there is no single address field — the extended public key (xpub) replaces it, enabling derivation of unlimited child addresses for UTXO discovery.
|
|
809
|
+
*/
|
|
810
|
+
export declare interface EndUserBtcAccount {
|
|
811
|
+
/** The Bitcoin address type and derivation path standard used for this account. */
|
|
812
|
+
addressType: EndUserBtcAccountAddressType;
|
|
813
|
+
/** The Bitcoin network this account is associated with. */
|
|
814
|
+
network: EndUserBtcAccountNetwork;
|
|
815
|
+
/** The BIP-32 extended public key (xpub) at the account derivation path, base58check encoded. Use this to derive child addresses for UTXO scanning. */
|
|
816
|
+
extendedPublicKey: string;
|
|
817
|
+
/** The date and time when the account was created, in ISO 8601 format. */
|
|
818
|
+
createdAt: string;
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* The Bitcoin address type and derivation path standard used for this account.
|
|
823
|
+
*/
|
|
824
|
+
export declare type EndUserBtcAccountAddressType = (typeof EndUserBtcAccountAddressType)[keyof typeof EndUserBtcAccountAddressType];
|
|
825
|
+
|
|
826
|
+
export declare const EndUserBtcAccountAddressType: {
|
|
827
|
+
readonly segwit: "segwit";
|
|
828
|
+
};
|
|
829
|
+
|
|
830
|
+
/**
|
|
831
|
+
* The Bitcoin network this account is associated with.
|
|
832
|
+
*/
|
|
833
|
+
export declare type EndUserBtcAccountNetwork = (typeof EndUserBtcAccountNetwork)[keyof typeof EndUserBtcAccountNetwork];
|
|
834
|
+
|
|
835
|
+
export declare const EndUserBtcAccountNetwork: {
|
|
836
|
+
readonly bitcoin: "bitcoin";
|
|
837
|
+
readonly "bitcoin-testnet": "bitcoin-testnet";
|
|
838
|
+
};
|
|
839
|
+
|
|
745
840
|
/**
|
|
746
841
|
* Information about an EVM account associated with an end user.
|
|
747
842
|
*/
|
|
@@ -940,6 +1035,7 @@ export declare const ErrorType: {
|
|
|
940
1035
|
readonly bad_gateway: "bad_gateway";
|
|
941
1036
|
readonly capture_expired: "capture_expired";
|
|
942
1037
|
readonly client_closed_request: "client_closed_request";
|
|
1038
|
+
readonly endpoint_unavailable: "endpoint_unavailable";
|
|
943
1039
|
readonly faucet_limit_exceeded: "faucet_limit_exceeded";
|
|
944
1040
|
readonly forbidden: "forbidden";
|
|
945
1041
|
readonly idempotency_error: "idempotency_error";
|
|
@@ -957,6 +1053,7 @@ export declare const ErrorType: {
|
|
|
957
1053
|
readonly service_unavailable: "service_unavailable";
|
|
958
1054
|
readonly timed_out: "timed_out";
|
|
959
1055
|
readonly unauthorized: "unauthorized";
|
|
1056
|
+
readonly unsupported_tos_language: "unsupported_tos_language";
|
|
960
1057
|
readonly policy_violation: "policy_violation";
|
|
961
1058
|
readonly policy_in_use: "policy_in_use";
|
|
962
1059
|
readonly account_limit_exceeded: "account_limit_exceeded";
|
|
@@ -981,6 +1078,7 @@ export declare const ErrorType: {
|
|
|
981
1078
|
readonly target_onchain_address_invalid: "target_onchain_address_invalid";
|
|
982
1079
|
readonly transfer_amount_invalid: "transfer_amount_invalid";
|
|
983
1080
|
readonly transfer_asset_not_supported: "transfer_asset_not_supported";
|
|
1081
|
+
readonly transfer_quote_expired: "transfer_quote_expired";
|
|
984
1082
|
readonly insufficient_balance: "insufficient_balance";
|
|
985
1083
|
readonly metadata_too_many_entries: "metadata_too_many_entries";
|
|
986
1084
|
readonly metadata_key_too_long: "metadata_key_too_long";
|
|
@@ -999,6 +1097,11 @@ export declare const ErrorType: {
|
|
|
999
1097
|
readonly insufficient_liquidity: "insufficient_liquidity";
|
|
1000
1098
|
readonly insufficient_allowance: "insufficient_allowance";
|
|
1001
1099
|
readonly transaction_simulation_failed: "transaction_simulation_failed";
|
|
1100
|
+
readonly delegation_not_found: "delegation_not_found";
|
|
1101
|
+
readonly delegation_expired: "delegation_expired";
|
|
1102
|
+
readonly delegation_revoked: "delegation_revoked";
|
|
1103
|
+
readonly delegation_not_authorized: "delegation_not_authorized";
|
|
1104
|
+
readonly delegation_not_enabled: "delegation_not_enabled";
|
|
1002
1105
|
};
|
|
1003
1106
|
|
|
1004
1107
|
export declare interface EvmCall {
|
|
@@ -1138,7 +1241,7 @@ export declare const EvmUserOperationStatus: {
|
|
|
1138
1241
|
* 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.
|
|
1139
1242
|
* @summary Export end user EVM account
|
|
1140
1243
|
*/
|
|
1141
|
-
export declare const exportEndUserEvmAccount: (userId: string, exportEndUserEvmAccountBody: ExportEndUserEvmAccountBody, params?: ExportEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
1244
|
+
export declare const exportEndUserEvmAccount: (userId: string, exportEndUserEvmAccountBody: ExportEndUserEvmAccountBody, params?: ExportEndUserEvmAccountParams, options?: SecondParameter<typeof cdpApiClient<ExportEndUserEvmAccount200>>) => Promise<ExportEndUserEvmAccount200>;
|
|
1142
1245
|
|
|
1143
1246
|
export declare type ExportEndUserEvmAccount200 = {
|
|
1144
1247
|
/** 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. */
|
|
@@ -1167,6 +1270,7 @@ export declare type ExportEndUserEvmAccountBody = {
|
|
|
1167
1270
|
export declare type ExportEndUserEvmAccountParams = {
|
|
1168
1271
|
/**
|
|
1169
1272
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1273
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1170
1274
|
*/
|
|
1171
1275
|
projectID?: ProjectIDOptionalParameter;
|
|
1172
1276
|
};
|
|
@@ -1177,7 +1281,7 @@ export declare type ExportEndUserEvmAccountResult = NonNullable<Awaited<ReturnTy
|
|
|
1177
1281
|
* Export an existing Solana account's private key. It is important to store the private key in a secure place after it's exported.
|
|
1178
1282
|
* @summary Export end user Solana account
|
|
1179
1283
|
*/
|
|
1180
|
-
export declare const exportEndUserSolanaAccount: (userId: string, exportEndUserSolanaAccountBody: ExportEndUserSolanaAccountBody, params?: ExportEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
1284
|
+
export declare const exportEndUserSolanaAccount: (userId: string, exportEndUserSolanaAccountBody: ExportEndUserSolanaAccountBody, params?: ExportEndUserSolanaAccountParams, options?: SecondParameter<typeof cdpApiClient<ExportEndUserSolanaAccount200>>) => Promise<ExportEndUserSolanaAccount200>;
|
|
1181
1285
|
|
|
1182
1286
|
export declare type ExportEndUserSolanaAccount200 = {
|
|
1183
1287
|
/** 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. */
|
|
@@ -1206,6 +1310,7 @@ export declare type ExportEndUserSolanaAccountBody = {
|
|
|
1206
1310
|
export declare type ExportEndUserSolanaAccountParams = {
|
|
1207
1311
|
/**
|
|
1208
1312
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1313
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1209
1314
|
*/
|
|
1210
1315
|
projectID?: ProjectIDOptionalParameter;
|
|
1211
1316
|
};
|
|
@@ -1230,7 +1335,7 @@ export declare type ExportEndUserSolanaAccountResult = NonNullable<Awaited<Retur
|
|
|
1230
1335
|
The returned challenge must be used exactly once and cannot be reused for multiple attestation attempts.
|
|
1231
1336
|
* @summary Generate attestation challenge (iOS only)
|
|
1232
1337
|
*/
|
|
1233
|
-
export declare const generateAttestationChallenge: (projectId: string, options?: SecondParameter<typeof cdpApiClient
|
|
1338
|
+
export declare const generateAttestationChallenge: (projectId: string, options?: SecondParameter<typeof cdpApiClient<IosAttestationChallenge>>) => Promise<IosAttestationChallenge>;
|
|
1234
1339
|
|
|
1235
1340
|
export declare type GenerateAttestationChallengeResult = NonNullable<Awaited<ReturnType<typeof generateAttestationChallenge>>>;
|
|
1236
1341
|
|
|
@@ -1238,11 +1343,12 @@ export declare type GenerateAttestationChallengeResult = NonNullable<Awaited<Ret
|
|
|
1238
1343
|
* Gets the currently authenticated end user.
|
|
1239
1344
|
* @summary Get authenticated end user
|
|
1240
1345
|
*/
|
|
1241
|
-
export declare const getAuthenticatedEndUser: (userId: string, params?: GetAuthenticatedEndUserParams, options?: SecondParameter<typeof cdpApiClient
|
|
1346
|
+
export declare const getAuthenticatedEndUser: (userId: string, params?: GetAuthenticatedEndUserParams, options?: SecondParameter<typeof cdpApiClient<EndUser>>) => Promise<EndUser>;
|
|
1242
1347
|
|
|
1243
1348
|
export declare type GetAuthenticatedEndUserParams = {
|
|
1244
1349
|
/**
|
|
1245
1350
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1351
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1246
1352
|
*/
|
|
1247
1353
|
projectID?: ProjectIDOptionalParameter;
|
|
1248
1354
|
};
|
|
@@ -1253,7 +1359,7 @@ export declare type GetAuthenticatedEndUserResult = NonNullable<Awaited<ReturnTy
|
|
|
1253
1359
|
* 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.
|
|
1254
1360
|
* @summary Get delegation for end user
|
|
1255
1361
|
*/
|
|
1256
|
-
export declare const getDelegationForEndUser: (userId: string, params?: GetDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient
|
|
1362
|
+
export declare const getDelegationForEndUser: (userId: string, params?: GetDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient<GetDelegationForEndUser200>>) => Promise<GetDelegationForEndUser200>;
|
|
1257
1363
|
|
|
1258
1364
|
export declare type GetDelegationForEndUser200 = {
|
|
1259
1365
|
/** The date until which the delegation is valid. */
|
|
@@ -1263,9 +1369,9 @@ export declare type GetDelegationForEndUser200 = {
|
|
|
1263
1369
|
/**
|
|
1264
1370
|
* Returns the active account-scoped delegation for the specified end user account, if one exists. Useful for showing delegation status in a UI.
|
|
1265
1371
|
When the address corresponds to an EVM Smart Account, this returns the delegation for the Smart Account's owner EOA.
|
|
1266
|
-
* @summary Get account-scoped delegation for
|
|
1372
|
+
* @summary Get account-scoped delegation for end user
|
|
1267
1373
|
*/
|
|
1268
|
-
export declare const getDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, params?: GetDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
1374
|
+
export declare const getDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, params?: GetDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<GetDelegationForEndUserAccount200>>) => Promise<GetDelegationForEndUserAccount200>;
|
|
1269
1375
|
|
|
1270
1376
|
export declare type GetDelegationForEndUserAccount200 = {
|
|
1271
1377
|
/** The date until which the delegation is valid. */
|
|
@@ -1275,6 +1381,7 @@ export declare type GetDelegationForEndUserAccount200 = {
|
|
|
1275
1381
|
export declare type GetDelegationForEndUserAccountParams = {
|
|
1276
1382
|
/**
|
|
1277
1383
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1384
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1278
1385
|
*/
|
|
1279
1386
|
projectID?: ProjectIDOptionalParameter;
|
|
1280
1387
|
};
|
|
@@ -1284,6 +1391,7 @@ export declare type GetDelegationForEndUserAccountResult = NonNullable<Awaited<R
|
|
|
1284
1391
|
export declare type GetDelegationForEndUserParams = {
|
|
1285
1392
|
/**
|
|
1286
1393
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1394
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1287
1395
|
*/
|
|
1288
1396
|
projectID?: ProjectIDOptionalParameter;
|
|
1289
1397
|
};
|
|
@@ -1295,7 +1403,7 @@ export declare type GetDelegationForEndUserResult = NonNullable<Awaited<ReturnTy
|
|
|
1295
1403
|
If `liquidityAvailable` is false in the response, no swap route exists for this pair or amount.
|
|
1296
1404
|
* @summary Get a price estimate for a token swap
|
|
1297
1405
|
*/
|
|
1298
|
-
export declare const getEndUserEvmSwapPrice: (userId: string, params: GetEndUserEvmSwapPriceParams, options?: SecondParameter<typeof cdpApiClient
|
|
1406
|
+
export declare const getEndUserEvmSwapPrice: (userId: string, params: GetEndUserEvmSwapPriceParams, options?: SecondParameter<typeof cdpApiClient<GetEndUserEvmSwapPrice200>>) => Promise<GetEndUserEvmSwapPrice200>;
|
|
1299
1407
|
|
|
1300
1408
|
/**
|
|
1301
1409
|
* Indicative price estimate for a token swap. Not binding. If `liquidityAvailable` is false, all fields other than `liquidityAvailable` are absent.
|
|
@@ -1435,6 +1543,7 @@ export declare type GetEndUserEvmSwapPrice200IssuesBalance = {
|
|
|
1435
1543
|
export declare type GetEndUserEvmSwapPriceParams = {
|
|
1436
1544
|
/**
|
|
1437
1545
|
* The end user's EVM address (EOA or smart account). Must belong to this end user.
|
|
1546
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
1438
1547
|
*/
|
|
1439
1548
|
taker: string;
|
|
1440
1549
|
/**
|
|
@@ -1443,22 +1552,28 @@ export declare type GetEndUserEvmSwapPriceParams = {
|
|
|
1443
1552
|
network: EvmSwapsNetwork;
|
|
1444
1553
|
/**
|
|
1445
1554
|
* The 0x-prefixed contract address of the token to sell.
|
|
1555
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
1446
1556
|
*/
|
|
1447
1557
|
fromToken: string;
|
|
1448
1558
|
/**
|
|
1449
1559
|
* The 0x-prefixed contract address of the token to buy.
|
|
1560
|
+
* @pattern ^0x[0-9a-fA-F]{40}$
|
|
1450
1561
|
*/
|
|
1451
1562
|
toToken: string;
|
|
1452
1563
|
/**
|
|
1453
1564
|
* The amount of `fromToken` to sell, in atomic units. For example, `100000000000000000` when selling WETH equates to 0.1 WETH.
|
|
1565
|
+
* @pattern ^[1-9]\d*$
|
|
1454
1566
|
*/
|
|
1455
1567
|
fromAmount: string;
|
|
1456
1568
|
/**
|
|
1457
1569
|
* Maximum slippage in basis points (100 = 1%). Influences the indicative `minToAmount` in the response. Default is 100 (1%).
|
|
1570
|
+
* @minimum 0
|
|
1571
|
+
* @maximum 10000
|
|
1458
1572
|
*/
|
|
1459
1573
|
slippageBps?: number;
|
|
1460
1574
|
/**
|
|
1461
1575
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1576
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1462
1577
|
*/
|
|
1463
1578
|
projectID?: ProjectIDOptionalParameter;
|
|
1464
1579
|
};
|
|
@@ -1469,11 +1584,12 @@ export declare type GetEndUserEvmSwapPriceResult = NonNullable<Awaited<ReturnTyp
|
|
|
1469
1584
|
* 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.
|
|
1470
1585
|
* @summary Get EIP-7702 delegation operation for end user EVM account
|
|
1471
1586
|
*/
|
|
1472
|
-
export declare const getEvmEip7702DelegationOperationByIdWithEndUserAccount: (userId: string, delegationOperationId: string, params?: GetEvmEip7702DelegationOperationByIdWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
1587
|
+
export declare const getEvmEip7702DelegationOperationByIdWithEndUserAccount: (userId: string, delegationOperationId: string, params?: GetEvmEip7702DelegationOperationByIdWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<EvmEip7702DelegationOperation>>) => Promise<EvmEip7702DelegationOperation>;
|
|
1473
1588
|
|
|
1474
1589
|
export declare type GetEvmEip7702DelegationOperationByIdWithEndUserAccountParams = {
|
|
1475
1590
|
/**
|
|
1476
1591
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1592
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1477
1593
|
*/
|
|
1478
1594
|
projectID?: ProjectIDOptionalParameter;
|
|
1479
1595
|
};
|
|
@@ -1484,7 +1600,7 @@ export declare type GetEvmEip7702DelegationOperationByIdWithEndUserAccountResult
|
|
|
1484
1600
|
* Retrieves the MFA configuration for a project. Returns 404 if MFA is not configured (disabled by default).
|
|
1485
1601
|
* @summary Get MFA configuration
|
|
1486
1602
|
*/
|
|
1487
|
-
export declare const getMfaConfig: (projectId: string, options?: SecondParameter<typeof cdpApiClient
|
|
1603
|
+
export declare const getMfaConfig: (projectId: string, options?: SecondParameter<typeof cdpApiClient<MfaConfig>>) => Promise<MfaConfig>;
|
|
1488
1604
|
|
|
1489
1605
|
export declare type GetMfaConfigResult = NonNullable<Awaited<ReturnType<typeof getMfaConfig>>>;
|
|
1490
1606
|
|
|
@@ -1492,7 +1608,7 @@ export declare type GetMfaConfigResult = NonNullable<Awaited<ReturnType<typeof g
|
|
|
1492
1608
|
* Retrieves the project configuration for a project. Returns 404 if project is not configured (disabled by default).
|
|
1493
1609
|
* @summary Get project configuration
|
|
1494
1610
|
*/
|
|
1495
|
-
export declare const getProjectConfig: (projectId: string, options?: SecondParameter<typeof cdpApiClient
|
|
1611
|
+
export declare const getProjectConfig: (projectId: string, options?: SecondParameter<typeof cdpApiClient<ProjectConfig>>) => Promise<ProjectConfig>;
|
|
1496
1612
|
|
|
1497
1613
|
export declare type GetProjectConfigResult = NonNullable<Awaited<ReturnType<typeof getProjectConfig>>>;
|
|
1498
1614
|
|
|
@@ -1500,11 +1616,12 @@ export declare type GetProjectConfigResult = NonNullable<Awaited<ReturnType<type
|
|
|
1500
1616
|
* Gets a user operation by its hash for an end user's EVM Smart Account.
|
|
1501
1617
|
* @summary Get a user operation for end user EVM Smart Account
|
|
1502
1618
|
*/
|
|
1503
|
-
export declare const getUserOperationWithEndUserAccount: (userId: string, address: string, userOpHash: string, params?: GetUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
1619
|
+
export declare const getUserOperationWithEndUserAccount: (userId: string, address: string, userOpHash: string, params?: GetUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<EvmUserOperation>>) => Promise<EvmUserOperation>;
|
|
1504
1620
|
|
|
1505
1621
|
export declare type GetUserOperationWithEndUserAccountParams = {
|
|
1506
1622
|
/**
|
|
1507
1623
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1624
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1508
1625
|
*/
|
|
1509
1626
|
projectID?: ProjectIDOptionalParameter;
|
|
1510
1627
|
};
|
|
@@ -1545,7 +1662,7 @@ export declare type IdempotencyKeyParameter = string;
|
|
|
1545
1662
|
* Initiates the authentication flow for an end user. This is an optionally authenticated endpoint. The exact response depends on the authentication method specified in the request body. If a valid access token is included in the Authorization header, it is treated as an attempt to add an additional authentication method to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
1546
1663
|
* @summary Initiate end user authentication
|
|
1547
1664
|
*/
|
|
1548
|
-
export declare const initiateAuthentication: (projectId: string, initiateAuthenticationRequest: InitiateAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient
|
|
1665
|
+
export declare const initiateAuthentication: (projectId: string, initiateAuthenticationRequest: InitiateAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<InitiateAuthenticationResponseWrapper>>) => Promise<InitiateAuthenticationResponseWrapper>;
|
|
1549
1666
|
|
|
1550
1667
|
/**
|
|
1551
1668
|
* The request body for an end user to initiate authentication.
|
|
@@ -1616,7 +1733,7 @@ export declare interface InitiateEmailAuthenticationResponse {
|
|
|
1616
1733
|
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.
|
|
1617
1734
|
* @summary Initiate MFA enrollment
|
|
1618
1735
|
*/
|
|
1619
|
-
export declare const initiateMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient
|
|
1736
|
+
export declare const initiateMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient<InitiateMfaEnrollmentResponseWrapper>>) => Promise<InitiateMfaEnrollmentResponseWrapper>;
|
|
1620
1737
|
|
|
1621
1738
|
/**
|
|
1622
1739
|
* Initiates MFA enrollment for an end user for given method.
|
|
@@ -1624,11 +1741,12 @@ export declare const initiateMfaEnrollment: (userId: string, mfaMethod: "totp" |
|
|
|
1624
1741
|
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.
|
|
1625
1742
|
* @summary Initiate MFA enrollment
|
|
1626
1743
|
*/
|
|
1627
|
-
export declare const initiateMfaEnrollment2: (userId: string, mfaMethod: "totp" | "sms", initiateMfaEnrollmentRequest: InitiateMfaEnrollmentRequest, params?: InitiateMfaEnrollment2Params, options?: SecondParameter<typeof cdpApiClient
|
|
1744
|
+
export declare const initiateMfaEnrollment2: (userId: string, mfaMethod: "totp" | "sms", initiateMfaEnrollmentRequest: InitiateMfaEnrollmentRequest, params?: InitiateMfaEnrollment2Params, options?: SecondParameter<typeof cdpApiClient<InitiateMfaEnrollmentResponseWrapper>>) => Promise<InitiateMfaEnrollmentResponseWrapper>;
|
|
1628
1745
|
|
|
1629
1746
|
export declare type InitiateMfaEnrollment2Params = {
|
|
1630
1747
|
/**
|
|
1631
1748
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1749
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1632
1750
|
*/
|
|
1633
1751
|
projectID?: ProjectIDOptionalParameter;
|
|
1634
1752
|
};
|
|
@@ -1638,6 +1756,7 @@ export declare type InitiateMfaEnrollment2Result = NonNullable<Awaited<ReturnTyp
|
|
|
1638
1756
|
export declare type InitiateMfaEnrollmentParams = {
|
|
1639
1757
|
/**
|
|
1640
1758
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1759
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1641
1760
|
*/
|
|
1642
1761
|
projectID?: ProjectIDOptionalParameter;
|
|
1643
1762
|
};
|
|
@@ -1678,11 +1797,12 @@ export declare interface InitiateMfaEnrollmentTotpResponse {
|
|
|
1678
1797
|
The mfaMethod parameter is required to specify which method to use for verification.
|
|
1679
1798
|
* @summary Initiate MFA verification
|
|
1680
1799
|
*/
|
|
1681
|
-
export declare const initiateMfaVerification: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient
|
|
1800
|
+
export declare const initiateMfaVerification: (userId: string, mfaMethod: "totp" | "sms", params?: InitiateMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
|
|
1682
1801
|
|
|
1683
1802
|
export declare type InitiateMfaVerificationParams = {
|
|
1684
1803
|
/**
|
|
1685
1804
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
1805
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1686
1806
|
*/
|
|
1687
1807
|
projectID?: ProjectIDOptionalParameter;
|
|
1688
1808
|
};
|
|
@@ -1856,7 +1976,7 @@ export declare interface IOSAppAttestationConfig {
|
|
|
1856
1976
|
}
|
|
1857
1977
|
|
|
1858
1978
|
/**
|
|
1859
|
-
* Generated by orval v7.
|
|
1979
|
+
* Generated by orval v7.20.0 🍺
|
|
1860
1980
|
* Do not edit manually.
|
|
1861
1981
|
* Coinbase Developer Platform APIs
|
|
1862
1982
|
* The Coinbase Developer Platform APIs - leading the world's transition onchain.
|
|
@@ -1947,7 +2067,7 @@ export declare interface ListResponse {
|
|
|
1947
2067
|
* Lists spend permission for the given end user smart account.
|
|
1948
2068
|
* @summary List spend permissions for end user smart account
|
|
1949
2069
|
*/
|
|
1950
|
-
export declare const listSpendPermissionsWithEndUserAccount: (userId: string, address: string, params?: ListSpendPermissionsWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2070
|
+
export declare const listSpendPermissionsWithEndUserAccount: (userId: string, address: string, params?: ListSpendPermissionsWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<ListSpendPermissionsWithEndUserAccount200>>) => Promise<ListSpendPermissionsWithEndUserAccount200>;
|
|
1951
2071
|
|
|
1952
2072
|
export declare type ListSpendPermissionsWithEndUserAccount200 = ListSpendPermissionsWithEndUserAccount200AllOf & ListResponse;
|
|
1953
2073
|
|
|
@@ -1967,6 +2087,7 @@ export declare type ListSpendPermissionsWithEndUserAccountParams = {
|
|
|
1967
2087
|
pageToken?: PageTokenParameter;
|
|
1968
2088
|
/**
|
|
1969
2089
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2090
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
1970
2091
|
*/
|
|
1971
2092
|
projectID?: ProjectIDOptionalParameter;
|
|
1972
2093
|
};
|
|
@@ -1977,7 +2098,7 @@ export declare type ListSpendPermissionsWithEndUserAccountResult = NonNullable<A
|
|
|
1977
2098
|
* Logs out the end user using the attached refresh token.
|
|
1978
2099
|
* @summary Log out end user
|
|
1979
2100
|
*/
|
|
1980
|
-
export declare const logOutEndUser: (projectId: string, logOutEndUserBody?: LogOutEndUserBody, options?: SecondParameter<typeof cdpApiClient
|
|
2101
|
+
export declare const logOutEndUser: (projectId: string, logOutEndUserBody?: LogOutEndUserBody, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
|
|
1981
2102
|
|
|
1982
2103
|
export declare type LogOutEndUserBody = {
|
|
1983
2104
|
/** The refresh token to exchange. */
|
|
@@ -2160,7 +2281,7 @@ export declare type ProjectIDOptionalParameter = string;
|
|
|
2160
2281
|
* 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.
|
|
2161
2282
|
* @summary Record MFA enrollment prompt
|
|
2162
2283
|
*/
|
|
2163
|
-
export declare const recordMfaEnrollmentPrompted: (userId: string, params?: RecordMfaEnrollmentPromptedParams, options?: SecondParameter<typeof cdpApiClient
|
|
2284
|
+
export declare const recordMfaEnrollmentPrompted: (userId: string, params?: RecordMfaEnrollmentPromptedParams, options?: SecondParameter<typeof cdpApiClient<RecordMfaEnrollmentPrompted200>>) => Promise<RecordMfaEnrollmentPrompted200>;
|
|
2164
2285
|
|
|
2165
2286
|
/**
|
|
2166
2287
|
* Information about the end user's last MFA enrollment prompt.
|
|
@@ -2173,6 +2294,7 @@ export declare type RecordMfaEnrollmentPrompted200 = {
|
|
|
2173
2294
|
export declare type RecordMfaEnrollmentPromptedParams = {
|
|
2174
2295
|
/**
|
|
2175
2296
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2297
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2176
2298
|
*/
|
|
2177
2299
|
projectID?: ProjectIDOptionalParameter;
|
|
2178
2300
|
};
|
|
@@ -2183,7 +2305,7 @@ export declare type RecordMfaEnrollmentPromptedResult = NonNullable<Awaited<Retu
|
|
|
2183
2305
|
* Refreshes the access token for the end user. This is an unauthenticated endpoint, but it assumes that the refresh token provided in the various `verify` endpoints is set in the `Cookie` header or request body. The new refresh token will be set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body.
|
|
2184
2306
|
* @summary Refresh end user access token
|
|
2185
2307
|
*/
|
|
2186
|
-
export declare const refreshAccessToken: (projectId: string, refreshAccessTokenBody: RefreshAccessTokenBody, options?: SecondParameter<typeof cdpApiClient
|
|
2308
|
+
export declare const refreshAccessToken: (projectId: string, refreshAccessTokenBody: RefreshAccessTokenBody, options?: SecondParameter<typeof cdpApiClient<RefreshAccessToken200>>) => Promise<RefreshAccessToken200>;
|
|
2187
2309
|
|
|
2188
2310
|
export declare type RefreshAccessToken200 = {
|
|
2189
2311
|
endUser: EndUser;
|
|
@@ -2266,7 +2388,7 @@ export declare interface RefreshTokenStorage {
|
|
|
2266
2388
|
- `429`: Rate limit exceeded (too many attestation attempts).
|
|
2267
2389
|
* @summary Register device key for iOS App Attest attestation (iOS only)
|
|
2268
2390
|
*/
|
|
2269
|
-
export declare const registerAttestation: (projectId: string, iosAttestationRegistrationRequest: IosAttestationRegistrationRequest, options?: SecondParameter<typeof cdpApiClient
|
|
2391
|
+
export declare const registerAttestation: (projectId: string, iosAttestationRegistrationRequest: IosAttestationRegistrationRequest, options?: SecondParameter<typeof cdpApiClient<IosAttestationRegistrationResponse>>) => Promise<IosAttestationRegistrationResponse>;
|
|
2270
2392
|
|
|
2271
2393
|
export declare type RegisterAttestationResult = NonNullable<Awaited<ReturnType<typeof registerAttestation>>>;
|
|
2272
2394
|
|
|
@@ -2318,7 +2440,7 @@ export declare type RegisterAttestationResult = NonNullable<Awaited<ReturnType<t
|
|
|
2318
2440
|
}); ```.
|
|
2319
2441
|
* @summary Register a Temporary Wallet Secret
|
|
2320
2442
|
*/
|
|
2321
|
-
export declare const registerTemporaryWalletSecret: (userId: string, registerTemporaryWalletSecretBody: RegisterTemporaryWalletSecretBody, params?: RegisterTemporaryWalletSecretParams, options?: SecondParameter<typeof cdpApiClient
|
|
2443
|
+
export declare const registerTemporaryWalletSecret: (userId: string, registerTemporaryWalletSecretBody: RegisterTemporaryWalletSecretBody, params?: RegisterTemporaryWalletSecretParams, options?: SecondParameter<typeof cdpApiClient<RegisterTemporaryWalletSecret200>>) => Promise<RegisterTemporaryWalletSecret200>;
|
|
2322
2444
|
|
|
2323
2445
|
export declare type RegisterTemporaryWalletSecret200 = {
|
|
2324
2446
|
/** A stable, unique identifier for the Temporary Wallet Secret. */
|
|
@@ -2346,6 +2468,7 @@ export declare type RegisterTemporaryWalletSecretBody = {
|
|
|
2346
2468
|
export declare type RegisterTemporaryWalletSecretParams = {
|
|
2347
2469
|
/**
|
|
2348
2470
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2471
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2349
2472
|
*/
|
|
2350
2473
|
projectID?: ProjectIDOptionalParameter;
|
|
2351
2474
|
};
|
|
@@ -2356,14 +2479,14 @@ export declare type RegisterTemporaryWalletSecretResult = NonNullable<Awaited<Re
|
|
|
2356
2479
|
* 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.
|
|
2357
2480
|
* @summary Revoke delegation for end user
|
|
2358
2481
|
*/
|
|
2359
|
-
export declare const revokeDelegationForEndUser: (userId: string, revokeDelegationForEndUserBody: RevokeDelegationForEndUserBody, params?: RevokeDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient
|
|
2482
|
+
export declare const revokeDelegationForEndUser: (userId: string, revokeDelegationForEndUserBody: RevokeDelegationForEndUserBody, params?: RevokeDelegationForEndUserParams, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
|
|
2360
2483
|
|
|
2361
2484
|
/**
|
|
2362
2485
|
* Revokes the active account-scoped delegation for the specified end user account. Other account-scoped delegations for the same user are unaffected. This operation can be performed by the end user themselves or by a developer using their API key.
|
|
2363
2486
|
When the address corresponds to an EVM Smart Account, this revokes the delegation for the Smart Account's owner EOA.
|
|
2364
|
-
* @summary Revoke account-scoped delegation for
|
|
2487
|
+
* @summary Revoke account-scoped delegation for end user
|
|
2365
2488
|
*/
|
|
2366
|
-
export declare const revokeDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, revokeDelegationForEndUserAccountBody: RevokeDelegationForEndUserAccountBody, params?: RevokeDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2489
|
+
export declare const revokeDelegationForEndUserAccount: (userId: string, address: BlockchainAddress, revokeDelegationForEndUserAccountBody: RevokeDelegationForEndUserAccountBody, params?: RevokeDelegationForEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
|
|
2367
2490
|
|
|
2368
2491
|
export declare type RevokeDelegationForEndUserAccountBody = {
|
|
2369
2492
|
/**
|
|
@@ -2376,6 +2499,7 @@ export declare type RevokeDelegationForEndUserAccountBody = {
|
|
|
2376
2499
|
export declare type RevokeDelegationForEndUserAccountParams = {
|
|
2377
2500
|
/**
|
|
2378
2501
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2502
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2379
2503
|
*/
|
|
2380
2504
|
projectID?: ProjectIDOptionalParameter;
|
|
2381
2505
|
};
|
|
@@ -2393,6 +2517,7 @@ export declare type RevokeDelegationForEndUserBody = {
|
|
|
2393
2517
|
export declare type RevokeDelegationForEndUserParams = {
|
|
2394
2518
|
/**
|
|
2395
2519
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2520
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2396
2521
|
*/
|
|
2397
2522
|
projectID?: ProjectIDOptionalParameter;
|
|
2398
2523
|
};
|
|
@@ -2419,13 +2544,14 @@ export declare interface RevokeSpendPermissionRequest {
|
|
|
2419
2544
|
|
|
2420
2545
|
/**
|
|
2421
2546
|
* Revokes an existing spend permission.
|
|
2422
|
-
* @summary Revoke
|
|
2547
|
+
* @summary Revoke spend permission
|
|
2423
2548
|
*/
|
|
2424
|
-
export declare const revokeSpendPermissionWithEndUserAccount: (userId: string, address: string, revokeSpendPermissionRequest: RevokeSpendPermissionRequest, params?: RevokeSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2549
|
+
export declare const revokeSpendPermissionWithEndUserAccount: (userId: string, address: string, revokeSpendPermissionRequest: RevokeSpendPermissionRequest, params?: RevokeSpendPermissionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<EvmUserOperation>>) => Promise<EvmUserOperation>;
|
|
2425
2550
|
|
|
2426
2551
|
export declare type RevokeSpendPermissionWithEndUserAccountParams = {
|
|
2427
2552
|
/**
|
|
2428
2553
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2554
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2429
2555
|
*/
|
|
2430
2556
|
projectID?: ProjectIDOptionalParameter;
|
|
2431
2557
|
};
|
|
@@ -2439,7 +2565,7 @@ declare type SecondParameter<T extends (...args: never) => unknown> = Parameters
|
|
|
2439
2565
|
The `amount` field accepts human-readable amounts as decimal strings (e.g., "1.5", "25.50").
|
|
2440
2566
|
* @summary Send USDC on EVM
|
|
2441
2567
|
*/
|
|
2442
|
-
export declare const sendEvmAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendEvmAssetWithEndUserAccountBody: SendEvmAssetWithEndUserAccountBody, params?: SendEvmAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2568
|
+
export declare const sendEvmAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendEvmAssetWithEndUserAccountBody: SendEvmAssetWithEndUserAccountBody, params?: SendEvmAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SendEvmAssetWithEndUserAccount200>>) => Promise<SendEvmAssetWithEndUserAccount200>;
|
|
2443
2569
|
|
|
2444
2570
|
export declare type SendEvmAssetWithEndUserAccount200 = {
|
|
2445
2571
|
/**
|
|
@@ -2501,6 +2627,7 @@ export declare const SendEvmAssetWithEndUserAccountBodyNetwork: {
|
|
|
2501
2627
|
export declare type SendEvmAssetWithEndUserAccountParams = {
|
|
2502
2628
|
/**
|
|
2503
2629
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2630
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2504
2631
|
*/
|
|
2505
2632
|
projectID?: ProjectIDOptionalParameter;
|
|
2506
2633
|
};
|
|
@@ -2534,9 +2661,9 @@ export declare type SendEvmAssetWithEndUserAccountResult = NonNullable<Awaited<R
|
|
|
2534
2661
|
- `value` *(Optional)*: The amount of ETH, in wei, to send with the transaction.
|
|
2535
2662
|
- `data` *(Optional)*: The data to send with the transaction; only used for contract calls.
|
|
2536
2663
|
- `accessList` *(Optional)*: The access list to use for the transaction.
|
|
2537
|
-
* @summary Send
|
|
2664
|
+
* @summary Send transaction via end user EVM account
|
|
2538
2665
|
*/
|
|
2539
|
-
export declare const sendEvmTransactionWithEndUserAccount: (userId: string, sendEvmTransactionWithEndUserAccountBody: SendEvmTransactionWithEndUserAccountBody, params?: SendEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2666
|
+
export declare const sendEvmTransactionWithEndUserAccount: (userId: string, sendEvmTransactionWithEndUserAccountBody: SendEvmTransactionWithEndUserAccountBody, params?: SendEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SendEvmTransactionWithEndUserAccount200>>) => Promise<SendEvmTransactionWithEndUserAccount200>;
|
|
2540
2667
|
|
|
2541
2668
|
export declare type SendEvmTransactionWithEndUserAccount200 = {
|
|
2542
2669
|
/** The hash of the transaction, as a 0x-prefixed hex string. */
|
|
@@ -2582,6 +2709,7 @@ export declare const SendEvmTransactionWithEndUserAccountBodyNetwork: {
|
|
|
2582
2709
|
export declare type SendEvmTransactionWithEndUserAccountParams = {
|
|
2583
2710
|
/**
|
|
2584
2711
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2712
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2585
2713
|
*/
|
|
2586
2714
|
projectID?: ProjectIDOptionalParameter;
|
|
2587
2715
|
};
|
|
@@ -2594,7 +2722,7 @@ export declare type SendEvmTransactionWithEndUserAccountResult = NonNullable<Awa
|
|
|
2594
2722
|
Use the optional `createRecipientAta` parameter to control whether the sender pays for creating the recipient's Associated Token Account if it doesn't exist.
|
|
2595
2723
|
* @summary Send USDC on Solana
|
|
2596
2724
|
*/
|
|
2597
|
-
export declare const sendSolanaAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendSolanaAssetWithEndUserAccountBody: SendSolanaAssetWithEndUserAccountBody, params?: SendSolanaAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2725
|
+
export declare const sendSolanaAssetWithEndUserAccount: (userId: string, address: BlockchainAddress, asset: "usdc", sendSolanaAssetWithEndUserAccountBody: SendSolanaAssetWithEndUserAccountBody, params?: SendSolanaAssetWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SendSolanaAssetWithEndUserAccount200>>) => Promise<SendSolanaAssetWithEndUserAccount200>;
|
|
2598
2726
|
|
|
2599
2727
|
export declare type SendSolanaAssetWithEndUserAccount200 = {
|
|
2600
2728
|
/** The base58 encoded transaction signature. */
|
|
@@ -2639,6 +2767,7 @@ export declare const SendSolanaAssetWithEndUserAccountBodyNetwork: {
|
|
|
2639
2767
|
export declare type SendSolanaAssetWithEndUserAccountParams = {
|
|
2640
2768
|
/**
|
|
2641
2769
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2770
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2642
2771
|
*/
|
|
2643
2772
|
projectID?: ProjectIDOptionalParameter;
|
|
2644
2773
|
};
|
|
@@ -2660,9 +2789,9 @@ export declare type SendSolanaAssetWithEndUserAccountResult = NonNullable<Awaite
|
|
|
2660
2789
|
* `solana` - Solana Mainnet
|
|
2661
2790
|
* `solana-devnet` - Solana Devnet
|
|
2662
2791
|
The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
|
|
2663
|
-
* @summary Send
|
|
2792
|
+
* @summary Send transaction via end user Solana account
|
|
2664
2793
|
*/
|
|
2665
|
-
export declare const sendSolanaTransactionWithEndUserAccount: (userId: string, sendSolanaTransactionWithEndUserAccountBody: SendSolanaTransactionWithEndUserAccountBody, params?: SendSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2794
|
+
export declare const sendSolanaTransactionWithEndUserAccount: (userId: string, sendSolanaTransactionWithEndUserAccountBody: SendSolanaTransactionWithEndUserAccountBody, params?: SendSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SendSolanaTransactionWithEndUserAccount200>>) => Promise<SendSolanaTransactionWithEndUserAccount200>;
|
|
2666
2795
|
|
|
2667
2796
|
export declare type SendSolanaTransactionWithEndUserAccount200 = {
|
|
2668
2797
|
/** The base58 encoded transaction signature. */
|
|
@@ -2701,6 +2830,7 @@ export declare const SendSolanaTransactionWithEndUserAccountBodyNetwork: {
|
|
|
2701
2830
|
export declare type SendSolanaTransactionWithEndUserAccountParams = {
|
|
2702
2831
|
/**
|
|
2703
2832
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2833
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2704
2834
|
*/
|
|
2705
2835
|
projectID?: ProjectIDOptionalParameter;
|
|
2706
2836
|
};
|
|
@@ -2709,9 +2839,9 @@ export declare type SendSolanaTransactionWithEndUserAccountResult = NonNullable<
|
|
|
2709
2839
|
|
|
2710
2840
|
/**
|
|
2711
2841
|
* Prepares, signs, and sends a user operation for an end user's Smart Account.
|
|
2712
|
-
* @summary Send
|
|
2842
|
+
* @summary Send user operation for end user Smart Account
|
|
2713
2843
|
*/
|
|
2714
|
-
export declare const sendUserOperationWithEndUserAccount: (userId: string, address: string, sendUserOperationWithEndUserAccountBody: SendUserOperationWithEndUserAccountBody, params?: SendUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2844
|
+
export declare const sendUserOperationWithEndUserAccount: (userId: string, address: string, sendUserOperationWithEndUserAccountBody: SendUserOperationWithEndUserAccountBody, params?: SendUserOperationWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<EvmUserOperation>>) => Promise<EvmUserOperation>;
|
|
2715
2845
|
|
|
2716
2846
|
export declare type SendUserOperationWithEndUserAccountBody = {
|
|
2717
2847
|
network: EvmUserOperationNetwork;
|
|
@@ -2736,6 +2866,7 @@ export declare type SendUserOperationWithEndUserAccountBody = {
|
|
|
2736
2866
|
export declare type SendUserOperationWithEndUserAccountParams = {
|
|
2737
2867
|
/**
|
|
2738
2868
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2869
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2739
2870
|
*/
|
|
2740
2871
|
projectID?: ProjectIDOptionalParameter;
|
|
2741
2872
|
};
|
|
@@ -2754,11 +2885,88 @@ export declare type ServiceUnavailableErrorResponse = Error_2;
|
|
|
2754
2885
|
*/
|
|
2755
2886
|
export declare const setAuthManager: (manager: AuthManager) => void;
|
|
2756
2887
|
|
|
2888
|
+
/**
|
|
2889
|
+
* Signs a 32-byte sighash using the child key derived from the end user's Bitcoin HD (Hierarchical Deterministic) account at the given child path. The child path [change, address_index] must correspond to the same path used to derive the address that controls the UTXO being spent. One call is required per UTXO input in the transaction.
|
|
2890
|
+
* @summary Sign a Bitcoin hash with an end user account
|
|
2891
|
+
*/
|
|
2892
|
+
export declare const signBtcHashWithEndUserAccount: (userId: string, signBtcHashWithEndUserAccountBody: SignBtcHashWithEndUserAccountBody, params?: SignBtcHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient>) => Promise<SignBtcHashWithEndUserAccount200>;
|
|
2893
|
+
|
|
2894
|
+
export declare type SignBtcHashWithEndUserAccount200 = {
|
|
2895
|
+
/**
|
|
2896
|
+
* The DER-encoded ECDSA signature as a bare hex string (no 0x prefix), 70–72 bytes (140–144 hex chars). To construct the SegWit witness input, append the sighash type byte (0x01 for SIGHASH_ALL) and push the result onto the witness stack alongside the compressed public key derived from the xpub.
|
|
2897
|
+
* @pattern ^[0-9a-fA-F]{140,144}$
|
|
2898
|
+
*/
|
|
2899
|
+
signature: string;
|
|
2900
|
+
};
|
|
2901
|
+
|
|
2902
|
+
export declare type SignBtcHashWithEndUserAccountBody = {
|
|
2903
|
+
/**
|
|
2904
|
+
* The ID of the Temporary Wallet Secret that was used to sign the X-Wallet-Auth Header.
|
|
2905
|
+
* @pattern ^[a-zA-Z0-9-]{1,100}$
|
|
2906
|
+
*/
|
|
2907
|
+
walletSecretId: string;
|
|
2908
|
+
/** The Bitcoin address type of the account to sign with. */
|
|
2909
|
+
addressType: SignBtcHashWithEndUserAccountBodyAddressType;
|
|
2910
|
+
/** The Bitcoin network of the account to sign with. */
|
|
2911
|
+
network: SignBtcHashWithEndUserAccountBodyNetwork;
|
|
2912
|
+
/** The BIP-32 change level index. 0 for external (receive) addresses, 1 for internal (change) addresses, as defined by BIP-44. */
|
|
2913
|
+
change: SignBtcHashWithEndUserAccountBodyChange;
|
|
2914
|
+
/**
|
|
2915
|
+
* The BIP-32 address index. Must match the index used to derive the address controlling the UTXO being signed.
|
|
2916
|
+
* @minimum 0
|
|
2917
|
+
* @maximum 2147483647
|
|
2918
|
+
*/
|
|
2919
|
+
addressIndex: number;
|
|
2920
|
+
/**
|
|
2921
|
+
* The 32-byte Bitcoin transaction signature hash (sighash) to sign, as a 64-character hex-encoded string (no 0x prefix). This is the precomputed signing digest for a specific UTXO input, not the transaction ID.
|
|
2922
|
+
* @pattern ^[0-9a-fA-F]{64}$
|
|
2923
|
+
*/
|
|
2924
|
+
hash: string;
|
|
2925
|
+
};
|
|
2926
|
+
|
|
2927
|
+
/**
|
|
2928
|
+
* The Bitcoin address type of the account to sign with.
|
|
2929
|
+
*/
|
|
2930
|
+
export declare type SignBtcHashWithEndUserAccountBodyAddressType = (typeof SignBtcHashWithEndUserAccountBodyAddressType)[keyof typeof SignBtcHashWithEndUserAccountBodyAddressType];
|
|
2931
|
+
|
|
2932
|
+
export declare const SignBtcHashWithEndUserAccountBodyAddressType: {
|
|
2933
|
+
readonly segwit: "segwit";
|
|
2934
|
+
};
|
|
2935
|
+
|
|
2936
|
+
/**
|
|
2937
|
+
* The BIP-32 change level index. 0 for external (receive) addresses, 1 for internal (change) addresses, as defined by BIP-44.
|
|
2938
|
+
*/
|
|
2939
|
+
export declare type SignBtcHashWithEndUserAccountBodyChange = (typeof SignBtcHashWithEndUserAccountBodyChange)[keyof typeof SignBtcHashWithEndUserAccountBodyChange];
|
|
2940
|
+
|
|
2941
|
+
export declare const SignBtcHashWithEndUserAccountBodyChange: {
|
|
2942
|
+
readonly NUMBER_0: 0;
|
|
2943
|
+
readonly NUMBER_1: 1;
|
|
2944
|
+
};
|
|
2945
|
+
|
|
2946
|
+
/**
|
|
2947
|
+
* The Bitcoin network of the account to sign with.
|
|
2948
|
+
*/
|
|
2949
|
+
export declare type SignBtcHashWithEndUserAccountBodyNetwork = (typeof SignBtcHashWithEndUserAccountBodyNetwork)[keyof typeof SignBtcHashWithEndUserAccountBodyNetwork];
|
|
2950
|
+
|
|
2951
|
+
export declare const SignBtcHashWithEndUserAccountBodyNetwork: {
|
|
2952
|
+
readonly bitcoin: "bitcoin";
|
|
2953
|
+
readonly "bitcoin-testnet": "bitcoin-testnet";
|
|
2954
|
+
};
|
|
2955
|
+
|
|
2956
|
+
export declare type SignBtcHashWithEndUserAccountParams = {
|
|
2957
|
+
/**
|
|
2958
|
+
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2959
|
+
*/
|
|
2960
|
+
projectID?: ProjectIDOptionalParameter;
|
|
2961
|
+
};
|
|
2962
|
+
|
|
2963
|
+
export declare type SignBtcHashWithEndUserAccountResult = NonNullable<Awaited<ReturnType<typeof signBtcHashWithEndUserAccount>>>;
|
|
2964
|
+
|
|
2757
2965
|
/**
|
|
2758
2966
|
* Signs an arbitrary 32 byte hash with the end user's given EVM account.
|
|
2759
2967
|
* @summary Sign a hash with end user EVM account
|
|
2760
2968
|
*/
|
|
2761
|
-
export declare const signEvmHashWithEndUserAccount: (userId: string, signEvmHashWithEndUserAccountBody: SignEvmHashWithEndUserAccountBody, params?: SignEvmHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
2969
|
+
export declare const signEvmHashWithEndUserAccount: (userId: string, signEvmHashWithEndUserAccountBody: SignEvmHashWithEndUserAccountBody, params?: SignEvmHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignEvmHashWithEndUserAccount200>>) => Promise<SignEvmHashWithEndUserAccount200>;
|
|
2762
2970
|
|
|
2763
2971
|
export declare type SignEvmHashWithEndUserAccount200 = {
|
|
2764
2972
|
/** The signature of the hash, as a 0x-prefixed hex string. */
|
|
@@ -2783,6 +2991,7 @@ export declare type SignEvmHashWithEndUserAccountBody = {
|
|
|
2783
2991
|
export declare type SignEvmHashWithEndUserAccountParams = {
|
|
2784
2992
|
/**
|
|
2785
2993
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
2994
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2786
2995
|
*/
|
|
2787
2996
|
projectID?: ProjectIDOptionalParameter;
|
|
2788
2997
|
};
|
|
@@ -2793,9 +3002,9 @@ export declare type SignEvmHashWithEndUserAccountResult = NonNullable<Awaited<Re
|
|
|
2793
3002
|
* Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given end user EVM account.
|
|
2794
3003
|
|
|
2795
3004
|
Per the specification, the message in the request body is prepended with `0x19 <0x45 (E)> <thereum Signed Message:\n" + len(message)>` before being signed.
|
|
2796
|
-
* @summary Sign
|
|
3005
|
+
* @summary Sign EIP-191 message via end user EVM account
|
|
2797
3006
|
*/
|
|
2798
|
-
export declare const signEvmMessageWithEndUserAccount: (userId: string, signEvmMessageWithEndUserAccountBody: SignEvmMessageWithEndUserAccountBody, params?: SignEvmMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3007
|
+
export declare const signEvmMessageWithEndUserAccount: (userId: string, signEvmMessageWithEndUserAccountBody: SignEvmMessageWithEndUserAccountBody, params?: SignEvmMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignEvmMessageWithEndUserAccount200>>) => Promise<SignEvmMessageWithEndUserAccount200>;
|
|
2799
3008
|
|
|
2800
3009
|
export declare type SignEvmMessageWithEndUserAccount200 = {
|
|
2801
3010
|
/** The signature of the message, as a 0x-prefixed hex string. */
|
|
@@ -2820,6 +3029,7 @@ export declare type SignEvmMessageWithEndUserAccountBody = {
|
|
|
2820
3029
|
export declare type SignEvmMessageWithEndUserAccountParams = {
|
|
2821
3030
|
/**
|
|
2822
3031
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3032
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2823
3033
|
*/
|
|
2824
3034
|
projectID?: ProjectIDOptionalParameter;
|
|
2825
3035
|
};
|
|
@@ -2831,9 +3041,9 @@ export declare type SignEvmMessageWithEndUserAccountResult = NonNullable<Awaited
|
|
|
2831
3041
|
The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/).
|
|
2832
3042
|
|
|
2833
3043
|
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.
|
|
2834
|
-
* @summary Sign
|
|
3044
|
+
* @summary Sign transaction via end user EVM account
|
|
2835
3045
|
*/
|
|
2836
|
-
export declare const signEvmTransactionWithEndUserAccount: (userId: string, signEvmTransactionWithEndUserAccountBody: SignEvmTransactionWithEndUserAccountBody, params?: SignEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3046
|
+
export declare const signEvmTransactionWithEndUserAccount: (userId: string, signEvmTransactionWithEndUserAccountBody: SignEvmTransactionWithEndUserAccountBody, params?: SignEvmTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignEvmTransactionWithEndUserAccount200>>) => Promise<SignEvmTransactionWithEndUserAccount200>;
|
|
2837
3047
|
|
|
2838
3048
|
export declare type SignEvmTransactionWithEndUserAccount200 = {
|
|
2839
3049
|
/** The RLP-encoded signed transaction, as a 0x-prefixed hex string. */
|
|
@@ -2858,6 +3068,7 @@ export declare type SignEvmTransactionWithEndUserAccountBody = {
|
|
|
2858
3068
|
export declare type SignEvmTransactionWithEndUserAccountParams = {
|
|
2859
3069
|
/**
|
|
2860
3070
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3071
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2861
3072
|
*/
|
|
2862
3073
|
projectID?: ProjectIDOptionalParameter;
|
|
2863
3074
|
};
|
|
@@ -2866,9 +3077,9 @@ export declare type SignEvmTransactionWithEndUserAccountResult = NonNullable<Awa
|
|
|
2866
3077
|
|
|
2867
3078
|
/**
|
|
2868
3079
|
* Signs [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data with the given end user EVM account.
|
|
2869
|
-
* @summary Sign EIP-712 typed data
|
|
3080
|
+
* @summary Sign EIP-712 typed data via end user EVM account
|
|
2870
3081
|
*/
|
|
2871
|
-
export declare const signEvmTypedDataWithEndUserAccount: (userId: string, signEvmTypedDataWithEndUserAccountBody: SignEvmTypedDataWithEndUserAccountBody, params?: SignEvmTypedDataWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3082
|
+
export declare const signEvmTypedDataWithEndUserAccount: (userId: string, signEvmTypedDataWithEndUserAccountBody: SignEvmTypedDataWithEndUserAccountBody, params?: SignEvmTypedDataWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignEvmTypedDataWithEndUserAccount200>>) => Promise<SignEvmTypedDataWithEndUserAccount200>;
|
|
2872
3083
|
|
|
2873
3084
|
export declare type SignEvmTypedDataWithEndUserAccount200 = {
|
|
2874
3085
|
/** The signature of the typed data, as a 0x-prefixed hex string. */
|
|
@@ -2892,6 +3103,7 @@ export declare type SignEvmTypedDataWithEndUserAccountBody = {
|
|
|
2892
3103
|
export declare type SignEvmTypedDataWithEndUserAccountParams = {
|
|
2893
3104
|
/**
|
|
2894
3105
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3106
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2895
3107
|
*/
|
|
2896
3108
|
projectID?: ProjectIDOptionalParameter;
|
|
2897
3109
|
};
|
|
@@ -2902,7 +3114,7 @@ export declare type SignEvmTypedDataWithEndUserAccountResult = NonNullable<Await
|
|
|
2902
3114
|
* Signs an arbitrary 32 byte hash with the end user's given Solana account.
|
|
2903
3115
|
* @summary Sign a hash with end user Solana account
|
|
2904
3116
|
*/
|
|
2905
|
-
export declare const signSolanaHashWithEndUserAccount: (userId: string, signSolanaHashWithEndUserAccountBody: SignSolanaHashWithEndUserAccountBody, params?: SignSolanaHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3117
|
+
export declare const signSolanaHashWithEndUserAccount: (userId: string, signSolanaHashWithEndUserAccountBody: SignSolanaHashWithEndUserAccountBody, params?: SignSolanaHashWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignSolanaHashWithEndUserAccount200>>) => Promise<SignSolanaHashWithEndUserAccount200>;
|
|
2906
3118
|
|
|
2907
3119
|
export declare type SignSolanaHashWithEndUserAccount200 = {
|
|
2908
3120
|
/** The signature of the hash, as a base58 encoded string. */
|
|
@@ -2927,6 +3139,7 @@ export declare type SignSolanaHashWithEndUserAccountBody = {
|
|
|
2927
3139
|
export declare type SignSolanaHashWithEndUserAccountParams = {
|
|
2928
3140
|
/**
|
|
2929
3141
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3142
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2930
3143
|
*/
|
|
2931
3144
|
projectID?: ProjectIDOptionalParameter;
|
|
2932
3145
|
};
|
|
@@ -2936,9 +3149,9 @@ export declare type SignSolanaHashWithEndUserAccountResult = NonNullable<Awaited
|
|
|
2936
3149
|
/**
|
|
2937
3150
|
* Signs an arbitrary Base64 encoded message with the given Solana account.
|
|
2938
3151
|
**WARNING:** Never sign a message that you didn't generate as it may put your funds at risk.
|
|
2939
|
-
* @summary Sign
|
|
3152
|
+
* @summary Sign Base64-encoded message
|
|
2940
3153
|
*/
|
|
2941
|
-
export declare const signSolanaMessageWithEndUserAccount: (userId: string, signSolanaMessageWithEndUserAccountBody: SignSolanaMessageWithEndUserAccountBody, params?: SignSolanaMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3154
|
+
export declare const signSolanaMessageWithEndUserAccount: (userId: string, signSolanaMessageWithEndUserAccountBody: SignSolanaMessageWithEndUserAccountBody, params?: SignSolanaMessageWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignSolanaMessageWithEndUserAccount200>>) => Promise<SignSolanaMessageWithEndUserAccount200>;
|
|
2942
3155
|
|
|
2943
3156
|
export declare type SignSolanaMessageWithEndUserAccount200 = {
|
|
2944
3157
|
/** The signature of the message, as a base58 encoded string. */
|
|
@@ -2963,6 +3176,7 @@ export declare type SignSolanaMessageWithEndUserAccountBody = {
|
|
|
2963
3176
|
export declare type SignSolanaMessageWithEndUserAccountParams = {
|
|
2964
3177
|
/**
|
|
2965
3178
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3179
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
2966
3180
|
*/
|
|
2967
3181
|
projectID?: ProjectIDOptionalParameter;
|
|
2968
3182
|
};
|
|
@@ -2977,9 +3191,9 @@ export declare type SignSolanaMessageWithEndUserAccountResult = NonNullable<Awai
|
|
|
2977
3191
|
* [Legacy transactions](https://solana-labs.github.io/solana-web3.js/classes/Transaction.html)
|
|
2978
3192
|
* [Versioned transactions](https://solana-labs.github.io/solana-web3.js/classes/VersionedTransaction.html)
|
|
2979
3193
|
The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.
|
|
2980
|
-
* @summary Sign
|
|
3194
|
+
* @summary Sign transaction via end user Solana account
|
|
2981
3195
|
*/
|
|
2982
|
-
export declare const signSolanaTransactionWithEndUserAccount: (userId: string, signSolanaTransactionWithEndUserAccountBody: SignSolanaTransactionWithEndUserAccountBody, params?: SignSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient
|
|
3196
|
+
export declare const signSolanaTransactionWithEndUserAccount: (userId: string, signSolanaTransactionWithEndUserAccountBody: SignSolanaTransactionWithEndUserAccountBody, params?: SignSolanaTransactionWithEndUserAccountParams, options?: SecondParameter<typeof cdpApiClient<SignSolanaTransactionWithEndUserAccount200>>) => Promise<SignSolanaTransactionWithEndUserAccount200>;
|
|
2983
3197
|
|
|
2984
3198
|
export declare type SignSolanaTransactionWithEndUserAccount200 = {
|
|
2985
3199
|
/** The base64 encoded signed transaction. */
|
|
@@ -3004,6 +3218,7 @@ export declare type SignSolanaTransactionWithEndUserAccountBody = {
|
|
|
3004
3218
|
export declare type SignSolanaTransactionWithEndUserAccountParams = {
|
|
3005
3219
|
/**
|
|
3006
3220
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3221
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
3007
3222
|
*/
|
|
3008
3223
|
projectID?: ProjectIDOptionalParameter;
|
|
3009
3224
|
};
|
|
@@ -3125,7 +3340,7 @@ export declare interface SpendPermissionResponseObject {
|
|
|
3125
3340
|
* Submits an MFA code to complete the enrollment process. On success, the MFA configuration is persisted to the end user.
|
|
3126
3341
|
* @summary Submit MFA enrollment
|
|
3127
3342
|
*/
|
|
3128
|
-
export declare const submitMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", submitMfaEnrollmentBody: SubmitMfaEnrollmentBody, params?: SubmitMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient
|
|
3343
|
+
export declare const submitMfaEnrollment: (userId: string, mfaMethod: "totp" | "sms", submitMfaEnrollmentBody: SubmitMfaEnrollmentBody, params?: SubmitMfaEnrollmentParams, options?: SecondParameter<typeof cdpApiClient<SubmitMfaEnrollment200>>) => Promise<SubmitMfaEnrollment200>;
|
|
3129
3344
|
|
|
3130
3345
|
/**
|
|
3131
3346
|
* Response after successful MFA enrollment with updated end user.
|
|
@@ -3148,6 +3363,7 @@ export declare type SubmitMfaEnrollmentBody = {
|
|
|
3148
3363
|
export declare type SubmitMfaEnrollmentParams = {
|
|
3149
3364
|
/**
|
|
3150
3365
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3366
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
3151
3367
|
*/
|
|
3152
3368
|
projectID?: ProjectIDOptionalParameter;
|
|
3153
3369
|
};
|
|
@@ -3158,7 +3374,7 @@ export declare type SubmitMfaEnrollmentResult = NonNullable<Awaited<ReturnType<t
|
|
|
3158
3374
|
* Submits an MFA code to complete the verification process.
|
|
3159
3375
|
* @summary Submit MFA verification
|
|
3160
3376
|
*/
|
|
3161
|
-
export declare const submitMfaVerification: (userId: string, mfaMethod: "totp" | "sms", submitMfaVerificationBody: SubmitMfaVerificationBody, params?: SubmitMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient
|
|
3377
|
+
export declare const submitMfaVerification: (userId: string, mfaMethod: "totp" | "sms", submitMfaVerificationBody: SubmitMfaVerificationBody, params?: SubmitMfaVerificationParams, options?: SecondParameter<typeof cdpApiClient<void>>) => Promise<void>;
|
|
3162
3378
|
|
|
3163
3379
|
/**
|
|
3164
3380
|
* Request to submit MFA code for verification.
|
|
@@ -3174,6 +3390,7 @@ export declare type SubmitMfaVerificationBody = {
|
|
|
3174
3390
|
export declare type SubmitMfaVerificationParams = {
|
|
3175
3391
|
/**
|
|
3176
3392
|
* The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
|
|
3393
|
+
* @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
3177
3394
|
*/
|
|
3178
3395
|
projectID?: ProjectIDOptionalParameter;
|
|
3179
3396
|
};
|
|
@@ -3306,7 +3523,7 @@ export declare interface UserOperationReceiptRevert {
|
|
|
3306
3523
|
* Verifies the end user's email address using a one-time password. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
3307
3524
|
* @summary Verify end user email address
|
|
3308
3525
|
*/
|
|
3309
|
-
export declare const verifyEmailAuthentication: (projectId: string, verifyEmailAuthenticationRequest: VerifyEmailAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient
|
|
3526
|
+
export declare const verifyEmailAuthentication: (projectId: string, verifyEmailAuthenticationRequest: VerifyEmailAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifyEmailAuthentication200>>) => Promise<VerifyEmailAuthentication200>;
|
|
3310
3527
|
|
|
3311
3528
|
export declare type VerifyEmailAuthentication200 = {
|
|
3312
3529
|
endUser: EndUser;
|
|
@@ -3350,7 +3567,7 @@ export declare interface VerifyOAuthAppleNativeRequest {
|
|
|
3350
3567
|
* Verifies the end user's OAuth code. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
3351
3568
|
* @summary Verify end user OAuth code
|
|
3352
3569
|
*/
|
|
3353
|
-
export declare const verifyOAuthCode: (projectId: string, providerType: OAuth2ProviderType, verifyOAuthCodeRequest: VerifyOAuthCodeRequest, options?: SecondParameter<typeof cdpApiClient
|
|
3570
|
+
export declare const verifyOAuthCode: (projectId: string, providerType: OAuth2ProviderType, verifyOAuthCodeRequest: VerifyOAuthCodeRequest, options?: SecondParameter<typeof cdpApiClient<VerifyOAuthCode200>>) => Promise<VerifyOAuthCode200>;
|
|
3354
3571
|
|
|
3355
3572
|
export declare type VerifyOAuthCode200 = {
|
|
3356
3573
|
endUser: EndUser;
|
|
@@ -3387,7 +3604,7 @@ export declare type VerifyOAuthEndUserIdentity = VerifyOAuthTelegramRequest | Ve
|
|
|
3387
3604
|
* Verifies the end user's identity using data from a third-party provider like Telegram or Apple native sign-in that does not support code-based OAuth flows and only provides user data to flows initiated on a bot's domain. This is optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
3388
3605
|
* @summary Verify third-party end user identity
|
|
3389
3606
|
*/
|
|
3390
|
-
export declare const verifyOAuthEndUserIdentity: (projectId: string, providerType: OAuth2ProviderType, verifyOAuthEndUserIdentity: VerifyOAuthEndUserIdentity, options?: SecondParameter<typeof cdpApiClient
|
|
3607
|
+
export declare const verifyOAuthEndUserIdentity: (projectId: string, providerType: OAuth2ProviderType, verifyOAuthEndUserIdentity: VerifyOAuthEndUserIdentity, options?: SecondParameter<typeof cdpApiClient<VerifyOAuthEndUserIdentity200>>) => Promise<VerifyOAuthEndUserIdentity200>;
|
|
3391
3608
|
|
|
3392
3609
|
export declare type VerifyOAuthEndUserIdentity200 = {
|
|
3393
3610
|
endUser: EndUser;
|
|
@@ -3431,7 +3648,7 @@ export declare interface VerifyOAuthTelegramRequest {
|
|
|
3431
3648
|
* Verifies the end user's Sign In With Ethereum (EIP-4361) signature. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
3432
3649
|
* @summary Verify end user SIWE signature
|
|
3433
3650
|
*/
|
|
3434
|
-
export declare const verifySiweAuthentication: (projectId: string, verifySiweAuthenticationRequest: VerifySiweAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient
|
|
3651
|
+
export declare const verifySiweAuthentication: (projectId: string, verifySiweAuthenticationRequest: VerifySiweAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifySiweAuthentication200>>) => Promise<VerifySiweAuthentication200>;
|
|
3435
3652
|
|
|
3436
3653
|
export declare type VerifySiweAuthentication200 = {
|
|
3437
3654
|
endUser: EndUser;
|
|
@@ -3463,7 +3680,7 @@ export declare type VerifySiweAuthenticationResult = NonNullable<Awaited<ReturnT
|
|
|
3463
3680
|
* Verifies the end user's phone number using a one-time password sent via SMS. This is an optionally authenticated endpoint. The API returns an access token that can be used to authenticate subsequent requests to the Embedded Wallet APIs, as well as a refresh token set in the `Set-Cookie` header for non-WebKit user agents, otherwise returned in the response body. If a valid access token is included in the Authorization header, the authentication method is added to the existing user associated with the token. If the authentication method already exists, an error is returned.
|
|
3464
3681
|
* @summary Verify end user phone number
|
|
3465
3682
|
*/
|
|
3466
|
-
export declare const verifySmsAuthentication: (projectId: string, verifySmsAuthenticationRequest: VerifySmsAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient
|
|
3683
|
+
export declare const verifySmsAuthentication: (projectId: string, verifySmsAuthenticationRequest: VerifySmsAuthenticationRequest, options?: SecondParameter<typeof cdpApiClient<VerifySmsAuthentication200>>) => Promise<VerifySmsAuthentication200>;
|
|
3467
3684
|
|
|
3468
3685
|
export declare type VerifySmsAuthentication200 = {
|
|
3469
3686
|
endUser: EndUser;
|