chore: merge conflicts and small fixes

Author: Sean Han

.github/workflows/release.yml

@@ -30,7 +30,6 @@ jobs:
         with:
           node-version: lts/*
       - run: npm ci
-      - run: npm run docs
       - uses: actions/download-artifact@v2
         with:
           name: build

.gitignore

@@ -3,4 +3,5 @@ dist
 npm-debug.log
 .env
 .DS_Store
+docs
 .eslintcache

.releaserc

@@ -15,7 +15,6 @@
       "@semantic-release/git",
       {
         "assets": [
-          "docs/README.md",
           "package.json",
           "CHANGELOG.md"
         ],

README.md

@@ -42,10 +42,10 @@ Install starknet with `npm`
 $ npm install starknet
 ```
 
-Import `starknet` and use the [API](docs)
+Import `starknet` and use the [API](https://www.starknetjs.com/modules.html)
 
 ```javascript
-import starknet from 'starknet';
+import * as starknet from 'starknet';
 
 starknet.getContractAddresses().then((data) => {
   console.log(data);
@@ -54,14 +54,14 @@ starknet.getContractAddresses().then((data) => {
 
 ## 🌐 API
 
-[Click Here](docs)
+[Click Here](https://www.starknetjs.com/modules.html)
 
 ## Contributing
 
-If you consider to contribute to this project please read [CONTRIBUTING.md](CONTRIBUTING.md) first.
+If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/seanjameshan/starknet.js/blob/main/CONTRIBUTING.md) first.
 
 ## License
 
 Copyright (c) 2021 Sean James Han
 
-Licensed under the [MIT license](LICENSE).
+Licensed under the [MIT license](https://github.com/seanjameshan/starknet.js/blob/main/LICENSE).

__tests__/contracts.test.ts

@@ -13,7 +13,7 @@ const compiledERC20: CompiledContract = JsonParser.parse(
   fs.readFileSync('./__mocks__/ERC20.json').toString('ascii')
 );
 
-describe('new Contract()', () => {
+describe('class Contract {}', () => {
   const address = randomAddress();
   const wallet = randomAddress();
   const contract = new Contract(compiledERC20.abi, address);

docs/.nojekyll

@@ -11,7 +11,7 @@
     "test": "jest",
     "posttest": "npm run format",
     "test:watch": "jest --watch",
-    "docs": "typedoc --readme none --name 'StarkNet.js Docs' --excludeNotDocumented --disableSources",
+    "docs": "typedoc",
     "format": "prettier --loglevel warn --write \"**/*.{ts,js,md,yml,json}\"",
     "lint": "eslint . --cache --fix --ext .ts"
   },
@@ -51,7 +51,6 @@
     "lint-staged": "^11.2.3",
     "prettier": "^2.4.1",
     "typedoc": "^0.22.6",
-    "typedoc-plugin-markdown": "^3.11.3",
     "typescript": "^4.4.4"
   },
   "dependencies": {

docs/README.md

@@ -2,7 +2,7 @@ import axios from 'axios';
 import { randomAddress, compressProgram, JsonParser } from './utils';
 import type {
   GetBlockResponse,
-  GetCode,
+  GetCodeResponse,
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
@@ -82,10 +82,10 @@ export function getBlock(blockId: number): Promise<GetBlockResponse> {
  * @param blockId
  * @returns Bytecode and ABI of compiled contract
  */
-export function getCode(contractAddress: string, blockId: number): Promise<GetCode> {
+export function getCode(contractAddress: string, blockId: number): Promise<GetCodeResponse> {
   return new Promise((resolve, reject) => {
     axios
-      .get<GetCode>(
+      .get<GetCodeResponse>(
         `${FEEDER_GATEWAY_URL}/get_code?contractAddress=${contractAddress}&blockId=${blockId}`
       )
       .then((resp) => {