@campnetwork/origin 1.3.0-alpha.5 → 1.3.0-alpha.7

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

@@ -320,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.
@@ -336,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>;
@@ -362,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.
@@ -541,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.
@@ -902,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;
@@ -909,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;

package/dist/react/index.esm.js

@@ -1,6 +1,6 @@
 'use client';
 import React, { createContext, useState, useContext, useEffect, useLayoutEffect, useRef, useSyncExternalStore } from 'react';
-import { custom, createWalletClient, createPublicClient, http, encodeFunctionData, checksumAddress, zeroAddress, keccak256, toBytes, toHex, erc20Abi, getAbiItem, formatEther, formatUnits, parseEther } from 'viem';
+import { custom, createWalletClient, createPublicClient, http, encodeFunctionData, checksumAddress, zeroAddress, keccak256, toBytes, erc20Abi, getAbiItem, formatEther, formatUnits, parseEther } from 'viem';
 import { toAccount } from 'viem/accounts';
 import { createSiweMessage } from 'viem/siwe';
 import axios from 'axios';
@@ -6845,11 +6845,155 @@ function raiseDispute(targetIpId, evidenceHash, disputeTag) {
     });
 }
 
+// base-x encoding / decoding
+// Copyright (c) 2018 base-x contributors
+// Copyright (c) 2014-2018 The Bitcoin Core developers (base58.cpp)
+// Distributed under the MIT software license, see the accompanying
+// file LICENSE or http://www.opensource.org/licenses/mit-license.php.
+function base (ALPHABET) {
+  if (ALPHABET.length >= 255) { throw new TypeError('Alphabet too long') }
+  const BASE_MAP = new Uint8Array(256);
+  for (let j = 0; j < BASE_MAP.length; j++) {
+    BASE_MAP[j] = 255;
+  }
+  for (let i = 0; i < ALPHABET.length; i++) {
+    const x = ALPHABET.charAt(i);
+    const xc = x.charCodeAt(0);
+    if (BASE_MAP[xc] !== 255) { throw new TypeError(x + ' is ambiguous') }
+    BASE_MAP[xc] = i;
+  }
+  const BASE = ALPHABET.length;
+  const LEADER = ALPHABET.charAt(0);
+  const FACTOR = Math.log(BASE) / Math.log(256); // log(BASE) / log(256), rounded up
+  const iFACTOR = Math.log(256) / Math.log(BASE); // log(256) / log(BASE), rounded up
+  function encode (source) {
+    // eslint-disable-next-line no-empty
+    if (source instanceof Uint8Array) ; else if (ArrayBuffer.isView(source)) {
+      source = new Uint8Array(source.buffer, source.byteOffset, source.byteLength);
+    } else if (Array.isArray(source)) {
+      source = Uint8Array.from(source);
+    }
+    if (!(source instanceof Uint8Array)) { throw new TypeError('Expected Uint8Array') }
+    if (source.length === 0) { return '' }
+    // Skip & count leading zeroes.
+    let zeroes = 0;
+    let length = 0;
+    let pbegin = 0;
+    const pend = source.length;
+    while (pbegin !== pend && source[pbegin] === 0) {
+      pbegin++;
+      zeroes++;
+    }
+    // Allocate enough space in big-endian base58 representation.
+    const size = ((pend - pbegin) * iFACTOR + 1) >>> 0;
+    const b58 = new Uint8Array(size);
+    // Process the bytes.
+    while (pbegin !== pend) {
+      let carry = source[pbegin];
+      // Apply "b58 = b58 * 256 + ch".
+      let i = 0;
+      for (let it1 = size - 1; (carry !== 0 || i < length) && (it1 !== -1); it1--, i++) {
+        carry += (256 * b58[it1]) >>> 0;
+        b58[it1] = (carry % BASE) >>> 0;
+        carry = (carry / BASE) >>> 0;
+      }
+      if (carry !== 0) { throw new Error('Non-zero carry') }
+      length = i;
+      pbegin++;
+    }
+    // Skip leading zeroes in base58 result.
+    let it2 = size - length;
+    while (it2 !== size && b58[it2] === 0) {
+      it2++;
+    }
+    // Translate the result into a string.
+    let str = LEADER.repeat(zeroes);
+    for (; it2 < size; ++it2) { str += ALPHABET.charAt(b58[it2]); }
+    return str
+  }
+  function decodeUnsafe (source) {
+    if (typeof source !== 'string') { throw new TypeError('Expected String') }
+    if (source.length === 0) { return new Uint8Array() }
+    let psz = 0;
+    // Skip and count leading '1's.
+    let zeroes = 0;
+    let length = 0;
+    while (source[psz] === LEADER) {
+      zeroes++;
+      psz++;
+    }
+    // Allocate enough space in big-endian base256 representation.
+    const size = (((source.length - psz) * FACTOR) + 1) >>> 0; // log(58) / log(256), rounded up.
+    const b256 = new Uint8Array(size);
+    // Process the characters.
+    while (psz < source.length) {
+      // Find code of next character
+      const charCode = source.charCodeAt(psz);
+      // Base map can not be indexed using char code
+      if (charCode > 255) { return }
+      // Decode character
+      let carry = BASE_MAP[charCode];
+      // Invalid character
+      if (carry === 255) { return }
+      let i = 0;
+      for (let it3 = size - 1; (carry !== 0 || i < length) && (it3 !== -1); it3--, i++) {
+        carry += (BASE * b256[it3]) >>> 0;
+        b256[it3] = (carry % 256) >>> 0;
+        carry = (carry / 256) >>> 0;
+      }
+      if (carry !== 0) { throw new Error('Non-zero carry') }
+      length = i;
+      psz++;
+    }
+    // Skip leading zeroes in b256.
+    let it4 = size - length;
+    while (it4 !== size && b256[it4] === 0) {
+      it4++;
+    }
+    const vch = new Uint8Array(zeroes + (size - it4));
+    let j = zeroes;
+    while (it4 !== size) {
+      vch[j++] = b256[it4++];
+    }
+    return vch
+  }
+  function decode (string) {
+    const buffer = decodeUnsafe(string);
+    if (buffer) { return buffer }
+    throw new Error('Non-base' + BASE + ' character')
+  }
+  return {
+    encode,
+    decodeUnsafe,
+    decode
+  }
+}
+
+var ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
+var bs58 = base(ALPHABET);
+
+/**
+ * Encode CIDv0 to bytes32 by stripping the 0x1220 multihash prefix.
+ * Only works with CIDv0 (SHA-256 hash, starts with "Qm").
+ */
+function encodeCidToBytes32(cid) {
+    const decoded = bs58.decode(cid);
+    if (decoded[0] !== 0x12 || decoded[1] !== 0x20 || decoded.length !== 34) {
+        throw new Error("Only CIDv0 with SHA-256 is supported");
+    }
+    // Return only the 32-byte digest (skip 0x1220 prefix)
+    return `0x${Buffer.from(decoded.slice(2)).toString("hex")}`;
+}
+
 /**
  * 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.
@@ -6863,19 +7007,17 @@ function raiseDispute(targetIpId, evidenceHash, disputeTag) {
  *   "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
  * ```
  */
 function raiseDisputeSmart(targetIpId, evidence, disputeTag) {
     return __awaiter(this, void 0, void 0, function* () {
         const cid = yield this.uploadJSONToIPFS(evidence);
-        const evidenceHash = keccak256(toHex(cid));
+        const evidenceHash = encodeCidToBytes32(cid);
         const transactionResult = yield this.raiseDispute(targetIpId, evidenceHash, disputeTag);
         return {
             transactionResult,
@@ -6904,6 +7046,48 @@ function disputeAssertion(disputeId, counterEvidenceHash) {
     });
 }
 
+/**
+ * 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}
+ * ```
+ */
+function disputeAssertionSmart(disputeId, counterEvidence) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cid = yield this.uploadJSONToIPFS(counterEvidence);
+        const counterEvidenceHash = encodeCidToBytes32(cid);
+        const transactionResult = yield this.disputeAssertion(disputeId, counterEvidenceHash);
+        return {
+            transactionResult,
+            counterEvidenceCid: cid,
+            counterEvidenceHash,
+        };
+    });
+}
+
 /**
  * Votes on a dispute as a CAMP token staker.
  * Only users who staked before the dispute was raised can vote.
@@ -7301,6 +7485,71 @@ function getDisputeProgress(disputeId) {
     });
 }
 
+/**
+ * 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}`);
+ * }
+ * ```
+ */
+function getDisputeRequirements(userAddress) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const publicClient = getPublicClient();
+        const disputeContractAddress = this.environment
+            .DISPUTE_CONTRACT_ADDRESS;
+        const disputeAbi = this.environment.DISPUTE_ABI;
+        // Get dispute parameters from the contract
+        const [bondAmount, protocolFee, tokenAddress] = yield Promise.all([
+            publicClient.readContract({
+                address: disputeContractAddress,
+                abi: disputeAbi,
+                functionName: "disputeBond",
+            }),
+            publicClient.readContract({
+                address: disputeContractAddress,
+                abi: disputeAbi,
+                functionName: "protocolDisputeFee",
+            }),
+            publicClient.readContract({
+                address: disputeContractAddress,
+                abi: disputeAbi,
+                functionName: "disputeToken",
+            }),
+        ]);
+        const isNativeToken = tokenAddress === zeroAddress;
+        const totalRequired = bondAmount + protocolFee;
+        // Get user's balance
+        let userBalance;
+        if (isNativeToken) {
+            userBalance = yield publicClient.getBalance({ address: userAddress });
+        }
+        else {
+            userBalance = (yield publicClient.readContract({
+                address: tokenAddress,
+                abi: erc20Abi,
+                functionName: "balanceOf",
+                args: [userAddress],
+            }));
+        }
+        return {
+            bondAmount,
+            protocolFee,
+            totalRequired,
+            tokenAddress,
+            isNativeToken,
+            userBalance,
+            hasSufficientBalance: userBalance >= totalRequired,
+        };
+    });
+}
+
 /**
  * Fractionalizes an IP NFT into fungible ERC20 tokens.
  * The NFT is transferred to the fractionalizer contract and a new ERC20 token is created.
@@ -7936,6 +8185,7 @@ class Origin {
         this.raiseDispute = raiseDispute.bind(this);
         this.raiseDisputeSmart = raiseDisputeSmart.bind(this);
         this.disputeAssertion = disputeAssertion.bind(this);
+        this.disputeAssertionSmart = disputeAssertionSmart.bind(this);
         this.voteOnDispute = voteOnDispute.bind(this);
         this.resolveDispute = resolveDispute.bind(this);
         this.cancelDispute = cancelDispute.bind(this);
@@ -7943,6 +8193,7 @@ class Origin {
         this.getDispute = getDispute.bind(this);
         this.canVoteOnDispute = canVoteOnDispute.bind(this);
         this.getDisputeProgress = getDisputeProgress.bind(this);
+        this.getDisputeRequirements = getDisputeRequirements.bind(this);
         // Fractionalizer module methods
         this.fractionalize = fractionalize.bind(this);
         this.redeem = redeem.bind(this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@campnetwork/origin",
-  "version": "1.3.0-alpha.5",
+  "version": "1.3.0-alpha.7",
   "main": "dist/core.cjs",
   "exports": {
     ".": {
@@ -41,6 +41,7 @@
     "@tanstack/react-query": "^5",
     "@walletconnect/ethereum-provider": "^2.17.2",
     "axios": "^1.7.7",
+    "bs58": "^6.0.0",
     "viem": "^2.21.37",
     "wagmi": "^2.12.33"
   },