@story-protocol/core-sdk 1.0.0-rc.2 → 1.0.0-rc.20
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +8 -9
- package/dist/declarations/src/abi/generated.d.ts +19643 -7849
- package/dist/declarations/src/abi/generated.d.ts.map +1 -1
- package/dist/declarations/src/client.d.ts +9 -1
- package/dist/declarations/src/client.d.ts.map +1 -1
- package/dist/declarations/src/constants/common.d.ts +2 -1
- package/dist/declarations/src/constants/common.d.ts.map +1 -1
- package/dist/declarations/src/index.d.ts +16 -8
- package/dist/declarations/src/index.d.ts.map +1 -1
- package/dist/declarations/src/resources/dispute.d.ts +3 -2
- package/dist/declarations/src/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAccount.d.ts +11 -3
- package/dist/declarations/src/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/resources/ipAsset.d.ts +193 -20
- package/dist/declarations/src/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/resources/license.d.ts +46 -48
- package/dist/declarations/src/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/resources/nftClient.d.ts +24 -0
- package/dist/declarations/src/resources/nftClient.d.ts.map +1 -0
- package/dist/declarations/src/resources/permission.d.ts +71 -9
- package/dist/declarations/src/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/resources/royalty.d.ts +52 -13
- package/dist/declarations/src/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/types/common.d.ts +12 -1
- package/dist/declarations/src/types/common.d.ts.map +1 -1
- package/dist/declarations/src/types/config.d.ts +2 -2
- package/dist/declarations/src/types/config.d.ts.map +1 -1
- package/dist/declarations/src/types/options.d.ts +1 -0
- package/dist/declarations/src/types/options.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/dispute.d.ts +13 -28
- package/dist/declarations/src/types/resources/dispute.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAccount.d.ts +16 -11
- package/dist/declarations/src/types/resources/ipAccount.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/ipAsset.d.ts +136 -14
- package/dist/declarations/src/types/resources/ipAsset.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/license.d.ts +41 -26
- package/dist/declarations/src/types/resources/license.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/nftClient.d.ts +18 -0
- package/dist/declarations/src/types/resources/nftClient.d.ts.map +1 -0
- package/dist/declarations/src/types/resources/permission.d.ts +34 -5
- package/dist/declarations/src/types/resources/permission.d.ts.map +1 -1
- package/dist/declarations/src/types/resources/royalty.d.ts +41 -23
- package/dist/declarations/src/types/resources/royalty.d.ts.map +1 -1
- package/dist/declarations/src/utils/sign.d.ts +16 -0
- package/dist/declarations/src/utils/sign.d.ts.map +1 -0
- package/dist/story-protocol-core-sdk.cjs.dev.js +17740 -7053
- package/dist/story-protocol-core-sdk.cjs.prod.js +17740 -7053
- package/dist/story-protocol-core-sdk.esm.js +17642 -6958
- package/package.json +5 -5
- package/dist/declarations/src/clients/storyAPI.d.ts +0 -9
- 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
|
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
|
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
|
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
|
-
|
104
|
-
|
105
|
-
- run `make compile_contracts`
|
103
|
+
- run `cd packages/wagmi-generator && npm run generate`
|
106
104
|
|
107
105
|
## Release
|
108
106
|
|
109
|
-
| Package
|
110
|
-
|
|
111
|
-
| [core-sdk](./packages/core-sdk)
|
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
|
|