bitcore-payid v1.0.0

Bitcore PayID

This is a library to assist PayId integration with Bitcore

Setup

npm install

Usage

Sign

• Bitcore key

import Bitcore from 'bitcore-lib';
import PayId from 'bitcore-payid';

const privKey = new Bitcore.HDPrivateKey(); // or Bitcore.PrivateKey() for a non-hierarchically derived private key

const signed = PayId.sign('alex$example.com', 'bitcoinaddress123', 'BTC', privKey.toString());

• Node crypto key

import crypto from 'crypto';
import PayId from 'bitcore-payid';

const keys = crypto.generateKeyPair('ec'); // could be 'rsa' too
const privKey = keys.privateKey.export({ format: 'pem', type: 'pkcs8' });

const signed = PayId.sign('alex$example.com', 'bitcoinaddress123', 'BTC', privKey);

• From file

import fs from 'fs';
import PayId from 'bitcore-payid';

const privKey = fs.readFileSync('/path/to/private/key');

const signed = PayId.sign('alex$example.com', 'bitcoinaddress123', 'BTC', privKey);

It is recommended to store the signed.signatures' signatures and protected properties. protected can be thought of as the public key to verify the signature because it contains the ingredients to build the public key as a JWK, but you could also discard the protected property if you intend to rebuild it at verification time.

Verify

verifiableAddress can be manually constructed as a IVerifyPayId object or a JWK.GeneralJWS object from the jose library. Note that the bitcore-payid sign method above returns a JWK.GeneralJWS object.

import PayId from 'PayId';

// ...

const isValid = PayId.verify('alice$example.com', verifiableAddress);