Update SDK according to PoC Periphery Supported Workflows

packages/core-sdk/src/client.ts

@@ -15,6 +15,7 @@ import { IPAccountClient } from "./resources/ipAccount";
 import { chainStringToViemChain } from "./utils/utils";
 import { RoyaltyClient } from "./resources/royalty";
 import { NftClient } from "./resources/nftClient";
+import { GroupClient } from "./resources/group";
 import { SimpleWalletClient } from "./abi/generated";
 
 if (typeof process !== "undefined") {
@@ -34,6 +35,7 @@ export class StoryClient {
   private _ipAccount: IPAccountClient | null = null;
   private _royalty: RoyaltyClient | null = null;
   private _nftClient: NftClient | null = null;
+  private _group: GroupClient | null = null;
 
   /**
    * @param config - the configuration for the SDK client
@@ -141,7 +143,7 @@ export class StoryClient {
    */
   public get license(): LicenseClient {
     if (this._license === null) {
-      this._license = new LicenseClient(this.rpcClient, this.wallet);
+      this._license = new LicenseClient(this.rpcClient, this.wallet, this.config.chainId);
     }
 
     return this._license;
@@ -202,4 +204,18 @@ export class StoryClient {
 
     return this._nftClient;
   }
+
+  /**
+   * Getter for the group client. The client is lazily created when
+   * this method is called.
+   *
+   * @returns the GroupClient instance
+   */
+  public get groupClient(): GroupClient {
+    if (this._group === null) {
+      this._group = new GroupClient(this.rpcClient, this.wallet, this.config.chainId);
+    }
+
+    return this._group;
+  }
 }

packages/core-sdk/src/index.ts

@@ -8,6 +8,7 @@ export { DisputeClient } from "./resources/dispute";
 export { NftClient } from "./resources/nftClient";
 export { IPAccountClient } from "./resources/ipAccount";
 export { RoyaltyClient } from "./resources/royalty";
+export { GroupClient } from "./resources/group";
 
 export type { StoryConfig, SupportedChainIds } from "./types/config";
 
@@ -35,6 +36,11 @@ export type {
   IpMedia,
   IPRobotTerms,
   StoryProtocolApp,
+  MintAndRegisterIpRequest,
+  RegisterPilTermsAndAttachRequest,
+  RegisterPilTermsAndAttachResponse,
+  MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest,
+  RegisterIpAndMakeDerivativeWithLicenseTokensRequest,
 } from "./types/resources/ipAsset";
 
 export type {
@@ -52,16 +58,20 @@ export type {
 export { PIL_TYPE } from "./types/resources/license";
 
 export type {
-  CollectRoyaltyTokensRequest,
-  CollectRoyaltyTokensResponse,
   PayRoyaltyOnBehalfRequest,
   PayRoyaltyOnBehalfResponse,
   SnapshotRequest,
   SnapshotResponse,
   ClaimableRevenueRequest,
   ClaimableRevenueResponse,
-  ClaimRevenueRequest,
-  ClaimRevenueResponse,
+  SnapshotAndClaimBySnapshotBatchRequest,
+  SnapshotAndClaimBySnapshotBatchResponse,
+  SnapshotAndClaimByTokenBatchRequest,
+  SnapshotAndClaimByTokenBatchResponse,
+  TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest,
+  TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse,
+  TransferToVaultAndSnapshotAndClaimByTokenBatchRequest,
+  TransferToVaultAndSnapshotAndClaimByTokenBatchResponse,
 } from "./types/resources/royalty";
 
 export type {
@@ -71,6 +81,8 @@ export type {
   SetAllPermissionsRequest,
   SetBatchPermissionsRequest,
   CreateBatchPermissionSignatureRequest,
+  PermissionSignatureRequest,
+  PermissionSignatureResponse,
 } from "./types/resources/permission";
 export { AccessPermission } from "./types/resources/permission";
 export type {
@@ -96,11 +108,22 @@ export type {
   CreateNFTCollectionResponse,
 } from "./types/resources/nftClient";
 
+export type {
+  RegisterGroupRequest,
+  RegisterGroupResponse,
+  RegisterGroupAndAttachLicenseRequest,
+  RegisterGroupAndAttachLicenseResponse,
+  RegisterGroupAndAttachLicenseAndAddIpsRequest,
+  RegisterGroupAndAttachLicenseAndAddIpsResponse,
+  MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest,
+  MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse,
+  RegisterIpAndAttachLicenseAndAddToGroupRequest,
+  RegisterIpAndAttachLicenseAndAddToGroupResponse,
+} from "./types/resources/group";
 export type {
   PiLicenseTemplateGetLicenseTermsResponse,
   IpAccountImplStateResponse,
   EncodedTxData,
 } from "./abi/generated";
 
 export { getPermissionSignature } from "./utils/sign";
-export type { PermissionSignatureRequest, PermissionSignatureResponse } from "./types/common";

packages/core-sdk/src/resources/dispute.ts

@@ -24,12 +24,11 @@ export class DisputeClient {
   /**
    * Raises a dispute on a given ipId
    * @param request - The request object containing necessary data to raise a dispute.
-   *   @param request.targetIpId - The IP ID that is the target of the dispute.
-   *   @param request.arbitrationPolicy - The address of the arbitration policy.
-   *   @param request.linkToDisputeEvidence - The link to the dispute evidence.
-   *   @param request.targetTag - The target tag of the dispute.
-   *   @param request.calldata - Optional calldata to initialize the policy.
-   *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
+   *   @param request.targetIpId The IP ID that is the target of the dispute.
+   *   @param request.targetTag The target tag of the dispute.
+   *   @param request.disputeEvidenceHash The hash pointing to the dispute evidence
+   *   @param request.data The data to initialize the policy
+   *   @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
    * @returns A Promise that resolves to a RaiseDisputeResponse containing the transaction hash.
    * @throws `NotRegisteredIpId` if targetIpId is not registered in the IPA Registry.
    * @throws `NotWhitelistedDisputeTag` if targetTag is not whitelisted.
@@ -41,9 +40,9 @@ export class DisputeClient {
     try {
       const req = {
         targetIpId: getAddress(request.targetIpId, "request.targetIpId"),
-        linkToDisputeEvidence: request.linkToDisputeEvidence,
         targetTag: stringToHex(request.targetTag, { size: 32 }),
-        data: request.calldata || "0x",
+        data: request.data || "0x",
+        disputeEvidenceHash: request.disputeEvidenceHash,
       };
 
       if (request.txOptions?.encodedTxDataOnly) {
@@ -73,7 +72,7 @@ export class DisputeClient {
    * Cancels an ongoing dispute
    * @param request - The request object containing details to cancel the dispute.
    *   @param request.disputeId The ID of the dispute to be cancelled.
-   *   @param request.calldata Optional additional data used in the cancellation process.
+   *   @param request.data [Optional] additional data used in the cancellation process.
    *   @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
    * @returns A Promise that resolves to a CancelDisputeResponse containing the transaction hash.
    * @throws NotInDisputeState, if the currentTag of the Dispute is not being disputed
@@ -86,7 +85,7 @@ export class DisputeClient {
     try {
       const req = {
         disputeId: BigInt(request.disputeId),
-        data: request.calldata ? request.calldata : "0x",
+        data: request.data ? request.data : "0x",
       };
       if (request.txOptions?.encodedTxDataOnly) {
         return { encodedTxData: this.disputeModuleClient.cancelDisputeEncode(req) };