Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/safe-global/safe-apps-sdk
Client-side SDKs to create third-party Safe Apps
https://github.com/safe-global/safe-apps-sdk
react-sdk safe safe-apps sdk typescript-library
Last synced: about 2 months ago
JSON representation
Client-side SDKs to create third-party Safe Apps
- Host: GitHub
- URL: https://github.com/safe-global/safe-apps-sdk
- Owner: safe-global
- License: mit
- Created: 2020-04-17T17:07:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T02:30:52.000Z (4 months ago)
- Last Synced: 2024-05-22T20:32:52.413Z (4 months ago)
- Topics: react-sdk, safe, safe-apps, sdk, typescript-library
- Language: TypeScript
- Homepage: https://safe.global
- Size: 11.4 MB
- Stars: 229
- Watchers: 20
- Forks: 109
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Safe Apps Developer Tools Monorepo
[](https://safe.global/)
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](https://docs.safe.global/safe-core-aa-sdk/safe-apps).
## Packages
| Package | Description |
|---------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------|
| [cra-template-safe-app](/packages/cra-template-safe-app) | CRA template to quickly bootstrap a Safe app |
| [safe-apps-react-sdk](/packages/safe-apps-react-sdk) | A wrapper of safe-apps-sdk with helpful React Hooks |
| [safe-apps-sdk](/packages/safe-apps-sdk) | JavaScript SDK |
| [safe-apps-provider](/packages/safe-apps-provider) | A generic provider that can be used with common web3 libraries (e.g. web3.js or Ethers) |
| [safe-apps-onboard](https://onboard.blocknative.com/) | Blocknative included Safe App support in onboard.js v1.26.0. Check [Blocknative docs](https://onboard.blocknative.com/) for the integration guide |
| [safe-apps-web3modal](/packages/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](https://github.com/Uniswap/web3-react) | A web3-react connector for Safe is included in web3-react starting from version 8 |
| [safe-apps-wagmi](/packages/safe-apps-wagmi) | A wagmi connector for Safe Apps |
| [safe-apps-test-app](/packages/safe-apps-test-app) | A test app to test the Safe Apps SDK |
## Testing your Safe App
You can directly use [our production interface](https://app.safe.global) for testing your Safe App
## Setting up development environment
### Installing dependencies
```
yarn install
```
### Running commands
We will use `build` command as an example. Same applies to other commands.
For all packages:
```
yarn build
```
For a specific package:
```
yarn 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](/docs/releases.md)
## Useful links
- [Making an app to withdraw all assets from a Safe in one transaction - tutorial](/guides/drain-safe-app)
- [Start a new project using the Safe App React template](/packages/cra-template-safe-app)
- [Video introduction to Building with Safe Apps SDK & Contract Proxy Kit](https://www.youtube.com/watch?v=YGw8WfBw5OI)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details