@story-protocol/core-sdk 1.0.0-rc.2 → 1.0.0-rc.21

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. package/README.md +8 -9
  2. package/dist/declarations/src/abi/generated.d.ts +19643 -7849
  3. package/dist/declarations/src/abi/generated.d.ts.map +1 -1
  4. package/dist/declarations/src/client.d.ts +9 -1
  5. package/dist/declarations/src/client.d.ts.map +1 -1
  6. package/dist/declarations/src/constants/common.d.ts +2 -1
  7. package/dist/declarations/src/constants/common.d.ts.map +1 -1
  8. package/dist/declarations/src/index.d.ts +16 -8
  9. package/dist/declarations/src/index.d.ts.map +1 -1
  10. package/dist/declarations/src/resources/dispute.d.ts +3 -2
  11. package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
  12. package/dist/declarations/src/resources/ipAccount.d.ts +11 -3
  13. package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
  14. package/dist/declarations/src/resources/ipAsset.d.ts +193 -20
  15. package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
  16. package/dist/declarations/src/resources/license.d.ts +46 -48
  17. package/dist/declarations/src/resources/license.d.ts.map +1 -1
  18. package/dist/declarations/src/resources/nftClient.d.ts +24 -0
  19. package/dist/declarations/src/resources/nftClient.d.ts.map +1 -0
  20. package/dist/declarations/src/resources/permission.d.ts +71 -9
  21. package/dist/declarations/src/resources/permission.d.ts.map +1 -1
  22. package/dist/declarations/src/resources/royalty.d.ts +52 -13
  23. package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
  24. package/dist/declarations/src/types/common.d.ts +12 -1
  25. package/dist/declarations/src/types/common.d.ts.map +1 -1
  26. package/dist/declarations/src/types/config.d.ts +2 -2
  27. package/dist/declarations/src/types/config.d.ts.map +1 -1
  28. package/dist/declarations/src/types/options.d.ts +1 -0
  29. package/dist/declarations/src/types/options.d.ts.map +1 -1
  30. package/dist/declarations/src/types/resources/dispute.d.ts +13 -28
  31. package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
  32. package/dist/declarations/src/types/resources/ipAccount.d.ts +16 -11
  33. package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
  34. package/dist/declarations/src/types/resources/ipAsset.d.ts +134 -14
  35. package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
  36. package/dist/declarations/src/types/resources/license.d.ts +41 -26
  37. package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
  38. package/dist/declarations/src/types/resources/nftClient.d.ts +18 -0
  39. package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -0
  40. package/dist/declarations/src/types/resources/permission.d.ts +34 -5
  41. package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
  42. package/dist/declarations/src/types/resources/royalty.d.ts +41 -23
  43. package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
  44. package/dist/declarations/src/utils/sign.d.ts +16 -0
  45. package/dist/declarations/src/utils/sign.d.ts.map +1 -0
  46. package/dist/story-protocol-core-sdk.cjs.dev.js +17743 -7055
  47. package/dist/story-protocol-core-sdk.cjs.prod.js +17743 -7055
  48. package/dist/story-protocol-core-sdk.esm.js +17641 -6956
  49. package/package.json +5 -5
  50. package/dist/declarations/src/clients/storyAPI.d.ts +0 -9
  51. package/dist/declarations/src/clients/storyAPI.d.ts.map +0 -1
@@ -1,10 +1,11 @@
1
- import { Hex } from "viem";
1
+ import { Address } from "viem";
2
2
  import { TxOptions } from "../options.js";
3
+ import { EncodedTxData } from "../../abi/generated.js";
3
4
  export type RoyaltyPolicyApiResponse = {
4
5
  data: RoyaltyPolicy;
5
6
  };
6
7
  export type RoyaltyPolicy = {
7
- id: `0x${string}`;
8
+ id: Address;
8
9
  targetAncestors: string[];
9
10
  targetRoyaltyAmount: string[];
10
11
  };
@@ -17,42 +18,59 @@ export type RoyaltyContext = {
17
18
  parentAncestorsRoyalties2: number[];
18
19
  };
19
20
  export type CollectRoyaltyTokensRequest = {
20
- ancestorIpId: Hex;
21
- derivativeId: Hex;
21
+ parentIpId: Address;
22
+ royaltyVaultIpId: Address;
22
23
  txOptions?: TxOptions;
23
24
  };
24
25
  export type CollectRoyaltyTokensResponse = {
25
- txHash: string;
26
+ txHash?: string;
27
+ encodedTxData?: EncodedTxData;
28
+ royaltyTokensCollected?: bigint;
26
29
  };
27
30
  export type RoyaltyData = [
28
31
  isUnlinkableToParents: boolean,
29
- ipRoyaltyVault: Hex,
32
+ ipRoyaltyVault: Address,
30
33
  royaltyStack: bigint,
31
- ancestorsAddresses: Hex,
34
+ ancestorsAddresses: Address,
32
35
  ancestorsRoyalties: bigint[]
33
36
  ];
34
37
  export type ClaimableRevenueRequest = {
35
- account: Hex;
36
- snapshotId: bigint;
37
- token: Hex;
38
- txOptions?: TxOptions;
39
- };
40
- export type ClaimableRevenueResponse = {
41
- claimableRevenueAmount: bigint;
42
- txHash: string;
38
+ royaltyVaultIpId: Address;
39
+ account: Address;
40
+ snapshotId: string | number | bigint;
41
+ token: Address;
43
42
  };
43
+ export type ClaimableRevenueResponse = bigint;
44
44
  export type PayRoyaltyOnBehalfRequest = {
45
- receiverIpId: Hex;
46
- payerIpId: Hex;
47
- token: Hex;
48
- amount: bigint;
45
+ receiverIpId: Address;
46
+ payerIpId: Address;
47
+ token: Address;
48
+ amount: string | number | bigint;
49
49
  txOptions?: TxOptions;
50
50
  };
51
51
  export type PayRoyaltyOnBehalfResponse = {
52
- txHash: string;
52
+ txHash?: string;
53
+ encodedTxData?: EncodedTxData;
54
+ };
55
+ export type SnapshotRequest = {
56
+ royaltyVaultIpId: Address;
57
+ txOptions?: TxOptions;
58
+ };
59
+ export type ClaimRevenueRequest = {
60
+ snapshotIds: string[] | number[] | bigint[];
61
+ token: Address;
62
+ royaltyVaultIpId: Address;
63
+ account?: Address;
64
+ txOptions?: TxOptions;
65
+ };
66
+ export type ClaimRevenueResponse = {
67
+ txHash?: string;
68
+ encodedTxData?: EncodedTxData;
69
+ claimableToken?: bigint;
53
70
  };
54
- export type ApproveResponse = {
55
- txHash: string;
56
- success: boolean;
71
+ export type SnapshotResponse = {
72
+ txHash?: string;
73
+ encodedTxData?: EncodedTxData;
74
+ snapshotId?: bigint;
57
75
  };
58
76
  //# sourceMappingURL=royalty.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AAEvC,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,KAAK,MAAM,EAAE,CAAC;IAClB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,GAAG;IACnB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,GAAG;IACvB,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,GAAG,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,GAAG,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC;IACf,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"royalty.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["royalty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,sBAAmB;AACvC,OAAO,EAAE,aAAa,EAAE,+BAA4B;AAEpD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,EAAE,OAAO;IAC9B,cAAc,EAAE,OAAO;IACvB,YAAY,EAAE,MAAM;IACpB,kBAAkB,EAAE,OAAO;IAC3B,kBAAkB,EAAE,MAAM,EAAE;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE9C,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,EAAE,OAAO,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}
@@ -0,0 +1,16 @@
1
+ import { PermissionSignatureRequest, PermissionSignatureResponse } from "../types/common.js";
2
+ /**
3
+ * Get the signature for setting permissions.
4
+ * @param param - The parameter object containing necessary data to get the signature.
5
+ * @param param.ipId - The IP ID.
6
+ * @param param.deadline - The deadline.
7
+ * @param param.nonce - The nonce.
8
+ * @param param.wallet - The wallet client.
9
+ * @param param.chainId - The chain ID.
10
+ * @param param.permissions - The permissions.
11
+ * @param param.permissionFunc - The permission function,default function is setPermission.
12
+ * @returns A Promise that resolves to the signature.
13
+ */
14
+ export declare const getPermissionSignature: (param: PermissionSignatureRequest) => Promise<PermissionSignatureResponse>;
15
+ export declare const getDeadline: (deadline?: bigint | number | string) => bigint;
16
+ //# sourceMappingURL=sign.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sign.d.ts","sourceRoot":"../../../../src/utils","sources":["sign.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,2BAAwB;AAE1F;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,UAC1B,0BAA0B,KAChC,OAAO,CAAC,2BAA2B,CA8ErC,CAAC;AAEF,eAAO,MAAM,WAAW,cAAe,MAAM,GAAG,MAAM,GAAG,MAAM,KAAG,MAMjE,CAAC"}