Merge pull request #23 from peaqnetwork/feature/1207515694088907_sdk-feat-update

Feature/1207515694088907 sdk feat update

Author: jpgundrum

README.md

@@ -1,3 +1,18 @@
 # peaq-js
 
 Follow [documentation](https://docs.peaq.network/sdk) for a detailed overview of the features and functionalities of peaq SDK.
+
+
+## Edit functions
+The SDK acts as a wrapper class that abstracts away calls to our substrate based blockchain
+
+Go to /packages/sdk/src/modules to see backend code
+- **main:** Creates an instance, connects/disconnects to chain, and stores metadata
+- **base:** Stores important multi use variables and performs generic blockchain operations
+- **did:** Class where did's are created, removed, read, and updated
+- **rbac:** Class where role-based access control is called
+
+## Test
+1. Go to proper directory with cmd `cd packages/sdk`
+2. Create a .env file in `packages/sdk` to store the base_url (network) you are testing, and seed phrases that connect to funded wallets that are needed to execute transactions.
+3. Run the tests with the cmd `npx nx test`

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "peaq-network",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "license": "MIT",
   "scripts": {
     "prepare": "ts-patch install -s"

package.json

@@ -1,7 +1,7 @@
 {
   "author": "peaq network <[email protected]>",
   "name": "@peaq-network/sdk",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "peaq network sdk",
   "license": "Apache-2.0",
   "repository": {

packages/sdk/package.json

@@ -47,7 +47,8 @@ export class Base {
     if (!seed) {
       throw new Error('Seed is required');
     }
-    const keyring = new Keyring({ type: 'sr25519' });
+    const keyring = new Keyring({ ss58Format: 42, type: 'sr25519' });
+
     return keyring.addFromUri(seed);
   };