@ont-community/ontology-ts-sdk-ledger

## Overview

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
20Aug 28, 2018Jul 3, 2018Minified + gzip package size for @ont-community/ontology-ts-sdk-ledger in KB

Readme

Ledger extension for Ontology blockchain TypeScript SDK

Overview

This is an extension of Ontology TypeScript SDK adding the support for managing private keys on Ledger Hardware wallet.

Installation

Required Tools and Dependencies

Developing and Running

Execute these commands in the project's root directory:

Setup:

Install yarn

For faster building process and development experience install Yarn

npm install --global yarn

Download

git clone 'https://github.com/OntologyCommunityDevelopers/ontology-ts-sdk-ledger.git'

Development build

This will build the extension with minimum polyfilling for better debug experience.

yarn build:dev

Production build

yarn build:prod

Ledger support

Because Chrome allows communication with the Ledger only from HTTPS loaded page (which chrome extension is not), there is a IFrame based transport implemented. This IFrame needs to be served on HTTPS. The source codes for the IFrame are at https://github.com/OntologyCommunityDevelopers/ledger-forwarder.git . To set the Iframe address make a call to

Ledger.setLedgerTransport(new Ledger.LedgerTransportIframe('https://drxwrxomfjdx5.cloudfront.net/forwarder.html', true));

To use your Ledger, you also needs Official Ontology Ledger App installed on your Ledger.

Built With

Authors

License

This project is licensed under the ISC License - see the LICENSE.md file for details

Acknowledgments

Many thanks to the whole Ontology team, who done a great job bringing Ontology to life.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.