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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. package/dist/declarations/src/abi/generated.d.ts +12678 -4293
  2. package/dist/declarations/src/abi/generated.d.ts.map +1 -1
  3. package/dist/declarations/src/constants/common.d.ts +1 -0
  4. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  5. package/dist/declarations/src/index.d.ts +1 -1
  6. package/dist/declarations/src/index.d.ts.map +1 -1
  7. package/dist/declarations/src/resources/dispute.d.ts +8 -4
  8. package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
  9. package/dist/declarations/src/resources/group.d.ts +73 -20
  10. package/dist/declarations/src/resources/group.d.ts.map +1 -1
  11. package/dist/declarations/src/resources/ipAsset.d.ts +299 -205
  12. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  13. package/dist/declarations/src/resources/license.d.ts +11 -3
  14. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  15. package/dist/declarations/src/resources/nftClient.d.ts +1 -1
  16. package/dist/declarations/src/resources/nftClient.d.ts.map +1 -1
  17. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/royalty.d.ts +5 -87
  19. package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
  20. package/dist/declarations/src/types/common.d.ts +18 -7
  21. package/dist/declarations/src/types/common.d.ts.map +1 -1
  22. package/dist/declarations/src/types/config.d.ts +1 -1
  23. package/dist/declarations/src/types/config.d.ts.map +1 -1
  24. package/dist/declarations/src/types/resources/dispute.d.ts +3 -2
  25. package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
  26. package/dist/declarations/src/types/resources/group.d.ts +19 -9
  27. package/dist/declarations/src/types/resources/group.d.ts.map +1 -1
  28. package/dist/declarations/src/types/resources/ipAsset.d.ts +54 -40
  29. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  30. package/dist/declarations/src/types/resources/license.d.ts +10 -7
  31. package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
  32. package/dist/declarations/src/types/resources/permission.d.ts +0 -1
  33. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  34. package/dist/declarations/src/types/resources/royalty.d.ts +1 -2
  35. package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
  36. package/dist/declarations/src/utils/chain.d.ts +5 -5
  37. package/dist/declarations/src/utils/chain.d.ts.map +1 -1
  38. package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts +9 -0
  39. package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts.map +1 -0
  40. package/dist/declarations/src/utils/sign.d.ts +0 -1
  41. package/dist/declarations/src/utils/sign.d.ts.map +1 -1
  42. package/dist/story-protocol-core-sdk.cjs.dev.js +2109 -2572
  43. package/dist/story-protocol-core-sdk.cjs.prod.js +2109 -2572
  44. package/dist/story-protocol-core-sdk.esm.js +2110 -2573
  45. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAQb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,qBAAqB,EACrB,yCAAyC,EACzC,0CAA0C,EAC1C,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EACrE,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EAErB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EACvC,kBAAkB,EAInB,4BAAyB;AAO1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,uCAAuC,EAAE,uCAAuC,CAAC;IACjF,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAsB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA0F5E;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwCzF;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA4DtC;;;;;;;;;;OAUG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IA+E3C;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAiCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAgDtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAiD3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAwG/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IA8H/C;;;;;;;;;;;;;;;;;OAiBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAiEtD;;;;;;;;;;;;;;;;;;OAkBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IAoE7C;;;;;;;;;;;;;;OAcG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA4C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IA6F9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IAyH7E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,mEAAmE,CAC9E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IAmHrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAsDhF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IA4DhF,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;YAyCvB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;CAgBpC"}
1
+ {"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,YAAY,EAQb,MAAM,MAAM,CAAC;AAGd,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,OAAO,EACL,8CAA8C,EAC9C,+CAA+C,EAC/C,8CAA8C,EAC9C,+CAA+C,EAC/C,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,qBAAqB,EACrB,yCAAyC,EACzC,0CAA0C,EAC1C,4BAA4B,EAC5B,uBAAuB,EACvB,SAAS,EACT,UAAU,EACV,yCAAyC,EACzC,0DAA0D,EAC1D,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,0CAA0C,EAC1C,2CAA2C,EAC3C,kCAAkC,EAClC,mCAAmC,EACnC,kCAAkC,EAClC,mCAAmC,EACnC,mDAAmD,EACnD,kBAAkB,EAClB,gCAAgC,EAChC,iCAAiC,EACjC,eAAe,EACf,0CAA0C,EAC1C,gEAAgE,EAGhE,iEAAiE,EAGjE,wEAAwE,EACxE,yEAAyE,EACzE,mEAAmE,EACnE,mEAAmE,EACnE,oEAAoE,EACpE,oEAAoE,EAIrE,sCAAmC;AACpC,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EAMzB,qBAAqB,EAErB,gCAAgC,EAIhC,6BAA6B,EAC7B,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,2BAA2B,EAG3B,wBAAwB,EACxB,uCAAuC,EAGvC,kBAAkB,EAKnB,4BAAyB;AAe1B,qBAAa,aAAa;IACjB,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,yBAAyB,EAAE,yBAAyB,CAAC;IACrD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,uCAAuC,EAAE,uCAAuC,CAAC;IACjF,wBAAwB,EAAE,wBAAwB,CAAC;IAE1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAsB3F;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAAC,KAAK,EAAE,4BAA4B,GAAG,SAAS;IAqB9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,UAAU;IAiCrE;;;;;;;;;;;;;;OAcG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAoF5E;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAwCzF;;;;;;;;;;;;;;;;OAgBG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA8BtC;;;;;;;;;;;;;OAaG;IACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IAkF3C;;;;;;;;;;OAUG;IACU,mCAAmC,CAC9C,OAAO,EAAE,0CAA0C,GAClD,OAAO,CAAC,2CAA2C,CAAC;IAsCvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IA0CtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkD3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACU,2BAA2B,CACtC,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAwF/C;;;;;;;;;;;;;;;;;;OAkBG;IACU,oBAAoB,CAC/B,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,mCAAmC,CAAC;IAgE/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,kCAAkC,CAC7C,OAAO,EAAE,yCAAyC,GACjD,OAAO,CAAC,0CAA0C,CAAC;IAoCtD;;;;;;;;;;;;;;;;;;OAkBG;IACU,uCAAuC,CAClD,OAAO,EAAE,8CAA8C,GACtD,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;;OAcG;IACU,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4B9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,yBAAyB,CACpC,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,iCAAiC,CAAC;IA2E7C;;;;;;;;;;;;;;;;;OAiBG;IACU,mDAAmD,CAC9D,OAAO,EAAE,0DAA0D,GAClE,OAAO,CAAC,kBAAkB,CAAC;IA0C9B;;;;;;;;;;;;;;OAcG;IACU,4CAA4C,CACvD,OAAO,EAAE,mDAAmD,GAC3D,OAAO,CAAC,kBAAkB,CAAC;IAwE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACU,yDAAyD,CACpE,OAAO,EAAE,gEAAgE,GACxE,OAAO,CAAC,iEAAiE,CAAC;IAkG7E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,mEAAmE,CAC9E,OAAO,EAAE,wEAAwE,GAChF,OAAO,CAAC,yEAAyE,CAAC;IAyFrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IA4ChF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,4DAA4D,CACvE,OAAO,EAAE,mEAAmE,GAC3E,OAAO,CAAC,oEAAoE,CAAC;IAoChF,OAAO,CAAC,gBAAgB;YAqBV,uBAAuB;YA8CvB,cAAc;IAYf,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;YAIxC,iBAAiB;YAWjB,uBAAuB;IAkBrC,OAAO,CAAC,2BAA2B;YAgBrB,qBAAqB;IAKnC,OAAO,CAAC,cAAc;YASR,sBAAsB;YAgEtB,wBAAwB;CAwBvC"}
@@ -74,7 +74,7 @@ export declare class LicenseClient {
74
74
  * Attaches license terms to an IP.
75
75
  * @param request - The request object that contains all data needed to attach license terms.
76
76
  * @param request.ipId The address of the IP to which the license terms are attached.
77
- * @param request.licenseTemplate The address of the license template.
77
+ * @param request.licenseTemplate The address of the license template, default value is Programmable IP License.
78
78
  * @param request.licenseTermsId The ID of the license terms.
79
79
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
80
80
  * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
@@ -95,10 +95,12 @@ export declare class LicenseClient {
95
95
  * configure the minting fee module to determine the minting fee.
96
96
  * @param request - The request object that contains all data needed to mint license tokens.
97
97
  * @param request.licensorIpId The licensor IP ID.
98
- * @param request.licenseTemplate The address of the license template.
98
+ * @param request.licenseTemplate The address of the license template, default value is Programmable IP License.
99
99
  * @param request.licenseTermsId The ID of the license terms within the license template.
100
100
  * @param request.amount The amount of license tokens to mint.
101
101
  * @param request.receiver The address of the receiver.
102
+ * @param request.maxMintingFee The maximum minting fee that the caller is willing to pay. if set to 0 then no limit.
103
+ * @param request.maxRevenueShare The maximum revenue share percentage allowed for minting the License Tokens. Must be between 0 and 100,000,000 (where 100,000,000 represents 100%).
102
104
  * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
103
105
  * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes license token IDs.
104
106
  * @emits LicenseTokensMinted (msg.sender, licensorIpId, licenseTemplate, licenseTermsId, amount, receiver, startLicenseTokenId);
@@ -116,7 +118,7 @@ export declare class LicenseClient {
116
118
  * @param request.licensorIpId The IP ID of the licensor.
117
119
  * @param request.licenseTermsId The ID of the license terms.
118
120
  * @param request.amount The amount of license tokens to mint.
119
- * @param request.licenseTemplate [Optional] The address of the license template,default value is Programmable IP License.
121
+ * @param request.licenseTemplate [Optional] The address of the license template, default value is Programmable IP License.
120
122
  * @param request.receiver [Optional] The address of the receiver,default value is your wallet address.
121
123
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
122
124
  * @returns A Promise that resolves to an object containing the currency token and token amount.
@@ -133,6 +135,12 @@ export declare class LicenseClient {
133
135
  * @param request.licensingConfig.mintingFee The minting fee to be paid when minting license tokens.
134
136
  * @param request.licensingConfig.hookData The data to be used by the licensing hook.
135
137
  * @param request.licensingConfig.licensingHook The hook contract address for the licensing module, or address(0) if none.
138
+ * @param request.licensingConfig.commercialRevShare The commercial revenue share percentage.
139
+ * @param request.licensingConfig.disabled Whether the license is disabled or not.
140
+ * @param request.licensingConfig.expectMinimumGroupRewardShare The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100 * 10 ** 6) that can be allocated to the IP when it is added to the group.
141
+ * If the remaining reward share in the group is less than the minimumGroupRewardShare, the IP cannot be added to the group.
142
+ * @param request.licensingConfig.expectGroupRewardPool The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address,
143
+ * or address(0) if the IP does not want to be added to any group.
136
144
  * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
137
145
  * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, and if waitForTransaction is true, includes success.
138
146
  */
@@ -1 +1 @@
1
- {"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAErB,+CAA+C,EAE/C,4BAA4B,EAC5B,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAIpC,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAClE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAY3F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;;;;;OASG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA0C/B;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAmDtC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAiErC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;;;;OAUG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;OAaG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YAuDxB,iBAAiB;CAIhC"}
1
+ {"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAEjD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,qBAAqB,EAGrB,+CAA+C,EAE/C,4BAA4B,EAC5B,uBAAuB,EACvB,wCAAwC,EACxC,+BAA+B,EAC/B,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAEL,sCAAsC,EACtC,mBAAmB,EACnB,+BAA+B,EAC/B,iCAAiC,EACjC,yBAAyB,EAEzB,wBAAwB,EACxB,yBAAyB,EAEzB,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,+BAA+B,EAC/B,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AAQpC,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAEpD,qBAAa,aAAa;IACjB,qBAAqB,EAAE,0BAA0B,CAAC;IAClD,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,+BAA+B,EAAE,+BAA+B,CAAC;IACjE,qBAAqB,EAAE,uBAAuB,CAAC;IAC/C,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,4BAA4B,EAAE,4BAA4B,CAAC;IAClE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAY3F;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiC7F;;;;;;OAMG;IACU,+BAA+B,CAC1C,OAAO,CAAC,EAAE,sCAAsC,GAC/C,OAAO,CAAC,mBAAmB,CAAC;IAiC/B;;;;;;;;;OASG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;OAUG;IACU,0BAA0B,CACrC,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA0C/B;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IAmDtC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAuErC;;;;OAIG;IACU,eAAe,CAC1B,sBAAsB,EAAE,cAAc,GACrC,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;;;;OAUG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,+CAA+C,CAAC;IAkC3D;;;;;;;;;;;;;;;;;;;OAmBG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;YA0ExB,iBAAiB;CAIhC"}
@@ -14,7 +14,7 @@ export declare class NftClient {
14
14
  * @param request.isPublicMinting - If true, anyone can mint from the collection. If false, only the addresses with the minter role can mint.
15
15
  * @param request.mintOpen Whether the collection is open for minting on creation.
16
16
  * @param request.mintFeeRecipient - The address to receive mint fees.
17
- * @param request.mintFeeRecipient - The contract URI for the collection. Follows ERC-7572 standard. See https://eips.ethereum.org/EIPS/eip-7572
17
+ * @param request.contractURI - The contract URI for the collection. Follows ERC-7572 standard. See https://eips.ethereum.org/EIPS/eip-7572
18
18
  * @param request.baseURI - [Optional] The base URI for the collection. If baseURI is not empty, tokenURI will be either baseURI + token ID (if nftMetadataURI is empty) or baseURI + nftMetadataURI.
19
19
  * @param request.maxSupply - [Optional] The maximum supply of the collection.
20
20
  * @param request.mintFee - [Optional] The cost to mint a token.
@@ -1 +1 @@
1
- {"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEvE,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAChE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;;;;;;OAiBG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;CAmDxC"}
1
+ {"version":3,"file":"nftClient.d.ts","sourceRoot":"../../../../src/resources","sources":["nftClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqC,MAAM,MAAM,CAAC;AAEvE,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EACL,0BAA0B,EAC1B,2BAA2B,EAC5B,wCAAqC;AAItC,qBAAa,SAAS;IACb,2BAA2B,EAAE,2BAA2B,CAAC;IAChE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAM/D;;;;;;;;;;;;;;;;;OAiBG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC;CAqDxC"}
@@ -1 +1 @@
1
- {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAS3F;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;;;;;;OAcG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA2DpB,iBAAiB;CAQhC"}
1
+ {"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAiE,MAAM,MAAM,CAAC;AAGnG,OAAO,EACL,qCAAqC,EACrC,mCAAmC,EACnC,wBAAwB,EACxB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACvB,yCAAsC;AACvC,OAAO,EAEL,sBAAsB,EACtB,wBAAwB,EAExB,qBAAqB,EACrB,kBAAkB,EACnB,4BAAyB;AAE1B,OAAO,EAAE,iBAAiB,EAAE,2BAAwB;AAIpD,qBAAa,gBAAgB;IACpB,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB;IAS3F;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;;;;;;;;;OAYG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;;;;;;;;;;OAaG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;;;;;;;;;;;OAcG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}
@@ -1,13 +1,12 @@
1
1
  import { Address, Hex, PublicClient } from "viem";
2
- import { ClaimableRevenueRequest, ClaimableRevenueResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse, SnapshotRequest, SnapshotResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchRequest, TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest, SnapshotAndClaimByTokenBatchRequest, SnapshotAndClaimBySnapshotBatchRequest, ClaimRevenueRequest, ClaimRevenueResponse, SnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse, TransferToVaultAndSnapshotAndClaimByTokenBatchResponse, SnapshotAndClaimByTokenBatchResponse } from "../types/resources/royalty.js";
3
- import { IpAssetRegistryClient, IpRoyaltyVaultImplClient, IpRoyaltyVaultImplEventClient, RoyaltyModuleClient, RoyaltyWorkflowsClient, SimpleWalletClient } from "../abi/generated.js";
2
+ import { ClaimableRevenueRequest, ClaimableRevenueResponse, PayRoyaltyOnBehalfRequest, PayRoyaltyOnBehalfResponse } from "../types/resources/royalty.js";
3
+ import { IpAssetRegistryClient, IpRoyaltyVaultImplEventClient, IpRoyaltyVaultImplReadOnlyClient, RoyaltyModuleClient, SimpleWalletClient } from "../abi/generated.js";
4
4
  import { IPAccountClient } from "./ipAccount.js";
5
5
  export declare class RoyaltyClient {
6
6
  royaltyModuleClient: RoyaltyModuleClient;
7
7
  ipAssetRegistryClient: IpAssetRegistryClient;
8
8
  ipAccountClient: IPAccountClient;
9
- royaltyWorkflowsClient: RoyaltyWorkflowsClient;
10
- ipRoyaltyVaultImplClient: IpRoyaltyVaultImplClient;
9
+ ipRoyaltyVaultImplReadOnlyClient: IpRoyaltyVaultImplReadOnlyClient;
11
10
  ipRoyaltyVaultImplEventClient: IpRoyaltyVaultImplEventClient;
12
11
  private readonly rpcClient;
13
12
  private readonly wallet;
@@ -24,100 +23,19 @@ export declare class RoyaltyClient {
24
23
  */
25
24
  payRoyaltyOnBehalf(request: PayRoyaltyOnBehalfRequest): Promise<PayRoyaltyOnBehalfResponse>;
26
25
  /**
27
- * Calculates the amount of revenue token claimable by a token holder at certain snapshot.
26
+ * Get total amount of revenue token claimable by a royalty token holder.
28
27
  * @param request - The request object that contains all data needed to claim Revenue.
29
28
  * @param request.royaltyVaultIpId The id of the royalty vault.
30
- * @param request.account The address of the token holder.
31
- * @param request.snapshotId The snapshot id.
29
+ * @param request.claimer The address of the royalty token holder
32
30
  * @param request.token The revenue token to claim.
33
31
  * @returns A Promise that contains the amount of revenue token claimable
34
32
  */
35
33
  claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
36
- /**
37
- * Allows token holders to claim by a list of snapshot ids based on the token balance at certain snapshot
38
- * @param request - The request object that contains all data needed to claim revenue.
39
- * @param request.snapshotIds The list of snapshot ids.
40
- * @param request.royaltyVaultIpId The id of the royalty vault.
41
- * @param request.token The revenue token to claim.
42
- * @param request.account [Optional] The ipId to send.
43
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
44
- * @returns A Promise that resolves to an object containing the transaction hash and optional claimableToken if waitForTxn is set to true.
45
- * @emits RevenueTokenClaimed (claimer, token, amount).
46
- */
47
- claimRevenue(request: ClaimRevenueRequest): Promise<ClaimRevenueResponse>;
48
- /**
49
- * Snapshots the claimable revenue and royalty token amounts.
50
- * @param request - The request object that contains all data needed to snapshot.
51
- * @param request.royaltyVaultIpId The id of the royalty vault.
52
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
53
- * @returns A Promise that resolves to an object containing the transaction hash and optional snapshotId if waitForTxn is set to true.
54
- * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
55
- */
56
- snapshot(request: SnapshotRequest): Promise<SnapshotResponse>;
57
34
  /**
58
35
  * Get the royalty vault proxy address of given royaltyVaultIpId.
59
36
  * @param royaltyVaultIpId the id of the royalty vault.
60
37
  * @returns A Promise that resolves to an object containing the royalty vault address.
61
38
  */
62
39
  getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<Address>;
63
- /**
64
- * Transfers royalties from royalty policy to the ancestor IP's royalty vault, takes a snapshot, and claims revenue on that snapshot for each specified currency token.
65
- * @param request - The request object that contains all data needed to transfer to vault and snapshot and claim by token batch.
66
- * @param request.ancestorIpId The address of the ancestor IP.
67
- * @param request.royaltyClaimDetails The details of the royalty claim from child IPs
68
- * @param request.royaltyClaimDetails - The details of the royalty claim from child IPs
69
- * @param request.royaltyClaimDetails.childIpId The address of the child IP.
70
- * @param request.royaltyClaimDetails.royaltyPolicy The address of the royalty policy.
71
- * @param request.royaltyClaimDetails.currencyToken The address of the currency (revenue) token to claim.
72
- * @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
73
- * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
74
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
75
- * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
76
- * @emits RevenueTokenClaimed (claimer, token, amount).
77
- */
78
- transferToVaultAndSnapshotAndClaimByTokenBatch(request: TransferToVaultAndSnapshotAndClaimByTokenBatchRequest): Promise<TransferToVaultAndSnapshotAndClaimByTokenBatchResponse>;
79
- /**
80
- * Transfers royalties to the ancestor IP's royalty vault, takes a snapshot, claims revenue for each
81
- * specified currency token both on the new snapshot and on each specified unclaimed snapshots.
82
- * @param request - The request object that contains all data needed to transfer to vault and snapshot and claim by snapshot batch.
83
- * @param request.ancestorIpId The address of the ancestor IP.
84
- * @param request.unclaimedSnapshotIds The IDs of unclaimed snapshots to include in the claim.
85
- * @param request.royaltyClaimDetails The details of the royalty claim from child IPs
86
- * @param request.royaltyClaimDetails - The details of the royalty claim from child IPs
87
- * @param request.royaltyClaimDetails.childIpId The address of the child IP.
88
- * @param request.royaltyClaimDetails.royaltyPolicy The address of the royalty policy.
89
- * @param request.royaltyClaimDetails.currencyToken The address of the currency (revenue) token to claim.
90
- * @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
91
- * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
92
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
93
- * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
94
- * @emits RevenueTokenClaimed (claimer, token, amount).
95
- */
96
- transferToVaultAndSnapshotAndClaimBySnapshotBatch(request: TransferToVaultAndSnapshotAndClaimBySnapshotBatchRequest): Promise<TransferToVaultAndSnapshotAndClaimBySnapshotBatchResponse>;
97
- /**
98
- * Takes a snapshot of the IP's royalty vault and claims revenue on that snapshot for each
99
- * @param request - The request object that contains all data needed to snapshot and claim by token batch.
100
- * @param request.royaltyVaultIpId The address of the IP.
101
- * @param request.currencyTokens The addresses of the currency (revenue) tokens to claim.
102
- * @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
103
- * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
104
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
105
- * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
106
- * @emits RevenueTokenClaimed (claimer, token, amount).
107
- */
108
- snapshotAndClaimByTokenBatch(request: SnapshotAndClaimByTokenBatchRequest): Promise<SnapshotAndClaimByTokenBatchResponse>;
109
- /**
110
- * Takes a snapshot of the IP's royalty vault and claims revenue for each specified currency token
111
- * @param request - The request object that contains all data needed to snapshot and claim by snapshot batch.
112
- * @param request.royaltyVaultIpId The address of the IP.
113
- * @param request.unclaimedSnapshotIds The IDs of unclaimed snapshots to include in the claim.
114
- * @param request.currencyTokens The addresses of the currency (revenue) tokens to claim.
115
- * @param request.claimer [Optional] The address of the claimer of the revenue tokens (must be a royalty token holder), default value is wallet address.
116
- * @param request.txOptions [Optional] This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
117
- * @returns A Promise that resolves to a transaction hash, and if encodedTxDataOnly is true, includes encoded transaction data, or if waitForTransaction is true, includes snapshot ID and amounts claimed.
118
- * @emits SnapshotCompleted (snapshotId, snapshotTimestamp, unclaimedTokens).
119
- * @emits RevenueTokenClaimed (claimer, token, amount).
120
- */
121
- snapshotAndClaimBySnapshotBatch(request: SnapshotAndClaimBySnapshotBatchRequest): Promise<SnapshotAndClaimBySnapshotBatchResponse>;
122
40
  }
123
41
  //# sourceMappingURL=royalty.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAmC,MAAM,MAAM,CAAC;AAGnF,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,qDAAqD,EACrD,wDAAwD,EACxD,mCAAmC,EACnC,sCAAsC,EACtC,mBAAmB,EACnB,oBAAoB,EACpB,uCAAuC,EACvC,yDAAyD,EACzD,sDAAsD,EACtD,oCAAoC,EACrC,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,6BAA6B,EAC7B,mBAAmB,EACnB,sBAAsB,EAKtB,kBAAkB,EAEnB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAE,uBAAoB;AAG9C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,eAAe,EAAE,eAAe,CAAC;IACjC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,6BAA6B,EAAE,6BAA6B,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAW/D;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA0CtC;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAmBpC;;;;;;;;;;OAUG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAsDtF;;;;;;;OAOG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA8B1E;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAS5E;;;;;;;;;;;;;;OAcG;IACU,8CAA8C,CACzD,OAAO,EAAE,qDAAqD,GAC7D,OAAO,CAAC,sDAAsD,CAAC;IAuDlE;;;;;;;;;;;;;;;;OAgBG;IACU,iDAAiD,CAC5D,OAAO,EAAE,wDAAwD,GAChE,OAAO,CAAC,yDAAyD,CAAC;IA8DrE;;;;;;;;;;OAUG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,oCAAoC,CAAC;IA+ChD;;;;;;;;;;;OAWG;IACU,+BAA+B,CAC1C,OAAO,EAAE,sCAAsC,GAC9C,OAAO,CAAC,uCAAuC,CAAC;CAgDpD"}
1
+ {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAG/D,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC3B,sCAAmC;AACpC,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAChC,mBAAmB,EACnB,kBAAkB,EACnB,4BAAyB;AAC1B,OAAO,EAAE,eAAe,EAAE,uBAAoB;AAG9C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,eAAe,EAAE,eAAe,CAAC;IACjC,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB;IAU/D;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA0CtC;;;;;;;OAOG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;OAIG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;CAS7E"}
@@ -1,16 +1,27 @@
1
- import { Hex } from "viem";
1
+ import { Address, Hex } from "viem";
2
2
  import { TxOptions } from "./options.js";
3
+ import { IpMetadataForWorkflow } from "../utils/getIpMetadataForWorkflow.js";
3
4
  export type TypedData = {
4
5
  interface: string;
5
6
  data: unknown[];
6
7
  };
7
8
  export type IpMetadataAndTxOption = {
8
- ipMetadata?: {
9
- ipMetadataURI?: string;
10
- ipMetadataHash?: Hex;
11
- nftMetadataURI?: string;
12
- nftMetadataHash?: Hex;
13
- };
9
+ ipMetadata?: Partial<IpMetadataForWorkflow>;
14
10
  txOptions?: TxOptions;
15
11
  };
12
+ export type LicensingConfig = {
13
+ isSet: boolean;
14
+ mintingFee: bigint | string | number;
15
+ licensingHook: Address;
16
+ hookData: Hex;
17
+ commercialRevShare: number | string;
18
+ disabled: boolean;
19
+ expectMinimumGroupRewardShare: number | string;
20
+ expectGroupRewardPool: Address;
21
+ };
22
+ export type InnerLicensingConfig = {
23
+ mintingFee: bigint;
24
+ commercialRevShare: number;
25
+ expectMinimumGroupRewardShare: number;
26
+ } & LicensingConfig;
16
27
  //# sourceMappingURL=common.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,qBAAkB;AAEtC,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,CAAC,EAAE;QACX,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,cAAc,CAAC,EAAE,GAAG,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,eAAe,CAAC,EAAE,GAAG,CAAC;KACvB,CAAC;IACF,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"common.d.ts","sourceRoot":"../../../../src/types","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,qBAAkB;AACtC,OAAO,EAAE,qBAAqB,EAAE,6CAA0C;AAE1E,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,GAAG,CAAC;IACd,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,6BAA6B,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/C,qBAAqB,EAAE,OAAO,CAAC;CAChC,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"}
@@ -5,7 +5,7 @@ import { SimpleWalletClient } from "../abi/generated.js";
5
5
  *
6
6
  * @public
7
7
  */
8
- export type SupportedChainIds = "1516" | "odyssey";
8
+ export type SupportedChainIds = "1315" | "homer";
9
9
  /**
10
10
  * Configuration for the SDK Client.
11
11
  *
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEnD,OAAO,EAAE,kBAAkB,EAAE,4BAAyB;AAEtD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAAE,CAAC"}
@@ -1,11 +1,12 @@
1
- import { Address, Hex } from "viem";
1
+ import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
3
  import { EncodedTxData } from "../../abi/generated.js";
4
4
  export type RaiseDisputeRequest = {
5
5
  targetIpId: Address;
6
6
  cid: string;
7
7
  targetTag: string;
8
- data?: Hex;
8
+ liveness: bigint | number | string;
9
+ bond: bigint | number | string;
9
10
  txOptions?: TxOptions;
10
11
  };
11
12
  export type RaiseDisputeResponse = {
@@ -1 +1 @@
1
- {"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,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,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
1
+ {"version":3,"file":"dispute.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["dispute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,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,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}
@@ -1,13 +1,24 @@
1
1
  import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
3
  import { EncodedTxData } from "../../abi/generated.js";
4
- import { IpMetadataAndTxOption } from "../common.js";
4
+ import { InnerLicensingConfig, IpMetadataAndTxOption, LicensingConfig } from "../common.js";
5
+ export type LicenseData = {
6
+ licenseTermsId: string | bigint | number;
7
+ licensingConfig: LicensingConfig;
8
+ licenseTemplate?: Address;
9
+ };
10
+ export type InnerLicenseData = {
11
+ licenseTermsId: bigint;
12
+ licensingConfig: InnerLicensingConfig;
13
+ licenseTemplate: Address;
14
+ };
5
15
  export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
6
16
  spgNftContract: Address;
7
- licenseTermsId: string | bigint | number;
8
17
  groupId: Address;
18
+ allowDuplicates: boolean;
19
+ maxAllowedRewardShare: number | string;
20
+ licenseData: LicenseData[];
9
21
  recipient?: Address;
10
- licenseTemplate?: Address;
11
22
  deadline?: string | number | bigint;
12
23
  } & IpMetadataAndTxOption;
13
24
  export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
@@ -29,9 +40,9 @@ export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
29
40
  nftContract: Address;
30
41
  tokenId: bigint | string | number;
31
42
  groupId: Address;
32
- licenseTermsId: bigint | string | number;
33
- licenseTemplate?: Address;
34
43
  deadline?: bigint;
44
+ licenseData: LicenseData[];
45
+ maxAllowedRewardShare: number | string;
35
46
  } & IpMetadataAndTxOption;
36
47
  export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
37
48
  txHash?: string;
@@ -41,8 +52,7 @@ export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
41
52
  };
42
53
  export type RegisterGroupAndAttachLicenseRequest = {
43
54
  groupPool: Address;
44
- licenseTermsId: bigint | string | number;
45
- licenseTemplate?: Address;
55
+ licenseData: LicenseData;
46
56
  txOptions?: TxOptions;
47
57
  };
48
58
  export type RegisterGroupAndAttachLicenseResponse = {
@@ -53,8 +63,8 @@ export type RegisterGroupAndAttachLicenseResponse = {
53
63
  export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
54
64
  groupPool: Address;
55
65
  ipIds: Address[];
56
- licenseTermsId: bigint | string | number;
57
- licenseTemplate?: Address;
66
+ licenseData: LicenseData;
67
+ maxAllowedRewardShare: number | string;
58
68
  txOptions?: TxOptions;
59
69
  };
60
70
  export type RegisterGroupAndAttachLicenseAndAddIpsResponse = {
@@ -1 +1 @@
1
- {"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,qBAAkB;AAElD,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,+CAA+C,GAAG;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,SAAS,EAAE,OAAO,CAAC;IACnB,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,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,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,8CAA8C,GAAG;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,eAAe,EAAE,qBAAkB;AAEzF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,oBAAoB,CAAC;IACtC,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,sDAAsD,GAAG;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC,GAAG,qBAAqB,CAAC;AAE1B,MAAM,MAAM,+CAA+C,GAAG;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG;IACjD,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
@@ -2,7 +2,25 @@ import { Address, Hex } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
3
  import { RegisterPILTermsRequest } from "./license.js";
4
4
  import { EncodedTxData } from "../../abi/generated.js";
5
- import { IpMetadataAndTxOption } from "../common.js";
5
+ import { IpMetadataAndTxOption, LicensingConfig } from "../common.js";
6
+ import { IpMetadataForWorkflow } from "../../utils/getIpMetadataForWorkflow.js";
7
+ export type DerivativeData = {
8
+ parentIpIds: Address[];
9
+ licenseTermsIds: bigint[] | string[] | number[];
10
+ maxMintingFee: bigint | string | number;
11
+ maxRts: number | string;
12
+ maxRevenueShare: number | string;
13
+ licenseTemplate?: Address;
14
+ };
15
+ export type InternalDerivativeData = {
16
+ parentIpIds: readonly Address[];
17
+ licenseTermsIds: readonly bigint[];
18
+ royaltyContext: Hex;
19
+ maxMintingFee: bigint;
20
+ maxRts: number;
21
+ maxRevenueShare: number;
22
+ licenseTemplate: Address;
23
+ };
6
24
  export type RegisterIpResponse = {
7
25
  txHash?: Hex;
8
26
  encodedTxData?: EncodedTxData;
@@ -17,6 +35,7 @@ export type RegisterRequest = {
17
35
  export type RegisterDerivativeWithLicenseTokensRequest = {
18
36
  childIpId: Address;
19
37
  licenseTokenIds: string[] | bigint[] | number[];
38
+ maxRts: number | string;
20
39
  txOptions?: TxOptions;
21
40
  };
22
41
  export type RegisterDerivativeWithLicenseTokensResponse = {
@@ -24,19 +43,21 @@ export type RegisterDerivativeWithLicenseTokensResponse = {
24
43
  encodedTxData?: EncodedTxData;
25
44
  };
26
45
  export type RegisterDerivativeRequest = {
27
- childIpId: Address;
28
- parentIpIds: Address[];
29
- licenseTermsIds: string[] | bigint[] | number[];
30
- licenseTemplate?: Address;
31
46
  txOptions?: TxOptions;
32
- };
47
+ childIpId: Address;
48
+ } & DerivativeData;
33
49
  export type RegisterDerivativeResponse = {
34
50
  txHash?: Hex;
35
51
  encodedTxData?: EncodedTxData;
36
52
  };
53
+ export type LicenseTermsData<T, U> = {
54
+ terms: T;
55
+ licensingConfig: U;
56
+ };
37
57
  export type MintAndRegisterIpAssetWithPilTermsRequest = {
38
58
  spgNftContract: Address;
39
- terms: RegisterPILTermsRequest[];
59
+ allowDuplicates: boolean;
60
+ licenseTermsData: LicenseTermsData<RegisterPILTermsRequest, LicensingConfig>[];
40
61
  recipient?: Address;
41
62
  royaltyPolicyAddress?: Address;
42
63
  } & IpMetadataAndTxOption;
@@ -51,10 +72,11 @@ export type RegisterIpAndMakeDerivativeRequest = {
51
72
  nftContract: Address;
52
73
  tokenId: string | number | bigint;
53
74
  deadline?: string | number | bigint;
54
- derivData: {
55
- parentIpIds: Address[];
56
- licenseTermsIds: string[] | bigint[] | number[];
57
- licenseTemplate?: Address;
75
+ derivData: DerivativeData;
76
+ sigMetadataAndRegister?: {
77
+ signer: Address;
78
+ deadline: bigint | string | number;
79
+ signature: Hex;
58
80
  };
59
81
  } & IpMetadataAndTxOption;
60
82
  export type RegisterIpAndMakeDerivativeResponse = {
@@ -66,7 +88,7 @@ export type RegisterIpAndMakeDerivativeResponse = {
66
88
  export type RegisterIpAndAttachPilTermsRequest = {
67
89
  nftContract: Address;
68
90
  tokenId: bigint | string | number;
69
- terms: RegisterPILTermsRequest[];
91
+ licenseTermsData: LicenseTermsData<RegisterPILTermsRequest, LicensingConfig>[];
70
92
  deadline?: bigint | number | string;
71
93
  } & IpMetadataAndTxOption;
72
94
  export type RegisterIpAndAttachPilTermsResponse = {
@@ -78,12 +100,9 @@ export type RegisterIpAndAttachPilTermsResponse = {
78
100
  };
79
101
  export type MintAndRegisterIpAndMakeDerivativeRequest = {
80
102
  spgNftContract: Address;
81
- derivData: {
82
- parentIpIds: Address[];
83
- licenseTermsIds: string[] | bigint[] | number[];
84
- licenseTemplate?: Address;
85
- };
103
+ derivData: DerivativeData;
86
104
  recipient?: Address;
105
+ allowDuplicates: boolean;
87
106
  } & IpMetadataAndTxOption;
88
107
  export type MintAndRegisterIpAndMakeDerivativeResponse = {
89
108
  txHash?: Hex;
@@ -179,10 +198,11 @@ export type IpMetadata = {
179
198
  export type MintAndRegisterIpRequest = {
180
199
  spgNftContract: Address;
181
200
  recipient?: Address;
201
+ allowDuplicates: boolean;
182
202
  } & IpMetadataAndTxOption;
183
203
  export type RegisterPilTermsAndAttachRequest = {
184
204
  ipId: Address;
185
- terms: RegisterPILTermsRequest[];
205
+ licenseTermsData: LicenseTermsData<RegisterPILTermsRequest, LicensingConfig>[];
186
206
  deadline?: string | number | bigint;
187
207
  txOptions?: TxOptions;
188
208
  };
@@ -195,12 +215,15 @@ export type MintAndRegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
195
215
  spgNftContract: Address;
196
216
  licenseTokenIds: string[] | bigint[] | number[];
197
217
  recipient?: Address;
218
+ maxRts: number | string;
219
+ allowDuplicates: boolean;
198
220
  } & IpMetadataAndTxOption;
199
221
  export type RegisterIpAndMakeDerivativeWithLicenseTokensRequest = {
200
222
  nftContract: Address;
201
223
  tokenId: string | number | bigint;
202
224
  licenseTokenIds: string[] | bigint[] | number[];
203
225
  deadline?: string | number | bigint;
226
+ maxRts: number | string;
204
227
  } & IpMetadataAndTxOption;
205
228
  export type BatchMintAndRegisterIpAssetWithPilTermsRequest = {
206
229
  args: Omit<MintAndRegisterIpAssetWithPilTermsRequest, "txOptions">[];
@@ -243,7 +266,7 @@ export type BatchRegisterResponse = {
243
266
  export type RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensRequest = {
244
267
  nftContract: Address;
245
268
  tokenId: bigint | string | number;
246
- terms: RegisterPILTermsRequest[];
269
+ licenseTermsData: LicenseTermsData<RegisterPILTermsRequest, LicensingConfig>[];
247
270
  deadline?: string | number | bigint;
248
271
  royaltyShares: RoyaltyShare[];
249
272
  txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
@@ -258,14 +281,13 @@ export type RegisterIPAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse =
258
281
  export type DistributeRoyaltyTokens = {
259
282
  ipId: Address;
260
283
  deadline: bigint;
261
- state: Hex;
262
284
  ipRoyaltyVault: Address;
263
285
  royaltyShares: RoyaltyShare[];
264
286
  totalAmount: number;
265
287
  txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
266
288
  };
267
289
  export type RoyaltyShare = {
268
- author: Address;
290
+ recipient: Address;
269
291
  percentage: number;
270
292
  };
271
293
  export type IpIdAndTokenId<T extends string | undefined> = T extends undefined ? {
@@ -281,14 +303,11 @@ export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensReq
281
303
  nftContract: Address;
282
304
  tokenId: bigint | string | number;
283
305
  deadline?: string | number | bigint;
284
- derivData: {
285
- parentIpIds: Address[];
286
- licenseTemplate?: Address;
287
- licenseTermsIds: bigint[];
288
- };
306
+ derivData: DerivativeData;
289
307
  royaltyShares: RoyaltyShare[];
308
+ ipMetadata?: IpMetadataForWorkflow;
290
309
  txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
291
- } & IPMetadataInfo;
310
+ };
292
311
  export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensResponse = {
293
312
  registerDerivativeIpAndAttachLicenseTermsAndDistributeRoyaltyTokensTxHash: Address;
294
313
  distributeRoyaltyTokensTxHash: Address;
@@ -298,11 +317,12 @@ export type RegisterDerivativeAndAttachLicenseTermsAndDistributeRoyaltyTokensRes
298
317
  };
299
318
  export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensRequest = {
300
319
  spgNftContract: Address;
301
- terms: RegisterPILTermsRequest[];
302
- royaltyShares: {
303
- author: Address;
304
- percentage: number;
320
+ allowDuplicates: boolean;
321
+ licenseTermsData: {
322
+ terms: RegisterPILTermsRequest;
323
+ licensingConfig: LicensingConfig;
305
324
  }[];
325
+ royaltyShares: RoyaltyShare[];
306
326
  recipient?: Address;
307
327
  txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
308
328
  } & IPMetadataInfo;
@@ -315,15 +335,9 @@ export type MintAndRegisterIpAndAttachPILTermsAndDistributeRoyaltyTokensResponse
315
335
  };
316
336
  export type MintAndRegisterIpAndMakeDerivativeAndDistributeRoyaltyTokensRequest = {
317
337
  spgNftContract: Address;
318
- derivData: {
319
- parentIpIds: Address[];
320
- licenseTermsIds: string[] | bigint[] | number[];
321
- licenseTemplate?: Address;
322
- };
323
- royaltyShares: {
324
- author: Address;
325
- percentage: number;
326
- }[];
338
+ derivData: DerivativeData;
339
+ royaltyShares: RoyaltyShare[];
340
+ allowDuplicates: boolean;
327
341
  recipient?: Address;
328
342
  txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
329
343
  } & IPMetadataInfo;