SDKs & Libraries

Full-featured TypeScript SDK for both browser and Node.js environments

npm install @fairway/sdk

import { FairwayClient } from '@fairway/sdk'

const client = new FairwayClient({
  apiKey: process.env.FAIRWAY_API_KEY,
  network: 'mainnet'
})

// Check eligibility
const result = await client.checkEligibility('addr1...')
console.log(result.eligible) // true/false

Aiken library for Cardano smart contract integration

aiken packages add fairway/aiken --version v1.3.0

use aiken/list
use fairway/compliance.{verify_kyc, PolicyDatum}

validator kyc_gated_pool {
  fn spend(datum: PolicyDatum, _redeemer: Data, ctx: ScriptContext) {
    let tx = ctx.transaction
    verify_kyc(datum.policy_id, tx.inputs)
  }
}

Solidity contracts for EVM-compatible chains with ERC-3643 support

npm install @fairway/contracts

import "@fairway/contracts/PolicyEngine.sol";

contract MyDeFiProtocol {
    PolicyEngine public policyEngine;
    
    constructor(address _policyEngine) {
        policyEngine = PolicyEngine(_policyEngine);
    }
    
    modifier onlyCompliant(address user) {
        require(
            policyEngine.isEligible(user, "institutional_kyc"),
            "User not compliant"
        );
        _;
    }
}

Python SDK for backend integrations and data analysis

pip install fairway-python

from fairway import FairwayClient

client = FairwayClient(api_key="your_api_key")

# Batch eligibility check
addresses = ["addr1...", "addr2..."]
results = client.batch_check_eligibility(addresses)

for addr, result in results.items():
    print(f"{addr}: {result.eligible}")