poh-validator-hcaptcha-react

0.0.2 • Public • Published

Proof-of-Humanity Validator Plugin React Component for hCaptcha API

NPM

React component providing the UI for Proof-Of-Humanity hCaptcha validator API.

This component has to be used as a plugin within Proof-of-Humanity-React wrapper component.

Live dApp demo

https://poh-counter.bakoush.in (source code)

Required props

You have to provide these props:

validatorApiUrl (string) – URL of validator API. Validator API for use with this component: Proof-of-Humanity hCaptcha Validator API

sitekey (string)hCaptcha sitekey. Must be obtained by registration on the hCaptcha site

Returned object

  • error (boolean)true in case of error; otherwise false

  • errorMessage (string) – in case of error; otherwise null

  • proof (string): proof-of-humanity (a hex string); null in case of error

Usage with poh-react

import hCaptchaValidator from 'poh-validator-hcaptcha';
import { useProofOfHumanity } from 'poh-react';

const validator = (
  <HCaptchaValidator
    validatorApiUrl="http://localhost:3000/api/v1/proof"
    sitekey="10000000-ffff-ffff-ffff-000000000001"
  />
);

const { getProofOfHumanity } = useProofOfHumanity(validator);

Hidden props

These props are used internally by poh-react. Normally you don't bother working with them.

These props are used internally by poh-react. Normally you don't bother working with them.

renderLogoOnly (boolean) – if true, the component will render its logo instead of the actual hCaptcha interface

data (string) – data (a hex string) to be included in signed proof-of-humanity. Can be a random hex challenge, or a random hex challenge along with the address owner's signature

onVerify (function) – will be called from the component once validation is complete with the returned object as the only parameter

See also

Author

Alex Bakoushin

License

MIT

Dependencies (2)

Dev Dependencies (15)

Package Sidebar

Install

npm i poh-validator-hcaptcha-react

Weekly Downloads

3

Version

0.0.2

License

MIT

Unpacked Size

49.4 kB

Total Files

7

Last publish

Collaborators

  • bakoushin