@aromedia/contracts-sdk 0.2.0 → 1.0.1

package/dist/{onboarding-BHpAJaNW.d.cts → onboarding-CC_y8QgN.d.cts}

@@ -2,7 +2,15 @@ import { PublicClient, WalletClient, GetContractReturnType, Chain, Transport, Ac
 import { AroChainId } from './generated/addresses.cjs';
 import { AroMediaAccessManager_ABI, AroMediaAssetsRegistry_ABI, ForcedTransferManager_ABI, AroMediaIncMultiSig_ABI, AroNomination_ABI, AroMediaRWA_ABI, AroSBT_ABI } from './generated/abis.cjs';
 
-/** Mirrors AroSBT.Tier. */
+/**
+ * Conventional default tier labels for AroSBT membership.
+ *
+ * On-chain, the SBT's `tier` is now an opaque `uint256` whose semantics
+ * are defined off-chain by the admin backend (no on-chain logic branches
+ * on it). These enum values are the conventional defaults the dapp
+ * displays when no off-chain override is available; new tier ids can be
+ * introduced server-side without a contract upgrade or SDK release.
+ */
 declare enum AroTier {
     STANDARD = 0,
     VERIFIED = 1,
@@ -10,13 +18,19 @@ declare enum AroTier {
     FOUNDING = 3
 }
 declare const AroTierLabels: Record<AroTier, string>;
-/** Mirrors AroNomination.NominationStatus. */
+/**
+ * @deprecated Mirrors AroNomination.NominationStatus. The on-chain
+ * nomination flow is being retired in favor of an admin-portal backend
+ * flow (see the AroNomination_ABI deprecation). New consumers should
+ * read status from the admin portal API instead.
+ */
 declare enum NominationStatus {
     NONE = 0,
     PENDING = 1,
     APPROVED = 2,
     CLEARED = 3
 }
+/** @deprecated See NominationStatus. */
 declare const NominationStatusLabels: Record<NominationStatus, string>;
 /** Mirrors ForcedTransferManager.ForcedTransferStatus. */
 declare enum ForcedTransferStatus {
@@ -187,11 +201,22 @@ declare function createAroSdk(opts: CreateAroSdkOpts): AroSdk;
 declare function addressesFor(chainId: AroChainId): Record<keyof AroAddressOverrides, `0x${string}`>;
 
 /**
- * Onboarding workflow helpers. These wrap multi-call sequences from the
- * ARO KYC/AML/CFT Policy §6 so the dapp does not have to re-implement the
- * choreography in three different places.
+ * Onboarding workflow helpers.
+ *
+ * STATUS: The on-chain nomination + admin-mint helpers below are
+ * @deprecated and slated for removal in a future major release. The
+ * nomination flow has moved to the admin backend (see the admin portal's
+ * /access-control + onboarding API), and SBT minting is now
+ * candidate-triggered against an EIP-712 voucher
+ * (`AroSBT.mintWithApproval`; see `../utils/mintApproval.ts` and
+ * `../hooks/useAroSBT.ts::useMintWithApproval`). The on-chain
+ * `AroNomination` contract is retained on Sepolia for compatibility but
+ * is no longer deployed to new networks.
+ *
+ * Status-read helpers (`checkMembershipStatus`, `describeOnboardingState`)
+ * remain useful regardless of the underlying flow and are NOT deprecated.
  *
- * Mental model (per Policy §6.3):
+ * Original mental model (kept for reference; pre-migration):
  *
  *   1. Existing member calls `nominateCandidate(candidate)`.
  *      The nominator's vouch counts as the first vouch automatically.
@@ -216,7 +241,12 @@ declare function addressesFor(chainId: AroChainId): Record<keyof AroAddressOverr
  */
 interface MembershipStatus {
     hasSBT: boolean;
-    tier?: AroTier;
+    /**
+     * Tier id (AroSBT.Tier enum, uint8) as returned by AroSBT.getMemberData.
+     * Compare with `tierLabel`, `tierAtLeast`, or the AroTier enum values for
+     * the conventional defaults; semantics live off-chain in the admin backend.
+     */
+    tier?: number;
     tokenId?: bigint;
     memberId?: bigint;
     issuanceDate?: bigint;
@@ -246,9 +276,16 @@ interface NominationSnapshot {
 /**
  * Snapshot of the candidate's progress through the vouch flow. The dapp
  * shows this as "you need N more vouches" in the onboarding UI.
+ *
+ * @deprecated On-chain nomination is retired. Read this status from the
+ * admin portal's onboarding API instead. Removal planned in a future
+ * major release.
  */
 declare function getNominationSnapshot(sdk: AroSdk, candidate: `0x${string}`): Promise<NominationSnapshot>;
 /**
+ * @deprecated On-chain nomination is retired. Use the admin portal's
+ * onboarding API instead. Removal planned in a future major release.
+ *
  * Send `nominate(candidate)` from the connected wallet. The contract
  * gates this behind "caller must already be an SBT holder"; we surface
  * the right user-facing message via `AroContractError`.
@@ -256,10 +293,17 @@ declare function getNominationSnapshot(sdk: AroSdk, candidate: `0x${string}`): P
 declare function nominateCandidate(sdk: AroSdk, candidate: `0x${string}`, opts?: {
     account?: Account | `0x${string}`;
 }): Promise<Hex>;
+/**
+ * @deprecated On-chain vouching is retired. Use the admin portal's
+ * onboarding API instead. Removal planned in a future major release.
+ */
 declare function vouchForCandidate(sdk: AroSdk, candidate: `0x${string}`, opts?: {
     account?: Account | `0x${string}`;
 }): Promise<Hex>;
 /**
+ * @deprecated On-chain nomination is retired. The admin portal handles
+ * rejections in its backend. Removal planned in a future major release.
+ *
  * Admin path: clear (reject) a nomination. Restricted to authorized roles
  * via AccessManager; will revert with AccessManagedUnauthorized if the
  * caller lacks the role.
@@ -273,11 +317,22 @@ interface MintSBTOpts {
     kycHash: `0x${string}`;
     /** Off-chain profile metadata URI (ipfs://... or https://...). */
     metadataURI: string;
-    /** Initial tier (defaults to STANDARD per Policy §6.1). */
-    tier?: AroTier;
+    /**
+     * Initial tier id (AroSBT.Tier enum, uint8; defaults to 0 / "Standard").
+     * Accepts AroTier enum values for the conventional defaults, or any tier
+     * id defined off-chain by the admin backend.
+     */
+    tier?: number | AroTier;
     account?: Account | `0x${string}`;
 }
 /**
+ * @deprecated SBT minting is now candidate-triggered against an EIP-712
+ * voucher (`AroSBT.mintWithApproval`). The admin backend issues vouchers
+ * via `signMintApproval` in `../utils/mintApproval`, and the candidate
+ * submits via the `useMintWithApproval` hook in `../hooks/useAroSBT`.
+ * The direct admin mint below remains gated by ROLE_MINTER but is the
+ * legacy path; removal planned in a future major release.
+ *
  * Admin-only: mint the SBT for an approved candidate. The contract gates
  * this behind ROLE_MINTER via AccessManager (per AroMediaAccessManager).
  *

package/dist/{onboarding-DxL_LpM3.d.ts → onboarding-KnUSrGNx.d.ts}

@@ -2,7 +2,15 @@ import { PublicClient, WalletClient, GetContractReturnType, Chain, Transport, Ac
 import { AroChainId } from './generated/addresses.js';
 import { AroMediaAccessManager_ABI, AroMediaAssetsRegistry_ABI, ForcedTransferManager_ABI, AroMediaIncMultiSig_ABI, AroNomination_ABI, AroMediaRWA_ABI, AroSBT_ABI } from './generated/abis.js';
 
-/** Mirrors AroSBT.Tier. */
+/**
+ * Conventional default tier labels for AroSBT membership.
+ *
+ * On-chain, the SBT's `tier` is now an opaque `uint256` whose semantics
+ * are defined off-chain by the admin backend (no on-chain logic branches
+ * on it). These enum values are the conventional defaults the dapp
+ * displays when no off-chain override is available; new tier ids can be
+ * introduced server-side without a contract upgrade or SDK release.
+ */
 declare enum AroTier {
     STANDARD = 0,
     VERIFIED = 1,
@@ -10,13 +18,19 @@ declare enum AroTier {
     FOUNDING = 3
 }
 declare const AroTierLabels: Record<AroTier, string>;
-/** Mirrors AroNomination.NominationStatus. */
+/**
+ * @deprecated Mirrors AroNomination.NominationStatus. The on-chain
+ * nomination flow is being retired in favor of an admin-portal backend
+ * flow (see the AroNomination_ABI deprecation). New consumers should
+ * read status from the admin portal API instead.
+ */
 declare enum NominationStatus {
     NONE = 0,
     PENDING = 1,
     APPROVED = 2,
     CLEARED = 3
 }
+/** @deprecated See NominationStatus. */
 declare const NominationStatusLabels: Record<NominationStatus, string>;
 /** Mirrors ForcedTransferManager.ForcedTransferStatus. */
 declare enum ForcedTransferStatus {
@@ -187,11 +201,22 @@ declare function createAroSdk(opts: CreateAroSdkOpts): AroSdk;
 declare function addressesFor(chainId: AroChainId): Record<keyof AroAddressOverrides, `0x${string}`>;
 
 /**
- * Onboarding workflow helpers. These wrap multi-call sequences from the
- * ARO KYC/AML/CFT Policy §6 so the dapp does not have to re-implement the
- * choreography in three different places.
+ * Onboarding workflow helpers.
+ *
+ * STATUS: The on-chain nomination + admin-mint helpers below are
+ * @deprecated and slated for removal in a future major release. The
+ * nomination flow has moved to the admin backend (see the admin portal's
+ * /access-control + onboarding API), and SBT minting is now
+ * candidate-triggered against an EIP-712 voucher
+ * (`AroSBT.mintWithApproval`; see `../utils/mintApproval.ts` and
+ * `../hooks/useAroSBT.ts::useMintWithApproval`). The on-chain
+ * `AroNomination` contract is retained on Sepolia for compatibility but
+ * is no longer deployed to new networks.
+ *
+ * Status-read helpers (`checkMembershipStatus`, `describeOnboardingState`)
+ * remain useful regardless of the underlying flow and are NOT deprecated.
  *
- * Mental model (per Policy §6.3):
+ * Original mental model (kept for reference; pre-migration):
  *
  *   1. Existing member calls `nominateCandidate(candidate)`.
  *      The nominator's vouch counts as the first vouch automatically.
@@ -216,7 +241,12 @@ declare function addressesFor(chainId: AroChainId): Record<keyof AroAddressOverr
  */
 interface MembershipStatus {
     hasSBT: boolean;
-    tier?: AroTier;
+    /**
+     * Tier id (AroSBT.Tier enum, uint8) as returned by AroSBT.getMemberData.
+     * Compare with `tierLabel`, `tierAtLeast`, or the AroTier enum values for
+     * the conventional defaults; semantics live off-chain in the admin backend.
+     */
+    tier?: number;
     tokenId?: bigint;
     memberId?: bigint;
     issuanceDate?: bigint;
@@ -246,9 +276,16 @@ interface NominationSnapshot {
 /**
  * Snapshot of the candidate's progress through the vouch flow. The dapp
  * shows this as "you need N more vouches" in the onboarding UI.
+ *
+ * @deprecated On-chain nomination is retired. Read this status from the
+ * admin portal's onboarding API instead. Removal planned in a future
+ * major release.
  */
 declare function getNominationSnapshot(sdk: AroSdk, candidate: `0x${string}`): Promise<NominationSnapshot>;
 /**
+ * @deprecated On-chain nomination is retired. Use the admin portal's
+ * onboarding API instead. Removal planned in a future major release.
+ *
  * Send `nominate(candidate)` from the connected wallet. The contract
  * gates this behind "caller must already be an SBT holder"; we surface
  * the right user-facing message via `AroContractError`.
@@ -256,10 +293,17 @@ declare function getNominationSnapshot(sdk: AroSdk, candidate: `0x${string}`): P
 declare function nominateCandidate(sdk: AroSdk, candidate: `0x${string}`, opts?: {
     account?: Account | `0x${string}`;
 }): Promise<Hex>;
+/**
+ * @deprecated On-chain vouching is retired. Use the admin portal's
+ * onboarding API instead. Removal planned in a future major release.
+ */
 declare function vouchForCandidate(sdk: AroSdk, candidate: `0x${string}`, opts?: {
     account?: Account | `0x${string}`;
 }): Promise<Hex>;
 /**
+ * @deprecated On-chain nomination is retired. The admin portal handles
+ * rejections in its backend. Removal planned in a future major release.
+ *
  * Admin path: clear (reject) a nomination. Restricted to authorized roles
  * via AccessManager; will revert with AccessManagedUnauthorized if the
  * caller lacks the role.
@@ -273,11 +317,22 @@ interface MintSBTOpts {
     kycHash: `0x${string}`;
     /** Off-chain profile metadata URI (ipfs://... or https://...). */
     metadataURI: string;
-    /** Initial tier (defaults to STANDARD per Policy §6.1). */
-    tier?: AroTier;
+    /**
+     * Initial tier id (AroSBT.Tier enum, uint8; defaults to 0 / "Standard").
+     * Accepts AroTier enum values for the conventional defaults, or any tier
+     * id defined off-chain by the admin backend.
+     */
+    tier?: number | AroTier;
     account?: Account | `0x${string}`;
 }
 /**
+ * @deprecated SBT minting is now candidate-triggered against an EIP-712
+ * voucher (`AroSBT.mintWithApproval`). The admin backend issues vouchers
+ * via `signMintApproval` in `../utils/mintApproval`, and the candidate
+ * submits via the `useMintWithApproval` hook in `../hooks/useAroSBT`.
+ * The direct admin mint below remains gated by ROLE_MINTER but is the
+ * legacy path; removal planned in a future major release.
+ *
  * Admin-only: mint the SBT for an approved candidate. The contract gates
  * this behind ROLE_MINTER via AccessManager (per AroMediaAccessManager).
  *

package/dist/workflows/index.cjs

@@ -1890,7 +1890,7 @@ async function mintSBTForApproved(sdk, opts) {
     throw new Error("mintSBTForApproved requires a walletClient on the SDK");
   }
   const wallet = sdk.walletClient;
-  const tier = opts.tier ?? 0 /* STANDARD */;
+  const tier = opts.tier === void 0 ? 0 : typeof opts.tier === "bigint" ? Number(opts.tier) : opts.tier;
   try {
     return await wallet.writeContract({
       account: pickAccount(wallet, opts.account),