-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from peaqnetwork/feature/1207515694088907_sdk-…
…feat-update Feature/1207515694088907 sdk feat update
- Loading branch information
Showing
13 changed files
with
1,580 additions
and
204 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.