Add presets page update on release workflow

.github/workflows/prepare-release.yml

@@ -1,8 +1,11 @@
-name: Update version on new release branch
+name: Update version and presets page on new release branch
 
 on:
   create:
 
+env:
+  SCARB_VERSION: 2.5.3
+
 jobs:
   update_version:
     if: github.ref_type == 'branch' && startsWith(github.ref, 'refs/heads/release-v')
@@ -26,7 +29,24 @@ jobs:
       run: |
         echo "Current version: $CURRENT_VERSION"
         echo "New version: $NEW_VERSION"
-        find . -type f -not -path '*/\.*' -not -path './CHANGELOG.md' -not -path './docs/package-lock.json' -not -path './RELEASING.md' -exec sed -i "s/$CURRENT_VERSION/$NEW_VERSION/g" {} +
+        find . -type f -not -path '*/\.*' -not -path './CHANGELOG.md' -not -path './docs/package-lock.json' \
+          -not -path './RELEASING.md' -exec sed -i "s/$CURRENT_VERSION/$NEW_VERSION/g" {} +
+
+    - name: Setup scarb
+      uses: software-mansion/setup-scarb@v1
+      id: setup_scarb
+      with:
+        scarb-version: ${{ env.SCARB_VERSION }}
+
+    - name: Setup class_hash
+      uses: ericnordelo/setup-class-hash@c14dd33506c3eb8e1acfe2ade9f82585f5acf28c
+      with:
+        version: "0.1.0"
+
+    - name: Update presets page
+      run: |
+        class_hash get --json | sed -e '1,4d' | python3 scripts/get_hashes_page.py v${{ env.SCARB_VERSION }} \
+          > ./docs/modules/ROOT/pages/utils/_class_hashes.adoc
 
     - name: Auto-commit changes
       uses: stefanzweifel/git-auto-commit-action@3ea6ae190baf489ba007f7c92608f33ce20ef04a #v4.16.0

CHANGELOG.md

@@ -18,7 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump scarb to v2.4.4 (#853)
 - Bump scarb to v2.5.3 (#898)
 - OwnershipTransferred event args are indexed (#809)
-  
+
 ### Removed
 
 - Non standard increase_allowance and decrease_allowance functions in ERC20 contract (#881)
@@ -42,4 +42,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support higher tx versions in Account (#858)
 - Bump scarb to v2.4.1 (#858)
 - Add security section to Upgrades docs (#861)
-

docs/modules/ROOT/pages/api/account.adoc

@@ -482,7 +482,7 @@ include::../utils/_class_hashes.adoc[]
 [.contract-index]
 .{presets-page}
 --
-{account-class-hash}
+{Account-class-hash}
 --
 
 [.contract-index]
@@ -534,7 +534,7 @@ include::../utils/_class_hashes.adoc[]
 [.contract-index]
 .{presets-page}
 --
-{eth-account-upgradeable-class-hash}
+{EthAccountUpgradeable-class-hash}
 --
 
 [.contract-index]

docs/modules/ROOT/pages/api/erc20.adoc

@@ -420,7 +420,7 @@ include::../utils/_class_hashes.adoc[]
 [.contract-index]
 .{presets-page}
 --
-{erc20-class-hash}
+{ERC20-class-hash}
 --
 
 [.contract-index]

docs/modules/ROOT/pages/api/erc721.adoc

@@ -615,7 +615,7 @@ include::../utils/_class_hashes.adoc[]
 [.contract-index]
 .{presets-page}
 --
-{erc721-class-hash}
+{ERC721-class-hash}
 --
 
 [.contract-index]

docs/modules/ROOT/pages/presets.adoc

@@ -27,16 +27,16 @@ NOTE: Class hashes were computed using {class-hash-cairo-version}.
 | Name | Sierra Class Hash
 
 | `{account}`
-| `{account-class-hash}`
+| `{Account-class-hash}`
 
 | `{eth-account-upgradeable}`
-| `{eth-account-upgradeable-class-hash}`
+| `{EthAccountUpgradeable-class-hash}`
 
 | `{erc20}`
-| `{erc20-class-hash}`
+| `{ERC20-class-hash}`
 
 | `{erc721}`
-| `{erc721-class-hash}`
+| `{ERC721-class-hash}`
 |===
 
 TIP: {starkli} class-hash command can be used to compute the class hash from a Sierra artifact.

docs/modules/ROOT/pages/utils/_class_hashes.adoc

@@ -2,10 +2,10 @@
 :class-hash-cairo-version: https://crates.io/crates/cairo-lang-compiler/2.5.3[cairo 2.5.3]
 
 // Class Hashes
-:account-class-hash: 0x01148c31dfa5c4708a4e9cf1eb0fd3d4d8ad9ccf09d0232cd6b56bee64a7de9d
-:eth-account-upgradeable-class-hash: 0x023e416842ca96b1f7067693892ed00881d97a4b0d9a4c793b75cb887944d98d
-:erc20-class-hash: 0x07c9b5a246fe83b0cd81de65daddb94b3803f94950db99bf2431bbfecf284642
-:erc721-class-hash: 0x06b7c9efc5467c621f58d87995302d940a39b7217b5c5a7a55555c97cabf5cd8
+:Account-class-hash: 0x01148c31dfa5c4708a4e9cf1eb0fd3d4d8ad9ccf09d0232cd6b56bee64a7de9d
+:ERC20-class-hash: 0x07c9b5a246fe83b0cd81de65daddb94b3803f94950db99bf2431bbfecf284642
+:ERC721-class-hash: 0x06b7c9efc5467c621f58d87995302d940a39b7217b5c5a7a55555c97cabf5cd8
+:EthAccountUpgradeable-class-hash: 0x023e416842ca96b1f7067693892ed00881d97a4b0d9a4c793b75cb887944d98d
 
 // Presets page
 :presets-page: xref:presets.adoc[Sierra class hash]

scripts/get_presets_page.py

@@ -0,0 +1,36 @@
+import sys
+import json
+
+
+def main():
+    # Required compiler version argument
+    cmp_version = sys.argv[1]
+
+    # Read class hashes from stdin
+    contracts = json.load(sys.stdin)
+
+    print(generate_doc_file(cmp_version, contracts))
+
+
+def generate_doc_file(cmp_version, contracts):
+    header = f"""// Version
+:class-hash-cairo-version: \
+https://crates.io/crates/cairo-lang-compiler/{cmp_version}[cairo {cmp_version}]
+"""
+    hashes = "// Class Hashes\n"
+    for contract in contracts['contracts']:
+        # The [13:] is to remove the "openzeppelin_" prefix from the contract name
+        hashes += f":{contract['name'][13:]}-class-hash: {normalize_len(contract['sierra'])}\n"
+
+    footer = """// Presets page
+:presets-page: xref:presets.adoc[Sierra class hash]"""
+
+    return f"{header}\n{hashes}\n{footer}\n"
+
+
+def normalize_len(sierra_hash):
+    return "0x" + "0" * (66 - len(sierra_hash)) + sierra_hash[2:]
+
+
+if __name__ == '__main__':
+    main()