Git Product home page Git Product logo

keystation's Introduction

Cosmostation logo

Keystation

๐Ÿ‘ฝ Developed / Developing by Cosmostation

Overview

Keystation is a decentralized keychain-based authenticator that DOES NOT require any installation. User keys are securely stored in the web browser Keychain, allowing for users to conveniently sign transactions for networks and decentralized applications built with the Cosmos SDK. Keystation can be used as a secure and convenient authentication and key management tool for web login, decentralized exchanges, decentralized applications, and various services built with the Cosmos SDK.

keystation1 keystation2 keystation3

Import

<script src="https://keystation.cosmostation.io/lib/keystation.js"></script>

Usage

// initializing configuration
var keystation = new Keystation();
keystation.client = "YOUR_WEB_URL";
keystation.lcd = "https://lcd-cosmos-free.cosmostation.io";
keystation.path = "44/118/0/0/0";

// The account parameter is required for users having multiple keychain accounts.
var keystationAccount = "";
// open popup window for sign-in
var prefix = "cosmos";  // Cosmos prefix: cosmos, Iris prefix: iaa
var popup = keystation.openWindow("signin", prefix);
// generate a transaction
var txJson = {"account_number":"18012","chain_id":"cosmoshub-3","fee":{"amount":[{"amount":"5000","denom":"uatom"}],"gas":"200000"},"memo":"","msgs":[{"type":"cosmos-sdk/MsgSend","value":{"amount":[{"amount":"10000","denom":"uatom"}],"from_address":"cosmos1z67fshyr48pa9a6htdz4qd0zullfk6y0fgvxv7","to_address":"cosmos10nv3yj0jdxf02vxyc0tavf97fdvppdth6wmcn3"}}],"sequence":"24"};

var txJsonStr = JSON.stringify(txJson);
var popup = keystation.openWindow("transaction", txJsonStr, keystationAccount);
// add an EventListener
window.addEventListener("message", function(e) {
    if (e.origin != "https://keystation.cosmostation.io") return;
    console.log(e.data);
    // e.data.account : User's keychain account. Remember this account!
    keystationAccount = e.data.account;
} , false);

If the user is log in as Alice, he or she should use Alice account to sign transaction.

Supporting Transaction Message Types

You can find currently supporting meesage types in our CosmosJS library

How to Create txJson

// CosmosJS supports to create tx for Cosmos
cosmos.getAccounts(address).then(data => {
	let stdSignMsg = cosmos.newStdMsg({
        msgs: [
            {
                type: "cosmos-sdk/MsgSend",
                value: {
                    amount: [
                        {
                            amount: String(100000),
                            denom: "uatom"
                        }
                    ],
                    from_address: address,
                    to_address: "cosmos18vhdczjut44gpsy804crfhnd5nq003nz0nf20v"
                }
            }
        ],
        chain_id: chainId,
        fee: { amount: [ { amount: String(5000), denom: "uatom" } ], gas: String(200000) },
        memo: "",
        account_number: String(data.result.value.account_number),
        sequence: String(data.result.value.sequence)
	});
    
	console.log(stdSignMsg.json);   // txJson
})

Security

Keystation stores user mnemonic phrase on a key management system, Keychain in Chrome and Safari. A user is the only one who can access the keychain, and no third party is granted access. User mnemonic phrase is encrypted with AES algorithm for higher security before being stored. A PIN set by the user is required in order to access the encrypted mnemonic phrase.

Issues

We welcome any type of issues. Please provide information in detail when you post issues or bugs.

Contribution

We welcome any contributions, suggestions, improvements, or feature requests.

There will be CONTRIBUTING.md that describes rules and procedure. It will be updated soon.

Services and Community by Cosmostation

keystation's People

Contributors

jaybxyz avatar

Watchers

 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.