@aromedia/contracts-sdk 0.2.0

package/dist/workflows/index.d.cts

@@ -0,0 +1,72 @@
+export { M as MembershipStatus, q as MintSBTOpts, s as NominationSnapshot, O as OnboardingState, v as OnboardingStep, x as checkMembershipStatus, y as clearNomination, K as describeOnboardingState, L as getNominationSnapshot, P as mintSBTForApproved, Q as nominateCandidate, T as vouchForCandidate } from '../onboarding-BHpAJaNW.cjs';
+import { Hex } from 'viem';
+import '../generated/addresses.cjs';
+import '../generated/abis.cjs';
+
+/**
+ * KYC hash computation as required by the ARO KYC/AML/CFT Policy §6.2.
+ *
+ * The on-chain `kycHash` (bytes32) is a keccak256 over a deterministic
+ * serialization of the verified identity payload returned by the KYC
+ * provider (Didit, per MEMO-KYC-PROVIDER). Storing only the hash on-chain
+ * gives us tamper-evidence without ever exposing PII on a public ledger.
+ *
+ * Why deterministic serialization: the same identity payload must hash to
+ * the same value across processes, languages, and timezones — JSON object
+ * key order is otherwise implementation-dependent, which would silently
+ * change the hash and break audit-trail equivalence.
+ *
+ * The serializer:
+ *   • Sorts object keys recursively.
+ *   • Coerces undefined → null so it survives JSON.stringify.
+ *   • Refuses functions, symbols, bigints, and class instances.
+ */
+interface KycPayload {
+    /** Provider's verification session id (e.g. Didit `session_id`). */
+    sessionId: string;
+    /** Provider name — lets us roll over to a different vendor later. */
+    provider: string;
+    /** Verification status returned by the provider. */
+    status: string;
+    /** ISO-8601 timestamp of the provider's verification decision. */
+    verifiedAt: string;
+    /** Wallet address the verification is bound to. */
+    walletAddress: `0x${string}`;
+    /** Anything else the provider returned that we want anchored on-chain. */
+    attributes?: Record<string, JsonScalar | JsonScalar[]>;
+}
+type JsonScalar = string | number | boolean | null;
+/**
+ * Compute the bytes32 hash stored on-chain in AroSBT.MemberData.kycHash.
+ *
+ * @param payload  Verified identity payload from the KYC provider.
+ * @returns        Hex-encoded keccak256 (`0x...`, 66 chars).
+ */
+declare function computeKycHash(payload: KycPayload): Hex;
+
+/**
+ * Normalized representation of a KYC verification result. Whatever vendor
+ * the dapp uses, results should be mapped into this shape before hashing
+ * so the on-chain hash is vendor-stable.
+ */
+interface NormalizedKycResult {
+    /** Vendor name — "didit" today. */
+    provider: string;
+    /** Vendor session id. */
+    sessionId: string;
+    /** Pass-through status string from the vendor. */
+    status: "verified" | "failed" | "pending" | "expired";
+    /** ISO-8601 timestamp from the vendor's verification decision. */
+    verifiedAt: string;
+    /** Wallet the verification is bound to. */
+    walletAddress: `0x${string}`;
+    /** Optional extras the dapp wants anchored on-chain. */
+    attributes?: Record<string, string | number | boolean | null>;
+}
+/**
+ * Hash a normalized KYC result for SBT minting. Wrapper around
+ * `computeKycHash` that enforces the shape we expect from the dapp.
+ */
+declare function hashKycResult(result: NormalizedKycResult): `0x${string}`;
+
+export { type KycPayload, type NormalizedKycResult, computeKycHash, hashKycResult };

package/dist/workflows/index.d.ts

@@ -0,0 +1,72 @@
+export { M as MembershipStatus, q as MintSBTOpts, s as NominationSnapshot, O as OnboardingState, v as OnboardingStep, x as checkMembershipStatus, y as clearNomination, K as describeOnboardingState, L as getNominationSnapshot, P as mintSBTForApproved, Q as nominateCandidate, T as vouchForCandidate } from '../onboarding-DxL_LpM3.js';
+import { Hex } from 'viem';
+import '../generated/addresses.js';
+import '../generated/abis.js';
+
+/**
+ * KYC hash computation as required by the ARO KYC/AML/CFT Policy §6.2.
+ *
+ * The on-chain `kycHash` (bytes32) is a keccak256 over a deterministic
+ * serialization of the verified identity payload returned by the KYC
+ * provider (Didit, per MEMO-KYC-PROVIDER). Storing only the hash on-chain
+ * gives us tamper-evidence without ever exposing PII on a public ledger.
+ *
+ * Why deterministic serialization: the same identity payload must hash to
+ * the same value across processes, languages, and timezones — JSON object
+ * key order is otherwise implementation-dependent, which would silently
+ * change the hash and break audit-trail equivalence.
+ *
+ * The serializer:
+ *   • Sorts object keys recursively.
+ *   • Coerces undefined → null so it survives JSON.stringify.
+ *   • Refuses functions, symbols, bigints, and class instances.
+ */
+interface KycPayload {
+    /** Provider's verification session id (e.g. Didit `session_id`). */
+    sessionId: string;
+    /** Provider name — lets us roll over to a different vendor later. */
+    provider: string;
+    /** Verification status returned by the provider. */
+    status: string;
+    /** ISO-8601 timestamp of the provider's verification decision. */
+    verifiedAt: string;
+    /** Wallet address the verification is bound to. */
+    walletAddress: `0x${string}`;
+    /** Anything else the provider returned that we want anchored on-chain. */
+    attributes?: Record<string, JsonScalar | JsonScalar[]>;
+}
+type JsonScalar = string | number | boolean | null;
+/**
+ * Compute the bytes32 hash stored on-chain in AroSBT.MemberData.kycHash.
+ *
+ * @param payload  Verified identity payload from the KYC provider.
+ * @returns        Hex-encoded keccak256 (`0x...`, 66 chars).
+ */
+declare function computeKycHash(payload: KycPayload): Hex;
+
+/**
+ * Normalized representation of a KYC verification result. Whatever vendor
+ * the dapp uses, results should be mapped into this shape before hashing
+ * so the on-chain hash is vendor-stable.
+ */
+interface NormalizedKycResult {
+    /** Vendor name — "didit" today. */
+    provider: string;
+    /** Vendor session id. */
+    sessionId: string;
+    /** Pass-through status string from the vendor. */
+    status: "verified" | "failed" | "pending" | "expired";
+    /** ISO-8601 timestamp from the vendor's verification decision. */
+    verifiedAt: string;
+    /** Wallet the verification is bound to. */
+    walletAddress: `0x${string}`;
+    /** Optional extras the dapp wants anchored on-chain. */
+    attributes?: Record<string, string | number | boolean | null>;
+}
+/**
+ * Hash a normalized KYC result for SBT minting. Wrapper around
+ * `computeKycHash` that enforces the shape we expect from the dapp.
+ */
+declare function hashKycResult(result: NormalizedKycResult): `0x${string}`;
+
+export { type KycPayload, type NormalizedKycResult, computeKycHash, hashKycResult };

package/dist/workflows/index.js

@@ -0,0 +1,25 @@
+import {
+  checkMembershipStatus,
+  clearNomination,
+  computeKycHash,
+  describeOnboardingState,
+  getNominationSnapshot,
+  hashKycResult,
+  mintSBTForApproved,
+  nominateCandidate,
+  vouchForCandidate
+} from "../chunk-7I5N3BGV.js";
+import "../chunk-BYPGUFYV.js";
+import "../chunk-TZQHQLNY.js";
+export {
+  checkMembershipStatus,
+  clearNomination,
+  computeKycHash,
+  describeOnboardingState,
+  getNominationSnapshot,
+  hashKycResult,
+  mintSBTForApproved,
+  nominateCandidate,
+  vouchForCandidate
+};
+//# sourceMappingURL=index.js.map

package/dist/workflows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@aromedia/contracts-sdk",
+  "version": "0.2.0",
+  "description": "TypeScript SDK for the Aro Media on-chain ecosystem (SBT identity, nomination, RWA, registry, multisig, forced transfer).",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "import": "./dist/hooks/index.js",
+      "require": "./dist/hooks/index.cjs"
+    },
+    "./abis": {
+      "types": "./dist/abis.d.ts",
+      "import": "./dist/abis.js",
+      "require": "./dist/abis.cjs"
+    },
+    "./addresses": {
+      "types": "./dist/addresses.d.ts",
+      "import": "./dist/addresses.js",
+      "require": "./dist/addresses.cjs"
+    },
+    "./chains": {
+      "types": "./dist/chains.d.ts",
+      "import": "./dist/chains.js",
+      "require": "./dist/chains.cjs"
+    },
+    "./workflows": {
+      "types": "./dist/workflows/index.d.ts",
+      "import": "./dist/workflows/index.js",
+      "require": "./dist/workflows/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "generate": "tsx scripts/generate.ts",
+    "build": "tsup --config ./tsup.config.json src/index.ts src/hooks/index.ts src/generated/abis.ts src/generated/addresses.ts src/chains.ts src/workflows/index.ts --format esm,cjs --dts --sourcemap --target es2022 --external react --external wagmi --external @tanstack/react-query --external viem",
+    "dev": "tsup --config ./tsup.config.json src/index.ts --format esm --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "npm run build && changeset publish",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@tanstack/react-query": "^5",
+    "react": "^18 || ^19",
+    "viem": "^2.21.0",
+    "wagmi": "^2 || ^3"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "wagmi": {
+      "optional": true
+    },
+    "@tanstack/react-query": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.0",
+    "@tanstack/react-query": "^5.0.0",
+    "@types/node": "^20.19.41",
+    "@types/react": "^19.0.0",
+    "react": "^19.0.0",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.5.0",
+    "viem": "^2.21.0",
+    "wagmi": "^3.6.10"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aromediainc/contracts-sdk.git"
+  },
+  "homepage": "https://github.com/aromediainc/contracts-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/aromediainc/contracts-sdk/issues"
+  },
+  "keywords": [
+    "aro",
+    "aromedia",
+    "ethereum",
+    "viem",
+    "wagmi",
+    "sbt",
+    "rwa",
+    "soulbound",
+    "erc-5192",
+    "kyc"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}