https://github.com/planetarium/sphere
A signing library encapsulating multiple account providers to be used on Libplanet-based applications.
https://github.com/planetarium/sphere
Last synced: 5 months ago
JSON representation
A signing library encapsulating multiple account providers to be used on Libplanet-based applications.
- Host: GitHub
- URL: https://github.com/planetarium/sphere
- Owner: planetarium
- Created: 2022-09-23T06:20:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-02T05:47:37.000Z (about 2 years ago)
- Last Synced: 2023-04-10T01:58:21.602Z (about 2 years ago)
- Language: TypeScript
- Size: 2.44 MB
- Stars: 5
- Watchers: 8
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `sphere`
"Sphere" is a monorepo consists of several typescript packages to provide safer, easier, and managable interface to sign transactions used in Libplanet-based projects, with various source of private key.
## Project Structure
- `/packages`
### signing-interface
Signing interface provides a unified method of signing transactions regardless of source of key (account).
- `/sign`
### account-providers
Account providers implement it's own method of handling private key safely, storing (or deriving) public key, and returning signature of given digest or hash.
- `/account-raw`
- `/account-local`
- `/account-aws-kms`
## Package Installation
```
# First Add Signing Interface as Dependency
yarn add @planetarium/sign
# Then Add Required Account Provider
yarn add @planetarium/account-raw
yarn add @planetarium/acocount-local
yarn add @planetarium/account-aws-kms
```
## Source Development Setup
```
git clone [email protected]:planetarium/sphere.git
cd sphere
# yarn workspace plugin is enabled, so you don't have to yarn install every package manually.
yarn install
# Builds all packages
yarn workspaces foreach run build
```