Code Monkey home page Code Monkey logo

prokey-webcore's Introduction

prokey-webcore

This is an all-in-one platform/library to use Prokey Hardware Wallet.

By using this library you will be able to implement these functionalities to your application straightforward:

  • Account discovery
  • List of transactions
  • Generate a transaction
  • Broadcast a transaction to the network
  • Get Address
  • Get public key
  • Access to Wallet Settings
  • etc

How to add?

It is recommended to add this repository main branch to your project as a submodule.

After adding, you need to run 'npm install' in the root directory of this module in order to install all prerequisites.

Supported Coins

  • Bitcoin based coins Like Bitcoin, Litecoin, Bitcoincash, Doge, Bitcoin Gold
  • Ethereum
  • ERC20
  • OMNI Protocol tokens based on Bitcoin Blockchain
  • Ripple

Sample code

  • First thing first, you need to create an instance of Prokey Device.

We assume that the current path to this library is 'lib/prokey-webcore'

import { Device } from 'lib/prokey-webcore/src/device/Device'

...
let device = new Device((success) => {
 if(!success)
   console.log("Can not load resource files");
});
  • Connecting to the Device

Due to WebUsb security, the USB devices are only accessible in secure HTTPS context or localhost. Please aware that some of the web browsers still do not support WebUsb.

let res = await device.TransportConnect();
if(res.success == false){
  console.log("Can not connect to device", res);
}

Due to WebUsb security reason, this function, TransportConnect, have to be called from a UI component like a Button.

By calling the TransportConnect function, the webUsb will be initialized and the browser shows a list of available devices. The user should select the device to connect.

  • Get a bitcoin address
 import { Device } from 'lib/prokey-webcore/src/device/Device'
 import { BitcoinCommands } from 'lib/prokey-webcore/src/device/BitcoinCommands'
 import * as Util from 'lib/prokey-webcore/src/utils/pathUtil'
 
 ...
 
 let btcCommands = new BitcoinCommands();
 
 // Getting path to the desire address using a helper function
 let pathModel = Util.GetListOfBipPath(
                        0, // SLIP44 CoinId check:https://github.com/satoshilabs/slips/blob/master/slip-0044.md
                        0,  // Account
                        1,  // Number of paths
                        true, // Segwit
                        false, // Change address
                        0); // Address Index
 
 let addressModel = btcCommands.GetAddress( device, pathModel.path, true ); 
 
 console.log('First HD wallet Bitcoin Address', addressModel.address );
 
  • Get Public key
...
// for pathModel.path, check GetAddress
let publicKeyModel = btcCommands.GetPublicKey( device, pathModel.path, true );

console.log('XPUB:', publicKeyModel.xpub );

Backend Servers(Blockchain)

Prokey.io has its own dedicated backend private servers which developed from scratch to access to the blockchain. THESE SERVERS ARE NOT AVAILABLE TO OTHER 3D PARTIES/PROJECTS/WEBSITES.

License

GNU General Public License version 3.0

prokey-webcore's People

Contributors

hadideveloper avatar kochol avatar northmz avatar aliakbarhamzeh1378 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.