Getting Started
WARNING
This documentation refers to the alpha release of Synpress v4. The API is subject to change.
For Synpress v3 documentation, please refer here.
Overview
INFO
Support for Cypress is coming soon.
Synpress is an E2E (End-to-End) testing library for Web3 dapps. It can be used with both Playwright and Cypress. Synpress is built with developer experience, stability, and performance in mind:
- Developer Experience: Type safety, simple API, comprehensive documentation, support for
bothPlaywrightand Cypressand all oftheirits features. - Stability: Complete test coverage, bullet-proof wallet integration API.
- Performance: Optimized for speed, parallelization, and fast feedback loops.
Check out the Why Synpress section to learn more about the project's rationale.
Installation
bash
pnpm add @synthetixio/synpress@alpha
bash
npm i @synthetixio/synpress@alpha
bash
yarn add @synthetixio/synpress@alpha
NOTE
Synpress is now an ESM-only package. Don't use require()
to import it, and make sure your nearest package.json
contains "type": "module"
.
Next Steps
For more information on what to do next, check out the following topics:
- TypeScript - Learn how to set up TypeScript with Synpress.
- Wallet Cache - Learn what's a wallet cache and how to use it.