This is the SDK for the Humanode Biomapper - a biometrics-based sybil-resistance utility for EVM smart contracts.

To learn more about the Humanode Biomapper itself (and not this SDK) see the docs.

Contract Addresses

Find the up-to-date contract addresses here.

Implementation Table

Contract	Implemented Interfaces
Biomapper	IGenerationChangeEvents, IProveUniquenessEvents
BiomapperLog	IBiomapperLogRead, IBiomapperLogAddressesPerGenerationEnumerator
BridgedBiomapper	IBridgedBiomapperRead, IBridgeBiomappingEvents

Installation

With NPM/Yarn

Install the packages:

npm install --save @biomapper-sdk/core @biomapper-sdk/libraries @biomapper-sdk/events

or with yarn:

yarn add @biomapper-sdk/core @biomapper-sdk/libraries @biomapper-sdk/events

Import the dependencies from the @biomapper-sdk like this:

import {IBiomapperLogRead} from "@biomapper-sdk/core/IBiomapperLogRead.sol";
import {IBridgedBiomapperRead} from "@biomapper-sdk/core/IBridgedBiomapperRead.sol";
import {IBiomapperLogAddressesPerGenerationEnumerator} from "@biomapper-sdk/core/IBiomapperLogAddressesPerGenerationEnumerator.sol";
import {BiomapperLogLib} from "@biomapper-sdk/libraries/BiomapperLogLib.sol";
import {BridgedBiomapperLib} from "@biomapper-sdk/libraries/BridgedBiomapperLib.sol";

With Foundry

Install the dependency:

forge install humanode-network/biomapper-sdk

Import the dependencies from biomapper-sdk like this:

import {IBiomapperLogRead} from "biomapper-sdk/core/IBiomapperLogRead.sol";
import {IBridgedBiomapperRead} from "biomapper-sdk/core/IBridgedBiomapperRead.sol";
import {IBiomapperLogAddressesPerGenerationEnumerator} from "biomapper-sdk/core/IBiomapperLogAddressesPerGenerationEnumerator.sol";
import {BiomapperLogLib} from "biomapper-sdk/libraries/BiomapperLogLib.sol";
import {BridgedBiomapperLib} from "biomapper-sdk/libraries/BridgedBiomapperLib.sol";

Usage

See the usage directory for the simple usage examples, and the examples directory for a more complete use cases demonstration.