Skip to content

Commit

Permalink
Update Safe Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tanay Pant committed Oct 27, 2023
1 parent 0f562ae commit f1ebb07
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 70 deletions.
3 changes: 3 additions & 0 deletions .gitbook.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ redirects:
safe-smart-account/security/security-audits: safe-smart-account/security-audits.md
safe-smart-account/security/bug-bounty-program: miscellaneous/bug-bounty-program.md
safe-smart-account/security/past-paid-bounties: miscellaneous/past-paid-bounties.md
safe-apps-sdk/safe-apps: safe-apps/README.md
safe-apps-sdk/overview: safe-apps/README.md
safe-apps-sdk/example-safe-app: safe-apps/get-started.md
10 changes: 3 additions & 7 deletions SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,11 @@

## Safe Apps SDK

* [Safe Apps SDK](safe-core-sdk/safe-apps/README.md)
* [Overview](safe-apps/README.md)

* [Overview](safe-core-sdk/safe-apps/overview.md)
* [Getting started](safe-apps/get-started.md)

* [Get started](safe-core-sdk/safe-apps/get-started.md)

* [Release](safe-core-sdk/safe-apps/release.md)
*
* [Safe App example](safe-core-sdk/safe-apps/example-safe-app.md)
* [Release](safe-apps/release.md)

## Reference

Expand Down
19 changes: 16 additions & 3 deletions safe-core-sdk/safe-apps/overview.md → safe-apps/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Safe Apps SDK Packages
# Safe Apps SDK

The Safe Apps SDK allow developers to build their dApps right into the Safe{Wallet}. Turn your Dapp into an HTML iframe component that can be accessed through the Safe. We are providing extensive developer tooling to make it easy to create, test and integrate Safe Apps into the Safe. This includes an unique design system, reusable components and a Safe App SDK that facilitates the Safe App <> Safe communication.

Check failure on line 3 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L3 

[Vale.Spelling] Did you really mean 'dApps'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'dApps'?", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 3, "column": 51}}}, "severity": "ERROR"}

Check failure on line 3 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L3 

[Vale.Spelling] Did you really mean 'Dapp'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Dapp'?", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 3, "column": 96}}}, "severity": "ERROR"}

Check failure on line 3 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L3 

[Microsoft.Contractions] Use 'we're' instead of 'We are'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'We are'.", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 3, "column": 170}}}, "severity": "ERROR"}

## Packages

You can find several packages on [our developer tools](https://github.com/safe-global/safe-apps-sdk) to make it easier to integrate third-party applications (Safe Apps) with [Safe](https://app.safe.global). Check the following diagram to see which package is more convenient for you:

<figure><img src="../../.gitbook/assets/diagram-safe-apps.png" width="100%" alt="" /></figure>

## Packages

| Package | Version | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [cra-template-safe-app](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/cra-template-safe-app) | | CRA template to quickly bootstrap a Safe App. Use this package to start a new Safe App from scratch using React. |
Expand All @@ -16,3 +18,14 @@ You can find several packages on [our developer tools](https://github.com/safe-g
| [safe-apps-wagmi](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-wagmi) | | A [wagmi](https://github.com/wagmi-dev/wagmi) connector for Safe Apps |
| [@web3-onboard/gnosis](https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop/packages/gnosis) | | Blocknative included Safe App support in [@web3-onboard](https://github.com/blocknative/web3-onboard) v1.26.0. If you are already using this package you can [check here](https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/gnosis/README.md) how to configure it. |
| [@web3-react/gnosis-safe](https://github.com/Uniswap/web3-react/tree/main/packages/gnosis-safe) | | [web3-react](https://github.com/Uniswap/web3-react) already includes a connector for Safe Apps by default. You can check at their docs how to use it. |

## Onchain stats

Check failure on line 22 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L22 

[Vale.Terms] Use 'onchain' instead of 'Onchain'.
Raw output 
{"message": "[Vale.Terms] Use 'onchain' instead of 'Onchain'.", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 22, "column": 4}}}, "severity": "ERROR"}

There are Dune Analytics dashboards about Safe Apps available:

Check failure on line 24 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L24 

[write-good.ThereIs] Don't start a sentence with 'There are'.
Raw output 
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 24, "column": 1}}}, "severity": "ERROR"}

* [Number of transactions](https://explore.duneanalytics.com/dashboard/gnosis-safe---safe-apps-transactions)
* [Transaction volume](https://explore.duneanalytics.com/dashboard/gnosis-safe---safe-apps-volume)

## Disclaimer

It is at our sole discretion to list or delist apps from the Safe. Safe Apps are not owned, controlled, maintained, or audited by Gnosis.

Check failure on line 31 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L31 

[Microsoft.Contractions] Use 'it's' instead of 'It is'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'It is'.", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 31, "column": 1}}}, "severity": "ERROR"}

Check failure on line 31 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L31 

[Vale.Spelling] Did you really mean 'delist'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'delist'?", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 31, "column": 41}}}, "severity": "ERROR"}

Check failure on line 31 in safe-apps/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/README.md#L31 

[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
Raw output 
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "safe-apps/README.md", "range": {"start": {"line": 31, "column": 78}}}, "severity": "ERROR"}
8 changes: 7 additions & 1 deletion safe-core-sdk/safe-apps/get-started.md → safe-apps/get-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Basic resources to start creating Safe Apps
---

# Get started
# Getting started

Welcome! We are glad on your interest about creating a Safe App. The team is working hard to provide the tools to make it easier for you to build apps that can interact with Safe.

Expand Down Expand Up @@ -118,3 +118,9 @@ If you are creating your Safe App from scratch, we provide a reusable react comp

* [Check all available components in the storybook](https://components.safe.global)
* [Check UI Kit repository](https://github.com/safe-global/safe-react-components)

## Example app

This tutorial will build a Safe App that enables us to migrate all the assets from a Safe to any other wallet in a single transaction. It doesn't include NFTs, but this is a great thing to do on your own. In addition, you will learn about smart contract wallets, multi-signature transaction flow, and batched transactions.

Check failure on line 124 in safe-apps/get-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/get-started.md#L124 

[Vale.Spelling] Did you really mean 'NFTs'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'NFTs'?", "location": {"path": "safe-apps/get-started.md", "range": {"start": {"line": 124, "column": 155}}}, "severity": "ERROR"}

Find the Github repo with the complete guide [here](https://github.com/gnosis/safe-apps-sdk/tree/master/guides/drain-safe-app).

Check failure on line 126 in safe-apps/get-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/get-started.md#L126 

[Vale.Spelling] Did you really mean 'Github'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Github'?", "location": {"path": "safe-apps/get-started.md", "range": {"start": {"line": 126, "column": 10}}}, "severity": "ERROR"}

Check failure on line 126 in safe-apps/get-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/get-started.md#L126 

[Vale.Avoid] Avoid using 'Github'.
Raw output 
{"message": "[Vale.Avoid] Avoid using 'Github'.", "location": {"path": "safe-apps/get-started.md", "range": {"start": {"line": 126, "column": 10}}}, "severity": "ERROR"}

Check failure on line 126 in safe-apps/get-started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] safe-apps/get-started.md#L126 

[Vale.Spelling] Did you really mean 'repo'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'repo'?", "location": {"path": "safe-apps/get-started.md", "range": {"start": {"line": 126, "column": 17}}}, "severity": "ERROR"}
0 safe-core-sdk/safe-apps/release.md → safe-apps/release.md
View file
File renamed without changes.
38 changes: 0 additions & 38 deletions safe-core-sdk/safe-apps/README.md
View file

This file was deleted.

21 changes: 0 additions & 21 deletions safe-core-sdk/safe-apps/example-safe-app.md
View file

This file was deleted.

0 comments on commit f1ebb07

Please sign in to comment.