Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Signatures using the Core SDK #318

Merged
merged 40 commits into from
Feb 13, 2024
Merged

Signatures using the Core SDK #318

merged 40 commits into from
Feb 13, 2024

Conversation

germartinez
Copy link
Member

Context:

The SDK team is updating the documentation to explain how to create signatures using the Safe{Core} SDK:

  • Utilities to generate signatures using the SDK
  • Signature collection to execute Transactions or to sign Messages
  • Signature collection using the SDK and Safe Services
  • on-chain vs off-chain messages

Note:

This PR cherry picks all the commits from #313 as that PR was created from the wrong base branch. This one is using development after nextra was squash merged.

Copy link

github-actions bot commented Jan 25, 2024

Overall readability score: 68.54 (🔴 -0.21)

File Readability
signatures.md 62.73 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
signatures.md 62.73 55.44 9.92 12 12.41 6.59
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 68.54 58.79 9.22 9.85 10.63 7.08
  🔴 -0.21 🔴 -0.03 🔴 -0.04 🔴 -0.05 🔴 -0.04 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@germartinez
Copy link
Member Author

germartinez commented Jan 25, 2024

Notes:

  • Acording to the code style in the docs all semicolons should be removed.
  • "Safe Account" should be writen this way: "Safe account" or just "Safe".

@yagopv
Copy link
Member

yagopv commented Jan 25, 2024

@germartinez all the suggestions and comments were addressed

@dasanra dasanra linked an issue Jan 26, 2024 that may be closed by this pull request
yagopv and others added 27 commits February 13, 2024 11:42
Co-authored-by: Mikhail <16622558+mmv08@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>
@germartinez germartinez merged commit 0b2c61c into main Feb 13, 2024
2 of 3 checks passed
@dasanra dasanra deleted the core-sdk-signatures branch February 14, 2024 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[core-sdk] Document how 1271 works with Safe
3 participants