@whitewall-os/sdk 0.1.0

package/dist/abis.d.ts

@@ -0,0 +1,321 @@
+export declare const humanVerifiedPolicyAbi: readonly [{
+    readonly inputs: readonly [];
+    readonly name: "getRequiredTier";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "getIdentityRegistry";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "getValidationRegistry";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "getWorldIdValidator";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+export declare const identityRegistryAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "tokenId";
+        readonly type: "uint256";
+    }];
+    readonly name: "ownerOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }];
+    readonly name: "getAgentWallet";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "tokenId";
+        readonly type: "uint256";
+    }];
+    readonly name: "tokenURI";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "metadataKey";
+        readonly type: "string";
+    }];
+    readonly name: "getMetadata";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly name: "agentURI";
+        readonly type: "string";
+    }, {
+        readonly indexed: true;
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+    readonly name: "Registered";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "tokenId";
+        readonly type: "uint256";
+    }];
+    readonly name: "Transfer";
+    readonly type: "event";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "agentURI";
+        readonly type: "string";
+    }];
+    readonly name: "register";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "validator";
+        readonly type: "address";
+    }, {
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+export declare const validationRegistryAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "validatorAddresses";
+        readonly type: "address[]";
+    }, {
+        readonly name: "tag";
+        readonly type: "string";
+    }];
+    readonly name: "getSummary";
+    readonly outputs: readonly [{
+        readonly name: "count";
+        readonly type: "uint64";
+    }, {
+        readonly name: "avgResponse";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }];
+    readonly name: "getAgentValidations";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32[]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "requestHash";
+        readonly type: "bytes32";
+    }];
+    readonly name: "getValidationStatus";
+    readonly outputs: readonly [{
+        readonly name: "validatorAddress";
+        readonly type: "address";
+    }, {
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "response";
+        readonly type: "uint8";
+    }, {
+        readonly name: "responseHash";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "tag";
+        readonly type: "string";
+    }, {
+        readonly name: "lastUpdate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "validatorAddress";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly name: "requestURI";
+        readonly type: "string";
+    }, {
+        readonly indexed: true;
+        readonly name: "requestHash";
+        readonly type: "bytes32";
+    }];
+    readonly name: "ValidationRequest";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "validatorAddress";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: true;
+        readonly name: "requestHash";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: false;
+        readonly name: "response";
+        readonly type: "uint8";
+    }, {
+        readonly indexed: false;
+        readonly name: "responseURI";
+        readonly type: "string";
+    }, {
+        readonly indexed: false;
+        readonly name: "responseHash";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: false;
+        readonly name: "tag";
+        readonly type: "string";
+    }];
+    readonly name: "ValidationResponse";
+    readonly type: "event";
+}];
+export declare const worldIdValidatorAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "root";
+        readonly type: "uint256";
+    }, {
+        readonly name: "nullifierHash";
+        readonly type: "uint256";
+    }, {
+        readonly name: "proof";
+        readonly type: "uint256[8]";
+    }];
+    readonly name: "verifyAndSetHumanTag";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+export declare const whitewallConsumerAbi: readonly [{
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: true;
+        readonly name: "accountableHuman";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly name: "tier";
+        readonly type: "uint8";
+    }];
+    readonly name: "AccessGranted";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly name: "reason";
+        readonly type: "bytes32";
+    }];
+    readonly name: "AccessDenied";
+    readonly type: "event";
+}];

package/dist/abis.js

@@ -0,0 +1,209 @@
+// ── HumanVerifiedPolicy — entry point, SDK reads config from here ──
+export const humanVerifiedPolicyAbi = [
+    {
+        inputs: [],
+        name: "getRequiredTier",
+        outputs: [{ name: "", type: "uint8" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [],
+        name: "getIdentityRegistry",
+        outputs: [{ name: "", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [],
+        name: "getValidationRegistry",
+        outputs: [{ name: "", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [],
+        name: "getWorldIdValidator",
+        outputs: [{ name: "", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+];
+// ── IdentityRegistry ──
+export const identityRegistryAbi = [
+    {
+        inputs: [{ name: "tokenId", type: "uint256" }],
+        name: "ownerOf",
+        outputs: [{ name: "", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ name: "agentId", type: "uint256" }],
+        name: "getAgentWallet",
+        outputs: [{ name: "", type: "address" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ name: "owner", type: "address" }],
+        name: "balanceOf",
+        outputs: [{ name: "", type: "uint256" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ name: "tokenId", type: "uint256" }],
+        name: "tokenURI",
+        outputs: [{ name: "", type: "string" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            { name: "agentId", type: "uint256" },
+            { name: "metadataKey", type: "string" },
+        ],
+        name: "getMetadata",
+        outputs: [{ name: "", type: "bytes" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "agentId", type: "uint256" },
+            { indexed: false, name: "agentURI", type: "string" },
+            { indexed: true, name: "owner", type: "address" },
+        ],
+        name: "Registered",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "from", type: "address" },
+            { indexed: true, name: "to", type: "address" },
+            { indexed: true, name: "tokenId", type: "uint256" },
+        ],
+        name: "Transfer",
+        type: "event",
+    },
+    {
+        inputs: [{ name: "agentURI", type: "string" }],
+        name: "register",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        inputs: [
+            { name: "validator", type: "address" },
+            { name: "agentId", type: "uint256" },
+        ],
+        name: "approve",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+];
+// ── ValidationRegistry ──
+export const validationRegistryAbi = [
+    {
+        inputs: [
+            { name: "agentId", type: "uint256" },
+            { name: "validatorAddresses", type: "address[]" },
+            { name: "tag", type: "string" },
+        ],
+        name: "getSummary",
+        outputs: [
+            { name: "count", type: "uint64" },
+            { name: "avgResponse", type: "uint8" },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ name: "agentId", type: "uint256" }],
+        name: "getAgentValidations",
+        outputs: [{ name: "", type: "bytes32[]" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ name: "requestHash", type: "bytes32" }],
+        name: "getValidationStatus",
+        outputs: [
+            { name: "validatorAddress", type: "address" },
+            { name: "agentId", type: "uint256" },
+            { name: "response", type: "uint8" },
+            { name: "responseHash", type: "bytes32" },
+            { name: "tag", type: "string" },
+            { name: "lastUpdate", type: "uint256" },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "validatorAddress", type: "address" },
+            { indexed: true, name: "agentId", type: "uint256" },
+            { indexed: false, name: "requestURI", type: "string" },
+            { indexed: true, name: "requestHash", type: "bytes32" },
+        ],
+        name: "ValidationRequest",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "validatorAddress", type: "address" },
+            { indexed: true, name: "agentId", type: "uint256" },
+            { indexed: true, name: "requestHash", type: "bytes32" },
+            { indexed: false, name: "response", type: "uint8" },
+            { indexed: false, name: "responseURI", type: "string" },
+            { indexed: false, name: "responseHash", type: "bytes32" },
+            { indexed: false, name: "tag", type: "string" },
+        ],
+        name: "ValidationResponse",
+        type: "event",
+    },
+];
+// ── WorldIDValidator ──
+export const worldIdValidatorAbi = [
+    {
+        inputs: [
+            { name: "agentId", type: "uint256" },
+            { name: "root", type: "uint256" },
+            { name: "nullifierHash", type: "uint256" },
+            { name: "proof", type: "uint256[8]" },
+        ],
+        name: "verifyAndSetHumanTag",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+];
+// ── WhitewallConsumer ──
+export const whitewallConsumerAbi = [
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "agentId", type: "uint256" },
+            { indexed: true, name: "accountableHuman", type: "address" },
+            { indexed: false, name: "tier", type: "uint8" },
+        ],
+        name: "AccessGranted",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            { indexed: true, name: "agentId", type: "uint256" },
+            { indexed: false, name: "reason", type: "bytes32" },
+        ],
+        name: "AccessDenied",
+        type: "event",
+    },
+];

package/dist/addresses.d.ts

@@ -0,0 +1,14 @@
+import type { Address } from "viem";
+export type ChainName = "baseSepolia";
+export interface WhitewallOSAddresses {
+    humanVerifiedPolicy: Address;
+    whitewallConsumer: Address;
+}
+/** Protocol-level policy config, read from on-chain HumanVerifiedPolicy */
+export interface PolicyConfig {
+    identityRegistry: Address;
+    validationRegistry: Address;
+    worldIdValidator: Address;
+    requiredTier: number;
+}
+export declare const addresses: Record<ChainName, WhitewallOSAddresses>;

package/dist/addresses.js

@@ -0,0 +1,6 @@
+export const addresses = {
+    baseSepolia: {
+        humanVerifiedPolicy: "0x8f66f55f4ade4e64b105820972d444a56449e8b3",
+        whitewallConsumer: "0xec3114ea6bb29f77b63cd1223533870b663120bb",
+    },
+};

package/dist/client.d.ts

@@ -0,0 +1,37 @@
+import { type Address, type PublicClient, type Transport, type Chain, type WatchEventReturnType } from "viem";
+import { type ChainName, type WhitewallOSAddresses, type PolicyConfig } from "./addresses.js";
+import type { AgentStatus, AccessGrantedEvent, ValidationSummary } from "./types.js";
+export interface WhitewallOSConfig {
+    chain: ChainName;
+    rpcUrl?: string;
+    /** Pass your own viem PublicClient to skip internal client creation */
+    publicClient?: PublicClient<Transport, Chain>;
+}
+export declare class WhitewallOS {
+    private client;
+    private addrs;
+    private policy;
+    private constructor();
+    /**
+     * Create and connect a WhitewallOS instance.
+     * Reads policy config from on-chain HumanVerifiedPolicy contract.
+     */
+    static connect(config: WhitewallOSConfig): Promise<WhitewallOS>;
+    /** Read policy configuration from the on-chain HumanVerifiedPolicy contract */
+    private loadPolicyConfig;
+    private get policyConfig();
+    isRegistered(agentId: bigint): Promise<boolean>;
+    isHumanVerified(agentId: bigint): Promise<boolean>;
+    getOwner(agentId: bigint): Promise<Address>;
+    getAgentWallet(agentId: bigint): Promise<Address>;
+    getTokenURI(agentId: bigint): Promise<string>;
+    getMetadata(agentId: bigint, key: string): Promise<`0x${string}`>;
+    getValidationSummary(agentId: bigint): Promise<ValidationSummary>;
+    getAgentValidations(agentId: bigint): Promise<readonly `0x${string}`[]>;
+    getAgentStatus(agentId: bigint): Promise<AgentStatus>;
+    onAccessGranted(callback: (event: AccessGrantedEvent) => void): WatchEventReturnType;
+    onRegistered(callback: (agentId: bigint, owner: Address) => void): WatchEventReturnType;
+    getAddresses(): WhitewallOSAddresses;
+    getPolicyConfig(): PolicyConfig;
+    getPublicClient(): PublicClient<Transport, Chain>;
+}