Skip to content
    hazBasehazBaseDocs
    API accessGitHub
    GuidesQuickstartMCPSDKHTTP APIPatternsBUILD WITH hazBase
    SMART CONTRACTS
    ← Contract catalog

    Whitelist

    Manage eligibility records used by token and transfer policies.

    Agreements, credentials & debtWhitelist.sol@hazbase/kit@0.9.0

    Role and use

    Keep participant approval status in one contract for tokens and markets to consult.

    Integration considerationsConnect identity checks and reviews through your business systems. Keep on-chain eligibility synchronized with review outcomes.

    Key SDK operations

    These operations are exposed by WhitelistHelper in @hazbase/kit@0.9.0. The signatures below are type definitions; see the SDK reference for parameter structures and the complete interface.

    typescript
    import { WhitelistHelper } from '@hazbase/kit';

    addBasic

    typescript
    async addBasic(user: Address): Promise<TransactionReceipt>

    removeBasic

    typescript
    async removeBasic(user: Address): Promise<TransactionReceipt>

    isWhitelisted

    typescript
    async isWhitelisted(user: Address): Promise<boolean>

    kycLevel

    typescript
    async kycLevel(user: Address): Promise<KYCLevel>
    View parameters, return types and all methods

    Related contracts

    FlexibleToken

    Issue and transfer rights or points represented as balances.

    BondToken

    Manage debt-like tokens by class and issuance nonce.

    MarketManager

    Handle token listings, purchases and fees.

    Put it into practice

    Access & membership

    See the data model, processing sequence and SDK code for an application-level implementation.

    Read the implementation pattern

    Specification and source

    The Solidity source is pinned to the revision below. Match it with the SDK version and your network’s implementation address and ABI.

    whitelist/contracts/Whitelist.sol

    Source revision: b53a5b5

    ← Back to the contract catalogPermissions & operations