dash-platform-sdk 1.0.3 → 1.0.5
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 -5
- package/dist/main.js +1 -1
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# dash-platform-sdk v1.0.
|
|
1
|
+
# dash-platform-sdk v1.0.5
|
|
2
2
|
[](https://github.com/pshenmic/dash-platform-sdk/blob/master/LICENSE)  
|
|
3
3
|
|
|
4
4
|
|
|
@@ -9,11 +9,13 @@ It uses an alternative WASM bindings layer to a Dash Platform Protocol, and othe
|
|
|
9
9
|
|
|
10
10
|
SDK uses a pre-defined set of seed nodes (public RPC) at the start, and then tries to switch to the latest list of nodes fetched from the Dash network through https://rpc.digitalcash.dev if possible
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
### This is development version, breaking changes may be each release
|
|
13
13
|
|
|
14
14
|
Currently, only minimal features are included, such as document querying and creation of the documents, and all necessary related functions to do that
|
|
15
15
|
There is no input validation and error handling implemented yet relying on a happy path, this is going to be fixed in next versions
|
|
16
16
|
|
|
17
|
+
**This package is not yet production and mainnet ready, and I would only recommend to use it in the testnet environment**
|
|
18
|
+
|
|
17
19
|
This library is isomorphic and works in both Node.js and Web browsers without polyfilling
|
|
18
20
|
|
|
19
21
|
|
|
@@ -25,7 +27,7 @@ $ npm install dash-platform-sdk
|
|
|
25
27
|
|
|
26
28
|
Alternatively, you could simply include the library from the CDN:
|
|
27
29
|
|
|
28
|
-
https://unpkg.com/dash-platform-sdk@1.0.
|
|
30
|
+
https://unpkg.com/dash-platform-sdk@1.0.4/dist/main.js
|
|
29
31
|
|
|
30
32
|
## Quickstart
|
|
31
33
|
To use the SDK, simply import the library and instantiate an instance of DashPlatformSDK:
|
|
@@ -42,7 +44,7 @@ const sdk = new DashPlatformSDK({network: 'testnet'})
|
|
|
42
44
|
Or load it straight from the web page:
|
|
43
45
|
|
|
44
46
|
```html
|
|
45
|
-
<script src="https://unpkg.com/dash-platform-sdk@1.0.
|
|
47
|
+
<script src="https://unpkg.com/dash-platform-sdk@1.0.4/dist/main.js"></script>
|
|
46
48
|
<script>
|
|
47
49
|
const sdk = new DashPlatformSDK({network: 'testnet'})
|
|
48
50
|
</script>
|
|
@@ -180,7 +182,7 @@ await sdk.stateTransitions.broadcastStateTransition(stateTransition)
|
|
|
180
182
|
Waits for an execution of a state transition in the network
|
|
181
183
|
|
|
182
184
|
```javascript
|
|
183
|
-
const stateTransitionHash =
|
|
185
|
+
const stateTransitionHash = hexToBytes('4B47EEA3E7621BCEDDD7531A153E01262391A8ECB3C3F93628E5DC3B791EBDFA')
|
|
184
186
|
await sdk.stateTransitions.broadcastStateTransition(stateTransitionHash)
|
|
185
187
|
```
|
|
186
188
|
|