@story-protocol/core-sdk 0.0.1-beta-rc.4 → 0.0.1-beta-rc.6
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +97 -43
- package/dist/declarations/src/client.d.ts +31 -7
- package/dist/declarations/src/client.d.ts.map +1 -1
- package/dist/declarations/src/constants/common.d.ts +1 -0
- package/dist/declarations/src/constants/common.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +2 -3
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/dispute.d.ts +0 -20
- package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAccount.d.ts +732 -0
- package/dist/declarations/src/resources/{tagging.d.ts.map → ipAccount.d.ts.map} +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +53 -36
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +44 -41
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/permission.d.ts +3 -43
- package/dist/declarations/src/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/resources/policy.d.ts +99 -82
- package/dist/declarations/src/resources/policy.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts +25 -0
- package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -0
- package/dist/declarations/src/types/resources/ipAsset.d.ts +5 -5
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/permission.d.ts +3 -3
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/policy.d.ts +39 -1
- package/dist/declarations/src/types/resources/policy.d.ts.map +1 -1
- package/dist/story-protocol-core-sdk.cjs.dev.js +734 -285
- package/dist/story-protocol-core-sdk.cjs.prod.js +734 -285
- package/dist/story-protocol-core-sdk.esm.js +736 -286
- package/package.json +1 -1
- package/dist/declarations/src/resources/tagging.d.ts +0 -718
- package/dist/declarations/src/types/resources/tagging.d.ts +0 -23
- package/dist/declarations/src/types/resources/tagging.d.ts.map +0 -1
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"
|
1
|
+
{"version":3,"file":"ipAccount.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAE9D,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAChC,wCAAqC;AAKtC,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAgB;gBAEvB,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKzD;;;;;;OAMG;IACU,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAwBzF;;;;;;;;;OASG;IACU,cAAc,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;CA8B5C"}
|
@@ -46,6 +46,42 @@ export declare class IPAssetClient {
|
|
46
46
|
}];
|
47
47
|
readonly name: "IPRegistered";
|
48
48
|
readonly type: "event";
|
49
|
+
}, {
|
50
|
+
readonly inputs: readonly [{
|
51
|
+
readonly internalType: "uint256";
|
52
|
+
readonly name: "chainId";
|
53
|
+
readonly type: "uint256";
|
54
|
+
}, {
|
55
|
+
readonly internalType: "address";
|
56
|
+
readonly name: "tokenContract";
|
57
|
+
readonly type: "address";
|
58
|
+
}, {
|
59
|
+
readonly internalType: "uint256";
|
60
|
+
readonly name: "tokenId";
|
61
|
+
readonly type: "uint256";
|
62
|
+
}];
|
63
|
+
readonly name: "ipId";
|
64
|
+
readonly outputs: readonly [{
|
65
|
+
readonly internalType: "address";
|
66
|
+
readonly name: "";
|
67
|
+
readonly type: "address";
|
68
|
+
}];
|
69
|
+
readonly stateMutability: "view";
|
70
|
+
readonly type: "function";
|
71
|
+
}, {
|
72
|
+
readonly inputs: readonly [{
|
73
|
+
readonly internalType: "address";
|
74
|
+
readonly name: "id";
|
75
|
+
readonly type: "address";
|
76
|
+
}];
|
77
|
+
readonly name: "isRegistered";
|
78
|
+
readonly outputs: readonly [{
|
79
|
+
readonly internalType: "bool";
|
80
|
+
readonly name: "";
|
81
|
+
readonly type: "bool";
|
82
|
+
}];
|
83
|
+
readonly stateMutability: "view";
|
84
|
+
readonly type: "function";
|
49
85
|
}];
|
50
86
|
address: `0x${string}`;
|
51
87
|
};
|
@@ -166,7 +202,21 @@ export declare class IPAssetClient {
|
|
166
202
|
}, {
|
167
203
|
readonly internalType: "address";
|
168
204
|
readonly name: "to";
|
169
|
-
readonly type: "address";
|
205
|
+
readonly type: "address"; /**
|
206
|
+
* Registers a root-level IP into the protocol. Root-level IPs can be thought of as organizational hubs
|
207
|
+
* for encapsulating policies that actual IPs can use to register through. As such, a root-level IP is not an
|
208
|
+
* actual IP, but a container for IP policy management for their child IP assets.
|
209
|
+
* @param request The request object that contains all data needed to register a root IP.
|
210
|
+
* @param request.policyId The policy that identifies the licensing terms of the IP.
|
211
|
+
* @param request.tokenContract The address of the NFT bound to the root-level IP.
|
212
|
+
* @param request.tokenId The token id of the NFT bound to the root-level IP.
|
213
|
+
* @param request.ipName [Optional] The name assigned to the new IP.
|
214
|
+
* @param request.contentHash [Optional] The content hash of the IP being registered.
|
215
|
+
* @param request.uri [Optional] An external URI to link to the IP.
|
216
|
+
* @param request.txOptions [Optional] The transaction options.
|
217
|
+
* @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
|
218
|
+
* @emits RootIPRegistered (msg.sender, ipId, policyId)
|
219
|
+
*/
|
170
220
|
}, {
|
171
221
|
readonly internalType: "bytes4";
|
172
222
|
readonly name: "func";
|
@@ -257,21 +307,7 @@ export declare class IPAssetClient {
|
|
257
307
|
} | {
|
258
308
|
readonly inputs: readonly [];
|
259
309
|
readonly name: "DisputeModule__NotWhitelistedArbitrationRelayer";
|
260
|
-
readonly type: "error";
|
261
|
-
* Registers derivative IPs into the protocol. Derivative IPs are IP assets that inherit policies from
|
262
|
-
* parent IPs by burning acquired license NFTs.
|
263
|
-
* @param request The request object that contains all data needed to register a root IP.
|
264
|
-
* @param request.licenseIds The policy that identifies the licensing terms of the IP.
|
265
|
-
* @param request.tokenContract The address of the NFT bound to the derivative IP.
|
266
|
-
* @param request.tokenId The token id of the NFT bound to the derivative IP.
|
267
|
-
* @param request.ipName [Optional] The name assigned to the new IP.
|
268
|
-
* @param request.contentHash [Optional] The content hash of the IP being registered.
|
269
|
-
* @param request.uri [Optional] An external URI to link to the IP.
|
270
|
-
* @param request.minRoyalty [Optional] The minimum royalty percentage that the IP owner will receive.
|
271
|
-
* @param request.txOptions [Optional] The transaction options.
|
272
|
-
* @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
|
273
|
-
* @emits RootIPRegistered (msg.sender, ipId, policyId)
|
274
|
-
*/
|
310
|
+
readonly type: "error";
|
275
311
|
} | {
|
276
312
|
readonly inputs: readonly [];
|
277
313
|
readonly name: "DisputeModule__NotWhitelistedDisputeTag";
|
@@ -780,26 +816,6 @@ export declare class IPAssetClient {
|
|
780
816
|
readonly inputs: readonly [];
|
781
817
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
782
818
|
readonly type: "error";
|
783
|
-
} | {
|
784
|
-
readonly inputs: readonly [];
|
785
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
786
|
-
readonly type: "error";
|
787
|
-
} | {
|
788
|
-
readonly inputs: readonly [];
|
789
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
790
|
-
readonly type: "error";
|
791
|
-
} | {
|
792
|
-
readonly inputs: readonly [];
|
793
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
794
|
-
readonly type: "error";
|
795
|
-
} | {
|
796
|
-
readonly inputs: readonly [];
|
797
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
798
|
-
readonly type: "error";
|
799
|
-
} | {
|
800
|
-
readonly inputs: readonly [];
|
801
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
802
|
-
readonly type: "error";
|
803
819
|
})[];
|
804
820
|
address: `0x${string}`;
|
805
821
|
};
|
@@ -836,5 +852,6 @@ export declare class IPAssetClient {
|
|
836
852
|
* @emits RootIPRegistered (msg.sender, ipId, policyId)
|
837
853
|
*/
|
838
854
|
registerDerivativeIp(request: RegisterDerivativeIpRequest): Promise<RegisterDerivativeIpResponse>;
|
855
|
+
private isNFTRegistered;
|
839
856
|
}
|
840
857
|
//# sourceMappingURL=ipAsset.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAK9D,OAAO,EAAE,cAAc,EAAE,+BAA4B;AACrD,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;
|
1
|
+
{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAc,MAAM,MAAM,CAAC;AAK9D,OAAO,EAAE,cAAc,EAAE,+BAA4B;AACrD,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACvB,sCAAmC;AAMpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IACtC,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAyB;IAC9C,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0CAQ/B;;;;;;;;;;;;;;mBAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAtBwD;gBAE/C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc;IAMtF;;;;;;;;;;;;;;OAcG;IACU,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAuC5F;;;;;;;;;;;;;;OAcG;IACU,oBAAoB,CAC/B,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;YAiD1B,eAAe;CAkB9B"}
|
@@ -653,26 +653,6 @@ export declare class LicenseClient {
|
|
653
653
|
readonly inputs: readonly [];
|
654
654
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
655
655
|
readonly type: "error";
|
656
|
-
} | {
|
657
|
-
readonly inputs: readonly [];
|
658
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
659
|
-
readonly type: "error";
|
660
|
-
} | {
|
661
|
-
readonly inputs: readonly [];
|
662
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
663
|
-
readonly type: "error";
|
664
|
-
} | {
|
665
|
-
readonly inputs: readonly [];
|
666
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
667
|
-
readonly type: "error";
|
668
|
-
} | {
|
669
|
-
readonly inputs: readonly [];
|
670
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
671
|
-
readonly type: "error";
|
672
|
-
} | {
|
673
|
-
readonly inputs: readonly [];
|
674
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
675
|
-
readonly type: "error";
|
676
656
|
} | {
|
677
657
|
readonly inputs: readonly [{
|
678
658
|
readonly internalType: "address";
|
@@ -1443,26 +1423,6 @@ export declare class LicenseClient {
|
|
1443
1423
|
readonly inputs: readonly [];
|
1444
1424
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
1445
1425
|
readonly type: "error";
|
1446
|
-
} | {
|
1447
|
-
readonly inputs: readonly [];
|
1448
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
1449
|
-
readonly type: "error";
|
1450
|
-
} | {
|
1451
|
-
readonly inputs: readonly [];
|
1452
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
1453
|
-
readonly type: "error";
|
1454
|
-
} | {
|
1455
|
-
readonly inputs: readonly [];
|
1456
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
1457
|
-
readonly type: "error";
|
1458
|
-
} | {
|
1459
|
-
readonly inputs: readonly [];
|
1460
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
1461
|
-
readonly type: "error";
|
1462
|
-
} | {
|
1463
|
-
readonly inputs: readonly [];
|
1464
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
1465
|
-
readonly type: "error";
|
1466
1426
|
} | {
|
1467
1427
|
readonly anonymous: false;
|
1468
1428
|
readonly inputs: readonly [{
|
@@ -1571,6 +1531,49 @@ export declare class LicenseClient {
|
|
1571
1531
|
}];
|
1572
1532
|
readonly stateMutability: "nonpayable";
|
1573
1533
|
readonly type: "function";
|
1534
|
+
} | {
|
1535
|
+
readonly inputs: readonly [{
|
1536
|
+
readonly components: readonly [{
|
1537
|
+
readonly internalType: "bool";
|
1538
|
+
readonly name: "isLicenseTransferable";
|
1539
|
+
readonly type: "bool";
|
1540
|
+
}, {
|
1541
|
+
readonly internalType: "address";
|
1542
|
+
readonly name: "policyFramework";
|
1543
|
+
readonly type: "address";
|
1544
|
+
}, {
|
1545
|
+
readonly internalType: "bytes";
|
1546
|
+
readonly name: "frameworkData";
|
1547
|
+
readonly type: "bytes";
|
1548
|
+
}, {
|
1549
|
+
readonly internalType: "address";
|
1550
|
+
readonly name: "royaltyPolicy";
|
1551
|
+
readonly type: "address";
|
1552
|
+
}, {
|
1553
|
+
readonly internalType: "bytes";
|
1554
|
+
readonly name: "royaltyData";
|
1555
|
+
readonly type: "bytes";
|
1556
|
+
}, {
|
1557
|
+
readonly internalType: "uint256";
|
1558
|
+
readonly name: "mintingFee";
|
1559
|
+
readonly type: "uint256";
|
1560
|
+
}, {
|
1561
|
+
readonly internalType: "address";
|
1562
|
+
readonly name: "mintingFeeToken";
|
1563
|
+
readonly type: "address";
|
1564
|
+
}];
|
1565
|
+
readonly internalType: "struct Licensing.Policy";
|
1566
|
+
readonly name: "pol";
|
1567
|
+
readonly type: "tuple";
|
1568
|
+
}];
|
1569
|
+
readonly name: "getPolicyId";
|
1570
|
+
readonly outputs: readonly [{
|
1571
|
+
readonly internalType: "uint256";
|
1572
|
+
readonly name: "policyId";
|
1573
|
+
readonly type: "uint256";
|
1574
|
+
}];
|
1575
|
+
readonly stateMutability: "view";
|
1576
|
+
readonly type: "function";
|
1574
1577
|
} | {
|
1575
1578
|
readonly inputs: readonly [{
|
1576
1579
|
readonly internalType: "uint256[]";
|
@@ -1676,7 +1679,7 @@ export declare class LicenseClient {
|
|
1676
1679
|
* @param request.licensorIpId_ The ID of the IP granting the license (ie. licensor)
|
1677
1680
|
* @param request.mintAmount Number of licenses to mint. License NFT is fungible for same policy and same licensors
|
1678
1681
|
* @param request.receiver Receiver address of the minted license NFT(s).
|
1679
|
-
* @
|
1682
|
+
* @returns licenseId The ID of the minted license NFT(s).
|
1680
1683
|
*/
|
1681
1684
|
mintLicense(request: MintLicenseRequest): Promise<MintLicenseResponse>;
|
1682
1685
|
linkIpToParent(request: LinkIpToParentRequest): Promise<LinkIpToParentResponse>;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAkC,MAAM,MAAM,CAAC;AAMlF,OAAO,EAAE,cAAc,EAAE,+BAA4B;AACrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAGpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IACtC,YAAY
|
1
|
+
{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAkC,MAAM,MAAM,CAAC;AAMlF,OAAO,EAAE,cAAc,EAAE,+BAA4B;AACrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAGpC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAiB;IACtC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAgB;IAC5B,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAyB;IAC9C,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAyB;gBAEzC,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc;IAMtF;;;;;;;;;;;OAWG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8CtE,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CA8C7F"}
|
@@ -1,5 +1,5 @@
|
|
1
1
|
import { PublicClient, WalletClient } from "viem";
|
2
|
-
import {
|
2
|
+
import { SetPermissionsRequest, SetPermissionsResponse } from "../types/resources/permission.js";
|
3
3
|
export declare class PermissionClient {
|
4
4
|
private readonly wallet;
|
5
5
|
private readonly rpcClient;
|
@@ -651,26 +651,6 @@ export declare class PermissionClient {
|
|
651
651
|
readonly inputs: readonly [];
|
652
652
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
653
653
|
readonly type: "error";
|
654
|
-
} | {
|
655
|
-
readonly inputs: readonly [];
|
656
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
657
|
-
readonly type: "error";
|
658
|
-
} | {
|
659
|
-
readonly inputs: readonly [];
|
660
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
661
|
-
readonly type: "error";
|
662
|
-
} | {
|
663
|
-
readonly inputs: readonly [];
|
664
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
665
|
-
readonly type: "error";
|
666
|
-
} | {
|
667
|
-
readonly inputs: readonly [];
|
668
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
669
|
-
readonly type: "error";
|
670
|
-
} | {
|
671
|
-
readonly inputs: readonly [];
|
672
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
673
|
-
readonly type: "error";
|
674
654
|
} | {
|
675
655
|
readonly inputs: readonly [{
|
676
656
|
readonly internalType: "address";
|
@@ -1377,26 +1357,6 @@ export declare class PermissionClient {
|
|
1377
1357
|
readonly inputs: readonly [];
|
1378
1358
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
1379
1359
|
readonly type: "error";
|
1380
|
-
} | {
|
1381
|
-
readonly inputs: readonly [];
|
1382
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
1383
|
-
readonly type: "error";
|
1384
|
-
} | {
|
1385
|
-
readonly inputs: readonly [];
|
1386
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
1387
|
-
readonly type: "error";
|
1388
|
-
} | {
|
1389
|
-
readonly inputs: readonly [];
|
1390
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
1391
|
-
readonly type: "error";
|
1392
|
-
} | {
|
1393
|
-
readonly inputs: readonly [];
|
1394
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
1395
|
-
readonly type: "error";
|
1396
|
-
} | {
|
1397
|
-
readonly inputs: readonly [];
|
1398
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
1399
|
-
readonly type: "error";
|
1400
1360
|
} | {
|
1401
1361
|
readonly anonymous: false;
|
1402
1362
|
readonly inputs: readonly [{
|
@@ -1476,11 +1436,11 @@ export declare class PermissionClient {
|
|
1476
1436
|
* @param request.ipAsset The address of the IP account that grants the permission for `signer`
|
1477
1437
|
* @param request.signer The address that can call `to` on behalf of the `ipAccount`
|
1478
1438
|
* @param request.to The address that can be called by the `signer` (currently only modules can be `to`)
|
1479
|
-
* @param request.func The function selector string of `to` that can be called by the `signer` on behalf of the `ipAccount
|
1439
|
+
* @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.
|
1480
1440
|
* @param request.permission The new permission level
|
1481
1441
|
* @returns A Promise that resolves to an object containing the transaction hash
|
1482
1442
|
* @emits PermissionSet (ipAccountOwner, ipAccount, signer, to, func, permission)
|
1483
1443
|
*/
|
1484
|
-
setPermission(request:
|
1444
|
+
setPermission(request: SetPermissionsRequest): Promise<SetPermissionsResponse>;
|
1485
1445
|
}
|
1486
1446
|
//# sourceMappingURL=permission.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuC,MAAM,MAAM,CAAC;AAGvF,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yCAAsC;AAI9F,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,YAAY
|
1
|
+
{"version":3,"file":"permission.d.ts","sourceRoot":"../../../../src/resources","sources":["permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAuC,MAAM,MAAM,CAAC;AAGvF,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yCAAsC;AAI9F,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAAgB;IAC5B,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAA0B;gBAE3C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKzD;;;;;;;;;;;;;;;;;;OAkBG;IACU,aAAa,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CA2C5F"}
|
@@ -1,5 +1,5 @@
|
|
1
1
|
import { PublicClient, WalletClient } from "viem";
|
2
|
-
import { RegisterPILPolicyRequest, RegisterPILPolicyResponse, AddPolicyToIpRequest, AddPolicyToIpResponse } from "../types/resources/policy.js";
|
2
|
+
import { RegisterPILPolicyRequest, RegisterPILPolicyResponse, RegisterPILSocialRemixPolicyRequest, RegisterPILSocialRemixPolicyResponse, RegisterPILCommercialUsePolicyRequest, RegisterPILCommercialUsePolicyResponse, AddPolicyToIpRequest, AddPolicyToIpResponse } from "../types/resources/policy.js";
|
3
3
|
export declare class PolicyClient {
|
4
4
|
private readonly wallet;
|
5
5
|
private readonly rpcClient;
|
@@ -209,13 +209,6 @@ export declare class PolicyClient {
|
|
209
209
|
readonly type: "error";
|
210
210
|
} | {
|
211
211
|
readonly inputs: readonly [];
|
212
|
-
/**
|
213
|
-
* Adds a policy to the set of policies of an IP
|
214
|
-
* @param request The request object containing details to add a policy to an IP
|
215
|
-
* @param request.ipId The id of the IP
|
216
|
-
* @param request.polId The id of the policy
|
217
|
-
* @return the transaction hash and the index of the policy in the IP's policy set if the txOptions.waitForTransaction is set to true
|
218
|
-
*/
|
219
212
|
readonly name: "IPAccount__InvalidCalldata";
|
220
213
|
readonly type: "error";
|
221
214
|
} | {
|
@@ -291,6 +284,15 @@ export declare class PolicyClient {
|
|
291
284
|
readonly name: "LicensingModuleAware__CallerNotLicensingModule";
|
292
285
|
readonly type: "error";
|
293
286
|
} | {
|
287
|
+
/**
|
288
|
+
* Convenient function to register a PIL social remix policy to the registry
|
289
|
+
* Internally, this function must generate a Licensing.Policy struct and call registerPolicy.
|
290
|
+
* @param request - the licensing parameters for the Programmable IP License v1 (PIL) standard.
|
291
|
+
* @param request.territories List of territories where the license is valid. If empty, global.
|
292
|
+
* @param request.distributionChannels List of distribution channels where the license is valid. Empty if no restrictions.
|
293
|
+
* @param request.contentRestrictions List of content restrictions where the license is valid. Empty if no restrictions.
|
294
|
+
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
295
|
+
*/
|
294
296
|
readonly inputs: readonly [];
|
295
297
|
readonly name: "LicensingModule__CallerNotLicenseRegistry";
|
296
298
|
readonly type: "error";
|
@@ -658,26 +660,6 @@ export declare class PolicyClient {
|
|
658
660
|
readonly inputs: readonly [];
|
659
661
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
660
662
|
readonly type: "error";
|
661
|
-
} | {
|
662
|
-
readonly inputs: readonly [];
|
663
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
664
|
-
readonly type: "error";
|
665
|
-
} | {
|
666
|
-
readonly inputs: readonly [];
|
667
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
668
|
-
readonly type: "error";
|
669
|
-
} | {
|
670
|
-
readonly inputs: readonly [];
|
671
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
672
|
-
readonly type: "error";
|
673
|
-
} | {
|
674
|
-
readonly inputs: readonly [];
|
675
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
676
|
-
readonly type: "error";
|
677
|
-
} | {
|
678
|
-
readonly inputs: readonly [];
|
679
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
680
|
-
readonly type: "error";
|
681
663
|
} | {
|
682
664
|
readonly inputs: readonly [{
|
683
665
|
readonly internalType: "address";
|
@@ -942,13 +924,6 @@ export declare class PolicyClient {
|
|
942
924
|
readonly type: "error";
|
943
925
|
} | {
|
944
926
|
readonly inputs: readonly [];
|
945
|
-
/**
|
946
|
-
* Adds a policy to the set of policies of an IP
|
947
|
-
* @param request The request object containing details to add a policy to an IP
|
948
|
-
* @param request.ipId The id of the IP
|
949
|
-
* @param request.polId The id of the policy
|
950
|
-
* @return the transaction hash and the index of the policy in the IP's policy set if the txOptions.waitForTransaction is set to true
|
951
|
-
*/
|
952
927
|
readonly name: "IPAccount__InvalidCalldata";
|
953
928
|
readonly type: "error";
|
954
929
|
} | {
|
@@ -1024,6 +999,15 @@ export declare class PolicyClient {
|
|
1024
999
|
readonly name: "LicensingModuleAware__CallerNotLicensingModule";
|
1025
1000
|
readonly type: "error";
|
1026
1001
|
} | {
|
1002
|
+
/**
|
1003
|
+
* Convenient function to register a PIL social remix policy to the registry
|
1004
|
+
* Internally, this function must generate a Licensing.Policy struct and call registerPolicy.
|
1005
|
+
* @param request - the licensing parameters for the Programmable IP License v1 (PIL) standard.
|
1006
|
+
* @param request.territories List of territories where the license is valid. If empty, global.
|
1007
|
+
* @param request.distributionChannels List of distribution channels where the license is valid. Empty if no restrictions.
|
1008
|
+
* @param request.contentRestrictions List of content restrictions where the license is valid. Empty if no restrictions.
|
1009
|
+
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
1010
|
+
*/
|
1027
1011
|
readonly inputs: readonly [];
|
1028
1012
|
readonly name: "LicensingModule__CallerNotLicenseRegistry";
|
1029
1013
|
readonly type: "error";
|
@@ -1391,26 +1375,6 @@ export declare class PolicyClient {
|
|
1391
1375
|
readonly inputs: readonly [];
|
1392
1376
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
1393
1377
|
readonly type: "error";
|
1394
|
-
} | {
|
1395
|
-
readonly inputs: readonly [];
|
1396
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
1397
|
-
readonly type: "error";
|
1398
|
-
} | {
|
1399
|
-
readonly inputs: readonly [];
|
1400
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
1401
|
-
readonly type: "error";
|
1402
|
-
} | {
|
1403
|
-
readonly inputs: readonly [];
|
1404
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
1405
|
-
readonly type: "error";
|
1406
|
-
} | {
|
1407
|
-
readonly inputs: readonly [];
|
1408
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
1409
|
-
readonly type: "error";
|
1410
|
-
} | {
|
1411
|
-
readonly inputs: readonly [];
|
1412
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
1413
|
-
readonly type: "error";
|
1414
1378
|
} | {
|
1415
1379
|
readonly anonymous: false;
|
1416
1380
|
readonly inputs: readonly [{
|
@@ -1519,6 +1483,49 @@ export declare class PolicyClient {
|
|
1519
1483
|
}];
|
1520
1484
|
readonly stateMutability: "nonpayable";
|
1521
1485
|
readonly type: "function";
|
1486
|
+
} | {
|
1487
|
+
readonly inputs: readonly [{
|
1488
|
+
readonly components: readonly [{
|
1489
|
+
readonly internalType: "bool";
|
1490
|
+
readonly name: "isLicenseTransferable";
|
1491
|
+
readonly type: "bool";
|
1492
|
+
}, {
|
1493
|
+
readonly internalType: "address";
|
1494
|
+
readonly name: "policyFramework";
|
1495
|
+
readonly type: "address";
|
1496
|
+
}, {
|
1497
|
+
readonly internalType: "bytes";
|
1498
|
+
readonly name: "frameworkData";
|
1499
|
+
readonly type: "bytes";
|
1500
|
+
}, {
|
1501
|
+
readonly internalType: "address";
|
1502
|
+
readonly name: "royaltyPolicy";
|
1503
|
+
readonly type: "address";
|
1504
|
+
}, {
|
1505
|
+
readonly internalType: "bytes";
|
1506
|
+
readonly name: "royaltyData";
|
1507
|
+
readonly type: "bytes";
|
1508
|
+
}, {
|
1509
|
+
readonly internalType: "uint256";
|
1510
|
+
readonly name: "mintingFee";
|
1511
|
+
readonly type: "uint256";
|
1512
|
+
}, {
|
1513
|
+
readonly internalType: "address";
|
1514
|
+
readonly name: "mintingFeeToken";
|
1515
|
+
readonly type: "address";
|
1516
|
+
}];
|
1517
|
+
readonly internalType: "struct Licensing.Policy";
|
1518
|
+
readonly name: "pol";
|
1519
|
+
readonly type: "tuple";
|
1520
|
+
}];
|
1521
|
+
readonly name: "getPolicyId";
|
1522
|
+
readonly outputs: readonly [{
|
1523
|
+
readonly internalType: "uint256";
|
1524
|
+
readonly name: "policyId";
|
1525
|
+
readonly type: "uint256";
|
1526
|
+
}];
|
1527
|
+
readonly stateMutability: "view";
|
1528
|
+
readonly type: "function";
|
1522
1529
|
} | {
|
1523
1530
|
readonly inputs: readonly [{
|
1524
1531
|
readonly internalType: "uint256[]";
|
@@ -1820,13 +1827,6 @@ export declare class PolicyClient {
|
|
1820
1827
|
readonly type: "error";
|
1821
1828
|
} | {
|
1822
1829
|
readonly inputs: readonly [];
|
1823
|
-
/**
|
1824
|
-
* Adds a policy to the set of policies of an IP
|
1825
|
-
* @param request The request object containing details to add a policy to an IP
|
1826
|
-
* @param request.ipId The id of the IP
|
1827
|
-
* @param request.polId The id of the policy
|
1828
|
-
* @return the transaction hash and the index of the policy in the IP's policy set if the txOptions.waitForTransaction is set to true
|
1829
|
-
*/
|
1830
1830
|
readonly name: "IPAccount__InvalidCalldata";
|
1831
1831
|
readonly type: "error";
|
1832
1832
|
} | {
|
@@ -1902,6 +1902,15 @@ export declare class PolicyClient {
|
|
1902
1902
|
readonly name: "LicensingModuleAware__CallerNotLicensingModule";
|
1903
1903
|
readonly type: "error";
|
1904
1904
|
} | {
|
1905
|
+
/**
|
1906
|
+
* Convenient function to register a PIL social remix policy to the registry
|
1907
|
+
* Internally, this function must generate a Licensing.Policy struct and call registerPolicy.
|
1908
|
+
* @param request - the licensing parameters for the Programmable IP License v1 (PIL) standard.
|
1909
|
+
* @param request.territories List of territories where the license is valid. If empty, global.
|
1910
|
+
* @param request.distributionChannels List of distribution channels where the license is valid. Empty if no restrictions.
|
1911
|
+
* @param request.contentRestrictions List of content restrictions where the license is valid. Empty if no restrictions.
|
1912
|
+
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
1913
|
+
*/
|
1905
1914
|
readonly inputs: readonly [];
|
1906
1915
|
readonly name: "LicensingModule__CallerNotLicenseRegistry";
|
1907
1916
|
readonly type: "error";
|
@@ -2269,26 +2278,6 @@ export declare class PolicyClient {
|
|
2269
2278
|
readonly inputs: readonly [];
|
2270
2279
|
readonly name: "RoyaltyPolicyLAP__ZeroRoyaltyModule";
|
2271
2280
|
readonly type: "error";
|
2272
|
-
} | {
|
2273
|
-
readonly inputs: readonly [];
|
2274
|
-
readonly name: "TaggingModule__DstIpIdDoesNotHaveDstTag";
|
2275
|
-
readonly type: "error";
|
2276
|
-
} | {
|
2277
|
-
readonly inputs: readonly [];
|
2278
|
-
readonly name: "TaggingModule__InvalidRelationTypeName";
|
2279
|
-
readonly type: "error";
|
2280
|
-
} | {
|
2281
|
-
readonly inputs: readonly [];
|
2282
|
-
readonly name: "TaggingModule__RelationTypeAlreadyExists";
|
2283
|
-
readonly type: "error";
|
2284
|
-
} | {
|
2285
|
-
readonly inputs: readonly [];
|
2286
|
-
readonly name: "TaggingModule__RelationTypeDoesNotExist";
|
2287
|
-
readonly type: "error";
|
2288
|
-
} | {
|
2289
|
-
readonly inputs: readonly [];
|
2290
|
-
readonly name: "TaggingModule__SrcIpIdDoesNotHaveSrcTag";
|
2291
|
-
readonly type: "error";
|
2292
2281
|
} | {
|
2293
2282
|
readonly inputs: readonly [{
|
2294
2283
|
readonly components: readonly [{
|
@@ -2380,6 +2369,9 @@ export declare class PolicyClient {
|
|
2380
2369
|
})[];
|
2381
2370
|
address: `0x${string}`;
|
2382
2371
|
};
|
2372
|
+
royaltyPolicyLAPConfig: {
|
2373
|
+
address: `0x${string}`;
|
2374
|
+
};
|
2383
2375
|
constructor(rpcClient: PublicClient, wallet: WalletClient);
|
2384
2376
|
/**
|
2385
2377
|
* Registers a PIL policy to the registry
|
@@ -2401,6 +2393,31 @@ export declare class PolicyClient {
|
|
2401
2393
|
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
2402
2394
|
*/
|
2403
2395
|
registerPILPolicy(request: RegisterPILPolicyRequest): Promise<RegisterPILPolicyResponse>;
|
2396
|
+
/**
|
2397
|
+
* Convenient function to register a PIL social remix policy to the registry
|
2398
|
+
* Internally, this function must generate a Licensing.Policy struct and call registerPolicy.
|
2399
|
+
* @param request - the licensing parameters for the Programmable IP License v1 (PIL) standard.
|
2400
|
+
* @param request.territories List of territories where the license is valid. If empty, global.
|
2401
|
+
* @param request.distributionChannels List of distribution channels where the license is valid. Empty if no restrictions.
|
2402
|
+
* @param request.contentRestrictions List of content restrictions where the license is valid. Empty if no restrictions.
|
2403
|
+
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
2404
|
+
*/
|
2405
|
+
registerPILSocialRemixPolicy(request: RegisterPILSocialRemixPolicyRequest): Promise<RegisterPILSocialRemixPolicyResponse>;
|
2406
|
+
/**
|
2407
|
+
* Convenient function to register a PIL social remix policy to the registry
|
2408
|
+
* Internally, this function must generate a Licensing.Policy struct and call registerPolicy.
|
2409
|
+
* @param request - the licensing parameters for the Programmable IP License v1 (PIL) standard.
|
2410
|
+
* @param request.commercialRevShare Percentage of revenue that must be shared with the licensor
|
2411
|
+
* @param mintingFee Fee to be paid when minting a license
|
2412
|
+
* @param mintingFeeToken Token to be used to pay the minting fee
|
2413
|
+
* @param request.territories List of territories where the license is valid. If empty, global.
|
2414
|
+
* @param request.distributionChannels List of distribution channels where the license is valid. Empty if no restrictions.
|
2415
|
+
* @param request.contentRestrictions List of content restrictions where the license is valid. Empty if no restrictions.
|
2416
|
+
* @returns the transaction hash and the policy ID if the txOptions.waitForTransaction is set to true
|
2417
|
+
*/
|
2418
|
+
registerPILCommercialUsePolicy(request: RegisterPILCommercialUsePolicyRequest): Promise<RegisterPILCommercialUsePolicyResponse>;
|
2419
|
+
private getPolicyId;
|
2420
|
+
private encodeFrameworkData;
|
2404
2421
|
/**
|
2405
2422
|
* Adds a policy to the set of policies of an IP
|
2406
2423
|
* @param request The request object containing details to add a policy to an IP
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"policy.d.ts","sourceRoot":"../../../../src/resources","sources":["policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAA+C,MAAM,MAAM,CAAC;
|
1
|
+
{"version":3,"file":"policy.d.ts","sourceRoot":"../../../../src/resources","sources":["policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAA+C,MAAM,MAAM,CAAC;AAU/F,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,mCAAmC,EACnC,oCAAoC,EACpC,qCAAqC,EACrC,sCAAsC,EACtC,oBAAoB,EACpB,qBAAqB,EAEtB,qCAAkC;AAEnC,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAClC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA6GnB;;;;;;;;WAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SArHgC;IAC5B,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA4G5B;;;;;;;;eAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MApHkD;IAC9C,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA2GtC;;;;;;;;eAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAnHsE;IAClE,sBAAsB;;MAA0B;gBAE3C,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKzD;;;;;;;;;;;;;;;;;;OAkBG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IA8ErC;;;;;;;;OAQG;IACU,4BAA4B,CACvC,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,oCAAoC,CAAC;IA6EhD;;;;;;;;;;;OAWG;IACU,8BAA8B,CACzC,OAAO,EAAE,qCAAqC,GAC7C,OAAO,CAAC,sCAAsC,CAAC;YA6EpC,WAAW;IA2BzB,OAAO,CAAC,mBAAmB;IAwB3B;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAoC1F"}
|