@campnetwork/origin 1.3.0-alpha.1 → 1.3.0-alpha.10

package/dist/react/index.esm.d.ts

@@ -294,11 +294,12 @@ declare function getDataWithIntent(this: Origin, tokenId: bigint, signer?: any,
 
 /**
  * Raises a dispute against an IP NFT.
- * Requires the caller to have the dispute bond amount in dispute tokens.
+ * Automatically handles token approval for ERC20 bonds or native token value.
+ * Includes the protocol dispute fee in the transaction.
  *
  * @param targetIpId The token ID of the IP NFT to dispute.
  * @param evidenceHash The hash of evidence supporting the dispute.
- * @param disputeTag A tag identifying the type of dispute.
+ * @param disputeTag A tag identifying the type of dispute (bytes32).
  * @returns A promise that resolves with the transaction result including the dispute ID.
  *
  * @example
@@ -306,7 +307,7 @@ declare function getDataWithIntent(this: Origin, tokenId: bigint, signer?: any,
  * const result = await origin.raiseDispute(
  *   1n,
  *   "0x1234...", // evidence hash
- *   "0x5678..." // dispute tag (e.g., "infringement", "fraud")
+ *   "0x0100000000000000000000000000000000000000000000000000000000000000" // dispute tag (bytes32)
  * );
  * ```
  */
@@ -319,9 +320,13 @@ interface RaiseDisputeSmartResult {
 }
 /**
  * Raises a dispute with automatic evidence upload to IPFS.
- * Uploads evidence JSON to IPFS, hashes the CID to bytes32 for on-chain storage,
+ * Uploads evidence JSON to IPFS, encodes the CID to bytes32 for on-chain storage,
  * and calls raiseDispute.
  *
+ * The CID is encoded by stripping the 0x1220 multihash prefix from CIDv0,
+ * leaving only the 32-byte SHA-256 digest. This encoding is reversible,
+ * allowing the original CID to be reconstructed from the on-chain data.
+ *
  * @param targetIpId The token ID of the IP NFT to dispute.
  * @param evidence The evidence JSON object to upload to IPFS.
  * @param disputeTag A tag identifying the type of dispute.
@@ -335,13 +340,11 @@ interface RaiseDisputeSmartResult {
  *   "0x696e6672696e67656d656e74..." // dispute tag
  * );
  *
- * // Store the CID for evidence retrieval
+ * // The CID can be recovered from evidenceHash using decodeCidFromBytes32
  * console.log("Evidence CID:", result.evidenceCid);
  *
- * // Fetch evidence later via IPFS gateway
+ * // Fetch evidence via IPFS gateway
  * // https://ipfs.io/ipfs/{result.evidenceCid}
- *
- * // Verify evidence hash matches on-chain: keccak256(toHex(evidenceCid)) === evidenceHash
  * ```
  */
 declare function raiseDisputeSmart(this: Origin, targetIpId: bigint, evidence: Record<string, any>, disputeTag: Hex): Promise<RaiseDisputeSmartResult>;
@@ -361,6 +364,42 @@ declare function raiseDisputeSmart(this: Origin, targetIpId: bigint, evidence: R
  */
 declare function disputeAssertion(this: Origin, disputeId: bigint, counterEvidenceHash: Hex): Promise<any>;
 
+interface DisputeAssertionSmartResult {
+    transactionResult: any;
+    counterEvidenceCid: string;
+    counterEvidenceHash: Hex;
+}
+/**
+ * Asserts a dispute with automatic counter-evidence upload to IPFS.
+ * Uploads counter-evidence JSON to IPFS, encodes the CID to bytes32 for on-chain storage,
+ * and calls disputeAssertion.
+ *
+ * The CID is encoded by stripping the 0x1220 multihash prefix from CIDv0,
+ * leaving only the 32-byte SHA-256 digest. This encoding is reversible,
+ * allowing the original CID to be reconstructed from the on-chain data.
+ *
+ * Must be called by the owner of the disputed IP within the cooldown period.
+ *
+ * @param disputeId The ID of the dispute to assert.
+ * @param counterEvidence The counter-evidence JSON object to upload to IPFS.
+ * @returns A promise that resolves with the transaction result, IPFS CID, and counter-evidence hash.
+ *
+ * @example
+ * ```typescript
+ * const result = await origin.disputeAssertionSmart(
+ *   1n,
+ *   { description: "This is my original work", proofUrl: "https://..." }
+ * );
+ *
+ * // The CID can be recovered from counterEvidenceHash using decodeCidFromBytes32
+ * console.log("Counter-evidence CID:", result.counterEvidenceCid);
+ *
+ * // Fetch counter-evidence via IPFS gateway
+ * // https://ipfs.io/ipfs/{result.counterEvidenceCid}
+ * ```
+ */
+declare function disputeAssertionSmart(this: Origin, disputeId: bigint, counterEvidence: Record<string, any>): Promise<DisputeAssertionSmartResult>;
+
 /**
  * Votes on a dispute as a CAMP token staker.
  * Only users who staked before the dispute was raised can vote.
@@ -540,6 +579,31 @@ interface DisputeProgress {
  */
 declare function getDisputeProgress(this: Origin, disputeId: bigint): Promise<DisputeProgress>;
 
+interface DisputeRequirements {
+    bondAmount: bigint;
+    protocolFee: bigint;
+    totalRequired: bigint;
+    tokenAddress: Address;
+    isNativeToken: boolean;
+    userBalance: bigint;
+    hasSufficientBalance: boolean;
+}
+/**
+ * Gets the requirements for raising a dispute, including balance check.
+ *
+ * @param userAddress The address to check balance for.
+ * @returns A promise that resolves with the dispute requirements.
+ *
+ * @example
+ * ```typescript
+ * const requirements = await origin.getDisputeRequirements(walletAddress);
+ * if (!requirements.hasSufficientBalance) {
+ *   console.log(`Need ${requirements.totalRequired} but only have ${requirements.userBalance}`);
+ * }
+ * ```
+ */
+declare function getDisputeRequirements(this: Origin, userAddress: Address): Promise<DisputeRequirements>;
+
 /**
  * Fractionalizes an IP NFT into fungible ERC20 tokens.
  * The NFT is transferred to the fractionalizer contract and a new ERC20 token is created.
@@ -901,6 +965,7 @@ declare class Origin {
     raiseDispute: typeof raiseDispute;
     raiseDisputeSmart: typeof raiseDisputeSmart;
     disputeAssertion: typeof disputeAssertion;
+    disputeAssertionSmart: typeof disputeAssertionSmart;
     voteOnDispute: typeof voteOnDispute;
     resolveDispute: typeof resolveDispute;
     cancelDispute: typeof cancelDispute;
@@ -908,6 +973,7 @@ declare class Origin {
     getDispute: typeof getDispute;
     canVoteOnDispute: typeof canVoteOnDispute;
     getDisputeProgress: typeof getDisputeProgress;
+    getDisputeRequirements: typeof getDisputeRequirements;
     fractionalize: typeof fractionalize;
     redeem: typeof redeem;
     getTokenForNFT: typeof getTokenForNFT;
@@ -924,6 +990,14 @@ declare class Origin {
     constructor(environment?: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint, appId?: string);
     getJwt(): string | undefined;
     setViemClient(client: WalletClient): void;
+    /**
+     * Approves an ERC20 token for spending by a spender address if the current allowance is insufficient.
+     * Waits for the approval transaction to be confirmed before returning.
+     * @param tokenAddress The address of the ERC20 token.
+     * @param spender The address that will be approved to spend the tokens.
+     * @param amount The amount of tokens to approve.
+     */
+    approveERC20IfNeeded(tokenAddress: Address, spender: Address, amount: bigint): Promise<void>;
     /**
      * Uploads a JSON object to IPFS and returns the resulting CID.
      * @param data The JSON object to upload.