A Redux library designed to efficiently sync and normalize blockchain data synced using web3.js and redux.
pnpm install @owlprotocol/web3-redux @owlprotocol/web3-redux-components
- web3-redux: Web3-Redux core library
- web3-redux-components: Web3-Redux React Component library
- web3-redux-docs: Docusaurus documentation.
See the official documentation at owlprotocol.github.io/web3-redux/
These instructions are only relevant if you are looking to contribute to web3-redux.
git clone git@github.com:owlprotocol/web3-redux.git
pnpm install
pnpm install #Bug https://github.com/owlprotocol/web3-redux/issues/130
Make sure to run the install twice if running a fresh install (this is due to a bug of how pnpm attempts to link the local dependency before it's transpiled). This is only required on initial install.
Run a watch build process to automatically re-build Typescript code on change.
cd packages/web3-redux
pnpm run build:watch # Runs tsc:watch typecheck + esbuild:watch build
Run storybook with Hot Module Replacement while developing UI Components.
cd packages/web3-redux-components
pnpm run storybook # Runs storybook with Vite
See RESEARCH.md for known issues and challenges.
We use StorybookJS for implementing components in an isolated environment. Check out STORYBOOK.md for more info on how to get setup.
2021 Owl Protocol MIT License.