@circle-fin/smart-contract-platform 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.
Files changed (8) hide show
  1. package/README.md +8 -8
  2. package/dist/smart-contract-platform.cjs.js +26 -23
  3. package/dist/smart-contract-platform.es.js +26 -23
  4. package/dist/types/clients/configurations.d.ts +30 -29
  5. package/dist/types/clients/core.d.ts +2 -1
  6. package/dist/types/clients/smart-contract-platform.d.ts +64 -57
  7. package/dist/types/smart-contract-platform.d.ts +6 -1
  8. package/package.json +8 -7
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Circle's Smart Contract Platform NodeJS SDK
2
2
 
3
- This SDK provides convenient access to Circle's Smart Contract Platform APIs for applications written in NodeJS. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/api-reference/w3s/smart-contract-platform/estimate-contract-template-deploy).
3
+ This SDK provides convenient access to Circle's Smart Contract Platform APIs for applications written in NodeJS. For the API reference, see the [Circle Web3 API docs](https://developers.circle.com/api-reference/contracts/common/ping).
4
4
 
5
5
  ## Installation
6
6
 
@@ -13,14 +13,14 @@ npm install @circle-fin/smart-contract-platform --save
13
13
  or
14
14
 
15
15
  ```sh
16
- yarn add @circle-fin/smart-contract-platform
16
+ pnpm add @circle-fin/smart-contract-platform
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. Register an entity secret following Circle's [Developer-Controlled QuickStart](https://developers.circle.com/interactive-quickstarts/dev-controlled-wallets). This step ensures that your account is correctly set up to interact with Circle's APIs.
23
+ 2. Register an entity secret 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.
24
24
 
25
25
  3. In your code, import the factory `initiateSmartContractPlatformClient` from the SDK and initialize the client using your API key and entity secret:
26
26
 
@@ -59,7 +59,7 @@ yarn add @circle-fin/smart-contract-platform
59
59
  console.log(response.data)
60
60
  ```
61
61
 
62
- We recommend reading through the official [documentation](https://developers.circle.com/w3s/smart-contract-platform) and [QuickStart guides](https://developers.circle.com/interactive-quickstarts) mentioned above to ensure a smooth setup and usage experience.
62
+ We recommend reading through the official [documentation](https://developers.circle.com/contracts) and [QuickStart guides](https://developers.circle.com/build-onchain) mentioned above to ensure a smooth setup and usage experience.
63
63
 
64
64
  ## Configuration
65
65
 
@@ -68,7 +68,7 @@ The client accepts the following configuration parameters:
68
68
  | Option | Required | Description |
69
69
  | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
70
70
  | `apiKey` | [x] | Api Key that is used to authenticate against Circle APIs. |
71
- | `entitySecret` | [x] | Your configured entity secret. You can follow the [QuickStart](https://learn.circle.com/quickstarts/dev-controlled-wallets/generate-entity-secret) to set it up. |
71
+ | `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. |
72
72
  | `baseUrl` | [ ] | Optional base URL to override the default: `https://api.circle.com`. |
73
73
  | `storage` | [ ] | Optional custom storage solution for persisting data. We will fallback to InMemoryStorage if none was provided. |
74
74
  | `userAgent` | [ ] | Optional custom user agent request header. We will prepend it to default user agent header if provided. |
@@ -77,10 +77,10 @@ The client accepts the following configuration parameters:
77
77
 
78
78
  Here are some helpful links, if you encounter any issues or have questions about this SDK:
79
79
 
80
- - 📖 [Getting started](https://learn.circle.com/quickstarts/user-controlled-wallets): Check out our official Developer-Controlled Wallets QuickStart.
80
+ - 📖 [Getting started](https://developers.circle.com/wallets/dev-controlled/create-your-first-wallet): Check out our official Developer-Controlled Wallets QuickStart.
81
81
  - 🎮 [Join our Discord Community](https://discord.com/invite/buildoncircle): Engage, learn, and collaborate.
82
- - 🛎 [Visit our Help-Desk Page](https://support.usdc.circle.com/hc/en-us/p/contactus?_gl=1*1va6vat*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Dive into curated FAQs and guides.
82
+ - 🛎 [Visit our Help-Desk Page](https://help.circle.com/s/submit-ticket): Dive into curated FAQs and guides.
83
83
  - 📧 [Direct Email](mailto:customer-support@circle.com): We're always a message away.
84
- - 📖 [Read docs](https://developers.circle.com/w3s/docs?_gl=1*15ozb5b*_ga*MTAyNTA0NTQ2NC4xNjk5NTYyMjgx*_ga_GJDVPCQNRV*MTcwMDQ5Mzg3Ny4xNC4xLjE3MDA0OTM4ODQuNTMuMC4w): Check out our developer documentation.
84
+ - 📖 [Read docs](https://developers.circle.com/contracts): Check out our developer documentation.
85
85
 
86
86
  Happy coding!