@imtbl/sdk 0.35.0 → 0.35.2

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 CHANGED
@@ -4,21 +4,16 @@
4
4
  <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
5
5
  </a>
6
6
  </p>
7
- <h1>Immutable Unified TypeScript SDK</h1>
7
+ <h1>Welcome to Immutable Unified TypeScript SDK</h1>
8
8
  </div>
9
9
 
10
10
  ## Documentation
11
11
 
12
- See our [developer documentation](https://docs.immutable.com) for information on building on Immutable.
13
-
14
- See our rollup API references for more information on our APIs.
12
+ [Typescript SDK Official Starting guide](https://docs.immutable.com/sdk-docs/ts-immutable-sdk/overview/)
15
13
 
14
+ Checkout our API references for more information.
16
15
  - [Immutable X API Reference](https://docs.immutable.com/x/reference)
17
- - [Immutable zkEVM API Reference](https://docs.immutable.com/zkevm/reference)
18
-
19
- ### Examples
20
-
21
- - For examples, please view them on our [documentation website](https://docs.immutable.com/sdk-docs/ts-immutable-sdk/overview/).
16
+ - [Immutable zkEVM API Reference](https://docs.immutable.com/zkevm/api/reference)
22
17
 
23
18
  ## Installation
24
19
 
@@ -27,6 +22,9 @@ npm install @imtbl/sdk
27
22
  # or
28
23
  yarn add @imtbl/sdk
29
24
  ```
25
+ ## Disclaimer for Alpha Releases
26
+
27
+ Please note that alpha releases are still in development and may contain bugs or breaking changes. Please do not use these versions as we do not intend to support them.
30
28
 
31
29
  ## Changelog
32
30
 
@@ -34,7 +32,7 @@ yarn add @imtbl/sdk
34
32
 
35
33
  #### Changed (breaking)
36
34
 
37
- ##### The `connectImx` method no longer registers users on Immutable X
35
+ ##### The `connectImx` method no longer registers users on Immutable X
38
36
 
39
37
  This method was previously responsible for automatically [registering a user](https://docs.immutable.com/docs/x/how-to-register-users/)
40
38
  the first time they connect to Immutable X.
@@ -3618,7 +3618,7 @@ class APIError extends Error {
3618
3618
 
3619
3619
  /* eslint-disable implicit-arrow-linebreak */
3620
3620
  const defaultHeaders = {
3621
- sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.35.0',
3621
+ sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.35.2',
3622
3622
  };
3623
3623
  /**
3624
3624
  * createAPIConfiguration to create a custom Configuration