@story-protocol/core-sdk 1.3.0-rc.3 → 1.3.1-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/README.md +29 -101
  2. package/dist/declarations/src/abi/generated.d.ts +1803 -3477
  3. package/dist/declarations/src/abi/generated.d.ts.map +1 -1
  4. package/dist/declarations/src/client.d.ts +3 -27
  5. package/dist/declarations/src/client.d.ts.map +1 -1
  6. package/dist/declarations/src/constants/common.d.ts +1 -4
  7. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  8. package/dist/declarations/src/index.d.ts +13 -13
  9. package/dist/declarations/src/index.d.ts.map +1 -1
  10. package/dist/declarations/src/resources/dispute.d.ts +13 -29
  11. package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
  12. package/dist/declarations/src/resources/group.d.ts +17 -14
  13. package/dist/declarations/src/resources/group.d.ts.map +1 -1
  14. package/dist/declarations/src/resources/ipAccount.d.ts +6 -24
  15. package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
  16. package/dist/declarations/src/resources/ipAsset.d.ts +74 -171
  17. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/license.d.ts +22 -79
  19. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  20. package/dist/declarations/src/resources/nftClient.d.ts +3 -15
  21. package/dist/declarations/src/resources/nftClient.d.ts.map +1 -1
  22. package/dist/declarations/src/resources/permission.d.ts +13 -56
  23. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  24. package/dist/declarations/src/resources/royalty.d.ts +12 -8
  25. package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
  26. package/dist/declarations/src/types/common.d.ts +20 -6
  27. package/dist/declarations/src/types/common.d.ts.map +1 -1
  28. package/dist/declarations/src/types/config.d.ts +15 -0
  29. package/dist/declarations/src/types/config.d.ts.map +1 -1
  30. package/dist/declarations/src/types/options.d.ts +9 -4
  31. package/dist/declarations/src/types/options.d.ts.map +1 -1
  32. package/dist/declarations/src/types/resources/dispute.d.ts +14 -3
  33. package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
  34. package/dist/declarations/src/types/resources/group.d.ts +29 -9
  35. package/dist/declarations/src/types/resources/group.d.ts.map +1 -1
  36. package/dist/declarations/src/types/resources/ipAccount.d.ts +13 -2
  37. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
  38. package/dist/declarations/src/types/resources/ipAsset.d.ts +99 -35
  39. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  40. package/dist/declarations/src/types/resources/license.d.ts +77 -13
  41. package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
  42. package/dist/declarations/src/types/resources/nftClient.d.ts +11 -3
  43. package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -1
  44. package/dist/declarations/src/types/resources/permission.d.ts +36 -4
  45. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  46. package/dist/declarations/src/types/resources/royalty.d.ts +4 -0
  47. package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
  48. package/dist/declarations/src/types/utils/wip.d.ts +64 -0
  49. package/dist/declarations/src/types/utils/wip.d.ts.map +1 -0
  50. package/dist/declarations/src/utils/chain.d.ts +2 -0
  51. package/dist/declarations/src/utils/chain.d.ts.map +1 -1
  52. package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts +1 -1
  53. package/dist/declarations/src/utils/getIpMetadataForWorkflow.d.ts.map +1 -1
  54. package/dist/declarations/src/utils/sign.d.ts +0 -17
  55. package/dist/declarations/src/utils/sign.d.ts.map +1 -1
  56. package/dist/declarations/src/utils/token.d.ts +28 -0
  57. package/dist/declarations/src/utils/token.d.ts.map +1 -0
  58. package/dist/story-protocol-core-sdk.cjs.dev.js +3538 -2847
  59. package/dist/story-protocol-core-sdk.cjs.prod.js +3538 -2847
  60. package/dist/story-protocol-core-sdk.esm.js +3538 -2847
  61. package/package.json +1 -1
@@ -11,80 +11,37 @@ export declare class PermissionClient {
11
11
  private readonly chainId;
12
12
  constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
13
13
  /**
14
- * Sets the permission for a specific function call
14
+ * Sets the permission for a specific function call.
15
15
  * Each policy is represented as a mapping from an IP account address to a signer address to a recipient
16
- * address to a function selector to a permission level. The permission level can be 0 (ABSTAIN), 1 (ALLOW), or
17
- * 2 (DENY).
18
- * By default, all policies are set to 0 (ABSTAIN), which means that the permission is not set.
16
+ * address to a function selector to a permission level. The permission level is an enum of `AccessPermission`.
17
+ * By default, all policies are set to ABSTAIN, which means that the permission is not set.
19
18
  * The owner of ipAccount by default has all permission.
20
- * address(0) => wildcard
21
- * bytes4(0) => wildcard
22
- * Specific permission overrides wildcard permission.
23
- * @param request - The request object containing necessary data to set `permission`.
24
- * @param request.ipId The IP ID that grants the permission for `signer`.
25
- * @param request.signer The address that can call `to` on behalf of the `ipAccount`.
26
- * @param request.to The address that can be called by the `signer` (currently only modules can be `to`).
27
- * @param request.permission The new permission level.
28
- * @param request.func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
29
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
30
- * @returns A Promise that resolves to an object containing the transaction hash.
31
- * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
19
+ *
20
+ * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
32
21
  */
33
22
  setPermission(request: SetPermissionsRequest): Promise<SetPermissionsResponse>;
34
23
  /**
35
24
  * Specific permission overrides wildcard permission with signature.
36
- * @param request - The request object containing necessary data to set permissions.
37
- * @param request.ipId The IP ID that grants the permission for `signer`
38
- * @param request.signer The address that can call `to` on behalf of the `ipAccount`
39
- * @param request.to The address that can be called by the `signer` (currently only modules can be `to`)
40
- * @param request.permission The new permission level.
41
- * @param request.func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
42
- * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
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.
45
- * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
25
+ *
26
+ * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
46
27
  */
47
28
  createSetPermissionSignature(request: CreateSetPermissionSignatureRequest): Promise<SetPermissionsResponse>;
48
29
  /**
49
30
  * Sets permission to a signer for all functions across all modules.
50
- * @param request - The request object containing necessary data to set all permissions.
51
- * @param request.ipId The IP ID that grants the permission for `signer`
52
- * @param request.signer The address of the signer receiving the permissions.
53
- * @param request.permission The new permission.
54
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
55
- * @returns A Promise that resolves to an object containing the transaction hash
56
- * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
31
+ *
32
+ * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
57
33
  */
58
34
  setAllPermissions(request: SetAllPermissionsRequest): Promise<SetPermissionsResponse>;
59
35
  /**
60
36
  * Sets a batch of permissions in a single transaction.
61
- * @param request - The request object containing necessary data to set all permissions.
62
- * @param {Array} request.permissions - An array of `Permission` structure, each representing the permission to be set.
63
- * @param request.permissions[].ipId The IP ID that grants the permission for `signer`.
64
- * @param request.permissions[].signer The address that can call `to` on behalf of the `ipAccount`.
65
- * @param request.permissions[].to The address that can be called by the `signer` (currently only modules can be `to`).
66
- * @param request.permissions[].permission The new permission level.
67
- * @param request.permissions[].func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
68
- * @param request.deadline [Optional] The deadline for the signature in milliseconds, default is 1000ms.
69
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
70
- * @returns A Promise that resolves to an object containing the transaction hash
71
- * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
37
+ *
38
+ * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
72
39
  */
73
40
  setBatchPermissions(request: SetBatchPermissionsRequest): Promise<SetPermissionsResponse>;
74
41
  /**
75
42
  * Sets a batch of permissions in a single transaction with signature.
76
- * @param request - The request object containing necessary data to set permissions.
77
- * @param request.ipId The IP ID that grants the permission for `signer`
78
- * @param {Array} request.permissions - An array of `Permission` structure, each representing the permission to be set.
79
- * @param request.permissions[].ipId The IP ID that grants the permission for `signer`.
80
- * @param request.permissions[].signer The address that can call `to` on behalf of the `ipAccount`.
81
- * @param request.permissions[].to The address that can be called by the `signer` (currently only modules can be `to`).
82
- * @param request.permissions[].permission The new permission level.
83
- * @param request.permissions[].func [Optional] The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount`. Be default, it allows all functions.
84
- * @param request.deadline [Optional] The deadline for the signature in seconds, default is 1000s.
85
- * @param request.txOptions - [Optional] transaction. This extends `WaitForTransactionReceiptParameters` from the Viem library, excluding the `hash` property.
86
- * @returns A Promise that resolves to an object containing the transaction hash.
87
- * @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
43
+ *
44
+ * Emits an on-chain {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/interfaces/access/IAccessController.sol#L13 | `PermissionSet`} event.
88
45
  */
89
46
  createBatchPermissionSignature(request: CreateBatchPermissionSignatureRequest): Promise<SetPermissionsResponse>;
90
47
  private checkIsRegistered;
@@ -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;AAI1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,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,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IASlF;;;;;;;;;;;;;;;;;;;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
+ {"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;AAI1B,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAE3C,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,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IASlF;;;;;;;;OAQG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA8B3F;;;;OAIG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,sBAAsB,CAAC;IA8DlC;;;;OAIG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,sBAAsB,CAAC;IA0BlC;;;;OAIG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAiClC;;;;OAIG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sBAAsB,CAAC;YA0DpB,iBAAiB;CAQhC"}
@@ -17,9 +17,14 @@ export declare class RoyaltyClient {
17
17
  private readonly chainId;
18
18
  constructor(rpcClient: PublicClient, wallet: SimpleWalletClient, chainId: ChainIds);
19
19
  /**
20
- * Claims all revenue from the child IPs of an ancestor IP, then transfer.
20
+ * Claims all revenue from the child IPs of an ancestor IP, then transfer
21
21
  * all claimed tokens to the wallet if the wallet owns the IP or is the claimer.
22
22
  * If claimed token is WIP, it will also be converted back to IP.
23
+ *
24
+ * @remarks
25
+ * Even if there are no child IPs, you must still populate {@link ClaimAllRevenueRequest.currencyTokens} with
26
+ * the token addresses you wish to claim. This is required for the claim operation to know which
27
+ * token balances to process.
23
28
  */
24
29
  claimAllRevenue(req: ClaimAllRevenueRequest): Promise<ClaimAllRevenueResponse>;
25
30
  /**
@@ -27,6 +32,11 @@ export declare class RoyaltyClient {
27
32
  * if multicall is disabled, it will call @link{claimAllRevenue} for each ancestor IP.
28
33
  * Then transfer all claimed tokens to the wallet if the wallet owns the IP or is the claimer.
29
34
  * If claimed token is WIP, it will also be converted back to IP.
35
+ *
36
+ * @remarks
37
+ * Even if there are no child IPs, you must still populate `currencyTokens` in each ancestor IP
38
+ * with the token addresses you wish to claim. This is required for the claim operation to know which
39
+ * token balances to process.
30
40
  */
31
41
  batchClaimAllRevenue(request: BatchClaimAllRevenueRequest): Promise<BatchClaimAllRevenueResponse>;
32
42
  /**
@@ -35,17 +45,11 @@ export declare class RoyaltyClient {
35
45
  payRoyaltyOnBehalf(request: PayRoyaltyOnBehalfRequest): Promise<PayRoyaltyOnBehalfResponse>;
36
46
  /**
37
47
  * Get total amount of revenue token claimable by a royalty token holder.
38
- * @param request - The request object that contains all data needed to claim Revenue.
39
- * @param request.royaltyVaultIpId The id of the royalty vault.
40
- * @param request.claimer The address of the royalty token holder
41
- * @param request.token The revenue token to claim.
42
- * @returns A Promise that contains the amount of revenue token claimable
48
+ * Returns the amount of revenue token claimable by the claimer.
43
49
  */
44
50
  claimableRevenue(request: ClaimableRevenueRequest): Promise<ClaimableRevenueResponse>;
45
51
  /**
46
52
  * Get the royalty vault proxy address of given royaltyVaultIpId.
47
- * @param royaltyVaultIpId the id of the royalty vault.
48
- * @returns A Promise that resolves to an object containing the royalty vault address.
49
53
  */
50
54
  getRoyaltyVaultAddress(royaltyVaultIpId: Hex): Promise<Address>;
51
55
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAE1B,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAEL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAEhC,gBAAgB,EAChB,mBAAmB,EAEnB,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAK1B,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAI3C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAalF;;;;OAIG;IACU,eAAe,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAmD3F;;;;;OAKG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAoHxC;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA6DtC;;;;;;;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;IAU5E;;OAEG;IACU,eAAe,CAAC,EAC3B,SAAS,EACT,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB1C,mCAAmC;YAuBnC,cAAc;IAY5B;;;OAGG;YACW,eAAe;CAe9B"}
1
+ {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../src/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAE1B,sBAAsB,EACvB,sCAAmC;AACpC,OAAO,EAEL,qBAAqB,EACrB,6BAA6B,EAC7B,gCAAgC,EAEhC,gBAAgB,EAChB,mBAAmB,EAEnB,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EAChB,4BAAyB;AAK1B,OAAO,EAAE,mBAAmB,EAAE,4BAAyB;AACvD,OAAO,EAAE,QAAQ,EAAE,2BAAwB;AAI3C,qBAAa,aAAa;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gCAAgC,EAAE,gCAAgC,CAAC;IACnE,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,eAAe,EAAE,eAAe,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ;IAalF;;;;;;;;;OASG;IACU,eAAe,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAmD3F;;;;;;;;;;OAUG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAoHxC;;OAEG;IACU,kBAAkB,CAC7B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC;IA6DtC;;;OAGG;IACU,gBAAgB,CAC3B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAepC;;OAEG;IACU,sBAAsB,CAAC,gBAAgB,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAU5E;;OAEG;IACU,eAAe,CAAC,EAC3B,SAAS,EACT,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,KAAK,GACN,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB1C,mCAAmC;YAuBnC,cAAc;IAY5B;;;OAGG;YACW,eAAe;CAe9B"}
@@ -9,25 +9,39 @@ export type IpMetadataAndTxOptions = WithTxOptions & {
9
9
  /** The desired metadata for the newly minted NFT and newly registered IP. */
10
10
  ipMetadata?: Partial<IpMetadataForWorkflow>;
11
11
  };
12
- export type LicensingConfig = {
13
- /** Whether the configuration is set or not */
12
+ /**
13
+ * This data used IP owners to define the configuration
14
+ * when others are minting license tokens of their IP through the LicensingModule.
15
+ * Contract reference: @see {@link https://github.com/storyprotocol/protocol-core-v1/blob/v1.3.1/contracts/lib/Licensing.sol#L27 | Licensing.sol}
16
+ * For detailed documentation on licensing configuration, visit {@link https://docs.story.foundation/concepts/licensing-module/license-config}
17
+ */
18
+ export type LicensingConfigInput = {
19
+ /** Whether the licensing configuration is active. If false, the configuration is ignored. */
14
20
  isSet: boolean;
15
21
  /** The minting fee to be paid when minting license tokens. */
16
22
  mintingFee: bigint | string | number;
17
- /** The hook contract address for the licensing module, or zero address if none. */
23
+ /**
24
+ * The licensingHook is an address to a smart contract that implements the `ILicensingHook` interface.
25
+ * This contract's `beforeMintLicenseTokens` function is executed before a user mints a License Token,
26
+ * allowing for custom validation or business logic to be enforced during the minting process.
27
+ * For detailed documentation on licensing hook, visit {@link https://docs.story.foundation/concepts/hooks#licensing-hooks}
28
+ */
18
29
  licensingHook: Address;
19
- /** The data to be used by the licensing hook. */
30
+ /**
31
+ * The data to be used by the licensing hook.
32
+ * Set to a zero hash if no data is provided.
33
+ */
20
34
  hookData: Hex;
21
35
  /** The commercial revenue share percentage (from 0 to 100%, represented as 100_000_000). */
22
36
  commercialRevShare: number | string;
23
- /** Whether the licensing is disabled or not. */
37
+ /** Whether the licensing is disabled or not. If this is true, then no licenses can be minted and no more derivatives can be attached at all. */
24
38
  disabled: boolean;
25
39
  /** The minimum percentage of the group’s reward share (from 0 to 100%, represented as 100_000_000) that can be allocated to the IP when it is added to the group. */
26
40
  expectMinimumGroupRewardShare: number | string;
27
41
  /** The address of the expected group reward pool. The IP can only be added to a group with this specified reward pool address, or zero address if the IP does not want to be added to any group. */
28
42
  expectGroupRewardPool: Address;
29
43
  };
30
- export type ValidatedLicensingConfig = LicensingConfig & {
44
+ export type LicensingConfig = LicensingConfigInput & {
31
45
  mintingFee: bigint;
32
46
  commercialRevShare: number;
33
47
  expectMinimumGroupRewardShare: number;
@@ -1 +1 @@
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,aAAa,EAAE,qBAAkB;AAC1C,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,sBAAsB,GAAG,aAAa,GAAG;IACnD,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC7C,CAAC;AACF,MAAM,MAAM,eAAe,GAAG;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,OAAO,CAAC;IACf,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,mFAAmF;IACnF,aAAa,EAAE,OAAO,CAAC;IACvB,iDAAiD;IACjD,QAAQ,EAAE,GAAG,CAAC;IACd,4FAA4F;IAC5F,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,gDAAgD;IAChD,QAAQ,EAAE,OAAO,CAAC;IAClB,qKAAqK;IACrK,6BAA6B,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/C,oMAAoM;IACpM,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,oBAAY,YAAY;IACtB,wBAAwB,uBAAuB;IAC/C,iBAAiB,oBAAoB;IACrC,wBAAwB,0BAA0B;CACnD"}
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,aAAa,EAAE,qBAAkB;AAC1C,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,sBAAsB,GAAG,aAAa,GAAG;IACnD,6EAA6E;IAC7E,UAAU,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,6FAA6F;IAC7F,KAAK,EAAE,OAAO,CAAC;IACf,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC;;;;;OAKG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,GAAG,CAAC;IACd,4FAA4F;IAC5F,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,gJAAgJ;IAChJ,QAAQ,EAAE,OAAO,CAAC;IAClB,qKAAqK;IACrK,6BAA6B,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/C,oMAAoM;IACpM,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C;;;GAGG;AACH,oBAAY,YAAY;IACtB,wBAAwB,uBAAuB;IAC/C,iBAAiB,oBAAoB;IACrC,wBAAwB,0BAA0B;CACnD"}
@@ -13,16 +13,31 @@ export type SupportedChainIds = "aeneid" | "mainnet" | ChainIds;
13
13
  */
14
14
  export type UseAccountStoryConfig = {
15
15
  readonly account: Account | Address;
16
+ /**
17
+ * The chain ID to use, the default is `aeneid`.
18
+ *
19
+ * @default 13_15
20
+ */
16
21
  readonly chainId?: SupportedChainIds;
17
22
  readonly transport: Transport;
18
23
  };
19
24
  export type UseWalletStoryConfig = {
25
+ /**
26
+ * The chain ID to use, the default is `aeneid`.
27
+ *
28
+ * @default 13_15
29
+ */
20
30
  readonly chainId?: SupportedChainIds;
21
31
  readonly transport: Transport;
22
32
  readonly wallet: SimpleWalletClient;
23
33
  };
24
34
  export type StoryConfig = {
25
35
  readonly transport: Transport;
36
+ /**
37
+ * The chain ID to use, the default is `aeneid`.
38
+ *
39
+ * @default 13_15
40
+ */
26
41
  readonly chainId?: SupportedChainIds;
27
42
  readonly wallet?: SimpleWalletClient;
28
43
  readonly account?: Account | Address;
@@ -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,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;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;AAErF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,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,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,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;;;;OAIG;IACH,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;AAErF,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC"}
@@ -1,4 +1,4 @@
1
- import { Hex, PublicClient, TransactionReceipt, WaitForTransactionReceiptParameters } from "viem";
1
+ import { Hash, PublicClient, TransactionReceipt, WaitForTransactionReceiptParameters } from "viem";
2
2
  export type TxOptions = Omit<WaitForTransactionReceiptParameters, "hash"> & {
3
3
  /**
4
4
  * Whether or not to wait for the transaction so you can receive a transaction receipt in return
@@ -62,13 +62,18 @@ export type WithWipOptions = {
62
62
  /** options to configure WIP behavior */
63
63
  wipOptions?: WipOptions;
64
64
  };
65
- export type HandleTxOptionsParams = {
66
- txHash: Hex;
65
+ export type WaitForTransactionReceiptRequest = {
66
+ txHash: Hash;
67
+ txOptions?: TxOptions;
68
+ rpcClient: PublicClient;
69
+ };
70
+ export type WaitForTransactionReceiptsRequest = {
71
+ txHashes: Hash[];
67
72
  txOptions?: TxOptions;
68
73
  rpcClient: PublicClient;
69
74
  };
70
75
  export type TransactionResponse = {
71
- txHash: Hex;
76
+ txHash: Hash;
72
77
  /** Transaction receipt, only available if waitForTransaction is set to true */
73
78
  receipt?: TransactionReceipt;
74
79
  };
@@ -1 +1 @@
1
- {"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,MAAM,CAAC;AAElG,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC,GAAG;IAC1E;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,GAAG,CAAC;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,GAAG,CAAC;IAEZ,+EAA+E;IAC/E,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC"}
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,mCAAmC,EAAE,MAAM,MAAM,CAAC;AAEnG,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC,GAAG;IAC1E;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,MAAM,EAAE,IAAI,CAAC;IACb,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;IAEb,+EAA+E;IAC/E,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC"}
@@ -22,8 +22,9 @@ export type RaiseDisputeRequest = WithTxOptions & {
22
22
  * The amount of wrapper IP that the dispute initiator pays upfront into a pool.
23
23
  * To counter that dispute the opposite party of the dispute has to place a bond of the same amount.
24
24
  * The winner of the dispute gets the original bond back + 50% of the other party bond. The remaining 50% of the loser party bond goes to the reviewer.
25
+ * The bond amount must be between the minimum and maximum bond values defined in the Optimistic Oracle V3 (OOV3) contract. If not specified, it defaults to the minimum bond value.
25
26
  */
26
- bond: bigint | number | string;
27
+ bond?: bigint | number | string;
27
28
  /**
28
29
  * Omit {@link WipOptions.useMulticallWhenPossible} for this function due to disputeInitiator issue.
29
30
  * It will be executed sequentially with several transactions.
@@ -37,7 +38,12 @@ export type RaiseDisputeResponse = {
37
38
  };
38
39
  export type CancelDisputeRequest = {
39
40
  disputeId: number | string | bigint;
40
- data?: Address;
41
+ /**
42
+ * Additional data used in the cancellation process.
43
+ *
44
+ * @default 0x
45
+ */
46
+ data?: Hex;
41
47
  txOptions?: TxOptions;
42
48
  };
43
49
  export type CancelDisputeResponse = {
@@ -46,7 +52,12 @@ export type CancelDisputeResponse = {
46
52
  };
47
53
  export type ResolveDisputeRequest = {
48
54
  disputeId: number | string | bigint;
49
- data: Address;
55
+ /**
56
+ * Additional data used in the resolution process.
57
+ *
58
+ * @default 0x
59
+ */
60
+ data?: Hex;
50
61
  txOptions?: TxOptions;
51
62
  };
52
63
  export type ResolveDisputeResponse = {
@@ -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,UAAU,EAAE,aAAa,EAAE,sBAAmB;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,mDAAmD;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,yGAAyG;IACzG,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,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;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,EAAE;QAChB,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,6DAA6D;QAC7D,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACrC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,GAAG,aAAa,CAAC"}
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,UAAU,EAAE,aAAa,EAAE,sBAAmB;AAClE,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,mDAAmD;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,yGAAyG;IACzG,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,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;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,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;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,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;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,EAAE;QAChB,sBAAsB;QACtB,IAAI,EAAE,OAAO,CAAC;QACd,6DAA6D;QAC7D,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACrC,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,GAAG,aAAa,CAAC;AAElB,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,0BAA0B,CAAC,CAAC;CAC3D,GAAG,aAAa,CAAC"}
@@ -1,15 +1,19 @@
1
1
  import { Address, Hash, TransactionReceipt } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
3
  import { EncodedTxData, GroupingModuleCollectedRoyaltiesToGroupPoolEvent } from "../../abi/generated.js";
4
- import { IpMetadataAndTxOptions, LicensingConfig, ValidatedLicensingConfig } from "../common.js";
5
- export type LicenseData = {
4
+ import { IpMetadataAndTxOptions, LicensingConfigInput, LicensingConfig } from "../common.js";
5
+ export type LicenseDataInput = {
6
6
  licenseTermsId: string | bigint | number;
7
- licensingConfig?: LicensingConfig;
7
+ /**
8
+ * The address of the license template.
9
+ * Defaults to {@link https://docs.story.foundation/docs/programmable-ip-license | PIL} address if not provided.
10
+ */
11
+ licensingConfig?: LicensingConfigInput;
8
12
  licenseTemplate?: Address;
9
13
  };
10
- export type ValidatedLicenseData = {
14
+ export type LicenseData = {
11
15
  licenseTermsId: bigint;
12
- licensingConfig: ValidatedLicensingConfig;
16
+ licensingConfig: LicensingConfig;
13
17
  licenseTemplate: Address;
14
18
  };
15
19
  export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
@@ -24,7 +28,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupRequest = {
24
28
  /** The maximum reward share percentage that can be allocated to each member IP. */
25
29
  maxAllowedRewardShare: number | string;
26
30
  /** The data of the license and its configuration to be attached to the new group IP. */
27
- licenseData: LicenseData[];
31
+ licenseData: LicenseDataInput[];
28
32
  /** The address of the recipient of the minted NFT. If not provided, the function will use the user's own wallet address. */
29
33
  recipient?: Address;
30
34
  /**
@@ -40,6 +44,7 @@ export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
40
44
  tokenId?: bigint;
41
45
  };
42
46
  export type RegisterGroupRequest = {
47
+ /** The address specifying how royalty will be split amongst the pool of IPs in the group. */
43
48
  groupPool: Address;
44
49
  txOptions?: TxOptions;
45
50
  };
@@ -59,7 +64,7 @@ export type RegisterIpAndAttachLicenseAndAddToGroupRequest = {
59
64
  */
60
65
  deadline?: bigint;
61
66
  /** The data of the license and its configuration to be attached to the new group IP. */
62
- licenseData: LicenseData[];
67
+ licenseData: LicenseDataInput[];
63
68
  /** The maximum reward share percentage that can be allocated to each member IP. */
64
69
  maxAllowedRewardShare: number | string;
65
70
  } & IpMetadataAndTxOptions;
@@ -73,7 +78,7 @@ export type RegisterGroupAndAttachLicenseRequest = {
73
78
  /** The address specifying how royalty will be split amongst the pool of IPs in the group. */
74
79
  groupPool: Address;
75
80
  /** The data of the license and its configuration to be attached to the new group IP. */
76
- licenseData: LicenseData;
81
+ licenseData: LicenseDataInput;
77
82
  txOptions?: TxOptions;
78
83
  };
79
84
  export type RegisterGroupAndAttachLicenseResponse = {
@@ -87,7 +92,7 @@ export type RegisterGroupAndAttachLicenseAndAddIpsRequest = {
87
92
  /** The IP IDs of the IPs to be added to the group. */
88
93
  ipIds: Address[];
89
94
  /** The data of the license and its configuration to be attached to the new group IP. */
90
- licenseData: LicenseData;
95
+ licenseData: LicenseDataInput;
91
96
  /** The maximum reward share percentage that can be allocated to each member IP. */
92
97
  maxAllowedRewardShare: number | string;
93
98
  txOptions?: TxOptions;
@@ -119,4 +124,19 @@ export type CollectAndDistributeGroupRoyaltiesResponse = {
119
124
  amountAfterFee: bigint;
120
125
  }[];
121
126
  };
127
+ export type AddIpRequest = {
128
+ groupIpId: Address;
129
+ /**
130
+ * The addresses of the IPs to add to the Group IP.
131
+ * IP IDs must be attached to the group IP license terms.
132
+ */
133
+ ipIds: Address[];
134
+ /**
135
+ * The maximum reward share percentage that can be allocated to each member IP.
136
+ * Must be between 0 and 100 (where 100% represents 100_000_000).
137
+ * @default 100
138
+ */
139
+ maxAllowedRewardSharePercentage?: number;
140
+ txOptions?: Omit<TxOptions, "encodedTxDataOnly">;
141
+ };
122
142
  //# sourceMappingURL=group.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EACL,aAAa,EACb,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,wBAAwB,EAAE,qBAAkB;AAE9F,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,wBAAwB,CAAC;IAC1C,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,wFAAwF;IACxF,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,4HAA4H;IAC5H,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,sBAAsB,CAAC;AAE3B,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;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC,GAAG,sBAAsB,CAAC;AAE3B,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,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,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;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,WAAW,CAAC;IACzB,mFAAmF;IACnF,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;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,EAAE,CAAC;IACtF,oBAAoB,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,OAAO,CAAC;QACf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC"}
1
+ {"version":3,"file":"group.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EACL,aAAa,EACb,gDAAgD,EACjD,+BAA4B;AAC7B,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,eAAe,EAAE,qBAAkB;AAE1F,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,qDAAqD,GAAG;IAClE,cAAc,EAAE,OAAO,CAAC;IACxB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,4HAA4H;IAC5H,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CACrC,GAAG,sBAAsB,CAAC;AAE3B,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,6FAA6F;IAC7F,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;AACF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,mFAAmF;IACnF,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC,GAAG,sBAAsB,CAAC;AAE3B,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,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,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;AACF,MAAM,MAAM,6CAA6C,GAAG;IAC1D,6FAA6F;IAC7F,SAAS,EAAE,OAAO,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,wFAAwF;IACxF,WAAW,EAAE,gBAAgB,CAAC;IAC9B,mFAAmF;IACnF,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;AAEF,MAAM,MAAM,yCAAyC,GAAG;IACtD,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,cAAc,EAAE,OAAO,EAAE,CAAC;IAC1B,8DAA8D;IAC9D,WAAW,EAAE,OAAO,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG;IACvD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,IAAI,CAAC,gDAAgD,EAAE,MAAM,CAAC,EAAE,CAAC;IACtF,oBAAoB,CAAC,EAAE;QACrB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,OAAO,CAAC;QACf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IACzC,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}
@@ -3,10 +3,14 @@ import { TxOptions } from "../options.js";
3
3
  import { EncodedTxData } from "../../abi/generated.js";
4
4
  import { TokenAmountInput } from "../common.js";
5
5
  export type IPAccountExecuteRequest = {
6
+ /** The IP ID of the IP Account {@link https://docs.story.foundation/docs/ip-account}. */
6
7
  ipId: Address;
8
+ /** The recipient of the transaction. */
7
9
  to: Address;
10
+ /** The amount of IP to send. */
8
11
  value: number;
9
- data: Address;
12
+ /** The data to send along with the transaction. */
13
+ data: Hex;
10
14
  txOptions?: TxOptions;
11
15
  };
12
16
  export type IPAccountExecuteResponse = {
@@ -14,12 +18,19 @@ export type IPAccountExecuteResponse = {
14
18
  encodedTxData?: EncodedTxData;
15
19
  };
16
20
  export type IPAccountExecuteWithSigRequest = {
21
+ /** The IP ID of the IP Account {@link https://docs.story.foundation/docs/ip-account}.*/
17
22
  ipId: Address;
23
+ /** The recipient of the transaction. */
18
24
  to: Address;
19
- data: Address;
25
+ /** The data to send along with the transaction. */
26
+ data: Hex;
27
+ /** The signer of the transaction. */
20
28
  signer: Address;
29
+ /** The deadline of the transaction signature in seconds. */
21
30
  deadline: number | bigint | string;
31
+ /** The signature of the transaction, EIP-712 encoded. The helper method `getPermissionSignature` supports generating the signature. */
22
32
  signature: Address;
33
+ /** The amount of IP to send. */
23
34
  value?: number | bigint | string;
24
35
  txOptions?: TxOptions;
25
36
  };
@@ -1 +1 @@
1
- {"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.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;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,uEAAuE;QACvE,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,gBAAgB,CAAC;QACzB,oCAAoC;QACpC,MAAM,EAAE,OAAO,CAAC;KACjB,EAAE,CAAC;IACJ,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}
1
+ {"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAccount.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;AACpD,OAAO,EAAE,gBAAgB,EAAE,qBAAkB;AAE7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,yFAAyF;IACzF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,wFAAwF;IACxF,IAAI,EAAE,OAAO,CAAC;IACd,wCAAwC;IACxC,EAAE,EAAE,OAAO,CAAC;IACZ,mDAAmD;IACnD,IAAI,EAAE,GAAG,CAAC;IACV,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACnC,uIAAuI;IACvI,SAAS,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE;QACN,uEAAuE;QACvE,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,gBAAgB,CAAC;QACzB,oCAAoC;QACpC,MAAM,EAAE,OAAO,CAAC;KACjB,EAAE,CAAC;IACJ,SAAS,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;CAClD,CAAC"}