Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

airgap-coin-lib

Package Overview
Dependencies
Maintainers
2
Versions
302
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

airgap-coin-lib

The airgap-coin-lib is setup in a way that prepare, signing and broadcasting are willingfully separated.

  • 0.4.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
33
increased by10%
Maintainers
2
Weekly downloads
 
Created
Source

AirGap Coin Library

npm documentation build codecov

The airgap-coin-lib is a protocol-agnostic library that allows easy handling of the most important tasks relating cryptocurrencies and blockchains.

It implements operations such as preparing, signing and broadcasting transactions for a range of protocols.

The library consists of a shared interface for all implements protocols. This is especially useful in the context of AirGap. The following operations are specified:

  • prepareTransaction - This is done on the wallet (online) side. Either a public key or extended public key is used and will fetch the required information from the network
  • signTransaction - This is done on the vault (offline) side. The output of "prepareTransaction" is the input for this method (hence the output of "prepareTransaction" is transferred via URL scheme (same-device) or QR code (2-device-setup)).
  • broadcastTransaction - This is done on the wallet (online) side. The output of "signTransaction" is the input for this method (hence the output of "signTransaction" is transferred via URL scheme (same-device) or QR code (2-device-setup)).

Supported Protocols

The modular design used in this library allows you to simply add new protocols with special logic. Adding a new Bitcoin-like protocol basically means:

  1. select the correct network parameters (see lib/networks.ts)
  2. set the Insight API URL to communicate with the blockchain

Adding a new Ethereum-like protocol means:

  1. set the correct chain id
  2. set the JSON RPC URL

Currently supported are:

  • Bitcoin
  • Ethereum
    • Generic ERC20 Tokens
  • Aeternity
  • Tezos (Beta)

Features

The way the interface was designed is to allow stateless calls. This means the class itself stores very little state itself. All required input comes from the method params (public key, extended public key, etc...)

Currently we support for Bitcoin-like protocols:

  • Single Address Wallets
  • HD Wallets

Currently we support for Ethereum-like protocols:

  • Single Address Wallets (HD-Wallets make no sense for account-based protocols)

Synchronising information between wallet and vault

Such that the system works we need to be able to synchronise wallets. A wallet can be:

  • Single Address Wallet
  • HD Wallet

For the single address wallet we only need to share the public key. For HD Wallet we need to share the extended public key.

Getting started

Requirements

npm >= 5
NodeJS >= 8

Everything else gets installed automatically using npm install.

Clone and Run

$ git clone https://github.com/airgap-it/airgap-coin-lib.git
$ cd airgap-coin-lib
$ npm install
$ npm test

Keywords

FAQs

Package last updated on 26 Apr 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc