Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 6.28 KB

README.md

File metadata and controls

23 lines (16 loc) · 6.28 KB

Safe Apps SDK

The Safe Apps SDK helps developers to build their dapps into the Safe{Wallet}. It turns a dapp into an HTML iframe component that can be accessed through Safe. This SDK provides extensive developer tooling to make it easy to create, test, and integrate Safe Apps into Safe. This includes a design system, reusable components, and a Safe App SDK that facilitates communication between the Safe App and Safe.

Packages

Here are several packages to make it easier to integrate third-party applications (Safe Apps) with Safe. Check the following diagram to see which package is suitable for you:

Package Version Description
cra-template-safe-app CRA (Create React App) template to bootstrap a Safe App. Use this package to start a new Safe App from scratch using React.
safe-apps-react-sdk npm A wrapper of safe-apps-sdk with helpful React Hooks.
safe-apps-sdk npm JavaScript SDK. This is the base package for all integrations.
safe-apps-provider npm A generic provider that can be used with common web3 libraries. For example, web3.js or Ethers.
safe-apps-web3modal npm A wrapper around Web3Modal that would automatically connect to the Safe when the app is loaded in the Safe Apps section.
safe-apps-wagmi A wagmi connector for Safe Apps.
@web3-onboard/gnosis Blocknative included Safe App support in @web3-onboard v1.26.0. If you are already using this package, you can check here how to configure it.
@web3-react/gnosis-safe web3-react already includes a connector for Safe Apps by default. You can check their docs on how to use it.

{% hint style="warning" %} Safe Apps are not owned, controlled, maintained, or audited by Safe. Safe can list or delist apps from Safe{Wallet} at its sole discretion. {% endhint %}