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.

IN DEVELOPMENT

This library is in very early development and everything is subject to change.

The master branch will contain early release builds of the Session Kit and will be published under the beta tag on npm. The dev branch will be the staging area for the next release, and all pull requests should be made against dev.

No releases have yet been published of any version. Refer to the WharfKit organization on npm for all releases:

https://www.npmjs.com/org/wharfkit

Installation

The @wharfkit/session package is distributed as a module on npm.

yarn add @wharfkit/session
# or
npm install --save @wharfkit/session

Usage

TODO

See unit tests for usage examples during early development.

Autodocs

Developing

You need Make, node.js and yarn installed.

All development should be done based on the dev branch.

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 continously 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

@greymass/eosio: Core library to provide Antelope data types.
eosio-signing-request: Antelope Signing Request Protocol.
pako: zlib javascript port, used to compress signing requests.

Made with ☕️ & ❤️ by Greymass.

README.md Unescape Escape

@wharfkit/session

Session Kit - An Antelope blockchain session management toolkit