@cofhe/sdk 1.0.0-alpha.0 → 1.1.0-alpha.0

package/dist/{clientTypes-CcU5WvdV.d.ts → clientTypes-CnslFzxB.d.ts}

@@ -1,7 +1,7 @@
-import { WalletClient, PublicClient, Hex } from 'viem';
+import { WalletClient, PublicClient, Hex, ContractFunctionParameters } from 'viem';
 import { C as CofheChain } from './types-C07FK-cL.js';
 import { z } from 'zod';
-import { A as ACP, k as EIP712Domain, C as CreateSelfACPOptions, J as SelfACP, g as CreateSharingACPOptions, K as SharingACP, I as ImportSharedACPOptions, R as RecipientACP, P as ACPHashFields, f as SerializedACP, O as ACPAccessStatus, S as ShareLabel, j as IncomingShare, p as AclServedAddresses, L as LabelledShare, w as ShareLabelVerifyMode, x as ShareLabelCheck, l as ACPUtils } from './onchain-utils-D9Z33IP7.js';
+import { A as ACP, k as EIP712Domain, C as CreateSelfACPOptions, $ as SelfACP, g as CreateSharingACPOptions, a0 as SharingACP, I as ImportSharedACPOptions, a1 as RecipientACP, a5 as ACPHashFields, f as SerializedACP, t as ACP_REVOKER_ABI, a4 as ACPAccessStatus, S as ShareLabel, v as ACP_SHARE_REGISTRY_ABI, j as IncomingShare, p as AclServedAddresses, L as LabelledShare, Q as ShareLabelVerifyMode, R as ShareLabelCheck, l as ACPUtils } from './onchain-utils-Ns56cBm0.js';
 import { StoreApi } from 'zustand/vanilla';
 
 type TfheInitializer = () => Promise<boolean>;
@@ -1031,6 +1031,21 @@ type ImportSharedOptions = ImportActivationOptions & {
      */
     name?: string;
 };
+/**
+ * Revoke a single acp on-chain via its revoker contract.
+ * Only the acp's issuer can revoke it (enforced by the revoker: revocations
+ * are keyed by msg.sender). The acp stays in local storage — on-chain
+ * validation will reject it from the next block onwards.
+ *
+ * @returns the revocation transaction hash
+ */
+/**
+ * A registry or revoker write built but not sent: what a simulation or `writeContract` takes,
+ * minus the sender. For a caller that sends through its own path (simulate first, record the
+ * transaction) instead of the plain `writeContract` the senders below do.
+ */
+type ShareRegistryWrite<functionName extends 'share' | 'removeShare'> = ContractFunctionParameters<typeof ACP_SHARE_REGISTRY_ABI, 'nonpayable', functionName>;
+type RevokerWrite = ContractFunctionParameters<typeof ACP_REVOKER_ABI, 'nonpayable', 'revokeSingle'>;
 /**
  * What `shareOnChain` posts with a share: the labels of its handles (one per handle, in order;
  * encoded with `encodeShareMetadata`), or an already encoded metadata blob. Written once, with the
@@ -1191,6 +1206,7 @@ declare const acps: {
     selectActiveACP: (chainId: number, account: string, hash: string) => void;
     removeActiveACP: (chainId: number, account: string) => Promise<void>;
     revokeACP: (acp: ACP, walletClient: WalletClient) => Promise<Hex>;
+    prepareRevokeACP: (acp: ACP) => RevokerWrite;
     revokeAllACPs: (walletClient: WalletClient, publicClient: PublicClient, revokerContract?: Hex) => Promise<Hex>;
     isACPRevoked: (acp: ACP, publicClient: PublicClient) => Promise<boolean>;
     checkAccess: (acp: ACP, publicClient: PublicClient, handle?: bigint | Hex) => Promise<ACPAccessStatus>;
@@ -1198,12 +1214,17 @@ declare const acps: {
         txHash: Hex;
         shareId: Hex;
     }>;
+    prepareShareOnChain: (acp: ACP, registry: Hex, options?: ShareOnChainOptions) => {
+        write: ShareRegistryWrite<"share">;
+        shareId: Hex;
+    };
     getIncomingShares: (publicClient: PublicClient, registry: Hex, recipient: Hex, { appKey }?: {
         appKey?: Hex;
     }) => Promise<IncomingShare[]>;
     getShareFromChain: (publicClient: PublicClient, registry: Hex, shareId: Hex) => Promise<IncomingShare | null>;
     importFromChain: (share: IncomingShare, publicClient: PublicClient, walletClient: WalletClient, importOptions?: ImportSharedOptions) => Promise<RecipientACP>;
     removeShareOnChain: (shareId: Hex, walletClient: WalletClient, registry: Hex) => Promise<Hex>;
+    prepareRemoveShare: (shareId: Hex, registry: Hex) => ShareRegistryWrite<"removeShare">;
     computeShareId: (acp: ACP) => Hex;
     applyACPDefaultsFromChain: <T extends {
         revokerData?: number;
@@ -1286,6 +1307,11 @@ type CofheClientACPs = {
     removeACP: (hash: string, chainId?: number, account?: string) => void;
     removeActiveACP: (chainId?: number, account?: string) => void;
     revokeACP: (acp: ACP) => Promise<`0x${string}`>;
+    /**
+     * The revoker write `revokeACP` sends, built but not sent — for an app that sends through its own
+     * path (a simulation first, a transaction store). Issuer only; throws for an acp without a revoker.
+     */
+    prepareRevokeACP: (acp: ACP) => RevokerWrite;
     revokeAllACPs: (revokerContract?: `0x${string}`) => Promise<`0x${string}`>;
     isACPRevoked: (acp: ACP) => Promise<boolean>;
     /**
@@ -1303,6 +1329,16 @@ type CofheClientACPs = {
         txHash: `0x${string}`;
         shareId: `0x${string}`;
     }>;
+    /**
+     * The registry write `shareOnChain` sends and the share id it gets, built but not sent — for an
+     * app that sends through its own path (a simulation first, a transaction store). Issuer only.
+     */
+    prepareShareOnChain: (acp: ACP, options?: ShareOnChainOptions) => Promise<{
+        write: ShareRegistryWrite<'share'>;
+        shareId: `0x${string}`;
+    }>;
+    /** The registry write `dismissShare` / `cancelShare` sends, built but not sent. */
+    prepareRemoveShare: (shareId: `0x${string}`) => Promise<ShareRegistryWrite<'removeShare'>>;
     /** Importable shares addressed to the connected account (unexpired, not revoked), with their metadata. */
     getIncomingShares: () => Promise<IncomingShare[]>;
     /** One share by id, as posted; null when unknown or removed. */

package/dist/{clientTypes-C0A9ji5O.d.cts → clientTypes-RXwLVWou.d.cts}

@@ -1,7 +1,7 @@
-import { WalletClient, PublicClient, Hex } from 'viem';
+import { WalletClient, PublicClient, Hex, ContractFunctionParameters } from 'viem';
 import { C as CofheChain } from './types-C07FK-cL.cjs';
 import { z } from 'zod';
-import { A as ACP, k as EIP712Domain, C as CreateSelfACPOptions, J as SelfACP, g as CreateSharingACPOptions, K as SharingACP, I as ImportSharedACPOptions, R as RecipientACP, P as ACPHashFields, f as SerializedACP, O as ACPAccessStatus, S as ShareLabel, j as IncomingShare, p as AclServedAddresses, L as LabelledShare, w as ShareLabelVerifyMode, x as ShareLabelCheck, l as ACPUtils } from './onchain-utils-D9Z33IP7.cjs';
+import { A as ACP, k as EIP712Domain, C as CreateSelfACPOptions, $ as SelfACP, g as CreateSharingACPOptions, a0 as SharingACP, I as ImportSharedACPOptions, a1 as RecipientACP, a5 as ACPHashFields, f as SerializedACP, t as ACP_REVOKER_ABI, a4 as ACPAccessStatus, S as ShareLabel, v as ACP_SHARE_REGISTRY_ABI, j as IncomingShare, p as AclServedAddresses, L as LabelledShare, Q as ShareLabelVerifyMode, R as ShareLabelCheck, l as ACPUtils } from './onchain-utils-Ns56cBm0.cjs';
 import { StoreApi } from 'zustand/vanilla';
 
 type TfheInitializer = () => Promise<boolean>;
@@ -1031,6 +1031,21 @@ type ImportSharedOptions = ImportActivationOptions & {
      */
     name?: string;
 };
+/**
+ * Revoke a single acp on-chain via its revoker contract.
+ * Only the acp's issuer can revoke it (enforced by the revoker: revocations
+ * are keyed by msg.sender). The acp stays in local storage — on-chain
+ * validation will reject it from the next block onwards.
+ *
+ * @returns the revocation transaction hash
+ */
+/**
+ * A registry or revoker write built but not sent: what a simulation or `writeContract` takes,
+ * minus the sender. For a caller that sends through its own path (simulate first, record the
+ * transaction) instead of the plain `writeContract` the senders below do.
+ */
+type ShareRegistryWrite<functionName extends 'share' | 'removeShare'> = ContractFunctionParameters<typeof ACP_SHARE_REGISTRY_ABI, 'nonpayable', functionName>;
+type RevokerWrite = ContractFunctionParameters<typeof ACP_REVOKER_ABI, 'nonpayable', 'revokeSingle'>;
 /**
  * What `shareOnChain` posts with a share: the labels of its handles (one per handle, in order;
  * encoded with `encodeShareMetadata`), or an already encoded metadata blob. Written once, with the
@@ -1191,6 +1206,7 @@ declare const acps: {
     selectActiveACP: (chainId: number, account: string, hash: string) => void;
     removeActiveACP: (chainId: number, account: string) => Promise<void>;
     revokeACP: (acp: ACP, walletClient: WalletClient) => Promise<Hex>;
+    prepareRevokeACP: (acp: ACP) => RevokerWrite;
     revokeAllACPs: (walletClient: WalletClient, publicClient: PublicClient, revokerContract?: Hex) => Promise<Hex>;
     isACPRevoked: (acp: ACP, publicClient: PublicClient) => Promise<boolean>;
     checkAccess: (acp: ACP, publicClient: PublicClient, handle?: bigint | Hex) => Promise<ACPAccessStatus>;
@@ -1198,12 +1214,17 @@ declare const acps: {
         txHash: Hex;
         shareId: Hex;
     }>;
+    prepareShareOnChain: (acp: ACP, registry: Hex, options?: ShareOnChainOptions) => {
+        write: ShareRegistryWrite<"share">;
+        shareId: Hex;
+    };
     getIncomingShares: (publicClient: PublicClient, registry: Hex, recipient: Hex, { appKey }?: {
         appKey?: Hex;
     }) => Promise<IncomingShare[]>;
     getShareFromChain: (publicClient: PublicClient, registry: Hex, shareId: Hex) => Promise<IncomingShare | null>;
     importFromChain: (share: IncomingShare, publicClient: PublicClient, walletClient: WalletClient, importOptions?: ImportSharedOptions) => Promise<RecipientACP>;
     removeShareOnChain: (shareId: Hex, walletClient: WalletClient, registry: Hex) => Promise<Hex>;
+    prepareRemoveShare: (shareId: Hex, registry: Hex) => ShareRegistryWrite<"removeShare">;
     computeShareId: (acp: ACP) => Hex;
     applyACPDefaultsFromChain: <T extends {
         revokerData?: number;
@@ -1286,6 +1307,11 @@ type CofheClientACPs = {
     removeACP: (hash: string, chainId?: number, account?: string) => void;
     removeActiveACP: (chainId?: number, account?: string) => void;
     revokeACP: (acp: ACP) => Promise<`0x${string}`>;
+    /**
+     * The revoker write `revokeACP` sends, built but not sent — for an app that sends through its own
+     * path (a simulation first, a transaction store). Issuer only; throws for an acp without a revoker.
+     */
+    prepareRevokeACP: (acp: ACP) => RevokerWrite;
     revokeAllACPs: (revokerContract?: `0x${string}`) => Promise<`0x${string}`>;
     isACPRevoked: (acp: ACP) => Promise<boolean>;
     /**
@@ -1303,6 +1329,16 @@ type CofheClientACPs = {
         txHash: `0x${string}`;
         shareId: `0x${string}`;
     }>;
+    /**
+     * The registry write `shareOnChain` sends and the share id it gets, built but not sent — for an
+     * app that sends through its own path (a simulation first, a transaction store). Issuer only.
+     */
+    prepareShareOnChain: (acp: ACP, options?: ShareOnChainOptions) => Promise<{
+        write: ShareRegistryWrite<'share'>;
+        shareId: `0x${string}`;
+    }>;
+    /** The registry write `dismissShare` / `cancelShare` sends, built but not sent. */
+    prepareRemoveShare: (shareId: `0x${string}`) => Promise<ShareRegistryWrite<'removeShare'>>;
     /** Importable shares addressed to the connected account (unexpired, not revoked), with their metadata. */
     getIncomingShares: () => Promise<IncomingShare[]>;
     /** One share by id, as posted; null when unknown or removed. */