Safe Apps Developer Tools Monorepo
Developer tools to integrate third-party applications (Safe Apps) with Safe (https://app.safe.global/).
You can find more resources on Safe Apps in the Safe Developer Portal.
Packages
| Package | Description |
|---|---|
| cra-template-safe-app | CRA template to quickly bootstrap a Safe app |
| safe-apps-react-sdk | A wrapper of safe-apps-sdk with helpful React Hooks |
| safe-apps-sdk | JavaScript SDK |
| safe-apps-provider | A generic provider that can be used with common web3 libraries (e.g. web3.js or Ethers) |
| safe-apps-onboard | Blocknative included Safe App support in onboard.js v1.26.0. Check Blocknative docs for the integration guide |
| safe-apps-web3modal | A wrapper around Web3Modal that would automatically connect to the Safe if the app is loaded as a Safe app |
| safe-apps-web3-react | A web3-react connector for Safe is included in web3-react starting from version 8 |
| safe-apps-wagmi | A wagmi connector for Safe Apps |
| safe-apps-test-app | A test app to test the Safe Apps SDK |
Testing your Safe App
You can directly use our production interface for testing your Safe App
Setting up development environment
Installing dependencies
npm i -g lerna
yarn global add lerna
lerna bootstrap
Running commands
We will use build command as an example. Same applies to other commands.
For all packages:
lerna run build
For a specific package:
lerna run --scope @safe-global/safe-apps-sdk build --stream
--stream options enables command output. By default, lerna displays it only in case of an error.
Release process
Release process is described in releases.md
Useful links
- Making an app to withdraw all assets from a Safe in one transaction - tutorial
- Start a new project using the Safe App React template
- Video introduction to Building with Safe Apps SDK & Contract Proxy Kit
License
This project is licensed under the MIT License - see the LICENSE.md file for details