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

docs: [EIP-1193] Update Protocol Kit initialization #461

Merged
merged 8 commits into from
May 7, 2024

Conversation

germartinez
Copy link
Member

@germartinez germartinez commented May 3, 2024

Context

This PR:
Updates the initialization of the Protocol Kit after the EthAdapter class was removed.
safe-global/safe-core-sdk#770

TBD:

  • Protocol Kit migration guides from v1 and v2 have not been updated yet.

@germartinez germartinez requested a review from yagopv May 3, 2024 16:28
Copy link

github-actions bot commented May 3, 2024

Overall readability score: 56.22 (🔴 -0.02)

File Readability
delegates.mdx 14.71 (🔴 -1.59)
messages.mdx 8.48 (🟢 +1.68)
transactions.mdx 9.15 (🟢 +0.9)
api-kit.mdx 58.92 (🔴 -3.18)
safe-auth.mdx 51.13 (🔴 -0.98)
protocol-kit.mdx 68.24 (🔴 -2.39)
signatures.md 62.99 (🟢 +0.27)
messages.mdx 75.05 (🟢 +0)
transactions.mdx 45.04 (🟢 +0.08)
safe-factory.md 59.97 (🟢 +3.22)
safe.md 70.29 (🟢 +0.66)
4337-safe-sdk.mdx 32.31 (🟢 +0.45)
gelato-relay.mdx 66.67 (🟢 +0)
safe-4337-pack.mdx 60.43 (🟢 +0.01)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
delegates.mdx 14.71 1.63 14.25 22 19 9.04
  🔴 -1.59 🟢 +1.63 🔴 -1.12 🟢 +0 🟢 +0 🟢 +0.02
messages.mdx 8.48 0 18.57 22 19 8.59
  🟢 +1.68 🟢 +0 🟢 +0.06 🟢 +0 🟢 +0 🟢 +0.49
transactions.mdx 9.15 0 18.8 22 19 8.26
  🟢 +0.9 🟢 +0 🔴 -0.17 🟢 +0 🟢 +0 🟢 +0.37
api-kit.mdx 58.92 45.56 10.96 11.6 11.48 7.3
  🔴 -3.18 🔴 -8.66 🔴 -0.12 🔴 -0.6 🔴 -0.52 🟢 +0.02
safe-auth.mdx 51.13 40.95 11.75 11.3 13.1 8.49
  🔴 -0.98 🔴 -0.41 🔴 -0.53 🟢 +0.2 🟢 +0.11 🔴 -0.14
protocol-kit.mdx 68.24 57.27 9.25 9.9 11.19 6.81
  🔴 -2.39 🔴 -0.6 🔴 -0.45 🔴 -0.5 🔴 -0.24 🔴 -0.14
signatures.md 62.99 55.64 9.88 11.9 12.35 6.61
  🟢 +0.27 🟢 +0.2 🟢 +0.04 🟢 +0.1 🟢 +0.06 🔴 -0.02
messages.mdx 75.05 64 8.29 9.8 10.15 6.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
transactions.mdx 45.04 52.8 9.48 19.5 19 5.91
  🟢 +0.08 🟢 +0 🟢 +0.03 🟢 +0 🟢 +0 🟢 +0.01
safe-factory.md 59.97 55.13 10.94 11.3 11.6 7.56
  🟢 +3.22 🟢 +8.35 🟢 +0.1 🟢 +0.4 🟢 +0.52 🟢 +0.11
safe.md 70.29 42.48 7.13 10.4 12.46 5.76
  🟢 +0.66 🟢 +0 🟢 +0.02 🟢 +0.2 🟢 +0.17 🟢 +0.03
4337-safe-sdk.mdx 32.31 43.8 17.61 21.1 11.15 7.79
  🟢 +0.45 🟢 +0.3 🟢 +0.16 🟢 +0.1 🔴 -0.06 🟢 +0.02
gelato-relay.mdx 66.67 54.42 9.56 10.5 10.79 6.89
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe-4337-pack.mdx 60.43 34.12 8.15 11.7 14.25 6.48
  🟢 +0.01 🔴 -0.1 🟢 +0.06 🟢 +0 🔴 -0.12 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.22 49 10.77 12.62 12.34 7.58
  🔴 -0.02 🟢 +0.01 🔴 -0.03 🟢 +0 🟢 +0 🟢 +0.01
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 germartinez changed the title Update Protocol Kit initialization docs: [EIP-1193] Update Protocol Kit initialization May 6, 2024
@yagopv yagopv requested a review from niharrs May 7, 2024 07:37
pages/sdk/protocol-kit.mdx Outdated Show resolved Hide resolved
@germartinez germartinez changed the base branch from main to development May 7, 2024 13:55
@germartinez germartinez merged commit 51c9e64 into development May 7, 2024
3 checks passed
@germartinez germartinez deleted the update-protocolkit-init branch May 7, 2024 13:56
@germartinez germartinez mentioned this pull request May 10, 2024
germartinez added a commit that referenced this pull request May 22, 2024
* Update Protocol Kit initialization

* Add signers and providers fixes

* Fix TransactionOptions

* Update signatures

* Update messages guide

* Update transactions guide

* Update 0x addresses

* Remove unused variables in guides
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.

2 participants