@cofhe/sdk 0.7.0 → 0.8.0

package/dist/{acp-Wi6isVQI.d.cts → onchain-utils-CUAK8glx.d.cts}

@@ -235,6 +235,13 @@ type SharedACP = Expand<Omit<ACPPublic, 'sealingKey' | 'recipientSignature'> & {
     name: string;
     type: 'sharing';
 }>;
+/**
+ * An ACP on-chain status, as `client.acp.checkAccess` reports it instead of a revert.
+ * Without a handle: 'valid' or the reason it is not. With a handle, a valid ACP reports
+ * 'allowed', 'out-of-scope' (the ACP scope does not cover the handle) or
+ * 'issuer-not-allowed' (the issuer itself may not read the handle, so no ACP of theirs can).
+ */
+type ACPAccessStatus = 'valid' | 'allowed' | 'out-of-scope' | 'issuer-not-allowed' | 'expired' | 'revoked' | 'invalid-issuer-signature' | 'invalid-recipient-signature';
 /**
  * A share read back from the on-chain ACPShareRegistry: the posted payload
  * (SharedACP minus the client-side name/type) plus its registry id.
@@ -402,6 +409,29 @@ declare const ACPUtils: {
      * Check if acp passes the on-chain validation
      */
     checkValidityOnChain: (acp: ACP, publicClient: PublicClient) => Promise<boolean>;
+    /**
+     * The acp on-chain status as a value instead of a revert: 'valid' or why not, and given a
+     * handle, whether the acp may read it (see `ACPAccessStatus`).
+     */
+    checkAccessOnChain: (acp: ACP, publicClient: PublicClient, handle?: bigint | Hex) => Promise<ACPAccessStatus>;
 };
 
-export { type ACP as A, type CreateSelfACPOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedACPOptions as I, type RecipientACP as R, type SerializedACP as S, type ValidationResult as V, type ACPPublic as a, type ACPSignaturePrimaryType as b, type EIP712Message as c, type CreateSharingACPOptions as d, type ACPMetadata as e, type SharedACP as f, type IncomingShare as g, type EIP712Domain as h, ACPUtils as i, type SealingKeyPair as j, type EthEncryptedData as k, type EIP712Type as l, type ACPPrivate as m, type ACPType as n, type ACPOf as o, type SelfACP as p, type SharingACP as q, ACPScope as r, seal as s, type ACPScopeOptions as t, unsealWithPrivateKey as u, type ACPHashFields as v, type Expand as w };
+declare const getAclAddress: (publicClient: PublicClient) => Promise<Hex>;
+interface AclServedAddresses {
+    defaultRevoker?: Hex;
+    shareRegistry?: Hex;
+}
+/** Test hook: forget resolved addresses (e.g. between redeployments on one chainId). */
+declare const clearAclServedAddresses: () => void;
+/**
+ * The ACP infrastructure addresses the chain's ACL serves (CoFHEAddressBook ->
+ * TaskManager -> acl() -> getters). Zero addresses and pre-upgrade ACLs (getters absent -> revert)
+ * resolve to `undefined` — callers fall back to `acp.*` config.
+ *
+ * Resolutions are cached per chainId. A failure to reach the TaskManager (network
+ * error, no CoFHE deployment) is NOT cached, so a transient outage does not pin
+ * an empty result for the whole session.
+ */
+declare const getAclServedAddresses: (publicClient: PublicClient, chainId: number) => Promise<AclServedAddresses>;
+
+export { type ACP as A, type ACPHashFields as B, type CreateSelfACPOptions as C, type Expand as D, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedACPOptions as I, type RecipientACP as R, type SerializedACP as S, type ValidationResult as V, type ACPPublic as a, type ACPSignaturePrimaryType as b, type EIP712Message as c, type CreateSharingACPOptions as d, type ACPMetadata as e, type SharedACP as f, type IncomingShare as g, type EIP712Domain as h, ACPUtils as i, getAclAddress as j, getAclServedAddresses as k, clearAclServedAddresses as l, type AclServedAddresses as m, type SealingKeyPair as n, type EthEncryptedData as o, type EIP712Type as p, type ACPPrivate as q, type ACPType as r, seal as s, type ACPOf as t, unsealWithPrivateKey as u, type SelfACP as v, type SharingACP as w, ACPScope as x, type ACPScopeOptions as y, type ACPAccessStatus as z };

package/dist/{acp-Wi6isVQI.d.ts → onchain-utils-CUAK8glx.d.ts}

@@ -235,6 +235,13 @@ type SharedACP = Expand<Omit<ACPPublic, 'sealingKey' | 'recipientSignature'> & {
     name: string;
     type: 'sharing';
 }>;
+/**
+ * An ACP on-chain status, as `client.acp.checkAccess` reports it instead of a revert.
+ * Without a handle: 'valid' or the reason it is not. With a handle, a valid ACP reports
+ * 'allowed', 'out-of-scope' (the ACP scope does not cover the handle) or
+ * 'issuer-not-allowed' (the issuer itself may not read the handle, so no ACP of theirs can).
+ */
+type ACPAccessStatus = 'valid' | 'allowed' | 'out-of-scope' | 'issuer-not-allowed' | 'expired' | 'revoked' | 'invalid-issuer-signature' | 'invalid-recipient-signature';
 /**
  * A share read back from the on-chain ACPShareRegistry: the posted payload
  * (SharedACP minus the client-side name/type) plus its registry id.
@@ -402,6 +409,29 @@ declare const ACPUtils: {
      * Check if acp passes the on-chain validation
      */
     checkValidityOnChain: (acp: ACP, publicClient: PublicClient) => Promise<boolean>;
+    /**
+     * The acp on-chain status as a value instead of a revert: 'valid' or why not, and given a
+     * handle, whether the acp may read it (see `ACPAccessStatus`).
+     */
+    checkAccessOnChain: (acp: ACP, publicClient: PublicClient, handle?: bigint | Hex) => Promise<ACPAccessStatus>;
 };
 
-export { type ACP as A, type CreateSelfACPOptions as C, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedACPOptions as I, type RecipientACP as R, type SerializedACP as S, type ValidationResult as V, type ACPPublic as a, type ACPSignaturePrimaryType as b, type EIP712Message as c, type CreateSharingACPOptions as d, type ACPMetadata as e, type SharedACP as f, type IncomingShare as g, type EIP712Domain as h, ACPUtils as i, type SealingKeyPair as j, type EthEncryptedData as k, type EIP712Type as l, type ACPPrivate as m, type ACPType as n, type ACPOf as o, type SelfACP as p, type SharingACP as q, ACPScope as r, seal as s, type ACPScopeOptions as t, unsealWithPrivateKey as u, type ACPHashFields as v, type Expand as w };
+declare const getAclAddress: (publicClient: PublicClient) => Promise<Hex>;
+interface AclServedAddresses {
+    defaultRevoker?: Hex;
+    shareRegistry?: Hex;
+}
+/** Test hook: forget resolved addresses (e.g. between redeployments on one chainId). */
+declare const clearAclServedAddresses: () => void;
+/**
+ * The ACP infrastructure addresses the chain's ACL serves (CoFHEAddressBook ->
+ * TaskManager -> acl() -> getters). Zero addresses and pre-upgrade ACLs (getters absent -> revert)
+ * resolve to `undefined` — callers fall back to `acp.*` config.
+ *
+ * Resolutions are cached per chainId. A failure to reach the TaskManager (network
+ * error, no CoFHE deployment) is NOT cached, so a transient outage does not pin
+ * an empty result for the whole session.
+ */
+declare const getAclServedAddresses: (publicClient: PublicClient, chainId: number) => Promise<AclServedAddresses>;
+
+export { type ACP as A, type ACPHashFields as B, type CreateSelfACPOptions as C, type Expand as D, type EIP712Types as E, GenerateSealingKey as G, type ImportSharedACPOptions as I, type RecipientACP as R, type SerializedACP as S, type ValidationResult as V, type ACPPublic as a, type ACPSignaturePrimaryType as b, type EIP712Message as c, type CreateSharingACPOptions as d, type ACPMetadata as e, type SharedACP as f, type IncomingShare as g, type EIP712Domain as h, ACPUtils as i, getAclAddress as j, getAclServedAddresses as k, clearAclServedAddresses as l, type AclServedAddresses as m, type SealingKeyPair as n, type EthEncryptedData as o, type EIP712Type as p, type ACPPrivate as q, type ACPType as r, seal as s, type ACPOf as t, unsealWithPrivateKey as u, type SelfACP as v, type SharingACP as w, ACPScope as x, type ACPScopeOptions as y, type ACPAccessStatus as z };