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

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 (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 +136 -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 +17740 -7053
  47. package/dist/story-protocol-core-sdk.cjs.prod.js +17740 -7053
  48. package/dist/story-protocol-core-sdk.esm.js +17642 -6958
  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
package/README.md CHANGED
@@ -42,7 +42,7 @@ The SDK supports using `viem` for initiating SDK client. Create a typescript fil
42
42
  import { privateKeyToAccount } from "viem/accounts";
43
43
 
44
44
  const WALLET_PRIVATE_KEY = process.env.WALLET_PRIVATE_KEY || "0x";
45
- const account = privateKeyToAccount(WALLET_PRIVATE_KEY as `0x${string}`);
45
+ const account = privateKeyToAccount(WALLET_PRIVATE_KEY as Address);
46
46
  ```
47
47
 
48
48
  The preceding code created the `account` object for creating the SDK client.
@@ -51,7 +51,7 @@ The preceding code created the `account` object for creating the SDK client.
51
51
 
52
52
  To set up the SDK client, import `StoryClient` and `StoryConfig` from `@story-protocol/core-sdk`. Write the following code, utilizing the `account` we created previously.
53
53
 
54
- > :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Sepolia network with `RPC_PROVIDER_URL=https://rpc.ankr.com/eth_sepolia`.
54
+ > :information-source: Make sure to have RPC_PROVIDER_URL for your desired chain set up in your .env file. We recommend using the Iliad network with `RPC_PROVIDER_URL=https://rpc.partner.testnet.storyprotocol.net`.
55
55
 
56
56
  ```typescript index.ts
57
57
  import { StoryClient, StoryConfig } from "@story-protocol/core-sdk";
@@ -98,17 +98,16 @@ In your testing environment:
98
98
 
99
99
  - Run `yalc update` to pull the latest changes.
100
100
 
101
- ## Steps to pull and compile latest smart contract ABIs (Currently pulls from the protocol-contracts `dev` branch)
101
+ ## Steps to pull and compile latest Protocol Core & Periphery v1 Smart Contract ABIs (Currently pulls from the protocol-core-v1 and protocol-periphery-v1 `release-v1.x.x` branch)
102
102
 
103
- Must have `solc` installed (https://docs.soliditylang.org/en/v0.8.9/installing-solidity.html)
104
-
105
- - run `make compile_contracts`
103
+ - run `cd packages/wagmi-generator && npm run generate`
106
104
 
107
105
  ## Release
108
106
 
109
- | Package | Description |
110
- | :------------------------------ | :--------------------------------------------- |
111
- | [core-sdk](./packages/core-sdk) | The core sdk for interacting with the protocol |
107
+ | Package | Description |
108
+ | :-------------------------------- | :---------------------------------------------- |
109
+ | [core-sdk](./packages/core-sdk) | The core sdk for interacting with the protocol |
110
+ | [react-sdk](./packages/react-sdk) | The react sdk for interacting with the protocol |
112
111
 
113
112
  ## Contributing
114
113