freedombase:web3-login

v0.2.1Published 2 years ago

freedombase:web3-login

Template package with CI and everything else to get started quickly with creating a new FOSS Meteor package.

Project Status: Active – The project has reached a stable, usable state and is being actively developed. GitHub JavaScript Style Guide Language grade: JavaScript GitHub tag (latest SemVer) All Contributors

ALPHA stage

This package is in active development and is bare bones. Do not use in production. Yet!

Getting started

Install

meteor add freedombase:web3-login

Settings

To set up additional providers beside Metamask add them to your settings.json:

1{
2  "public": {
3    "packages": {
4      "freedombase:web3-login": {
5        "providername": {
6          "provider": "settings"
7        }
8      }
9    }
10  }
11}

Providers available at this moment (no need to install provider package, for settings see the providerOptions part):

More coming soon!

Client methods

Meteor.loginWithWeb3 / loginWithWeb3

@locus client @param loginMessage { String } @param callback optional { (error?: Meteor.Error, result?: boolean) => void }

verifyUserAction

@locus client @param message { String } @param recordVerification { Boolean } @param callback optional { (error?: Meteor.Error, result?: boolean) => void }

verifyUserLogin

@locus client @param message { String } @param usersEthAddress { String } @param callback optional { (error?: Meteor.Error, result?: boolean) => void }

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!