@tokenops/sdk 1.6.0 → 2.0.0-alpha.1

package/dist/fhe-airdrop/index.d.cts

@@ -1,10 +1,48 @@
-export { ConfidentialAirdropFactoryClient, createConfidentialAirdropFactoryClient, type ConfidentialAirdropFactoryClientConfig, type CreateAirdropArgs, type CreateAirdropResult, type CreateAndFundAirdropArgs, type FundAirdropArgs, type PreflightCreateAirdropArgs, } from "./factory.js";
-export { ConfidentialAirdropClient, createConfidentialAirdropClient, type ClaimArgs, type ConfidentialAirdropClientConfig, type EncryptedViewResult, type GetClaimAmountArgs, type IsSignatureValidArgs, } from "./airdrop.js";
+/**
+ * `@tokenops/sdk/fhe-airdrop` - confidential airdrop campaigns on the
+ * TokenOps airdrop v2 contracts.
+ *
+ * **Unaudited contracts. Alpha software. No stability promise.** This module
+ * targets `tokenops-fhe-airdrop-v2`, which has not been audited. It is
+ * intended for the `alpha` npm dist-tag only, and must not be published to
+ * `latest`: the release that first ships this module is the one that sets
+ * that tag. Two contract
+ * behaviours would otherwise produce a wrong result rather than a revert,
+ * and the SDK enforces both as guardrails rather than merely documenting
+ * them: `claimAndUnwrap`'s delivered-amount inference is exact only for a
+ * stock `ERC7984ERC20Wrapper` (the SDK preflights and blocks non-stock
+ * wrappers, see {@link NonStockWrapperError}), and an in-place UUPS upgrade
+ * of a Merkle campaign would reset every account's claimed counter (the SDK
+ * refuses `mode: "uups"` for Merkle campaigns outright, see
+ * {@link MerkleUupsUnsupportedError}). See the module README for the full
+ * detail.
+ *
+ * Every export below is deliberate. There is no `export *`: anything named
+ * here is a compatibility promise, so the rule is that a symbol must be
+ * something a consumer calls, constructs, catches, or annotates. Internal
+ * helpers (receipt parsing, ABI-edge param converters, the OpenZeppelin ABI
+ * fragment the base client merges in, the product revert mapper) stay
+ * unexported even though the modules export them for their own tests.
+ *
+ * Address prediction and its integrity guards live on the
+ * `@tokenops/sdk/fhe-airdrop/advanced` subpath.
+ */
+export { AIRDROP_CONTRACTS_COMMIT, DEDUP_MODE, DEPLOYMENT_MODE, type DedupMode, type DeploymentMode, } from "./constants.js";
+export { ConfidentialAirdropFactoryClient, createConfidentialAirdropFactoryClient, FACTORY_ROLE_CONCENTRATION_NOTE, type CompliancePolicy, type ConfidentialAirdropFactoryClientConfig, type CustomFee, type FundInput, type UpgradeabilityPolicy, } from "./factory.js";
+export { AirdropBaseClient, createAirdropBaseClient, type AirdropBaseClientConfig, type WriteAccountOverride, } from "./airdrop-base.js";
+export { CLAIM_TYPEHASH, CLAIM_TYPES, createEcdsaAirdropClient, EcdsaAirdropClient, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, type Eip712Domain, type EcdsaAirdropClientConfig, type EcdsaClaimArgs, type GetClaimAmountArgs as EcdsaGetClaimAmountArgs, type IsSignatureValidArgs, } from "./ecdsa.js";
+export { createMerkleAirdropClient, MerkleAirdropClient, type GetClaimAmountArgs as MerkleGetClaimAmountArgs, type MerkleClaimArgs, } from "./merkle.js";
+export { buildMerkleTree, leafOf, type BuildMerkleTreeArgs, type BuiltMerkleTree, type LeafOfArgs, type MerkleLeafInput, } from "./merkle-tree.js";
+export { ComplianceManagerClient, createComplianceManagerClient, isAclPropagationError, type ComplianceManagerClientConfig, } from "./compliance.js";
+export type { BuiltCampaign, CampaignEntry, CampaignRecipient, CommonAirdropParams, CreateAirdropArgs, CreateAirdropResult, EcdsaAirdropParams, MerkleAirdropParams, } from "./types.js";
+export type { EncryptedInput, EncryptedInputs, EncryptedViewResult } from "../fhe/types.js";
+export { buildMerkleCampaign, encryptCampaignAmounts, planMerkleCampaign, rotateMerkleRoot, validateCampaignRecipients, type BuildMerkleCampaignArgs, type EncryptCampaignAmountsArgs, type EncryptedCampaignLeaf, type PlanMerkleCampaignArgs, type PlannedCampaign, type RotatedCampaign, type RotateMerkleRootArgs, } from "./campaign.js";
+export { grantInstanceRoles, planInstanceRoleSplit, type InstanceRoleAssignment, type RoleGrantOutcome, type RoleGrantStep, type RoleName, } from "./roles.js";
 export { encryptUint64, encryptUint64Batch, resolveEncryptor, signClaimAuthorization, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "./encryption.js";
-export { type AirdropParams, type CreateAirdropPreflightReport, type CustomFee, type EncryptedInput, type EncryptedInputs, } from "./types.js";
-export { asAirdropId, type AirdropId, asEncryptedHandle, type EncryptedHandle, } from "../core/brands.js";
-export { confidentialAirdropFactoryAbi, confidentialAirdropCloneableAbi } from "./abis/index.js";
-export { erc7984OperatorAbi } from "../fhe/erc7984-abi.js";
-export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, TokenOpsValidationError, ContractRevertError, TokenOpsContractError, PausedError, AccessDeniedError, OperatorNotApprovedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../core/errors.js";
+export { preflightClaim, preflightCreate, type ClaimPreflightTarget, type EcdsaClaimPreflightSignature, type PreflightClaimArgs, type PreflightCreateArgs, } from "./guards.js";
 export { type PreflightResult } from "../core/preflight.js";
-export { AlreadyClaimedError, ClaimNotStartedError, ClaimWindowClosedError } from "./errors.js";
+export { airdropFactoryAbi, complianceRoleManagerAbi, confidentialAirdropBaseAbi, ecdsaConfidentialAirdropAbi, merkleConfidentialAirdropAbi, } from "./abis/index.js";
+export { AlreadyClaimedError, ClaimNotStartedError, ClaimWindowClosedError, DedupIdConsumedError, FeeCollectorSelfAdministeredError, MerkleUupsUnsupportedError, NonStockWrapperError, PredictionDriftError, SaltCollisionError, SignatureExpiredError, UpgradeabilityNotAllowedError, type AirdropVariant, } from "./errors.js";
+export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, TokenOpsValidationError, ContractRevertError, TokenOpsContractError, PausedError, AccessDeniedError, OperatorNotApprovedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../core/errors.js";
+export { ERC7984_OPERATOR_MAX_DEADLINE, revokeOperator, setOperator, type RevokeOperatorArgs, type SetOperatorArgs, } from "../fhe/operators.js";
+export { erc7984OperatorAbi } from "../fhe/erc7984-abi.js";

package/dist/fhe-airdrop/index.d.ts

@@ -1,10 +1,48 @@
-export { ConfidentialAirdropFactoryClient, createConfidentialAirdropFactoryClient, type ConfidentialAirdropFactoryClientConfig, type CreateAirdropArgs, type CreateAirdropResult, type CreateAndFundAirdropArgs, type FundAirdropArgs, type PreflightCreateAirdropArgs, } from "./factory.js";
-export { ConfidentialAirdropClient, createConfidentialAirdropClient, type ClaimArgs, type ConfidentialAirdropClientConfig, type EncryptedViewResult, type GetClaimAmountArgs, type IsSignatureValidArgs, } from "./airdrop.js";
+/**
+ * `@tokenops/sdk/fhe-airdrop` - confidential airdrop campaigns on the
+ * TokenOps airdrop v2 contracts.
+ *
+ * **Unaudited contracts. Alpha software. No stability promise.** This module
+ * targets `tokenops-fhe-airdrop-v2`, which has not been audited. It is
+ * intended for the `alpha` npm dist-tag only, and must not be published to
+ * `latest`: the release that first ships this module is the one that sets
+ * that tag. Two contract
+ * behaviours would otherwise produce a wrong result rather than a revert,
+ * and the SDK enforces both as guardrails rather than merely documenting
+ * them: `claimAndUnwrap`'s delivered-amount inference is exact only for a
+ * stock `ERC7984ERC20Wrapper` (the SDK preflights and blocks non-stock
+ * wrappers, see {@link NonStockWrapperError}), and an in-place UUPS upgrade
+ * of a Merkle campaign would reset every account's claimed counter (the SDK
+ * refuses `mode: "uups"` for Merkle campaigns outright, see
+ * {@link MerkleUupsUnsupportedError}). See the module README for the full
+ * detail.
+ *
+ * Every export below is deliberate. There is no `export *`: anything named
+ * here is a compatibility promise, so the rule is that a symbol must be
+ * something a consumer calls, constructs, catches, or annotates. Internal
+ * helpers (receipt parsing, ABI-edge param converters, the OpenZeppelin ABI
+ * fragment the base client merges in, the product revert mapper) stay
+ * unexported even though the modules export them for their own tests.
+ *
+ * Address prediction and its integrity guards live on the
+ * `@tokenops/sdk/fhe-airdrop/advanced` subpath.
+ */
+export { AIRDROP_CONTRACTS_COMMIT, DEDUP_MODE, DEPLOYMENT_MODE, type DedupMode, type DeploymentMode, } from "./constants.js";
+export { ConfidentialAirdropFactoryClient, createConfidentialAirdropFactoryClient, FACTORY_ROLE_CONCENTRATION_NOTE, type CompliancePolicy, type ConfidentialAirdropFactoryClientConfig, type CustomFee, type FundInput, type UpgradeabilityPolicy, } from "./factory.js";
+export { AirdropBaseClient, createAirdropBaseClient, type AirdropBaseClientConfig, type WriteAccountOverride, } from "./airdrop-base.js";
+export { CLAIM_TYPEHASH, CLAIM_TYPES, createEcdsaAirdropClient, EcdsaAirdropClient, EIP712_DOMAIN_NAME, EIP712_DOMAIN_VERSION, type Eip712Domain, type EcdsaAirdropClientConfig, type EcdsaClaimArgs, type GetClaimAmountArgs as EcdsaGetClaimAmountArgs, type IsSignatureValidArgs, } from "./ecdsa.js";
+export { createMerkleAirdropClient, MerkleAirdropClient, type GetClaimAmountArgs as MerkleGetClaimAmountArgs, type MerkleClaimArgs, } from "./merkle.js";
+export { buildMerkleTree, leafOf, type BuildMerkleTreeArgs, type BuiltMerkleTree, type LeafOfArgs, type MerkleLeafInput, } from "./merkle-tree.js";
+export { ComplianceManagerClient, createComplianceManagerClient, isAclPropagationError, type ComplianceManagerClientConfig, } from "./compliance.js";
+export type { BuiltCampaign, CampaignEntry, CampaignRecipient, CommonAirdropParams, CreateAirdropArgs, CreateAirdropResult, EcdsaAirdropParams, MerkleAirdropParams, } from "./types.js";
+export type { EncryptedInput, EncryptedInputs, EncryptedViewResult } from "../fhe/types.js";
+export { buildMerkleCampaign, encryptCampaignAmounts, planMerkleCampaign, rotateMerkleRoot, validateCampaignRecipients, type BuildMerkleCampaignArgs, type EncryptCampaignAmountsArgs, type EncryptedCampaignLeaf, type PlanMerkleCampaignArgs, type PlannedCampaign, type RotatedCampaign, type RotateMerkleRootArgs, } from "./campaign.js";
+export { grantInstanceRoles, planInstanceRoleSplit, type InstanceRoleAssignment, type RoleGrantOutcome, type RoleGrantStep, type RoleName, } from "./roles.js";
 export { encryptUint64, encryptUint64Batch, resolveEncryptor, signClaimAuthorization, type Encryptor, type EncryptorSource, type EncryptUint64Args, type EncryptUint64BatchArgs, type FheValueInput, } from "./encryption.js";
-export { type AirdropParams, type CreateAirdropPreflightReport, type CustomFee, type EncryptedInput, type EncryptedInputs, } from "./types.js";
-export { asAirdropId, type AirdropId, asEncryptedHandle, type EncryptedHandle, } from "../core/brands.js";
-export { confidentialAirdropFactoryAbi, confidentialAirdropCloneableAbi } from "./abis/index.js";
-export { erc7984OperatorAbi } from "../fhe/erc7984-abi.js";
-export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, TokenOpsValidationError, ContractRevertError, TokenOpsContractError, PausedError, AccessDeniedError, OperatorNotApprovedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../core/errors.js";
+export { preflightClaim, preflightCreate, type ClaimPreflightTarget, type EcdsaClaimPreflightSignature, type PreflightClaimArgs, type PreflightCreateArgs, } from "./guards.js";
 export { type PreflightResult } from "../core/preflight.js";
-export { AlreadyClaimedError, ClaimNotStartedError, ClaimWindowClosedError } from "./errors.js";
+export { airdropFactoryAbi, complianceRoleManagerAbi, confidentialAirdropBaseAbi, ecdsaConfidentialAirdropAbi, merkleConfidentialAirdropAbi, } from "./abis/index.js";
+export { AlreadyClaimedError, ClaimNotStartedError, ClaimWindowClosedError, DedupIdConsumedError, FeeCollectorSelfAdministeredError, MerkleUupsUnsupportedError, NonStockWrapperError, PredictionDriftError, SaltCollisionError, SignatureExpiredError, UpgradeabilityNotAllowedError, type AirdropVariant, } from "./errors.js";
+export { TokenOpsSdkError, isTokenOpsSdkError, DeploymentAddressUnavailableError, UnsupportedChainError, MissingAccountError, MissingClientError, MissingEncryptorError, MissingPublicClientError, MissingWalletClientError, InvalidArgumentError, ReceiptEventAmbiguousError, ReceiptEventNotFoundError, TokenOpsValidationError, ContractRevertError, TokenOpsContractError, PausedError, AccessDeniedError, OperatorNotApprovedError, InsufficientFeeError, InsufficientBalanceError, BatchTooLargeError, FeatureDisabledError, TransferFailedError, FheHandleNotAllowedError, AlreadyInitializedError, ReentrancyError, InvalidSignatureError, WalletRejectedError, WalletChainMismatchError, NetworkError, InsufficientGasFundsError, UnknownWriteFailureError, UserRejectedSignatureError, SigningFailedError, RelayerUnreachableError, EncryptionFailedError, DecryptionFailedError, UserDecryptNotAllowedError, type DeploymentAddressUnavailableReason, type TokenOpsSdkErrorCode, } from "../core/errors.js";
+export { ERC7984_OPERATOR_MAX_DEADLINE, revokeOperator, setOperator, type RevokeOperatorArgs, type SetOperatorArgs, } from "../fhe/operators.js";
+export { erc7984OperatorAbi } from "../fhe/erc7984-abi.js";