⚠️ This is a developer preview! Actions is not yet ready for production use.
Actions SDK and demo app by Optimism.
This monorepo contains the following packages:
-
packages/sdk- The core Actions SDK - A Typescript library of lightweight abstractions for building onchain. -
packages/demo/frontend- A React+vite splash page + demo app displaying supported wallets and DeFi protocols. -
packages/demo/backend- A hono service demonstrating the Actions SDK in a backend environment. -
packages/demo/contracts- Demo smart contracts including a Faucet contract and a Morpho market deployment script for setting up lending markets on testnets.
- Install dependencies
pnpm install-
Add env vars
Copy all example environment files to create local configuration:
cp packages/demo/backend/.env.example packages/demo/backend/.env cp packages/demo/frontend/.env.example packages/demo/frontend/.env
-
Configure Providers
- Sign up for a wallet provider and add secrets. Note that certain provider support both back and frontend signing.
# Edit packages/demo/backend/.env PRIVY_APP_ID=your_privy_app_id_here PRIVY_APP_SECRET=your_privy_app_secret_here- For gas sponsorship, sign up for a bundler. For this demo we use Pimlico.
The remaining environment variables are pre-configured for local development.
While each component of the repo can be run independently, start the complete demo environment in one command:
pnpm devThis uses mprocs to orchestrate multiple processes:
- Backend: Starts the Actions SDK backend service
- Frontend: Starts the React web application
The demo will be available at http://localhost:5173 once all services are running.
No contribution is too small and all contributions are valued. Thanks for your help improving the project! We are so happy to have you!
You can read our contribution guide here to understand better how we work in the repo.
Instructions for releasing a new sdk version are found here.
All other files within this repository are licensed under the MIT License unless stated otherwise.