Web3 Token

Version 0.2 updates 🎉

Version 1.0 updates 🥂

Install

$ npm i web3-token web3

$ npm i web3-token ethers

Example usage (Client side)

import Web3 from 'web3';
import Web3Token from 'web3-token';
// Connection to MetaMask wallet
const web3 = new Web3(ethereum);
await ethereum.request({ method: 'eth_requestAccounts'});
// getting address from which we will sign message
const address = (await web3.eth.getAccounts())[0];
// generating a token with 1 day of expiration time
const token = await Web3Token.sign(msg => web3.eth.personal.sign(msg, address), '1d');
// attaching token to authorization header ... for example

import { ethers } from "ethers";
import Web3Token from 'web3-token';
// Connection to MetaMask wallet
const provider = new ethers.providers.Web3Provider(window.ethereum);
const signer = provider.getSigner();
// generating a token with 1 day of expiration time
const token = await Web3Token.sign(async msg => await signer.signMessage(msg), '1d');
// attaching token to authorization header ... for example

Example usage (Server side)

const Web3Token = require('web3-token');
// getting token from authorization header ... for example
const token = req.headers['Authorization']
const { address, body } = await Web3Token.verify(token);
// now you can find that user by his address 
// (better to do it case insensitive)
req.user = await User.findOne({ address });

Handle exceptions

const generateToken = async () => {
 if (!window.ethereum) {
 return console.log('Please install and activate the metamask extension!');
 }
 const provider = new ethers.providers.Web3Provider(window.ethereum);
 const signer = provider.getSigner();
 try {
 return await Web3Token.sign(async msg => {
 try {
 return await signer.signMessage(msg);
 }
 catch (err) {
 const { reason } = err;
 if (reason === "unknown account #0") {
 return console.log('Have you unlocked metamask and are connected to this page?')
 }
 console.log(err.toString());
 }
 }, '1d');
 }
 catch (err) {
 if (/returnsasignature/.test(err.toString())) {
 return;
 }
 console.log(err.toString());
 }
}

Advanced usage with options (Client&Server side)

// I assume here a lot of things to be imported 😀
const token = await Web3Token.sign(async msg => await signer.signMessage(msg), {
 domain: 'worldofdefish.com',
 statement: 'I accept the WoD Terms of Service: https://service.org/tos',
 expires_in: '3 days',
 // won't be able to use this token for one hour
 not_before: new Date(Date.now() + (3600 * 1000)),
 nonce: 11111111,
});
const { address, body } = await Web3Token.verify(token, {
 // verify that received token is signed only for our domain
 domain: 'worldofdefish.com'
});

API

sign(signer, options)

verify(token, options)

License