🗃️SDK

Installation

npm install basepass-sdk

Quick Start

import { BasePass } from "basepass-sdk";

const bp = new BasePass({
  creatorWallet: "0xYOUR_CREATOR_ADDRESS",
});

const hasAccess = await bp.checkAccess("0xSUBSCRIBER_WALLET");

Configuration

const bp = new BasePass({
  creatorWallet: "0xCREATOR",     // required
  network: "mainnet",             // "mainnet" (default) or "sepolia"
  rpcUrl: "https://custom.rpc",   // optional custom RPC
});

Methods

checkAccess(walletAddress)

Returns true if the wallet has an active subscription.

const hasAccess = await bp.checkAccess("0x...");
// boolean

getSubscriptionStatus(walletAddress)

Returns detailed subscription info.

const status = await bp.getSubscriptionStatus("0x...");
// { isActive, expiresAt, remainingDays }

getCreatorInfo()

Returns creator data from the contract.

const info = await bp.getCreatorInfo();
// { pricePerMonth, isActive }

Integration Examples

Express

import { BasePass } from "basepass-sdk";

const bp = new BasePass({ creatorWallet: "0x..." });

function requireSub(req, res, next) {
  const wallet = req.headers["x-wallet-address"];
  if (!wallet) return res.status(401).json({ error: "Wallet required" });

  bp.checkAccess(wallet).then((ok) => {
    if (!ok) return res.status(403).json({ error: "Subscription required" });
    next();
  });
}

app.get("/premium", requireSub, (req, res) => {
  res.json({ content: "Gated content" });
});

Next.js

React

The SDK reads directly from the blockchain. For production, use a dedicated RPC provider and pass your URL via the rpcUrl option.