@circle-fin/developer-controlled-wallets 10.1.0 → 10.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/dist/developer-controlled-wallets.cjs.js +29 -26
- package/dist/developer-controlled-wallets.es.js +29 -26
- package/dist/types/clients/configurations.d.ts +30 -29
- package/dist/types/clients/core.d.ts +2 -1
- package/dist/types/clients/developer-controlled-wallets.d.ts +109 -108
- package/dist/types/developer-controlled-wallets.d.ts +2 -1
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Circle's Developer Controlled Wallets NodeJS SDK
|
|
2
2
|
|
|
3
|
-
This SDK provides convenient access to Circle's Developer 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 Developer 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,7 +13,7 @@ npm install @circle-fin/developer-controlled-wallets --save
|
|
|
13
13
|
or
|
|
14
14
|
|
|
15
15
|
```sh
|
|
16
|
-
|
|
16
|
+
pnpm add @circle-fin/developer-controlled-wallets
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
@@ -39,7 +39,7 @@ yarn add @circle-fin/developer-controlled-wallets
|
|
|
39
39
|
> [!IMPORTANT]
|
|
40
40
|
Protect your Entity Secret as you would protect your house key. Losing it or sharing it with others can have serious consequences. As the name suggests, the Entity Secret is sensitive information. Store it securely and treat it with the highest level of confidentiality to prevent unauthorized access or use.
|
|
41
41
|
|
|
42
|
-
3. Register the entity secret either by using the SDK or by following Circle's [Developer-Controlled QuickStart](https://developers.circle.com/
|
|
42
|
+
3. Register the entity secret either by using the SDK or by following Circle's [Developer-Controlled QuickStart](https://developers.circle.com/wallets/dev-controlled/create-your-first-wallet). This step ensures that your account is correctly set up to interact with Circle's APIs.
|
|
43
43
|
|
|
44
44
|
```javascript
|
|
45
45
|
const { registerEntitySecretCiphertext } = require('@circle-fin/developer-controlled-wallets')
|
|
@@ -106,7 +106,7 @@ The `registerEntitySecretCiphertext` function downloads a recovery file named `r
|
|
|
106
106
|
console.log('Created Wallets', walletsResponse.data?.wallets)
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
-
We recommend reading through the official [documentation](https://developers.circle.com/
|
|
109
|
+
We recommend reading through the official [documentation](https://developers.circle.com/wallets/dev-controlled) and [QuickStart guides](https://developers.circle.com/build-onchain) mentioned above to ensure a smooth setup and usage experience.
|
|
110
110
|
|
|
111
111
|
## Configuration
|
|
112
112
|
|
|
@@ -115,7 +115,7 @@ The client accepts the following configuration parameters:
|
|
|
115
115
|
| Option | Required | Description |
|
|
116
116
|
| -------------- | ----------- | --------------------------------------------------------------------------------------------------------------- |
|
|
117
117
|
| `apiKey` | [x] | Api Key that is used to authenticate against Circle APIs. |
|
|
118
|
-
| `entitySecret` | [x] | Your configured entity secret. You can follow the [QuickStart](https://
|
|
118
|
+
| `entitySecret` | [x] | Your configured entity secret. You can follow the [QuickStart](https://developers.circle.com/wallets/dev-controlled/entity-secret-management) to set it up. |
|
|
119
119
|
| `baseUrl` | [ ] | Optional base URL to override the default: `https://api.circle.com`. |
|
|
120
120
|
| `storage` | [ ] | Optional custom storage solution for persisting data. We will fallback to InMemoryStorage if none was provided. |
|
|
121
121
|
| `userAgent` | [ ] | Optional custom user agent request header. We will prepend it to default user agent header if provided. |
|
|
@@ -124,10 +124,10 @@ The client accepts the following configuration parameters:
|
|
|
124
124
|
|
|
125
125
|
Here are some helpful links, if you encounter any issues or have questions about this SDK:
|
|
126
126
|
|
|
127
|
-
- 🎥 [Watch and learn](https://www.youtube.com/watch?v=17hOaMNf87s&list=PLoJwRn8qrG26yB_Y5uLpamwzp1onYMe7O): Watch our step-by-step walkthrough of our official [Developer-Controlled Wallets QuickStart](https://
|
|
127
|
+
- 🎥 [Watch and learn](https://www.youtube.com/watch?v=17hOaMNf87s&list=PLoJwRn8qrG26yB_Y5uLpamwzp1onYMe7O): Watch our step-by-step walkthrough of our official [Developer-Controlled Wallets QuickStart](https://developers.circle.com/wallets/dev-controlled/create-your-first-wallet).
|
|
128
128
|
- 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
|
|
129
|
-
- 🛎 [Visit our Help-Desk Page](https://
|
|
129
|
+
- 🛎 [Visit our Help-Desk Page](https://help.circle.com/s/submit-ticket): Dive into curated FAQs and guides.
|
|
130
130
|
- 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
|
|
131
|
-
- 📖 [Read docs](https://developers.circle.com/
|
|
131
|
+
- 📖 [Read docs](https://developers.circle.com/wallets): Check out our developer documentation.
|
|
132
132
|
|
|
133
133
|
Happy coding!
|