@wharfkit/session
v1.4.0
Published
Create account-based sessions, perform transactions, and allow users to login using Antelope-based blockchains.
Downloads
5,187
Readme
@wharfkit/session
Session Kit - An Antelope blockchain session management toolkit
Authenticate and persist sessions using blockchain accounts within JavaScript and TypeScript applications. Each session can be used to interact with smart contracts using the authenticated account.
Installation
The @wharfkit/session
package is distributed on npm.
yarn add @wharfkit/session
# or
npm install --save @wharfkit/session
Usage
Please refer to the documentation on wharfkit.com.
Autodocs
Developing
You need Make, node.js and yarn installed.
The master
branch will contain production release builds of the Session Kit. The dev
branch will be where all development is performed and act as the staging area for the next release. All pull requests should be made against dev
.
Clone the repository and run make
to checkout all dependencies and build the project. The tests can be run using make test
and can be continuously tested during development with make test/watch
.
See the Makefile for other useful targets.
Before submitting a pull request make sure to run make check
and make format
.
Dependencies
- @wharfkit/antelope: Core library to provide Antelope data types.
- @wharfkit/signing-request: Signing request protocol for Antelope blockchains.
- pako: zlib javascript port, used to compress signing requests.
Made with ☕️ & ❤️ by Greymass.