IpKit

IpKit provides a number of convenient tanstack-query hooks to quickly access Story's on-chain data, including assets, collections, transactions and more, via the Protocol V4 API.

Using IpKit

View the IpKit package docs here, or in StoryBook here

Run locally

Storybook

To run locally you will need to define your API keys for Storybook in .env.local

STORYBOOK_STORY_PROTOCOL_X_TESTNET_API_KEY="YOUR STAGING API KEY"
STORYBOOK_STORY_PROTOCOL_X_API_KEY="YOUR PRODUCTION API KEY"

Storybook defaults to the staging API, but you can switch the environment in the Storybook toolbar.

Make sure to use the correct npm version with:

nvm use

Run Storybook locally for component development and documentation:

pnpm dev

Find the Storybook at http://localhost:6006

Example app

Run the example app.

pnpm build
pnpm example --filter @example/simple-setup

The dev server will be running at http://localhost:3000

Building

• Build: pnpm build
• Lint: pnpm lint
• Format: pnpm format

Contributing

For guidelines on contributing to IpKit, see the CONTRIBUTING.md file.