Add specific types for value and gas limit (#822)

.github/workflows/CI-CD-gear-js-api.yml

@@ -71,12 +71,15 @@ jobs:
           file-url: https://unpkg.com/@gear-js/api@latest/package.json
           static-checking: localIsNew
 
+      - name: Install dependencies and build @gear-js/api
+        working-directory: api
+        run: npm ci
+
       - name: Publish
         if: steps.check.outputs.changed == 'true'
-        working-directory: api
+        working-directory: api/lib
         run: |
           export token=$(printenv $(printenv GITHUB_ACTOR))
-          npm ci
           npm config set //registry.npmjs.org/:_authToken=$token
           npm publish
         env:

api/.npmignore

@@ -1,13 +1,13 @@
+.vscode/
 node_modules/
 src/
+examples/
 test/
-using-examples/
-**/tsconfig*
-.prettierrc
-.tslint.json
-.env
-babel.*
-jest.*
-rollup.*
+
+.eslintrc.cjs
+.gitignore
+babel.config.json
+jest.config.js
 package-lock.json
-examples/
+rollup.config.js
+tsconfig*

api/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.23.3
+
+_07/12/2022_
+
+https://github.com/gear-tech/gear-js/pull/822
+
+### Changes
+
+- Add specific types for gas limit and value
+- Update build process
+
+---
+
 ## 0.23.2
 
 _07/12/2022_

api/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@gear-js/api",
-  "version": "0.23.2",
+  "version": "0.23.3",
   "description": "A JavaScript library that provides functionality to connect GEAR Component APIs.",
-  "main": "lib/index.js",
-  "module": "lib/index.mjs",
-  "types": "lib/index.d.ts",
+  "main": "cjs/index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
   "type": "module",
   "author": "Gear Technologies",
   "bugs": {
@@ -29,15 +29,15 @@
     "prepare": "npm run build"
   },
   "exports": {
-    "./cjs/package.json": "./lib/cjs/package.json",
-    "./cjs/*": "./lib/cjs/*.js",
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.js",
     ".": {
-      "import": "./lib/index.js",
-      "require": "./lib/cjs/index.js",
-      "types": "./lib/index.d.ts"
+      "import": "./index.js",
+      "require": "./cjs/index.js",
+      "types": "./index.d.ts"
     },
     "./types": {
-      "import": "./lib/types/index.d.ts"
+      "import": "./types/index.d.ts"
     }
   },
   "license": "GPL-3.0",
@@ -67,8 +67,5 @@
     "rollup-plugin-typescript2": "0.31.2",
     "ts-jest": "28.0.4",
     "typescript": "4.7.3"
-  },
-  "files": [
-    "lib"
-  ]
+  }
 }

api/rollup.config.js

@@ -2,13 +2,22 @@ import typescript from 'rollup-plugin-typescript2';
 import json from '@rollup/plugin-json';
 import nodeResolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
-import { writeFileSync } from 'fs';
+import { writeFileSync, cpSync } from 'fs';
 
-function writeCjsPackageJson() {
+function writePackageJson() {
   return {
-    name: 'write-cjs-package-json',
+    name: 'write-package-json',
     closeBundle() {
       writeFileSync('./lib/cjs/package.json', JSON.stringify({ type: 'commonjs' }));
+      cpSync('./package.json', 'lib/package.json');
+    },
+  };
+}
+function cpReadme() {
+  return {
+    name: 'cp-readme',
+    closeBundle() {
+      cpSync('./README.md', 'lib/README.md');
     },
   };
 }
@@ -51,7 +60,8 @@ export default [
       json(),
       nodeResolve({ preferBuiltins: true, resolveOnly: (module) => !module.includes('polkadot') }),
       commonjs(),
-      writeCjsPackageJson(),
+      writePackageJson(),
+      cpReadme(),
     ],
   },
 ];

api/src/Balance.ts

@@ -1,9 +1,10 @@
-import { ISystemAccountInfo } from './types/interfaces';
+import { SubmittableExtrinsic } from '@polkadot/api/types';
+import { ISubmittableResult } from '@polkadot/types/types';
 import { Balance } from '@polkadot/types/interfaces';
 import { BN } from '@polkadot/util';
+
 import { GearTransaction } from './Transaction';
-import { SubmittableExtrinsic } from '@polkadot/api/types';
-import { ISubmittableResult } from '@polkadot/types/types';
+import { ISystemAccountInfo } from './types';
 import { GearApi } from './GearApi';
 
 export class GearBalance extends GearTransaction {

api/src/Blocks.ts

@@ -1,11 +1,12 @@
-import { GearApi } from './GearApi';
-import { GetBlockError } from './errors';
-import { AnyTuple, AnyNumber } from '@polkadot/types/types';
 import { u64, Compact, GenericExtrinsic, Vec } from '@polkadot/types';
 import { SignedBlock, BlockNumber, BlockHash } from '@polkadot/types/interfaces';
 import { FrameSystemEventRecord } from '@polkadot/types/lookup';
+import { AnyTuple, AnyNumber } from '@polkadot/types/types';
 import { isHex, isU8a } from '@polkadot/util';
+
 import { CreateType } from './create-type';
+import { GetBlockError } from './errors';
+import { GearApi } from './GearApi';
 export class GearBlock {
   protected api: GearApi;
   constructor(api: GearApi) {

api/src/Claim.ts

@@ -1,8 +1,9 @@
 import { SubmittableExtrinsic } from '@polkadot/api/types';
 import { ISubmittableResult } from '@polkadot/types/types';
+
+import { GearTransaction } from './Transaction';
 import { ClaimValueError } from './errors';
 import { Hex } from './types';
-import { GearTransaction } from './Transaction';
 
 /**
  * Claim value from mailbox

api/src/Code.ts

@@ -1,9 +1,10 @@
-import { GearTransaction } from './Transaction';
-import { Hex } from './types';
-import { Bytes } from '@polkadot/types';
-import { generateCodeHash } from './utils';
 import { ISubmittableResult } from '@polkadot/types/types';
 import { SubmittableExtrinsic } from '@polkadot/api/types';
+import { Bytes } from '@polkadot/types';
+
+import { GearTransaction } from './Transaction';
+import { generateCodeHash } from './utils';
+import { Hex } from './types';
 export class GearCode extends GearTransaction {
   /**
    * Submit code without initialization

api/src/Gas.ts

@@ -1,11 +1,12 @@
 import { isHex, isString, isU8a, u8aToHex } from '@polkadot/util';
 import { Codec } from '@polkadot/types-codec/types';
-import { CreateType } from './create-type';
+
+import { GetGasSpentError } from './errors/program.errors';
+import { Hex, PayloadType, Value } from './types';
 import { Metadata } from './types/interfaces';
-import { Hex, PayloadType } from './types';
-import { GearApi } from './GearApi';
+import { CreateType } from './create-type';
 import { createPayload } from './utils';
-import { GetGasSpentError } from './errors/program.errors';
+import { GearApi } from './GearApi';
 import { GasInfo } from './types';
 
 export class GearGas {
@@ -66,7 +67,7 @@ export class GearGas {
     sourceId: Hex,
     code: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     meta?: Metadata,
   ): Promise<GasInfo>;
@@ -97,7 +98,7 @@ export class GearGas {
     sourceId: Hex,
     code: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     typeOfPayload?: string,
   ): Promise<GasInfo>;
@@ -116,7 +117,7 @@ export class GearGas {
     sourceId: Hex,
     code: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo>;
@@ -125,7 +126,7 @@ export class GearGas {
     sourceId: Hex,
     code: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo> {
@@ -171,7 +172,7 @@ export class GearGas {
     sourceId: Hex,
     destinationId: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     meta?: Metadata,
   ): Promise<GasInfo>;
@@ -203,7 +204,7 @@ export class GearGas {
     sourceId: Hex,
     destinationId: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     typeOfPayload?: string,
   ): Promise<GasInfo>;
@@ -222,7 +223,7 @@ export class GearGas {
     sourceId: Hex,
     destinationId: Hex | Buffer,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo>;
@@ -231,7 +232,7 @@ export class GearGas {
     sourceId: Hex,
     destinationId: Hex,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo> {
@@ -275,7 +276,7 @@ export class GearGas {
     messageId: Hex,
     exitCode: number,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     meta?: Metadata,
   ): Promise<GasInfo>;
@@ -311,7 +312,7 @@ export class GearGas {
     messageId: Hex,
     exitCode: number,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     typeOfPayload?: string,
   ): Promise<GasInfo>;
@@ -332,7 +333,7 @@ export class GearGas {
     messageId: Hex,
     exitCode: number,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo>;
@@ -342,7 +343,7 @@ export class GearGas {
     messageId: Hex,
     exitCode: number,
     payload: PayloadType,
-    value?: number | string,
+    value?: Value,
     allowOtherPanics?: boolean,
     metaOrTypeOfPayload?: string | Metadata,
   ): Promise<GasInfo> {

api/src/GearApi.ts

@@ -4,11 +4,11 @@ import { ApiPromise, WsProvider } from '@polkadot/api';
 import { Event } from '@polkadot/types/interfaces';
 
 import { GearMessageReply } from './MessageReply';
-import { GearApiOptions } from './types/interfaces';
 import { gearRpc, gearTypes } from './default';
 import { GearProgramState } from './State';
 import { GearWaitlist } from './Waitlist';
 import { GearClaimValue } from './Claim';
+import { GearApiOptions } from './types';
 import { GearProgram } from './Program';
 import { GearStorage } from './Storage';
 import { GearMailbox } from './Mailbox';

api/src/Keyring.ts

@@ -1,9 +1,10 @@
-import { Keyring } from '@polkadot/api';
-import { KeyringPair, KeyringPair$Json } from '@polkadot/keyring/types';
-import { hexToU8a, isU8a, stringToU8a, isString, u8aToHex } from '@polkadot/util';
 import { mnemonicGenerate, mnemonicToMiniSecret, signatureVerify } from '@polkadot/util-crypto';
+import { hexToU8a, isU8a, stringToU8a, isString, u8aToHex } from '@polkadot/util';
+import { KeyringPair, KeyringPair$Json } from '@polkadot/keyring/types';
 import { Keypair } from '@polkadot/util-crypto/types';
 import { waitReady } from '@polkadot/wasm-crypto';
+import { Keyring } from '@polkadot/api';
+
 import { Hex } from './types';
 
 export class GearKeyring {

api/src/Mailbox.ts

@@ -1,10 +1,10 @@
-import { GearApi } from './GearApi';
-import { StoredMessage } from './types';
-import { MailboxRecord, Hex } from './types';
-import { Option } from '@polkadot/types';
 import { AccountId32, H256 } from '@polkadot/types/interfaces';
 import { UnsubscribePromise } from '@polkadot/api/types';
+import { Option } from '@polkadot/types';
+
+import { MailboxRecord, Hex, StoredMessage } from './types';
 import { GearClaimValue } from './Claim';
+import { GearApi } from './GearApi';
 
 export class GearMailbox {
   api: GearApi;