Code Monkey home page Code Monkey logo

scc-js's Introduction

SCC.js - An SCC implementation in pure Node.js

SCC.js can be used as an internal factory system to produce Transactions, On-Chain Scripts, Contracts and Signature creation/verification, all without any full node, RPC or cryptography necessary!

For example, SCP Wallet (an Electron-based Lightwallet) uses SCC.js as it's internal wallet system.

API Documentation

The following docs assume that you've minimally imported the SCC.js library into your Node.js script, e.g:

const SCC = require('scc-js');
// The SCC module exposes two sub-modules, the Wallet and Signer modules
// SCC.wallet
// SCC.signer

Wallet (Key Store)

Generate Wallet (Promise)

Creates a cryptographically-random SCC wallet key pair (Private Key and Public Key)

const SCC = require('scc-js');

// Async
async function newWallet() {
    return await SCC.wallet.generateWallet(); // { 'pubkey': '...', 'privkey': '...' }
}

// Callback
SCC.generateWallet().then(cWallet => {
    // { 'pubkey': '...', 'privkey': '...' }
});

Derive Public Key from Private Key

Derives the public key from an existing WIF-encoded private key.

  • Decodes Base58 private keys by default, but can accept raw key bytes with an optional flag.
  • Returns a network-encoded, Base58 address by default, but can return a raw Secp256k1 public key with an optional flag.
const SCC = require('scc-js');

// Derive a native base58 SCC address (String)
//                                           Private Key String
const base58Address = SCC.wallet.pubFromPriv('base58_private_key');

// Derive a raw Secp256k1 public key (Uint8Array)
//                                    Private Key String,   fRaw,  fPubBytesOnly
const pubKey = SCC.wallet.pubFromPriv('base58_private_key', false, true);

// Derive a native base58 SCC address (String) from raw private key bytes (Uint8Array)
//                                           Private Key String, fRaw
const base58Address = SCC.wallet.pubFromPriv(uint8PrivKeyBytes,  true);

Wallet (Transactions)

// TODO!


Signer

Create Signature (Promise)

Creates a cryptographic signature of a given message, for a given private key.

const SCC = require('scc-js');

// Async
async function signMessage(msg, privkey)) {
    return await SCC.signer.sign(msg, privkey); // Buffer([signature bytes]);
}

// Callback
SCC.signer.sign('hello world', 'WIF_private_key').then(cSig => {
    // Buffer([signature bytes]);
});

Verify Signature (Promise)

Verify the integrity and authorship of a message by it's public key and signature.

const SCC = require('scc-js');

// Async
async function verifyMessage(msg, pubkey, cSig)) {
    return await SCC.signer.verify(msg, pubkey, cSig); // Boolean(true / false)
}

// Callback
SCC.signer.verify(msg, pubkey, cSig).then(fValid => {
    // Boolean(true / false)
});

scc-js's People

Contributors

jskitty avatar luke-larsen avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  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.