Skip to content

MPoulhazan/siwc

Repository files navigation

Sign in with Conflux

Sign-In with Conflux describes how Conflux accounts authenticate with off-chain services by signing a standard message format parameterized by scope, session details, and security mechanisms (e.g., a nonce). The goals of this specification are to provide a self-custodied alternative to centralized identity providers, improve interoperability across off-chain services for Conflux-based authentication, and provide wallet vendors a consistent machine-readable message format to achieve improved user experiences and consent management.

This project is based on Sign-In With Ethereum.

Getting Started

To use siwc in you project, execute the following command

npm i siwc

Or with yarn

yarn add siwc

Check this article for more informations.

Examples

A siwc-quickstart project with front and back examples can be found here.

Prerequisites

Npm installed

Installing

Run npm install to install dependencies, then npm bootstrap to link the dependencies in their respective packages. Afteward run npm run build to build the library. Development can occur on the package/* level with tests being run on each package itself.

Running the tests

Go to package siwc or siwc-parser and run npm run test to run the tests with Jest.

Deployment

SIWC is deployed on npm registry.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

For the versions available, see the tags on this repository.

Authors

  • Mickael Poulhazan - Fullstack dev - MPoulhazan
  • Spruce System, Inc - Multiple contributors - Spruceid

See also the list of contributors who participated in this project and SIWE contributors for initial project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

Sign-In with Conflux library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages