Giter Club home page Giter Club logo

substrate-connect-wip's Introduction

license Actions Status Dependabot Status CodeClimate

Substrate Connect

NPM Module @substrate/light

A npm module that adds Substrate light-client functionality to any JavaScript environment, from in-browser applications to browser extensions and electron apps up to IOT devices.

It contains Wasm light clients from various chains, bundled in a single package. @substrate/light makes running a light-client as easy as installing a npm module.

Applications: Lichen / "Substrate Light UI"

Lichen is a light-client-based, in-browser wallet for Substrate.

The Light UI is meant to be an intuitive interface for beginner users to easily interact with various Substrate chains. It is provided in two forms:

  • A browser one-page application
  • A Chrome/Firefox browser extension

Both provide the same functionalities and use the same UI, feel free to choose the medium that suits you best.

A very alpha version of the browser extension can be found in the Github Releases page.

You can also check out the master branch and build from source.

Overview

As of v0.3.0, the main functions are as follows:

  • Identity management - manage accounts and addresses, including ability to create, edit, restore, backup, and forget them.
  • Transfer balance - send and receive funds in the currency of the relevant substrate chain.
  • Embed a light client in a browser extension, and let Light UI be the user interface of this extension.

And here is a rough roadmap of what's coming next (see the v0.4.0-MVP milestone for details):

  • Handle changing:
    • provider,
    • chain spec,
    • user uploaded light client WASM blob or chain spec.
  • Provider injection inside dapps.
  • Improve overall beginner-friendliness (e.g. #67).

Build from sources

Dependencies

Make sure you have yarn >= 1.13.0 and nodejs >= 10.10.0. Then run

git clone https://github.com/paritytech/substrate-connect
cd ./substrate-connect
yarn install

Run the Browser Extension

yarn build:extension

Then install the extension:

  • Chrome:
    • go to chrome://extensions/
    • ensure you have the Development flag set
    • "Load unpacked" and point to packages/extension-app/build
    • if developing, after making changes - refresh the extension
  • Firefox:
    • go to about:debugging#addons
    • check "Enable add-on debugging"
    • click on "Load Temporary Add-on" and point to packages/extension-app/build/manifest.json
    • if developing, after making changes - reload the extension

Contributing

We welcome any and all contributions whether it is in the form of raising an issue, filing a PR, or participating in the discussions. Please read the Contributing Docs first.

Run with Hot-Reloading

If you would like to run this project with hot-reloading, use the following commands:

  • yarn start:light-app: If you would only like to modify the UI, run this command and visit http://localhost:3000

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.