@story-protocol/core-sdk 1.3.0-beta.2 → 1.3.0-rc.1

package/dist/declarations/src/types/resources/ipMetadata.d.ts

@@ -0,0 +1,274 @@
+import { Address, Hash } from "viem";
+export type AIMetadata = {
+    /**
+     * Url to the character file.
+     *
+     * @example https://github.com/elizaOS/characterfile/blob/main/examples/example.character.json
+     */
+    characterFileUrl: string;
+    /**
+     * Hash of the character file using SHA-256 hashing algorithm.
+     */
+    characterFileHash: Hash;
+};
+/**
+ * IPA Metadata Standard Parameters
+ *
+ * This is the metadata that is associated with an IP Asset,
+ * and gets stored inside of an IP Account.
+ *
+ * @see {@link https://docs.story.foundation/docs/ipa-metadata-standard|IPA Metadata Standard Docs}
+ */
+export type IpMetadata = {
+    /** Title of the IP. Required for Story Explorer. */
+    title?: string;
+    /** Description of the IP. Required for Story Explorer. */
+    description?: string;
+    /**
+     * Date/Time that the IP was created (either ISO8601 or unix format).
+     *
+     * This field can be used to specify historical dates that aren’t on-chain.
+     * For example, Harry Potter was published on June 26.
+     *
+     * Required for Story Explorer.
+     *
+     * @example "1728401700"
+     */
+    createdAt?: string;
+    /** An image for the IP. Required for Story Explorer. */
+    image?: string;
+    /**
+     * Hash of your `image` using SHA-256 hashing algorithm.
+     * See {@link https://docs.story.foundation/docs/ipa-metadata-standard#hashing-content|here} for how that is done.
+     *
+     * Required for Story Explorer.
+     */
+    imageHash?: Hash;
+    /**
+     * An array of information about the creators.
+     *
+     * Required for Story Explorer.
+     */
+    creators?: IpCreator[];
+    /**
+     * Url to the actual media file (ex video, audio, image, etc).
+     * Used for infringement checking.
+     *
+     * Required for Commercial Infringement Check
+     *
+     * @example https://ipfs.io/ipfs/QmSamy4zqP91X42k6wS7kLJQVzuYJuW2EN94couPaq82A8
+     */
+    mediaUrl?: string;
+    /**
+     * Hashed string of the media using SHA-256 hashing algorithm.
+     *
+     * Required for Commercial Infringement Check
+     *
+     * @example 0x21937ba9d821cb0306c7f1a1a2cc5a257509f228ea6abccc9af1a67dd754af6e
+     */
+    mediaHash?: Hash;
+    /**
+     * Type of media (audio, video, image), based on mimeType.
+     *
+     * See {@link https://docs.story.foundation/docs/ipa-metadata-standard#media-types|here}
+     * for all the allowed media types.
+     *
+     * Required for Commercial Infringement Check
+     */
+    mediaType?: string;
+    /**
+     * Used for registering & displaying AI Agent Metadata.
+     *
+     * Required for AI Agents
+     */
+    aiMetadata?: AIMetadata;
+    /**
+     * Any other fields can be included in the metadata.
+     */
+    [key: string]: unknown;
+} & IpMetadataExperimentalAttributes;
+/**
+ * Experimental ip metadata fields that are not required but may be
+ * considered for future use.
+ */
+export type IpMetadataExperimentalAttributes = {
+    /**
+     * **Experimental**: Type of the IP Asset, can be defined arbitrarily by the
+     * creator. I.e. “character”, “chapter”, “location”, “items”, "music", etc
+     */
+    ipType?: string;
+    /**
+     * **Experimental**: The detailed relationship info with the IPA’s direct parent asset,
+     * such as APPEARS_IN, FINETUNED_FROM, etc
+     */
+    relationships?: IpRelationship[];
+    /**
+     * **Experimental**: A separate image with your watermark already applied.
+     * This way apps choosing to use it can render this version of the image (with watermark applied).
+     */
+    watermarkImg?: string;
+    /**
+     * **Experimental**: An array of supporting media
+     */
+    media?: IpMedia[];
+    /**
+     * **Experimental**: This is assigned to verified application from
+     * Story Protocol directly (on a request basis so far).
+     */
+    app?: StoryProtocolApp;
+    /**
+     * **Experimental**: Any tags that can help surface this IPA
+     */
+    tags?: string[];
+    /**
+     * **Experimental**: Allows you to set Do Not Train for a specific agent
+     */
+    robotTerms?: IPRobotTerms;
+};
+export type IPRobotTerms = {
+    userAgent: string;
+    allow: string;
+};
+export type StoryProtocolApp = {
+    id: string;
+    name: string;
+    website: string;
+    action?: string;
+};
+export type IpMedia = {
+    name: string;
+    url: string;
+    mimeType: string;
+};
+export type IpRelationship = {
+    parentIpId: Address;
+    /**
+     * Type of relationship between the parent and child IP.
+     *
+     * @see {@link https://docs.story.foundation/docs/ipa-metadata-standard#relationship-types|Relationship Types} for all relationship types.
+     *
+     * @example StoryRelationship.APPEARS_IN
+     */
+    type: StoryRelationship | AIRelationship;
+};
+export type IpCreator = {
+    /**
+     * Name of the creator.
+     *
+     * @example "Story Foundation"
+     */
+    name: string;
+    address: Address;
+    description?: string;
+    image?: string;
+    socialMedia?: IpCreatorSocial[];
+    role?: string;
+    /**
+     * Contribution percent of the creator.
+     *
+     * Total contribution percent of all creators should add up to 100.
+     */
+    contributionPercent: number;
+};
+export type IpCreatorSocial = {
+    /**
+     * Social media platform.
+     *
+     * @example "Discord"
+     */
+    platform: string;
+    url: string;
+};
+/**
+ * Enum representing the various relationship types in a story narrative.
+ */
+export declare enum StoryRelationship {
+    /** A character appears in a chapter. */
+    APPEARS_IN = "APPEARS_IN",
+    /** A chapter belongs to a book. */
+    BELONGS_TO = "BELONGS_TO",
+    /** A book is part of a series. */
+    PART_OF = "PART_OF",
+    /** A chapter continues from the previous one. */
+    CONTINUES_FROM = "CONTINUES_FROM",
+    /** An event leads to a consequence. */
+    LEADS_TO = "LEADS_TO",
+    /** An event foreshadows future developments. */
+    FORESHADOWS = "FORESHADOWS",
+    /** A character conflicts with another character. */
+    CONFLICTS_WITH = "CONFLICTS_WITH",
+    /** A decision results in a significant change. */
+    RESULTS_IN = "RESULTS_IN",
+    /** A subplot depends on the main plot. */
+    DEPENDS_ON = "DEPENDS_ON",
+    /** A prologue sets up the story. */
+    SETS_UP = "SETS_UP",
+    /** A chapter follows from the previous one. */
+    FOLLOWS_FROM = "FOLLOWS_FROM",
+    /** A twist reveals that something unexpected occurred. */
+    REVEALS_THAT = "REVEALS_THAT",
+    /** A character develops over the course of the story. */
+    DEVELOPS_OVER = "DEVELOPS_OVER",
+    /** A chapter introduces a new character or element. */
+    INTRODUCES = "INTRODUCES",
+    /** A conflict resolves in a particular outcome. */
+    RESOLVES_IN = "RESOLVES_IN",
+    /** A theme connects to the main narrative. */
+    CONNECTS_TO = "CONNECTS_TO",
+    /** A subplot relates to the central theme. */
+    RELATES_TO = "RELATES_TO",
+    /** A scene transitions from one setting to another. */
+    TRANSITIONS_FROM = "TRANSITIONS_FROM",
+    /** A character interacted with another character. */
+    INTERACTED_WITH = "INTERACTED_WITH",
+    /** An event leads into the climax. */
+    LEADS_INTO = "LEADS_INTO",
+    /** Story happening in parallel or around the same timeframe. */
+    PARALLEL = "PARALLEL"
+}
+/**
+ * Enum representing the different relationship types for AI-related metadata.
+ */
+export declare enum AIRelationship {
+    /** A model is trained on a dataset. */
+    TRAINED_ON = "TRAINED_ON",
+    /** A model is finetuned from a base model. */
+    FINETUNED_FROM = "FINETUNED_FROM",
+    /** An image is generated from a fine-tuned model. */
+    GENERATED_FROM = "GENERATED_FROM",
+    /** A model requires data for training. */
+    REQUIRES_DATA = "REQUIRES_DATA",
+    /** A remix is based on a specific workflow. */
+    BASED_ON = "BASED_ON",
+    /** Sample data influences model output. */
+    INFLUENCES = "INFLUENCES",
+    /** A pipeline creates a fine-tuned model. */
+    CREATES = "CREATES",
+    /** A workflow utilizes a base model. */
+    UTILIZES = "UTILIZES",
+    /** A fine-tuned model is derived from a base model. */
+    DERIVED_FROM = "DERIVED_FROM",
+    /** A model produces generated images. */
+    PRODUCES = "PRODUCES",
+    /** A remix modifies the base workflow. */
+    MODIFIES = "MODIFIES",
+    /** An AI-generated image references original data. */
+    REFERENCES = "REFERENCES",
+    /** A model is optimized by specific algorithms. */
+    OPTIMIZED_BY = "OPTIMIZED_BY",
+    /** A fine-tuned model inherits features from the base model. */
+    INHERITS = "INHERITS",
+    /** A fine-tuning process applies to a model. */
+    APPLIES_TO = "APPLIES_TO",
+    /** A remix combines elements from multiple datasets. */
+    COMBINES = "COMBINES",
+    /** A model generates variants of an image. */
+    GENERATES_VARIANTS = "GENERATES_VARIANTS",
+    /** A fine-tuning process expands on base capabilities. */
+    EXPANDS_ON = "EXPANDS_ON",
+    /** A workflow configures a model’s parameters. */
+    CONFIGURES = "CONFIGURES",
+    /** A fine-tuned model adapts to new data. */
+    ADAPTS_TO = "ADAPTS_TO"
+}
+//# sourceMappingURL=ipMetadata.d.ts.map

package/dist/declarations/src/types/resources/ipMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipMetadata.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,iBAAiB,EAAE,IAAI,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,GAAG,gCAAgC,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAClB;;;OAGG;IACH,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,IAAI,EAAE,iBAAiB,GAAG,cAAc,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,wCAAwC;IACxC,UAAU,eAAe;IACzB,mCAAmC;IACnC,UAAU,eAAe;IACzB,kCAAkC;IAClC,OAAO,YAAY;IACnB,iDAAiD;IACjD,cAAc,mBAAmB;IACjC,uCAAuC;IACvC,QAAQ,aAAa;IACrB,gDAAgD;IAChD,WAAW,gBAAgB;IAC3B,oDAAoD;IACpD,cAAc,mBAAmB;IACjC,kDAAkD;IAClD,UAAU,eAAe;IACzB,0CAA0C;IAC1C,UAAU,eAAe;IACzB,oCAAoC;IACpC,OAAO,YAAY;IACnB,+CAA+C;IAC/C,YAAY,iBAAiB;IAC7B,0DAA0D;IAC1D,YAAY,iBAAiB;IAC7B,yDAAyD;IACzD,aAAa,kBAAkB;IAC/B,uDAAuD;IACvD,UAAU,eAAe;IACzB,mDAAmD;IACnD,WAAW,gBAAgB;IAC3B,8CAA8C;IAC9C,WAAW,gBAAgB;IAC3B,8CAA8C;IAC9C,UAAU,eAAe;IACzB,uDAAuD;IACvD,gBAAgB,qBAAqB;IACrC,qDAAqD;IACrD,eAAe,oBAAoB;IACnC,sCAAsC;IACtC,UAAU,eAAe;IACzB,gEAAgE;IAChE,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,uCAAuC;IACvC,UAAU,eAAe;IACzB,8CAA8C;IAC9C,cAAc,mBAAmB;IACjC,qDAAqD;IACrD,cAAc,mBAAmB;IACjC,0CAA0C;IAC1C,aAAa,kBAAkB;IAC/B,+CAA+C;IAC/C,QAAQ,aAAa;IACrB,2CAA2C;IAC3C,UAAU,eAAe;IACzB,6CAA6C;IAC7C,OAAO,YAAY;IACnB,wCAAwC;IACxC,QAAQ,aAAa;IACrB,uDAAuD;IACvD,YAAY,iBAAiB;IAC7B,yCAAyC;IACzC,QAAQ,aAAa;IACrB,0CAA0C;IAC1C,QAAQ,aAAa;IACrB,sDAAsD;IACtD,UAAU,eAAe;IACzB,mDAAmD;IACnD,YAAY,iBAAiB;IAC7B,gEAAgE;IAChE,QAAQ,aAAa;IACrB,gDAAgD;IAChD,UAAU,eAAe;IACzB,wDAAwD;IACxD,QAAQ,aAAa;IACrB,8CAA8C;IAC9C,kBAAkB,uBAAuB;IACzC,0DAA0D;IAC1D,UAAU,eAAe;IACzB,kDAAkD;IAClD,UAAU,eAAe;IACzB,6CAA6C;IAC7C,SAAS,cAAc;CACxB"}

package/dist/declarations/src/types/resources/license.d.ts

@@ -1,8 +1,7 @@
 import { Address, TransactionReceipt } from "viem";
-import { WithTxOptions, TxOptions } from "../options.js";
+import { WithTxOptions, TxOptions, WithWipOptions } from "../options.js";
 import { EncodedTxData } from "../../abi/generated.js";
 import { LicensingConfig } from "../common.js";
-import { WithWipOptions } from "../utils/wip.js";
 export type LicenseApiResponse = {
     data: License;
 };
@@ -104,16 +103,15 @@ export type PredictMintingLicenseFeeRequest = {
     receiver?: Address;
     txOptions?: TxOptions;
 };
-export type InnerLicensingConfig = {
-    mintingFee: bigint;
-    commercialRevShare: number;
-    expectMinimumGroupRewardShare: number;
-} & LicensingConfig;
 export type SetLicensingConfigRequest = {
+    /** The address of the IP for which the configuration is being set. */
     ipId: Address;
+    /** The ID of the license terms within the license template. */
     licenseTermsId: string | number | bigint;
-    licensingConfig: LicensingConfig;
+    /** The address of the license template used. */
     licenseTemplate: Address;
+    /** The licensing configuration for the license. */
+    licensingConfig: LicensingConfig;
     txOptions?: TxOptions;
 };
 export type SetLicensingConfigResponse = {

package/dist/declarations/src/types/resources/license.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,sBAAmB;AACtD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,eAAe,EAAE,qBAAkB;AAC5C,OAAO,EAAE,cAAc,EAAE,wBAAqB;AAE9C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;IAGI;AACJ,MAAM,MAAM,YAAY,GAAG;IAEzB,YAAY,EAAE,OAAO,CAAC;IAEtB,aAAa,EAAE,OAAO,CAAC;IAEvB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,OAAO,CAAC;IAEvB,qBAAqB,EAAE,OAAO,CAAC;IAE/B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,yBAAyB,EAAE,OAAO,CAAC;IACnC,qFAAqF;IACrF,kBAAkB,EAAE,MAAM,CAAC;IAE3B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,kBAAkB,EAAE,OAAO,CAAC;IAE5B,sBAAsB,EAAE,OAAO,CAAC;IAEhC,mBAAmB,EAAE,OAAO,CAAC;IAE7B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,YAAY,EACZ,mBAAmB,GAAG,YAAY,GAAG,sBAAsB,GAAG,sBAAsB,CACrF,GAAG;IACF,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACxC,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG,aAAa,GACf,cAAc,CAAC;AAEjB,MAAM,MAAM,yBAAyB,GAAG;IACtC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,oBAAY,QAAQ;IAClB,oBAAoB,IAAA;IACpB,cAAc,IAAA;IACd,gBAAgB,IAAA;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtD,MAAM,MAAM,+BAA+B,GAAG;IAC5C,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;CACvC,GAAG,eAAe,CAAC;AACpB,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,EAAE,sBAAmB;AACtE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,eAAe,EAAE,qBAAkB;AAE5C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sCAAsC,GAAG;IACnD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;IAGI;AACJ,MAAM,MAAM,YAAY,GAAG;IAEzB,YAAY,EAAE,OAAO,CAAC;IAEtB,aAAa,EAAE,OAAO,CAAC;IAEvB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,OAAO,CAAC;IAEvB,qBAAqB,EAAE,OAAO,CAAC;IAE/B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,yBAAyB,EAAE,OAAO,CAAC;IACnC,qFAAqF;IACrF,kBAAkB,EAAE,MAAM,CAAC;IAE3B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,kBAAkB,EAAE,OAAO,CAAC;IAE5B,sBAAsB,EAAE,OAAO,CAAC;IAEhC,mBAAmB,EAAE,OAAO,CAAC;IAE7B,qBAAqB,EAAE,OAAO,CAAC;IAE/B,oBAAoB,EAAE,MAAM,CAAC;IAE7B,QAAQ,EAAE,OAAO,CAAC;IAElB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,YAAY,EACZ,mBAAmB,GAAG,YAAY,GAAG,sBAAsB,GAAG,sBAAsB,CACrF,GAAG;IACF,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,iBAAiB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC5C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACxC,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GAAG,aAAa,GACf,cAAc,CAAC;AAEjB,MAAM,MAAM,yBAAyB,GAAG;IACtC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,oBAAY,QAAQ;IAClB,oBAAoB,IAAA;IACpB,cAAc,IAAA;IACd,gBAAgB,IAAA;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtD,MAAM,MAAM,+BAA+B,GAAG;IAC5C,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,sEAAsE;IACtE,IAAI,EAAE,OAAO,CAAC;IACd,+DAA+D;IAC/D,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,gDAAgD;IAChD,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/declarations/src/types/resources/royalty.d.ts

@@ -1,131 +1,30 @@
 import { Address, Hash, TransactionReceipt } from "viem";
-import { TxOptions, WithTxOptions } from "../options.js";
-import { EncodedTxData, IpAccountImplClient } from "../../abi/generated.js";
-import { WithWipOptions } from "../utils/wip.js";
+import { WithTxOptions, WithWipOptions } from "../options.js";
+import { EncodedTxData, IpAccountImplClient, IpRoyaltyVaultImplRevenueTokenClaimedEvent } from "../../abi/generated.js";
+import { WithERC20Options } from "../options.js";
 import { TokenAmountInput } from "../common.js";
-export type RoyaltyPolicyApiResponse = {
-    data: RoyaltyPolicy;
-};
-export type RoyaltyPolicy = {
-    id: Address;
-    targetAncestors: string[];
-    targetRoyaltyAmount: string[];
-};
-export type RoyaltyContext = {
-    targetAncestors: string[];
-    targetRoyaltyAmount: number[];
-    parentAncestors1: string[];
-    parentAncestors2: string[];
-    parentAncestorsRoyalties1: number[];
-    parentAncestorsRoyalties2: number[];
-};
-export type RoyaltyData = [
-    isUnlinkableToParents: boolean,
-    ipRoyaltyVault: Address,
-    royaltyStack: bigint,
-    ancestorsAddresses: Address,
-    ancestorsRoyalties: bigint[]
-];
 export type ClaimableRevenueRequest = {
     royaltyVaultIpId: Address;
     claimer: Address;
     token: Address;
 };
 export type ClaimableRevenueResponse = bigint;
-export type PayRoyaltyOnBehalfRequest = {
+export type PayRoyaltyOnBehalfRequest = WithTxOptions & WithERC20Options & WithWipOptions & {
+    /** The IP ID that receives the royalties. */
     receiverIpId: Address;
+    /** The IP ID that pays the royalties. */
     payerIpId: Address;
+    /** The token to use to pay the royalties. */
     token: Address;
+    /** The amount to pay. */
     amount: TokenAmountInput;
-} & WithTxOptions & WithWipOptions;
+};
 export type PayRoyaltyOnBehalfResponse = {
     txHash?: string;
     receipt?: TransactionReceipt;
     encodedTxData?: EncodedTxData;
 };
-export type SnapshotRequest = {
-    royaltyVaultIpId: Address;
-    txOptions?: TxOptions;
-};
-export type ClaimRevenueRequest = {
-    snapshotIds: string[] | number[] | bigint[];
-    token: Address;
-    royaltyVaultIpId: Address;
-    account?: Address;
-    txOptions?: TxOptions;
-};
-export type ClaimRevenueResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    claimableToken?: bigint;
-};
-export type SnapshotResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    snapshotId?: bigint;
-};
-type RoyaltyClaimDetail = {
-    childIpId: Address;
-    royaltyPolicy: Address;
-    currencyToken: Address;
-    amount: bigint | string | number;
-};
-export type TransferToVaultAndSnapshotAndClaimByTokenBatchRequest = {
-    ancestorIpId: Address;
-    royaltyClaimDetails: RoyaltyClaimDetail[];
-    claimer?: Address;
-    txOptions?: TxOptions;
-};
-export type TransferToVaultAndSnapshotAndClaimByTokenBatchResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    snapshotId?: bigint;
-    amountsClaimed?: bigint;
-};
-export type TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest = {
-    ancestorIpId: Address;
-    unclaimedSnapshotIds: bigint[] | number[] | string[];
-    claimer?: Address;
-    royaltyClaimDetails: RoyaltyClaimDetail[];
-    txOptions?: TxOptions;
-};
-export type TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    snapshotId?: bigint;
-    amountsClaimed?: bigint;
-};
-export type SnapshotAndClaimByTokenBatchRequest = {
-    royaltyVaultIpId: Address;
-    currencyTokens: Address[];
-    claimer?: Address;
-    txOptions?: TxOptions;
-};
-export type SnapshotAndClaimByTokenBatchResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    snapshotId?: bigint;
-    amountsClaimed?: bigint;
-};
-export type SnapshotAndClaimBySnapshotBatchRequest = {
-    royaltyVaultIpId: Address;
-    unclaimedSnapshotIds: bigint[] | number[] | string[];
-    currencyTokens: Address[];
-    claimer?: Address;
-    txOptions?: TxOptions;
-};
-export type SnapshotAndClaimBySnapshotBatchResponse = {
-    txHash?: string;
-    encodedTxData?: EncodedTxData;
-    snapshotId?: bigint;
-    amountsClaimed?: bigint;
-};
-/**
- * Claims all revenue from the child IPs of an ancestor IP, then transfer
- * all claimed tokens to the wallet if the wallet owns the IP or is the claimer.
- * If claimed token is WIP, it will also be converted back to IP.
- */
-export type ClaimAllRevenueRequest = {
+export type ClaimAllRevenueRequest = WithClaimOptions & {
     /** The address of the ancestor IP from which the revenue is being claimed. */
     ancestorIpId: Address;
     /**
@@ -144,6 +43,8 @@ export type ClaimAllRevenueRequest = {
     royaltyPolicies: Address[];
     /** The addresses of the currency tokens in which royalties will be claimed */
     currencyTokens: Address[];
+};
+export type WithClaimOptions = {
     claimOptions?: {
         /**
          * When enabled, all claimed tokens on the claimer are transferred to the
@@ -165,19 +66,39 @@ export type ClaimAllRevenueRequest = {
         autoUnwrapIpTokens?: boolean;
     };
 };
-export type ClaimedToken = {
-    token: Address;
-    amount: bigint;
+export type BatchClaimAllRevenueRequest = WithClaimOptions & {
+    /** The ancestor IPs from which the revenue is being claimed. */
+    ancestorIps: (Omit<ClaimAllRevenueRequest, "ancestorIpId" | "claimOptions"> & {
+        /** The address of the ancestor IP from which the revenue is being claimed. */
+        ipId: Address;
+    })[];
+    options?: {
+        /**
+         * Use multicall to batch the calls `claimAllRevenue` into one transaction when possible.
+         *
+         * If only 1 ancestorIp is provided, multicall will not be used.
+         * @default true
+         */
+        useMulticallWhenPossible?: boolean;
+    };
+};
+export type BatchClaimAllRevenueResponse = {
+    txHashes: Hash[];
+    receipts: TransactionReceipt[];
+    claimedTokens?: IpRoyaltyVaultImplRevenueTokenClaimedEvent[];
 };
 export type ClaimAllRevenueResponse = {
     txHashes: Hash[];
-    receipt?: TransactionReceipt;
-    claimedTokens?: ClaimedToken[];
+    receipt: TransactionReceipt;
+    /**
+     * Aggregate list of all tokens claimed across all transactions in the batch.
+     * Events are aggregated by unique combinations of claimer and token addresses,
+     * summing up the amounts for the same claimer-token pairs.
+     */
+    claimedTokens?: IpRoyaltyVaultImplRevenueTokenClaimedEvent[];
 };
 export type TransferClaimedTokensFromIpToWalletParams = {
     ipAccount: IpAccountImplClient;
-    skipUnwrapIp: boolean;
-    claimedTokens: ClaimedToken[];
+    claimedTokens: IpRoyaltyVaultImplRevenueTokenClaimedEvent[];
 };
-export {};
 //# sourceMappingURL=royalty.d.ts.map

package/dist/declarations/src/types/resources/royalty.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,sBAAmB;AACtD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,+BAA4B;AACzE,OAAO,EAAE,cAAc,EAAE,wBAAqB;AAC9C,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,gBAAgB,CAAC;CAC1B,GAAG,aAAa,GACf,cAAc,CAAC;AAEjB,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,KAAK,kBAAkB,GAAG;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,YAAY,EAAE,OAAO,CAAC;IACtB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,wDAAwD,GAAG;IACrE,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,yDAAyD,GAAG;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG;IAChD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,sCAAsC,GAAG;IACnD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACrD,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,8EAA8E;IAC9E,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,uEAAuE;IACvE,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB;;;OAGG;IACH,eAAe,EAAE,OAAO,EAAE,CAAC;IAC3B,8EAA8E;IAC9E,cAAc,EAAE,OAAO,EAAE,CAAC;IAE1B,YAAY,CAAC,EAAE;QACb;;;;;;;;WAQG;QACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;QAE7C;;;;;;WAMG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAmB;AAC3D,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,0CAA0C,EAC3C,+BAA4B;AAC7B,OAAO,EAAE,gBAAgB,EAAE,sBAAmB;AAC9C,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAC9C,MAAM,MAAM,yBAAyB,GAAG,aAAa,GACnD,gBAAgB,GAChB,cAAc,GAAG;IACf,6CAA6C;IAC7C,YAAY,EAAE,OAAO,CAAC;IACtB,yCAAyC;IACzC,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,KAAK,EAAE,OAAO,CAAC;IACf,yBAAyB;IACzB,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEJ,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG;IACtD,8EAA8E;IAC9E,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,uEAAuE;IACvE,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB;;;OAGG;IACH,eAAe,EAAE,OAAO,EAAE,CAAC;IAC3B,8EAA8E;IAC9E,cAAc,EAAE,OAAO,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE;QACb;;;;;;;;WAQG;QACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;QAE7C;;;;;;WAMG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;CACH,CAAC;AACF,MAAM,MAAM,2BAA2B,GAAG,gBAAgB,GAAG;IAC3D,gEAAgE;IAChE,WAAW,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,cAAc,GAAG,cAAc,CAAC,GAAG;QAC5E,8EAA8E;QAC9E,IAAI,EAAE,OAAO,CAAC;KACf,CAAC,EAAE,CAAC;IACL,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,0CAA0C,EAAE,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,0CAA0C,EAAE,CAAC;CAC7D,CAAC"}

package/dist/declarations/src/types/resources/wip.d.ts

@@ -13,4 +13,11 @@ export type DepositRequest = WithTxOptions & {
 export type WithdrawRequest = WithTxOptions & {
     amount: TokenAmountInput;
 };
+export type TransferRequest = WithTxOptions & {
+    to: Address;
+    amount: TokenAmountInput;
+};
+export type TransferFromRequest = TransferRequest & {
+    from: Address;
+};
 //# sourceMappingURL=wip.d.ts.map

package/dist/declarations/src/types/resources/wip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAC7C,OAAO,EAAE,aAAa,EAAE,sBAAmB;AAE3C,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,4CAA4C;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"wip.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["wip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAC7C,OAAO,EAAE,aAAa,EAAE,sBAAmB;AAE3C,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,4CAA4C;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC3C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG;IAC5C,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG;IAC5C,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG;IAClD,IAAI,EAAE,OAAO,CAAC;CACf,CAAC"}

package/dist/declarations/src/utils/chain.d.ts

@@ -8,7 +8,7 @@ export declare const aeneid: {
     contracts: {
         readonly multicall3: {
             readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
-            readonly blockCreated: 5882;
+            readonly blockCreated: 1792;
         };
     };
     id: 1315;
@@ -30,4 +30,36 @@ export declare const aeneid: {
     serializers?: import("viem").ChainSerializers<undefined> | undefined;
     fees?: import("viem").ChainFees<undefined> | undefined;
 };
+export declare const mainnet: {
+    blockExplorers: {
+        readonly default: {
+            readonly name: "Explorer";
+            readonly url: "https://dev-mainnet.storyscan.xyz/";
+        };
+    };
+    contracts: {
+        readonly multicall3: {
+            readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
+            readonly blockCreated: 340998;
+        };
+    };
+    id: 1514;
+    name: "mainnet";
+    nativeCurrency: {
+        readonly name: "IP";
+        readonly symbol: "IP";
+        readonly decimals: 18;
+    };
+    rpcUrls: {
+        readonly default: {
+            readonly http: readonly ["https://mainnet.storyrpc.io/"];
+        };
+    };
+    sourceId?: number | undefined;
+    testnet: false;
+    custom?: Record<string, unknown> | undefined;
+    formatters?: undefined;
+    serializers?: import("viem").ChainSerializers<undefined> | undefined;
+    fees?: import("viem").ChainFees<undefined> | undefined;
+};
 //# sourceMappingURL=chain.d.ts.map

package/dist/declarations/src/utils/chain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC"}
+{"version":3,"file":"chain.d.ts","sourceRoot":"../../../../src/utils","sources":["chain.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBjB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsBlB,CAAC"}

package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts

@@ -1,8 +1,12 @@
 import { Hex } from "viem";
 export type IpMetadataForWorkflow = {
+    /** The URI of the metadata for the IP. */
     ipMetadataURI: string;
+    /** The hash of the metadata for the IP. */
     ipMetadataHash: Hex;
+    /** The URI of the metadata for the NFT. */
     nftMetadataURI: string;
+    /** The hash of the metadata for the IP NFT. */
     nftMetadataHash: Hex;
 };
 export declare const getIpMetadataForWorkflow: (metadata?: Partial<IpMetadataForWorkflow>) => IpMetadataForWorkflow;

package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getIpMetadataForWorkflow.d.ts","sourceRoot":"../../../../src/utils","sources":["getIpMetadataForWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAY,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,wBAAwB,cACxB,QAAQ,qBAAqB,CAAC,KACxC,qBAOF,CAAC"}
+{"version":3,"file":"getIpMetadataForWorkflow.d.ts","sourceRoot":"../../../../src/utils","sources":["getIpMetadataForWorkflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAY,MAAM,MAAM,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,cAAc,EAAE,GAAG,CAAC;IACpB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,wBAAwB,cACxB,QAAQ,qBAAqB,CAAC,KACxC,qBAOF,CAAC"}