# chain-auth

> Chain-Auth is a decentralized identity provider for the web.

Latest version **1.1.1** (published 2023-12-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install chain-auth
pnpm add chain-auth
yarn add chain-auth
bun add chain-auth
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-12-16 |
| First published | 2023-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kürşad Erduhan |
| Maintainers | kursaderduhan |
| Keywords | chain-auth package github npm decentralized identity provider web3 |

## Links

- npm: https://www.npmjs.com/package/chain-auth
- Repository: https://github.com/Chain-Auth/npm
- Homepage: https://github.com/Chain-Auth/npm#readme
- Issues: https://github.com/Chain-Auth/npm/issues
- npm.io page: https://npm.io/package/chain-auth

## Dependencies (4)

- [md5](https://npm.io/package/md5.md) ^2.3.0
- [ethers](https://npm.io/package/ethers.md) ^6.9.0
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.2.0
- [@types/crypto-js](https://npm.io/package/@types/crypto-js.md) ^4.2.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2023-12-16
- 1.1.0 — 2023-12-16
- 1.0.9 — 2023-12-16
- 1.0.8 — 2023-12-16
- 1.0.7 — 2023-12-16
- 1.0.6 — 2023-12-11
- 1.0.5 — 2023-12-11
- 1.0.4 — 2023-12-11
- 1.0.3 — 2023-12-11
- 1.0.2 — 2023-12-11
- 1.0.1 — 2023-12-10
- 1.0.0 — 2023-12-10

## README

# Chain-Auth

`Chain-Auth` is a JavaScript library that provides Ethereum smart contract-based user authentication for React applications.

## Installation

You can install the package in your project using npm or yarn:

```bash
npm install chain-auth
# or
yarn add chain-auth
```

## Usage

Once you have added the package to your project, usage is straightforward. Here's a basic example:

```bash
import React, { useEffect } from 'react';
import { ChainAuth } from 'chain-auth';

function App() {
  useEffect(() => {
    const fetchData = async () => {
      const username = 'your_username';
      const password = 'your_password';
      const userkey = 'your_userkey';

      try {
        const result = await ChainAuth({ username, password, userkey });
        console.log('ChainAuth Result:', result);
        // Perform desired actions with the returned result.
      } catch (error) {
        console.error('ChainAuth Error:', error);
      }
    };

    fetchData();
  }, []);

  return (
    <div>
      <!-- Your content -->
    </div>
  );

export default App;
```

## Props

The `ChainAuth` component accepts the following props:

- **username**: User's username
- **password**: User's password
- **userkey**: User's key

## Contributions

Contributions to this project are welcome! If you have any suggestions, find any issues, or want to contribute to the development, please feel free to do so. Here are a few guidelines to get you started:

- **Reporting Issues**: If you encounter any issues or bugs, please open an issue on the [GitHub repository](https://github.com/Chain-Auth/npm).

- **Feature Requests**: If you have ideas for new features or improvements, you can also open an issue to discuss them.

- **Pull Requests**: If you'd like to contribute directly, you can fork the repository, create a branch, make your changes, and then submit a pull request. Your contributions will be greatly appreciated!

## License

This package is open-source and is distributed under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/chain-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._