starknet 0.1.4 → 1.1.0

package/.babelrc

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    ["@babel/preset-env", { "targets": { "node": "current" } }],
+    "@babel/preset-typescript"
+  ]
+}

package/.commitlintrc

@@ -0,0 +1,12 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ],
+  "rules": {
+    "body-max-line-length": [
+      0,
+      "always",
+      100
+    ]
+  }
+}

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

package/.eslintrc

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true,
+    "jest": true
+  },
+  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier", "plugin:prettier/recommended", ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module",
+    "project": "./tsconfig.eslint.json"
+  },
+  "plugins": ["@typescript-eslint"]
+}

package/.github/workflows/docs-bot.yml

@@ -0,0 +1,25 @@
+name: Docs Bot
+on:
+  push:
+    branches-ignore:
+      - main
+      - develop
+    paths:
+      - 'src/'
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+      - run: npm ci
+      - run: npm run docs
+      - name: Do git actions
+        run: |
+          git config user.email "janek@argent.xyz"
+          git config user.name "Docs Bot"
+          git add --force -- docs/README.md
+          git commit -m "docs: add generated docs"
+          git push

package/.github/workflows/pr.yml

@@ -0,0 +1,23 @@
+name: PR check
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 14.x
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+      - develop
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 14
+        uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+      - uses: actions/upload-artifact@v2
+        with:
+          name: build
+          path: dist
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [build-and-test]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+      - run: npm ci
+      - uses: actions/download-artifact@v2
+        with:
+          name: build
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/{.prettierrc.json → .prettierrc}

@@ -2,6 +2,5 @@
   "printWidth": 100,
   "tabWidth": 2,
   "singleQuote": true,
-  "jsxBracketSameLine": true,
   "trailingComma": "es5"
 }

package/.releaserc

@@ -0,0 +1,28 @@
+{
+  "branches": [
+    "main",
+    {
+      "name": "develop",
+      "channel": "next"
+    }
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "docs/README.md",
+          "package.json",
+          "CHANGELOG.md"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "repositoryUrl": "https://github.com/seanjameshan/starknet.js"
+}

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# [1.1.0](https://github.com/seanjameshan/starknet.js/compare/v1.0.0...v1.1.0) (2021-10-24)
+
+### Bug Fixes
+
+- btoa isomorphic ([f3eb0f5](https://github.com/seanjameshan/starknet.js/commit/f3eb0f5aa01647c0994935b72b723bd13f940faa))
+- json formatting and deploy ([0fe7e3d](https://github.com/seanjameshan/starknet.js/commit/0fe7e3d50c4ebcbc64f30611b1888c966452c910))
+- pr review ([457a852](https://github.com/seanjameshan/starknet.js/commit/457a85266de6cd548a15af1dc866671f3664f418))
+- test ([c307390](https://github.com/seanjameshan/starknet.js/commit/c3073902e838bd9e07f783c13e546e298356e16b))
+- test browser and node ([4c23de0](https://github.com/seanjameshan/starknet.js/commit/4c23de0ef510724fa33e1c3cbb00bc638acb54c2))
+- test structure ([b686f04](https://github.com/seanjameshan/starknet.js/commit/b686f04dc5f74e6042cbd30ec56eeb4ef6b9c45b))
+- tests regarding compressing ([21a83f2](https://github.com/seanjameshan/starknet.js/commit/21a83f25bbb88875854ad3d0cb5f7c7fa1ebacd4))
+- update package-lock ([cd373cb](https://github.com/seanjameshan/starknet.js/commit/cd373cbd8df98f3d973e4076f15681927325c9e2))
+
+### Features
+
+- add deploy ([509fa84](https://github.com/seanjameshan/starknet.js/commit/509fa84532ab5a1a46863edbe63d7538ddacfbc8))
+
+# 1.0.0 (2021-10-21)
+
+### Bug Fixes
+
+- badge ([6a0a989](https://github.com/seanjameshan/starknet.js/commit/6a0a9893c1298a815aec21abda20f78ac697a4bf))
+- ci git push ([571b1d5](https://github.com/seanjameshan/starknet.js/commit/571b1d5092ee18b9ed0828f1cbc834f4aece3363))
+- ci job ([31d1b8d](https://github.com/seanjameshan/starknet.js/commit/31d1b8d7717145a5dd7beef606a9c253d1ceb62d))
+- naming pipeline ([f16427f](https://github.com/seanjameshan/starknet.js/commit/f16427f8a33b46a51d37ad7fbe8a3f34edcf344e))
+- pipeline ([f9186de](https://github.com/seanjameshan/starknet.js/commit/f9186de8f72d80d212317d8c823b981b7df31920))
+- pipeline ([c7d56d0](https://github.com/seanjameshan/starknet.js/commit/c7d56d06644108d71e1bea3e73554b5c4178b82e))
+- pipeline ([d46d175](https://github.com/seanjameshan/starknet.js/commit/d46d175aa9d51f283e2dd9aeeac41ab50fa3ac2e))
+- split pipelines ([e862cfb](https://github.com/seanjameshan/starknet.js/commit/e862cfbf13d9e6d3509b609a31f8ebad1a31569a))
+- tests ([6a242ce](https://github.com/seanjameshan/starknet.js/commit/6a242cedc0a261c55a433ee5a82f0acf28cfcdc2))
+
+### Features
+
+- change src code ([5fe4630](https://github.com/seanjameshan/starknet.js/commit/5fe4630a53a75c0387854b1cd53e5aa2c6b259eb))
+- project tooling ([eee89aa](https://github.com/seanjameshan/starknet.js/commit/eee89aa92cab7b7df3a9a7ae439c4df7d1e893b0))
+- start adding types ([3760687](https://github.com/seanjameshan/starknet.js/commit/3760687a0c72da7ac8c0fd2427d471fe4bdf7202))

package/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# How to contribute
+
+We love pull requests. And following this guidelines will make your pull request easier to merge.
+
+If you want to contribute but don’t know what to do, take a look at these two labels: [help wanted](https://github.com/seanjameshan/starknet/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/seanjameshan/starknet/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+
+_[Use GitHub interface](https://blog.sapegin.me/all/open-source-for-everyone/) for simple documentation changes, otherwise follow the steps below._
+
+## 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.
+- Install dependencies: `npm install`.
+
+## Development workflow
+
+ALways start from `develop` branch and merge back to `develop` branch.
+
+To build you changes run:
+
+```bash
+npm build
+```
+
+Run linters and tests:
+
+```bash
+npm test
+```
+
+Or run tests in watch mode:
+
+```bash
+npm run test --watch
+```
+
+**Don’t forget to add tests and update documentation for your changes.**
+Documentation can be archived by using JSDoc.
+
+**Please update npm lock file (`package-lock.json`) if you add or update dependencies.**
+
+## Other notes
+
+- If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
+- We’re using [Prettier](https://github.com/prettier/prettier) to format code, so don’t worry much about code formatting.
+- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), like so: `feat(scope): topic`
+- Don’t commit generated files, like minified JavaScript.
+- Don’t change version number and changelog.
+
+## 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.

package/README.md

@@ -8,21 +8,39 @@
 
 <!-- primary badges -->
 <p align="center">
-  <img src='https://img.shields.io/github/package-json/v/seanjameshan/starknet.js?label=npm' />
-  <img src='https://img.shields.io/bundlephobia/minzip/starknet?color=success&label=size' />
-  <!-- <img src='https://img.shields.io/npm/dt/starknet?color=blueviolet' /> -->
-  <img src="https://img.shields.io/badge/license-MIT-black">
-  <img src='https://img.shields.io/github/stars/seanjameshan/starknet.js?color=yellow' />
-  <img src='https://img.shields.io/github/followers/seanjameshan?color=red' />
-  <img src="https://img.shields.io/badge/powered_by-StarkWare-navy">
+  <a href="https://github.com/seanjameshan/starknet.js/actions">
+    <img src="https://img.shields.io/github/workflow/status/seanjameshan/starknet.js/Release">
+  </a>
+  <a href="https://www.npmjs.com/package/starknet">
+    <img src='https://img.shields.io/github/package-json/v/seanjameshan/starknet.js?label=npm' />
+  </a>
+  <a href="https://bundlephobia.com/package/starknet">
+    <img src='https://img.shields.io/bundlephobia/minzip/starknet?color=success&label=size' />
+  </a>
+  <a href="https://www.npmjs.com/package/starknet">
+    <img src='https://img.shields.io/npm/dt/starknet?color=blueviolet' />
+  </a>
+  <a href="https://github.com/seanjameshan/starknet.js/blob/main/LICENSE/">
+    <img src="https://img.shields.io/badge/license-MIT-black">
+  </a>
+  <a href="https://github.com/seanjameshan/starknet.js/stargazers">
+    <img src='https://img.shields.io/github/stars/seanjameshan/starknet.js?color=yellow' />
+  </a>
+  <a href="https://starkware.co/">
+    <img src="https://img.shields.io/badge/powered_by-StarkWare-navy">
+  </a>
 </p>
 
 ## 🕹️ Usage
-Install the starknet with `npm`
+
+Install starknet with `npm`
+
 ```bash
 $ npm install starknet
 ```
-Import `starknet` and use the [API](https://github.com/seanjameshan/starknet.js/blob/main/docs/Home.md)
+
+Import `starknet` and use the [API](docs)
+
 ```javascript
 import starknet from 'starknet';
 
@@ -32,9 +50,15 @@ starknet.getContractAddresses().then((data) => {
 ```
 
 ## 🌐 API
-[Click Here](https://github.com/seanjameshan/starknet.js/blob/main/docs/Home.md)
+
+[Click Here](docs)
+
+## Contributing
+
+If you consider to contribute to this project please read [CONTRIBUTING.md](CONTRIBUTING.md) first.
 
 ## License
+
 Copyright (c) 2021 Sean James Han
 
-Licensed under the MIT license.
+Licensed under the [MIT license](LICENSE).