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

Sdk new release updates #690

Merged
merged 32 commits into from
Feb 27, 2025
Merged

Sdk new release updates #690

merged 32 commits into from
Feb 27, 2025

Conversation

yagopv
Copy link
Member

@yagopv yagopv commented Feb 13, 2025

We are launching a major version of the SDK and this PR will reflect some breaking changes in our kits

Copy link

github-actions bot commented Feb 13, 2025

Branch preview

✅ Deployed successfully in branch deployment:

https://sdk_new_release_updates--docs.review.5afe.dev

Copy link

github-actions bot commented Feb 13, 2025

Overall readability score: 36.01 (🟢 +0.61)

File Readability
overview.mdx 41.38 (🟢 +0)
safe-4337-pack.mdx 60.29 (🟢 +0.42)
migrate-to-v4.md 56.08 (-)
4337-safe-sdk.mdx 30.75 (🟢 +0)
migrate-to-v6.md 82.03 (-)
migrate-to-v3.md 3.63 (-)
sendsafeoperation.mdx 46.06 (🔴 -2.41)
gettokenlist.mdx 50.47 (🟢 +47.65)
getsafeoperationsbyaddress.mdx 51.66 (🟢 +22.03)
getsafeoperationconfirmations.mdx 27.78 (🟢 +6.05)
getsafeoperation.mdx 18.98 (🟢 +6.21)
getpendingtransactions.mdx 43.76 (🟢 +23.79)
getpendingsafeoperations.mdx 36.46 (-)
getmultisigtransactions.mdx 37.28 (🟢 +28.05)
getmoduletransactions.mdx 34.89 (🟢 +21.69)
getmessages.mdx 25.4 (🟢 +0)
getincomingtransactions.mdx 26.92 (🟢 +13.16)
decodedata.mdx 18.1 (🟢 +13.05)
confirmsafeoperation.mdx 30.58 (🟢 +8.12)
addsafeoperation.mdx 19.92 (🟢 +1.12)
addmessage.mdx 20.56 (🟢 +0)
messages.mdx 6.62 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
overview.mdx 41.38 32.39 10.83 15.3 16.81 8.14
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe-4337-pack.mdx 60.29 34.22 8.19 11.7 14.13 6.56
  🟢 +0.42 🟢 +0.2 🔴 -0.01 🟢 +0.1 🟢 +0.3 🔴 -0.05
migrate-to-v4.md 56.08 37.71 10.26 12.3 13.16 7.1
  - - - - - -
4337-safe-sdk.mdx 30.75 36.76 17.32 20.8 11.91 7.87
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v6.md 82.03 76.72 9.82 6.2 8.04 6.27
  - - - - - -
migrate-to-v3.md 3.63 0 19 22 19 9.87
  - - - - - -
sendsafeoperation.mdx 46.06 38.52 10.32 15.5 14.96 7.99
  🔴 -2.41 🔴 -1.83 🔴 -0.76 🔴 -0.5 🟢 +0.17 🔴 -0.1
gettokenlist.mdx 50.47 49.82 8.28 16.7 14.54 7.93
  🟢 +47.65 🟢 +42.29 🟢 +10.72 🟢 +5.3 🟢 +4.46 🟢 +2.58
getsafeoperationsbyaddress.mdx 51.66 33.81 9.17 14.5 14.78 7.15
  🟢 +22.03 🟢 +8.56 🟢 +1.19 🟢 +6.5 🟢 +4.22 🟢 +0.99
getsafeoperationconfirmations.mdx 27.78 29.65 12.41 20.6 17.86 8.53
  🟢 +6.05 🟢 +9.27 🟢 +0.27 🟢 +1.4 🟢 +1.14 🟢 +0.13
getsafeoperation.mdx 18.98 21.4 13.07 22 19 9.36
  🟢 +6.21 🟢 +18.45 🟢 +0.79 🟢 +0 🟢 +0 🟢 +0.56
getpendingtransactions.mdx 43.76 41.66 9.12 17.4 16.46 7.99
  🟢 +23.79 🟢 +15.15 🟢 +4.12 🟢 +4.6 🟢 +2.54 🟢 +1.23
getpendingsafeoperations.mdx 36.46 33 10.49 18.5 17.1 8.31
  - - - - - -
getmultisigtransactions.mdx 37.28 35.23 9.08 18.8 18.02 8.38
  🟢 +28.05 🟢 +35.23 🟢 +5.9 🟢 +3.2 🟢 +0.98 🟢 +1.89
getmoduletransactions.mdx 34.89 32.49 9.54 19.9 17.86 8.31
  🟢 +21.69 🟢 +25.14 🟢 +4.64 🟢 +2.1 🟢 +1.14 🟢 +1.53
getmessages.mdx 25.4 15.57 10.73 22 19 8.31
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
getincomingtransactions.mdx 26.92 25.46 10.13 21.9 19 8.71
  🟢 +13.16 🟢 +24.54 🟢 +3.82 🟢 +0.1 🟢 +0 🟢 +0.75
decodedata.mdx 18.1 28.54 13.88 22 18.56 9.76
  🟢 +13.05 🟢 +28.54 🟢 +2.17 🟢 +0 🟢 +0.44 🟢 +1.24
confirmsafeoperation.mdx 30.58 37.3 12.92 19.1 16.35 9.12
  🟢 +8.12 🟢 +9.47 🟢 +0.39 🟢 +2.3 🟢 +1.28 🟢 +0.23
addsafeoperation.mdx 19.92 3.16 12.54 22 19 8.41
  🟢 +1.12 🟢 +3.16 🟢 +0.22 🟢 +0 🟢 +0 🟢 +0.07
addmessage.mdx 20.56 10.77 11.27 22 19 9.28
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
messages.mdx 6.62 0 19 22 19 8.94
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 36.01 31.97 13.13 16.57 15.2 8.69
  🟢 +0.61 🟢 +0.65 🟢 +0.1 🟢 +0.09 🟢 +0.05 🟢 +0.04
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

@yagopv yagopv marked this pull request as ready for review February 14, 2025 12:01
@yagopv yagopv linked an issue Feb 14, 2025 that may be closed by this pull request
@yagopv yagopv requested a review from dasanra February 20, 2025 11:00
@louis-md louis-md self-requested a review February 27, 2025 13:50
@louis-md louis-md self-requested a review February 27, 2025 14:19
@louis-md louis-md merged commit c1c4c17 into main Feb 27, 2025
3 of 4 checks passed
@louis-md louis-md deleted the sdk-new-release-updates branch February 27, 2025 14:20
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.

[4337]: New release documentation
3 participants