Merge pull request #1305 from starknet-io/develop

Main Release

Author: penovicp

.github/workflows/_test.yml

@@ -5,6 +5,9 @@ on:
       use-devnet:
         type: boolean
         default: false
+      ignore-scripts:
+        type: boolean
+        default: false
     secrets:
       TEST_RPC_URL:
         required: false
@@ -21,7 +24,7 @@ jobs:
     # TODO - periodically check if conditional services are supported; https://github.com/actions/runner/issues/822
     services:
       devnet:
-        image: ${{ (inputs.use-devnet) && 'shardlabs/starknet-devnet-rs:0.0.7-seed0' || '' }}
+        image: ${{ (inputs.use-devnet) && 'shardlabs/starknet-devnet-rs:0.2.4' || '' }}
         ports:
           - 5050:5050
 
@@ -38,4 +41,6 @@ jobs:
           node-version: lts/*
           cache: 'npm'
       - run: npm ci --ignore-scripts
+      - run: npm run pretest && npm run posttest
+        if: ${{ !inputs.ignore-scripts }}
       - run: npm run test:coverage

.github/workflows/manual-docs-deploy-pages.yml

@@ -0,0 +1,52 @@
+name: '[Manual] Documentation Deploy Pages'
+on: workflow_dispatch
+
+# populate the following environment variables for the "github-pages" environment
+# - default:
+#     ORGANIZATION_NAME
+#     PROJECT_NAME
+#     DEPLOYMENT_BRANCH
+# - custom:
+#     DOCS_BASE_URL
+
+jobs:
+  build:
+    name: Documentation build
+    runs-on: ubuntu-latest
+    environment: github-pages
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: 'npm'
+      - name: Setup
+        run: |
+          npm ci --ignore-scripts
+          cd www/
+          npm ci --ignore-scripts
+      - name: Build
+        run: |
+          rm -rf www/docs/API/
+          npm run docs:build
+        env:
+          DOCS_BASE_URL: ${{ vars.DOCS_BASE_URL || '/starknet.js/' }}
+      - name: Upload
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: www/build
+
+  deploy:
+    name: documentation deploy
+    runs-on: ubuntu-latest
+    needs: [build]
+    permissions:
+      pages: write # to deploy to pages
+      id-token: write # to verify the deployment originates from an appropriate source
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/manual-tests-devnet.yml

@@ -1,5 +1,11 @@
 name: '[Manual] Test Devnet'
-on: workflow_dispatch
+on:
+  workflow_dispatch:
+    inputs:
+      ignore-scripts:
+        description: 'Ignore scripts'
+        type: boolean
+        default: false
 
 jobs:
   tests:
@@ -14,5 +20,6 @@ jobs:
     uses: ./.github/workflows/_test.yml
     with:
       use-devnet: ${{ matrix.TEST_RPC_URL != '' }}
+      ignore-scripts: ${{ inputs.ignore-scripts }}
     secrets:
       TEST_RPC_URL: ${{ matrix.TEST_RPC_URL }}

.github/workflows/manual-tests-testnet.yml

@@ -1,5 +1,11 @@
 name: '[Manual] Test Testnet'
-on: workflow_dispatch
+on:
+  workflow_dispatch:
+    inputs:
+      ignore-scripts:
+        description: 'Ignore scripts'
+        type: boolean
+        default: false
 
 jobs:
   tests:
@@ -10,6 +16,8 @@ jobs:
         name: [rpc-sepolia]
 
     uses: ./.github/workflows/_test.yml
+    with:
+      ignore-scripts: ${{ inputs.ignore-scripts }}
     secrets:
       TEST_RPC_URL: ${{ secrets.TEST_RPC_URL }}
       TEST_ACCOUNT_PRIVATE_KEY: ${{ secrets.TEST_ACCOUNT_PRIVATE_KEY }}

CHANGELOG.md

@@ -111,4 +111,4 @@ For major changes that markedly transform the existing API or significantly alte
 
 If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with `WIP` (Work in progress) in its title and ask questions in the pull request description.
 
-You can also ask your query on our dedicated channel for [Starknet.js](https://discord.com/channels/793094838509764618/927918707613786162) on the [Starknet Discord](https://discord.com/invite/YgsdxEx3)
+You can also ask your query on our dedicated channel for [Starknet.js](https://discord.com/channels/793094838509764618/1270119831559078061) on the [Starknet Discord](https://discord.com/invite/Ft6Xtzdg)

CONTRIBUTING.md

@@ -32,6 +32,9 @@
   <a href="https://twitter.com/starknetjs">
     <img src="https://img.shields.io/badge/follow_us-Twitter-blue">
   </a>
+  <a href="https://www.drips.network/app/projects/github/starknet-io/starknet.js" target="_blank">
+    <img src="https://www.drips.network/api/embed/project/https%3A%2F%2Fgithub.com%2Fstarknet-io%2Fstarknet.js/support.png?background=light&style=github&text=project&stat=none" alt="Support starknet.js on drips.network" height="20">
+  </a>
 </p>
 
 ## Installation
@@ -59,7 +62,7 @@ Play with [Code Examples](https://github.com/PhilippeR26/starknet.js-workshop-ty
 
 If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/starknet-io/starknet.js/blob/main/CONTRIBUTING.md) first.
 
-You can also join our dedicated channel for [Starknet.js](https://discord.com/channels/793094838509764618/927918707613786162) on the [Starknet Discord](https://discord.com/invite/YgsdxEx3)
+You can also join our dedicated channel for [Starknet.js](https://discord.com/channels/793094838509764618/1270119831559078061) on the [Starknet Discord](https://discord.com/invite/starknet-community)
 
 ## ❤️ Special Thanks
 
@@ -69,7 +72,7 @@ Special thanks to all the [contributors](https://github.com/starknet-io/starknet
 
 - Janek ([@janek26](https://github.com/janek26)) and Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Argent](https://github.com/argentlabs)
 
-- Toni ([@tabaktoni](https://github.com/tabaktoni)) and Ivan ([@ivpavici](https://github.com/ivpavici)) from [SpaceShard](https://www.spaceshard.io/)
+- Toni ([@tabaktoni](https://github.com/tabaktoni)), Petar ([@penovicp](https://github.com/penovicp)) and Ivan ([@ivpavici](https://github.com/ivpavici)) from [SpaceShard](https://www.spaceshard.io/)
 
 - Philippe ROSTAN ([@PhilippeR26](https://github.com/PhilippeR26))