latest
Search…
⌃K
Links

Releasing your Safe App

Release Process

How to get your Safe Apps into the hands of users

As soon as you finish developing and testing your Safe App, you can already let some actual users test it by simply sending them the link to the hosted Safe App and asking them to add it as a Custom App. This guide explains how to add custom apps.

Get your Safe App listed in the Safe

If you would like your Safe App to appear in the Safe, it must meet the following criteria:
1) Smart contracts must be audited
Security it's a top priority. If your Safe App includes smart contracts of your own you should provide an external audit result document. If smart contracts were created by a 3rd party you should be using smart contracts that are properly audited.
2) Your Safe App must include a manifest.json file at the root containing the following data:
"name": "Name of your Safe App"
Your Safe App's name, maximum 50 characters.
"iconPath": "your_logo.svg"
A relative file path to your App's logo. The icon must be a square SVG image of at least 128 by 128 pixels.
"description": "This is the Safe app description."
Few sentences describing your application, maximum 200 characters
You can find an example manifest file on Github. In addition, you can find an example Safe App on IPFS here.
Remember that CORS should be configured correctly on the manifest.json so we can fetch the information as mentioned here.
3) The app auto-connects to the Safe
When an user opens the app, it should automatically select the Safe as a wallet. Ensure to check the case if the user previously opened the app outside of the Safe with another wallet.
4) The Safe team has reviewed the Safe App
The requirement doesn't apply for battle-tested applications hosted on the same domain like the main dApp.
While we won't be able to do a proper audit for your Safe App, we still would like to look at the source code to raise issues or suggest improvements. So whether your Safe App is open or closed source, please send us either a link to the public repo or an invitation to the private code repository.
We also would like to make a rough functional review of the App, so please provide us with a high-level test plan/feature list that allows our QA team to make sure everything works as intended in production. Video walkthroughs are also welcome.
5) Help us decode your Safe App transactions
We want to display interactions with Safe Apps as human-readable as possible. To do this, we need the contract ABI of the contracts that your Safe App interacts with. The ideal way to do this would be to verify your contracts via Sourcify, which we can leverage to decode transactions interacting with those contracts.
Alternatively, you can provide us with the ABIs as JSON files or the links to the verified contracts on Etherscan, so we can implement transaction decoding for your Safe App interactions.
Create an issue in our repository once you've verified that your app meets these requirements: https://github.com/5afe/safe-apps-list

The Official launch and beyond

After we have reviewed and integrated your Safe App, the App will first be available in the staging environment of the Safe for you to do a final review. We would then approach you to coordinate the launch and a joint announcement.
At any point after the launch, if you or your users encounter issues with the Safe App, or you want to release an update to an existing Safe App, please get in touch with us via Discord.