`sig`

EXPERIMENTAL. DO NOT USE THIS YET.

A signing library for Cosmos.

Supported in Node.js and browsers.

@TODO: expand description

Demo

@TODO: add demo links

Documentation

@TODO: add brief description of documentation

https://jordansexton.github.io/sig/

Install

@TODO: move repo and publish package

Please note that the NPM package name is @tendermint/sig rather than @cosmos/sig.

Yarn

yarn add @tendermint/sig

NPM

npm install --save @tendermint/sig

Usage

@TODO: expand to show the full API

import { instantiate } from '@tendermint/sig';

(async function () {
    const { createWallet, signTx, verifyTx } = await instantiate();
    
    const tx = {
        fee:  {
            amount: [{
                amount: '0',
                denom:  ''
            }],
            gas:    '21906'
        },
        memo: '',
        msgs: [{
            type:  'cosmos-sdk/Send',
            value: {
                inputs:  [{
                    address: 'cosmos1qperwt9wrnkg5k9e5gzfgjppzpqhyav5j24d66',
                    coins:   [{
                        amount: '1',
                        denom:  'STAKE'
                    }]
                }],
                outputs: [{
                    address: 'cosmos1yeckxz7tapz34kjwnjxvmxzurerquhtrmxmuxt',
                    coins:   [{
                        amount: '1',
                        denom:  'STAKE'
                    }]
                }]
            }
        }]
    };
    
    const txMeta = {
        account_number: '1',
        chain_id:       'cosmos',
        sequence:       '0'
    };
    
    const wallet   = createWallet();
    const signedTx = signTx(tx, txMeta, wallet);
    const isValid  = verifyTx(signedTx, txMeta);
})();

Contributing

sig is very new! Questions, feedback, use cases, issues, and code are all very, very welcome.

Thank you for helping us help you help us all. 🎁

hschoenburg / sig