GitXplorerGitXplorer
p

web3-cardano-token

public
28 stars
15 forks
5 issues

Commits

List of commits on branch main.
Unverified
ecb707aa3858d7031cee9718420e26a795deff6b

Fix isWindow check

ppyropy committed 3 years ago
Unverified
6012794b5a7954abce4a1733be572dd2b2e1c485

Bump version to 0.0.2

ppyropy committed 3 years ago
Unverified
795af92244d7014b0651e8dc22801f8c1c72c467

Add new build

ppyropy committed 3 years ago
Unverified
98c005748a279d552b234dfc97dfdc8e19b77a93

Update readme

ppyropy committed 3 years ago
Unverified
04558e9d11f8fd86fc3c31e05a001b0d5e21a65f

Initial commit 🍾

ppyropy committed 3 years ago

README

The README file for this repository.

Web3 Cardano Token

Web3 Cardano Token is a new way to authenticate users. A replacement for JWT in hybrid dApps.

Install

$ npm i web3-cardano-token

Example usage (Client side)

Using Nami Wallet extension:

import Web3Token from 'web3-cardano-token/dist/browser';

// Connection to Nami wallet
const cardano = window.cardano;
await cardano.nami.enable();

// getting address from which we will sign message
const address = (await cardano.getUsedAddresses())[0];

// generating a token with 1 day of expiration time
const token = await Web3Token.sign(msg => cardano.signData(your_address, toHex(msg)), '1d');

// attaching token to authorization header ... for example

Example usage (Server side)

const Web3Token = require('web3-cardano-token/dist/node');

// 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 });

API

Argument Name Description Required Example
1 signer A function that returns a promise with signature string eg: await namiWallet.signData(address, data) required (body) => await namiWallet.signData(addr1e2..0c, body)
2 expire_in A string that represents a time span (see ms module) or a number of milliseconds optional (default: 1d) 1 day
3 body An object that will be appended to a signature's body. Can only contain string values. Can be used for some custom data. optional { 'Custom-data': 'some custom data' }

License

Web3 Cardano Token is released under the MIT license. © 2021 Srdjan Stankovic

Note:

This package is based upon web3-token package and uses the same API.