penovicp · penovicp · Oct 10, 2023 · Oct 10, 2023 · Oct 16, 2023 · Oct 16, 2023
diff --git a/.eslintrc b/.eslintrc
@@ -5,8 +5,15 @@
     "node": true,
     "jest": true
   },
-  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier", "plugin:prettier/recommended"],
-  "ignorePatterns": ["tsup.config.ts"],
+  "extends": [
+    "airbnb-base",
+    "airbnb-typescript/base",
+    "prettier",
+    "plugin:prettier/recommended"
+  ],
+  "ignorePatterns": [
+    "tsup.config.ts"
+  ],
   "globals": {
     "Atomics": "readonly",
     "SharedArrayBuffer": "readonly"
@@ -17,13 +24,24 @@
     "sourceType": "module",
     "project": "./tsconfig.eslint.json"
   },
-  "plugins": ["@typescript-eslint"],
+  "plugins": [
+    "@typescript-eslint"
+  ],
   "rules": {
     "class-methods-use-this": 0,
     "import/prefer-default-export": 0,
+    "@typescript-eslint/no-redeclare": 0,
     "@typescript-eslint/naming-convention": 0,
-    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
-    "@typescript-eslint/no-use-before-define": ["error", "nofunc"],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/no-use-before-define": [
+      "error",
+      "nofunc"
+    ],
     "func-names": 0
   }
 }
diff --git a/.github/workflows/_test.yml b/.github/workflows/_test.yml
@@ -21,7 +21,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:85495efb71a37ad3921c8986474b7e78a9a9f5fc-amd-seed0' || '' }}
+        image: ${{ (inputs.use-devnet) && 'shardlabs/starknet-devnet-rs:0.2.2' || '' }}
         ports:
           - 5050:5050
 
@@ -38,4 +38,4 @@ jobs:
           node-version: lts/*
           cache: 'npm'
       - run: npm ci --ignore-scripts
-      - run: npm test
+      - run: npm run test:coverage
diff --git a/.github/workflows/manual-docs-deploy-pages.yml b/.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
diff --git a/.github/workflows/manual-tests-testnet.yml b/.github/workflows/manual-tests-testnet.yml
@@ -7,7 +7,7 @@ jobs:
     strategy:
       max-parallel: 1
       matrix:
-        name: [rpc-goerli]
+        name: [rpc-sepolia]
 
     uses: ./.github/workflows/_test.yml
     secrets:

diff --git a/.github/workflows/pr-push-main.yml b/.github/workflows/pr-push-main.yml
@@ -40,7 +40,7 @@ jobs:
     strategy:
       max-parallel: 1
       matrix:
-        name: [rpc-goerli]
+        name: [rpc-sepolia]
 
     uses: ./.github/workflows/_test.yml
     secrets:

diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,9 @@
 .env
 .eslintcache
 .vscode
+.idea
 coverage
+coverage-ts
 dist
 node_modules
 npm-debug.log

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx --no-install commitlint --edit "$1"
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx lint-staged
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,15 +6,20 @@ If you want to contribute but don’t know what to do, take a look at these two
 
 _[Use GitHub interface](https://blog.sapegin.me/all/open-source-for-everyone/) for simple documentation changes, otherwise follow the steps below._
 
+> :warning: IMPORTANT NOTE :warning:
+>
+> All contributions are expected to be of the highest possible quality! That means the PR is thoroughly tested and documented, and without blindly generated ChatGPT code and documentation! We will not consider nor merge PR-s that do not comply to these rules!
+
 ## Prerequisites
 
 - If it’s your first pull request, watch [this amazing course](http://makeapullrequest.com/) by [Kent C. Dodds](https://twitter.com/kentcdodds).
 - Fork the repository and clone your fork.
+- Checkout to the `develop` branch.
 - Install dependencies: `npm install`.
 
 ## Development workflow
 
-Start from the `develop` branch.
+Start from the `develop` branch (or `next-version` if latest).
 
 To build your changes, run:
 
@@ -34,15 +39,27 @@ Or run tests in watch mode:
 npm test --watch
 ```
 
-By default the tests are executed in your local Devnet. If you want to use a specific rpc node, you have to set some global variables before executing the tests :
+By default the tests are executed in your local Devnet and everything should run automatically.
+
+If you want to use a specific RPC node, you have to set some global variables before executing the tests:
 
 ```bash
-export TEST_RPC_URL=http://192.168.1.44:9545/rpc/v0.5 # example of a Pathfinder node located in your local network
-export TEST_RPC_URL=https://starknet-testnet.public.blastapi.io/rpc/v0.5 # example of a public testnet node
+export TEST_RPC_URL=http://192.168.1.44:9545/rpc/v0_7 # example of a Pathfinder node located in your local network
+export TEST_RPC_URL=https://starknet-sepolia.public.blastapi.io/rpc/v0_7 # example of a public Sepolia testnet node
 export TEST_ACCOUNT_ADDRESS=0x065A822f0000000000000000000000000c26641
 export TEST_ACCOUNT_PRIVATE_KEY=0x02a80000000000000000000000001754438a
 ```
 
+The global variables above will only be valid for some of the tests.
+The recommended and more straightforward approach is to go with the docker.
+You just need to do the following steps:
+
+- Install [Docker](https://docs.docker.com/engine/install/) (it can also be installed via a package manager, e.g. `brew` for Mac)
+- Run `Docker` on your machine (open the application).
+- Go to the [starknet-devnet-rs](https://hub.docker.com/r/shardlabs/starknet-devnet-rs/tags) and copy the `docker pull` command from the latest tag
+- Run `docker pull shardlabs/starknet-devnet-rs:latest` in your terminal
+- Run tests locally with `npm run test`
+
 **Don’t forget to add tests and [update documentation](./www/README.md) for your changes.**
 Documentation can be archived by using JSDoc.
 
@@ -86,7 +103,12 @@ For major changes that markedly transform the existing API or significantly alte
 - We’re using [Prettier](https://github.com/prettier/prettier) to format code, so don’t worry much about code formatting.
 - Don’t commit generated files, like minified JavaScript.
 - Don’t change the version number or changelog.
+- Use `npm run test:coverage` for a complete project test coverage.
+- Use for example `npm run test:coverage __tests__/utils/uint256.test.ts` for a single file coverage.
+- Use `npm run ts:coverage` to check the global type coverage rate and `npm run ts:coverage:report` to generate a complete report (summary displayed in the console, full HTML report available in the `coverage-ts` folder by launching `./coverage-ts/index.html` in your browser) and find files having low coverage.
 
 ## Need help?
 
 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)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Sean James Han
+Copyright (c) StarkWare Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -34,32 +34,33 @@
   </a>
 </p>
 
-## 🕹️ Usage
-
-Install starknet with `npm`
+## Installation
 
 ```bash
 # latest official release (main branch)
 $ npm install starknet
 
-# or for latest pre-release version (develop branch):
+# or for latest pre-release version (develop branch)
 $ npm install starknet@next
+
+# or for latest beta release version (beta branch)
+$ npm install starknet@beta
 ```
 
 Import `starknet` and use the [API](https://www.starknetjs.com/docs/API/).
 
-## 🌐 API
+## 🌐 Documentation
 
-[Click Here](https://www.starknetjs.com/docs/API/)
+How to [Guides](https://www.starknetjs.com/docs/guides/intro) :book: & [API](https://www.starknetjs.com/docs/API/) 💻
 
-Please refer to the following code examples [here](https://github.com/PhilippeR26/starknet.js-workshop-typescript)! :video_game:
-
-Guides can be found [here](https://www.starknetjs.com/docs/guides/intro) :book:
+Play with [Code Examples](https://github.com/PhilippeR26/starknet.js-workshop-typescript) :video_game:
 
 ## ✏️ Contributing
 
 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)
+
 ## ❤️ Special Thanks
 
 Special thanks to all the [contributors](https://github.com/starknet-io/starknet.js/graphs/contributors), especially to:
@@ -68,7 +69,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))
 
@@ -78,6 +79,6 @@ This library would not be possible without these rockstars.
 
 ## 📜 License
 
-Copyright (c) 2023 StarkWare
+Copyright (c) 2024 StarkWare
 
 Licensed under the [MIT license](https://github.com/starknet-io/starknet.js/blob/main/LICENSE).