safe-global / safe-docs Goto Github PK

The tutorial was written only with the wallet app in mind; it misses some essential parts, such as signing the safe message hash, etc

https://gnosis-safe.readthedocs.io/en/latest/contracts/transactions.html

https://github.com/safe-global/safe-docs/blob/main/learn/safe-tools/untitled.md

Here untitled.md should be web.md and inside the file "https://www.gnosis-safe.io/app/rinkeby" 👈🏻 this link is present which is 404

A user pointed out that the phrasing is misleading in: docs/tutorial_tx_service_initiate_sign

"signature": "<0x prefixed hex string>", // One or more ethereum ECDSA signatures of the contractTransactionHash as an hex string

It wasn't clear how multiple signatures need to be formatted as arrays are not accepted.

We could rephrase the comment to:

"signature": "<0x prefixed hex string>", // One or more ethereum ECDSA signatures of the contractTransactionHash as an hex string. See: signature types)

Broken links found: Failed Run
Workflow: Weekly link check

In multiple places asset paths are hardcoded (e.g. fonts, images) this cause them not to work properly (e.g. in staging).

Production works by "accident" since the required files have been deployed to root at some point before the sub directory change.

See gnosis/dex-docs@8f8b04d

It would be nice to have separate section for the ModuleManager and OwnerManager contract.

For the ModuleManager it should be outlined how modules are stored and managed. Also shortly explain one module to show how the interaction with the safe works and what needs to be implemented (e.g. replay protection)

For the OwnerManager it should be outlined how owners are stored and managed. Also mention scenarios where transactions might fail.

The code snippet above provided in the docs on the auth-kit section installs the latest version of web3auth i.e. v7. v7 is not compatible with safe libraries and is throwing errors. Would be helpful if the supported web3auth version i.e v4 is mentioned in the docs

• Android: from github
• Extension: from github
• iOS: testflight

I think I found a mistake in the docs:
https://docs.gnosis.io/safe/docs/contracts_tx_execution/

The doc says that it’s needed to include “dataGas” field in EIP-712 signature
However, the smart contract expects “baseGas” field instead:
https://github.com/gnosis/safe-contracts/blob/master/contracts/GnosisSafe.sol#L370
And it considers signatures with dataGas as invalid

Update scope, contract names, etc that needs to be updated

Problem

Recently there has been renaming of transaction guards and modules. The choices behind this change in naming are outside of scope of this issue filing. The issue this creates is those that have already been actively building on Safe now find a change in documentation which is incongruent with the smart contract nomenclature implementing the features.

Proposed Solution

Projects choose to change nomenclature from time to time for various reasons. A transition period (read: 6 months - 12 months arbitrarily, or more accurately determined from market research) should be adopted during which times nomenclature changes are accompanied with a NOTE section indicating such history.

Click Next on page 4 of the CPK tutorial and it will be redirected to the error page

We added a new auth endpoint (v2) this should be part of the docs.

5afe/safe#153

Currently we are not mentioning Safe Apps in the introduction.

• Include general changes for 1.3.0
• Improve documentation about safeTxGas
• Add documentation about HandlerContext
• Add documentation for EIP-1271

Describe the bug
Whereas on Github diagrams like the one for the Offchain transaction signatures for the tx-service are displayed as expected:

On the Docs page this and other diagrams following the same structure are not:

Apologies if this isn't the right repo. Couldn't find the source for this safe transaction service tutorial anywhere, but this seems like the best fit.

The linked page mentions that:

If you can code in Javascript, you can edit this example to fit your needs: https://gist.github.com/rmeissner/0fa5719dc6b306ba84ee34bebddc860b

I've been trying to run that example (specifically, it's submit function) by just modifying the arguments therein, but keep running into issues related to signing.

Firstly, the endpoint tells me that the Contract-transaction-hash=0xaaa... does not match provided contract-tx-hash=0xbbb....
If I then hardcode the contractTransactionHash it expects, it tells me Signer=0xccc... is not an owner or delegate. The signer address it gives though isn't an address related to the private key I passed in.

This feels vaguely like address recovery from the signed message, on the Gnosis service's end, is happening incorrectly, or mismatching with the way signing happens locally.
(Passing a chainId argument into the signing function does change the recovered address compared to not passing the argument, but still doesn't give an expected result.)

Notably, I ran into the same issues when hand-rolling my own version of this code, as well as when following the set delegate tutorial, so perhaps the issue is deeper than just this gist.

Context

Failed Run
Workflow name - Weekly link check

Currently we are not mentioning the CPK in the introduction

Artifact from template that should be removed (e.g. https://docs.gnosis.io/safe/blog/)

Context

We are removing the current Web3AuthModalPack from the safe-core-sdk auth-kit package

Proposed solution

This task is about updating the example section for the auth-kit in the docs

Additional context

Web3Auth Safe Signer epic

testing

Summary

Errors per input

Errors in other/things-you-can-do-with-safe.md

• [403] https://dune.com/safe/optimism | Failed: Network error: Forbidden
• [ERR] file:///home/runner/work/safe-docs/safe-docs/other/safe-core-sdk/relay-kit/README.md | Failed: Cannot find file
• [403] https://dune.com/safe/bsc | Failed: Network error: Forbidden
• [403] https://dune.com/safe/gnosis-chain | Failed: Network error: Forbidden
• [403] https://dune.com/safe/polygon | Failed: Network error: Forbidden

Errors in other/built-on-safe.md

• [403] https://twitter.com/safe/status/1620017821714624518 | Failed: Network error: Forbidden
• [403] https://twitter.com/safe | Failed: Network error: Forbidden

Errors in examples/README.md

• [ERR] file:///home/runner/work/safe-docs/safe-docs/learn/safe-core/safe-core-account-abstraction-sdk/relay-kit.md | Failed: Cannot find file

Errors in other/what-is-a-smart-account.md

• [ERR] file:///home/runner/work/safe-docs/safe-docs/other/safe-core-protocol/guards.md | Failed: Cannot find file
• [403] https://twitter.com/tomiwa1a/status/1619059531480444933 | Failed: Network error: Forbidden
• [ERR] file:///home/runner/work/safe-docs/safe-docs/other/safe-core-sdk/introduction.md | Failed: Cannot find file
• [ERR] file:///home/runner/work/safe-docs/safe-docs/other/safe-core-protocol/modules.md | Failed: Cannot find file
• [403] https://twitter.com/koeppelmann/status/1618998969992097793 | Failed: Network error: Forbidden

Errors in other/other-tools.md

• [ERR] file:///home/runner/work/safe-docs/safe-docs/other/safe-core/safe-core-account-abstraction-sdk/protocol-kit/core-sdk.md | Failed: Cannot find file

Errors in safe-core-sdk/safe-apps/README.md

• [403] https://explore.duneanalytics.com/dashboard/gnosis-safe---safe-apps-transactions | Failed: Network error: Forbidden
• [403] https://explore.duneanalytics.com/dashboard/gnosis-safe---safe-apps-volume | Failed: Network error: Forbidden

Errors in safe-smart-account/security/past-paid-bounties.md

• [403] https://twitter.com/micahzoltu | Failed: Network error: Forbidden
• [403] https://twitter.com/davidnich11 | Failed: Network error: Forbidden

Errors in contact-us.md

• [403] https://dune.com/safe | Failed: Network error: Forbidden
• [403] https://twitter.com/safe | Failed: Network error: Forbidden

Errors in safe-core-sdk/safe-apps/get-started.md

• [ERR] https://yourappurl/myAppIcon.svg | Failed: Network error: dns error: no record found for Query { name: Name("yourappurl."), query_type: AAAA, query_class: IN }
  Full Github Actions output

Some teams (I remember Micobo and Chainlink) have asked about details on how to submit txs via the REST API.
Other teams (Synthetix) are using this feature already to submit new txs via a script to the API.

Task:
Please write a brief tutorial about how to submit a tx via the REST API. Please include an example for a Multisend as well.
Please linke the tutorial at https://docs.gnosis.io/safe/docs/services_tutorials/

The Safe App tutorial found at https://docs.gnosis.io/safe/docs/sdks_safe_apps/ contains a list of links to existing safe apps. Two of which (as far as I can tell) are broken.

• Compound:
  https://github.com/gnosis/safe-react-apps/tree/development/src/apps/Compound
  https://github.com/gnosis/safe-react-apps/tree/development/apps/compound

• Transaction Builder
  https://github.com/gnosis/safe-react-apps/tree/development/src/apps/TxBuilder
  https://github.com/gnosis/safe-react-apps/tree/development/apps/tx-builder

• Aave
  https://github.com/mrdavey/gnosis-safe-app
  Does not seem to exist on @mrdavey's github anywhere.

Also, perhaps this would be a good place to update the list to include Wallet Connect

More details at: safe-global/safe-smart-account#229

Ideas:

• Simple module

https://docs.gnosis.io/safe/docs/intro_accounts/

On the right side it should say "contract account"

We have an endpoint that returns estimates of the Safe creation for all payment tokens we support. This should be part of the safe docs

#163

Recently we got a fair amount of questions asking on how to use this feature.

A doc for QA on how to test custom TXs which may help: https://docs.google.com/document/d/1z3WGxMvycNzJGKvWSVaMhoZaLcwKlDjD5rE_PvKPfYs/edit?usp=sharing

Update links on introduction cards

• Services link is not correct

• Remove api endpoint documentation (we have this in swagger)
• Add high level overview what the service can do and why it exists
• Add example for service interfaction (see #26)
  • Old example for the relay service: https://github.com/gnosis/safe-demo

It would be nice to have a graph displaying the deployment of a proxy for the Gnosis Safe Personal Edition. Currently it is only outlined and the video of the dappcon talk is linked.

The documentation reference the following:

• Complexity of the Smart Contracts and why formal verification is important
• Contract Signatures - mention that smart contracts cannot sign messages and reference EIP1271 (Standard Signature Validation Method for Contracts)
• Delegates in State Channels

In the first paragraph, in /docs/contracts_05_relayer.md, there is a dead link!

Context

We are removing the current Web3AuthModalPack from the safe-core-sdk auth-kit package

Proposed solution

This task is about updating the reference section in the docs with the changes

Additional context

Web3Auth Safe Signer epic

Broken links found: Failed Run
Workflow: Weekly link check

Notification Service section (docs7 https://docs.gnosis.io/safe/docs/docs7/#notification-service) has malformed link:

https://blog.openzeppelin.com/proxy-patterns/(https://safe-notification.gnosis.io/)

I wasn't sure what the intention was, otherwise I would have submitted a PR:
https://github.com/gnosis/safe-docs/blob/master/docs/documentation07.md

https://github.com/safe-global/safe-docs/actions/runs/7002839276

Hi,
I want to deploy a dapp that is Ethereum based. For testing purposes, I want to use Testnet but the only Testnet available in safe services is Goerli which will be deprecated until the end of the year and already has many problems to use. I wanted to know if there are going to be any Testnet chains in available services soon.

Broken links found: Failed Run
Workflow: Weekly link check

Broken links found: Failed Run
Workflow: Weekly link check

Available services should be updated to include new supported chains:

• polygon zkEVM -> https://safe-transaction-zkevm.safe.global/
• zksync Era mainnet -> https://safe-transaction-zksync.safe.global/

This page https://docs.gnosis-safe.io/tutorials/tutorial_tx_service_initiate_sign contains a link to delegate tutorial:
https://github.com/gnosis/safe-docs/tree/98cffd3359a173173543997a027134572e00cf29/tutorials/tutorial_tx_service_set_delegate.md

which does not exist anymore.

Could you point me to a new location or has the delegation feature been deprecated?