@circle-fin/user-controlled-wallets 10.2.0 → 10.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist/types/clients/configurations.d.ts +2 -1
- package/dist/types/clients/core.d.ts +2 -1
- package/dist/types/clients/user-controlled-wallets.d.ts +2 -1
- package/dist/types/user-controlled-wallets.d.ts +2 -1
- package/dist/user-controlled-wallets.cjs.js +27 -24
- package/dist/user-controlled-wallets.es.js +27 -24
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Circle's User Controlled Wallets NodeJS SDK
|
|
2
2
|
|
|
3
|
-
This SDK provides convenient access to Circle's User Controlled Wallets APIs for applications written in NodeJS. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/api-reference/
|
|
3
|
+
This SDK provides convenient access to Circle's User Controlled Wallets APIs for applications written in NodeJS. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/api-reference/wallets/common/ping).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -13,14 +13,14 @@ npm install @circle-fin/user-controlled-wallets --save
|
|
|
13
13
|
or
|
|
14
14
|
|
|
15
15
|
```sh
|
|
16
|
-
|
|
16
|
+
pnpm add @circle-fin/user-controlled-wallets
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
20
20
|
|
|
21
21
|
1. Generate an API key, if you haven't already, in the [Web3 Services Console](https://console.circle.com/api-keys). This API key will be used for authentication and authorization when making requests to Circle's APIs.
|
|
22
22
|
|
|
23
|
-
2. Follow our [User-Controlled QuickStart](https://developers.circle.com/
|
|
23
|
+
2. Follow our [User-Controlled QuickStart](https://developers.circle.com/wallets/user-controlled/create-user-wallets-with-social-login). This step ensures that you fully grasp the concept of Circle's User-Controlled Wallets.
|
|
24
24
|
|
|
25
25
|
3. In your code, import the factory `initiateUserControlledWalletsClient` from the SDK and initialize the client using your API key and entity secret:
|
|
26
26
|
|
|
@@ -61,7 +61,7 @@ yarn add @circle-fin/user-controlled-wallets
|
|
|
61
61
|
console.log(response.data?.challengeId)
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
We recommend reading through the official [documentation](https://developers.circle.com/
|
|
64
|
+
We recommend reading through the official [documentation](https://developers.circle.com/wallets/user-controlled) and [QuickStart guides](https://developers.circle.com/build-onchain) mentioned above to ensure a smooth setup and usage experience.
|
|
65
65
|
|
|
66
66
|
## Configuration
|
|
67
67
|
|
|
@@ -78,10 +78,10 @@ The client accepts the following configuration parameters:
|
|
|
78
78
|
|
|
79
79
|
Here are some helpful links, if you encounter any issues or have questions about this SDK:
|
|
80
80
|
|
|
81
|
-
- 📖 [Getting started](https://
|
|
81
|
+
- 📖 [Getting started](https://developers.circle.com/wallets/user-controlled/create-user-wallets-with-social-login): Check out our official User-Controlled Wallets QuickStart.
|
|
82
82
|
- 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
|
|
83
|
-
- 🛎 [Visit our Help-Desk Page](https://
|
|
83
|
+
- 🛎 [Visit our Help-Desk Page](https://help.circle.com/s/submit-ticket): Dive into curated FAQs and guides.
|
|
84
84
|
- 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
|
|
85
|
-
- 📖 [Read docs](https://developers.circle.com/
|
|
85
|
+
- 📖 [Read docs](https://developers.circle.com/wallets): Check out our developer documentation.
|
|
86
86
|
|
|
87
87
|
Happy coding!
|
|
@@ -1611,4 +1611,5 @@ declare class ConfigurationsClient {
|
|
|
1611
1611
|
constructor(baseUrl: string, config: ClientConfig, headers?: Record<string, string>);
|
|
1612
1612
|
}
|
|
1613
1613
|
|
|
1614
|
-
export {
|
|
1614
|
+
export { Blockchain, ConfigurationsClient, DeveloperAccountApi, DeveloperAccountApiAxiosParamCreator, DeveloperAccountApiFactory, DeveloperAccountApiFp, FaucetApi, FaucetApiAxiosParamCreator, FaucetApiFactory, FaucetApiFp, HealthApi, HealthApiAxiosParamCreator, HealthApiFactory, HealthApiFp, MonitorTokensApi, MonitorTokensApiAxiosParamCreator, MonitorTokensApiFactory, MonitorTokensApiFp, NotificationType, TestnetBlockchain, TokenMonitorScope, TokenStandard, WebhookSubscriptionsApi, WebhookSubscriptionsApiAxiosParamCreator, WebhookSubscriptionsApiFactory, WebhookSubscriptionsApiFp };
|
|
1615
|
+
export type { BadRequestResponse, CreateMonitoredTokensRequest, CreateSubscriptionRequest, DeleteMonitoredTokensRequest, EntityConfig, EntityConfigData, FaucetRequest, ModelError, MonitoredTokens, MonitoredTokensData, NotAuthorizedResponse, NotFoundResponse, NotificationSignaturePublicKey, NotificationSignaturePublicKeyData, Ping, PublicKey, PublicKeyData, Subscription, SubscriptionResponse, Subscriptions, Token, UpdateMonitoredTokensRequest, UpdateMonitoredTokensScopeRequest, UpdateSubscriptionRequest };
|
|
@@ -1556,4 +1556,5 @@ declare class Error177901 extends HttpResponseError {
|
|
|
1556
1556
|
static readonly message = "smart contract query failed";
|
|
1557
1557
|
}
|
|
1558
1558
|
|
|
1559
|
-
export {
|
|
1559
|
+
export { BadGatewayError, BadRequestError, ConnectionAbortedError, ConnectionRefusedError, ConnectionResetError, ConnectionTimeoutError, DNSNotFoundError, DNSTimeoutError, Error110700, Error110701, Error110702, Error110703, Error155101, Error155102, Error155103, Error155104, Error155105, Error155106, Error155107, Error155108, Error155109, Error155110, Error155111, Error155112, Error155113, Error155114, Error155115, Error155116, Error155117, Error155118, Error155119, Error155120, Error155121, Error155122, Error155123, Error155124, Error155130, Error155131, Error155132, Error155133, Error155134, Error155135, Error155136, Error155137, Error155138, Error155139, Error155140, Error155141, Error155142, Error155143, Error155144, Error155145, Error155146, Error155150, Error155151, Error155152, Error155154, Error155155, Error155156, Error155157, Error155158, Error155159, Error155160, Error155201, Error155202, Error155203, Error155204, Error155205, Error155206, Error155207, Error155208, Error155209, Error155210, Error155211, Error155215, Error155218, Error155219, Error155220, Error155221, Error155222, Error155223, Error155224, Error155225, Error155226, Error155227, Error155228, Error155229, Error155230, Error155231, Error155232, Error155233, Error155234, Error155235, Error155236, Error155237, Error155238, Error155239, Error155240, Error155241, Error155242, Error155243, Error155244, Error155245, Error155247, Error155254, Error155257, Error155258, Error155262, Error155264, Error155501, Error155502, Error155503, Error155504, Error155505, Error155506, Error155507, Error155508, Error155509, Error155510, Error155511, Error155512, Error155514, Error155515, Error155516, Error155517, Error155601, Error155701, Error155702, Error155703, Error155704, Error155705, Error155706, Error155707, Error155708, Error155709, Error155710, Error155711, Error155712, Error155713, Error155714, Error155715, Error155716, Error155717, Error155718, Error155719, Error155720, Error155721, Error155801, Error155802, Error155803, Error155804, Error155805, Error155806, Error155807, Error155808, Error156001, Error156002, Error156003, Error156004, Error156005, Error156006, Error156007, Error156008, Error156009, Error156010, Error156011, Error156012, Error156013, Error156014, Error156015, Error156016, Error156017, Error156018, Error156019, Error156020, Error156021, Error156023, Error156024, Error156025, Error156026, Error156027, Error156030, Error156031, Error156032, Error175001, Error175002, Error175003, Error175004, Error175005, Error175006, Error175007, Error175008, Error175009, Error175010, Error175011, Error175012, Error175013, Error175201, Error175202, Error175203, Error175204, Error175205, Error175301, Error175302, Error175303, Error175401, Error175402, Error175403, Error175404, Error175405, Error175406, Error175407, Error175408, Error175409, Error175410, Error177001, Error177002, Error177003, Error177004, Error177005, Error177006, Error177007, Error177008, Error177009, Error177010, Error177011, Error177012, Error177013, Error177014, Error177015, Error177016, Error177017, Error177018, Error177019, Error177020, Error177021, Error177022, Error177023, Error177024, Error177025, Error177026, Error177301, Error177302, Error177303, Error177304, Error177305, Error177601, Error177602, Error177603, Error177604, Error177605, Error177606, Error177607, Error177901, ForbiddenError, GatewayTimeoutError, HostUnreachableError, HttpError, HttpRequestError, HttpResponseError, InMemoryStorage, InternalServerError, NetworkUnreachableError, NotFoundError, NotImplementedError, RatelimitError, ServiceUnavailableError, UnauthorizedError, createMonitoredTokens, createSubscription, deleteMonitoredTokens, deleteSubscription, fromAxiosError, generateEntitySecretCiphertext, generateIdempotencyKey, getNotificationSignature, getPublicKey, getSubscription, listMonitoredTokens, listSubscriptions, requestTestnetTokens, resolvePathRelativeToAppDir, trimData, updateMonitoredTokens, updateMonitoredTokensScope, updateSubscription };
|
|
1560
|
+
export type { APIParams, APIReturnType, ClientParams, Common, CreateMonitoredTokensInput, CreateSubscriptionInput, DeleteMonitoredTokensInput, FeeConfiguration, ListMonitoredTokensInput, Pagination, RequestTestnetTokensInput, Storage, TrimDataResponse, UpdateMonitoredTokensInput, UpdateMonitoredTokensScopeInput, UpdateSubscriptionInput, WithIdempotencyKey };
|
|
@@ -5257,4 +5257,5 @@ declare class UserControlledWalletsClient {
|
|
|
5257
5257
|
constructor(baseUrl: string, config: ClientConfig, headers?: Record<string, string>);
|
|
5258
5258
|
}
|
|
5259
5259
|
|
|
5260
|
-
export {
|
|
5260
|
+
export { AccountType, Blockchain, ChallengeStatusEnum, ChallengeTypeEnum, ContractExecutionBlockchain, CustodyType, EndUserSecurityQuestionStatusEnum, EndUserStatus, FeeLevel, ListTransactionsOperationEnum, ListTransactionsOrderEnum, ListUserChallengesStatusEnum, ListUsersOrderEnum, ListUsersPinStatusEnum, ListUsersSecurityQuestionStatusEnum, ListWalletsOrderEnum, NewScaCore, Operation, PINAuthenticationApi, PINAuthenticationApiAxiosParamCreator, PINAuthenticationApiFactory, PINAuthenticationApiFp, PinStatus, RiskAction, RiskCategory, RiskScore, RiskSignalSourceEnum, RiskType, ScaCore, SigningApi, SigningApiAxiosParamCreator, SigningApiFactory, SigningApiFp, SocialEmailAuthenticationApi, SocialEmailAuthenticationApiAxiosParamCreator, SocialEmailAuthenticationApiFactory, SocialEmailAuthenticationApiFp, TokenBlockchain, TokenLookupApi, TokenLookupApiAxiosParamCreator, TokenLookupApiFactory, TokenLookupApiFp, TokenStandard, TransactionState, TransactionType, TransactionsApi, TransactionsApiAxiosParamCreator, TransactionsApiFactory, TransactionsApiFp, UserControlledWalletsClient, UsersApi, UsersApiAxiosParamCreator, UsersApiFactory, UsersApiFp, WalletState, WalletsApi, WalletsApiAxiosParamCreator, WalletsApiFactory, WalletsApiFp };
|
|
5261
|
+
export type { AbiParametersInner, AccelerateTransactionForEndUserRequest, AccelerateTransactionForEndUserResponse, BadRequestResponse, Balance, Balances, BalancesData, BaseScreeningDecision, CancelTransactionForEndUserRequest, CancelTransactionForEndUserResponse, Challenge, ChallengeResponse, ChallengeResponseData, Challenges, ChallengesData, CreateContractExecutionTransactionForEndUserRequest, CreateContractExecutionTransactionForEndUserResponse, CreateEndUserWallet, CreateEndUserWalletRequest, CreateTransferTransactionForEndUserRequest, CreateTransferTransactionForEndUserResponse, CreateUserRequest, CreateWalletUpgradeTransactionForEndUserRequest, CreateWalletUpgradeTransactionForEndUserResponse, DeviceTokenEmail, DeviceTokenEmailData, DeviceTokenEmailRequest, DeviceTokenSocial, DeviceTokenSocialData, DeviceTokenSocialRequest, EOAWallet, EndUser, EstimateContractExecutionTransactionFeeRequest, EstimateTransactionFee, EstimateTransactionFeeData, EstimateTransferTransactionFeeRequest, GetLowestNonceTransactionResponse, GetLowestNonceTransactionResponseData, GetUserByIDResponse, GetUserByIDResponseData, LowestNonceTransactionFeeInfo, ModelError, Nft, Nfts, NftsData, NotAuthorizedResponse, NotFoundResponse, Pin, PinData, PinSecurityDetails, RefreshUserToken, RefreshUserTokenData, RefreshUserTokenRequest, ResendOTPRequest, ResentOTP, ResentOTPData, RiskSignal, SCAWallet, SetPinAndInitWalletRequest, SetPinRequest, SignMessageRequest, SignTransactionResponse, SignTypedDataRequest, SignUserTransactionRequest, Signature, Token, TokenResponse, TokenResponseData, Transaction, TransactionFee, TransactionResponse, TransactionResponseData, TransactionScreeningDecision, Transactions, TransactionsData, UpdateWalletRequest, UserResponse, UserTokenRequest, UserTokenResponse, UserTokenResponseData, Users, UsersData, ValidateAddress, ValidateAddressData, ValidateAddressRequest, Wallet, WalletMetadata, WalletResponse, WalletResponseData, WalletResponseDataWallet, Wallets, WalletsData };
|
|
@@ -1338,4 +1338,5 @@ declare class CircleUserControlledWalletsClient {
|
|
|
1338
1338
|
*/
|
|
1339
1339
|
declare function initiateUserControlledWalletsClient(config: ClientParams): CircleUserControlledWalletsClient;
|
|
1340
1340
|
|
|
1341
|
-
export {
|
|
1341
|
+
export { CircleUserControlledWalletsClient, defaultBaseUrl, initiateUserControlledWalletsClient };
|
|
1342
|
+
export type { APIParams, AccelerateTransactionInput, CancelTransactionInput, ClientParams, CreateContractExecutionTransactionInput, CreateDeviceTokenForEmailLoginInput, CreateDeviceTokenForSocialLoginInput, CreateTransactionInput, CreateUserInput, CreateUserPinWithWalletsInput, CreateUserTokenInput, CreateWalletsInput, EstimateContractExecutionFeeInput, EstimateTransferFeeInput, GetLowestNonceTransactionInput, GetTokenInput, GetTransactionInput, GetUserByTokenInput, GetUserChallengeInput, GetUserInput, GetWalletInput, GetWalletNFTBalanceInput, GetWalletTokenBalanceInput, ListTransactionsInput, ListUserChallengesInput, ListUsersInput, ListWalletsFilterInput, ManageUserPinInput, RefreshUserTokenInput, ResendOTPInput, SignMessageInput, SignTransactionInput, SignTypedDataInput, TokenAddressAndBlockchainInput, TokenIdInput, TokenInfo, UpdateWalletInput, UserIdInput, UserIdOrTokenInput, UserTokenInput, ValidateAddressInput };
|