Merge pull request #35 from AcalaNetwork/auto-version

v6

.eslintignore

@@ -1,4 +1,5 @@
 **/build/*
+**/dist/*
 **/coverage/*
 **/node_modules/*
 **/configs/*

.eslintrc.js

@@ -1,27 +1,64 @@
-const base = require('@polkadot/dev/config/eslint.cjs');
-
 module.exports = {
-  ...base,
-  ignorePatterns: [
-    '.eslintrc.js',
-    '.github/**',
-    '.vscode/**',
-    '.yarn/**',
-    '**/build/*',
-    '**/coverage/*',
-    '**/node_modules/*'
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'import', 'sort-imports-es6-autofix'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
   ],
-  parserOptions: {
-    project: ['./tsconfig.eslint.json']
-  },
   rules: {
-    ...base.rules,
-    '@typescript-eslint/no-explicit-any': 'off',
-    'import/extensions': 'off',
-    'header/header': 'off',
-    'sort-keys': 'off',
-    '@typescript-eslint/no-unsafe-assignment': 'off',
-    '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-return': 'off',
-  }
+    indent: [2, 2, { SwitchCase: 1 }],
+    quotes: [2, 'single'],
+    semi: [1, 'always'],
+    'no-trailing-spaces': [2],
+    'quote-props': [2, 'as-needed'],
+    'eol-last': [2, 'always'],
+    'object-curly-spacing': [2, 'always'],
+    'comma-dangle': [2, {
+      arrays: 'always-multiline',
+      objects: 'always-multiline',
+      imports: 'always-multiline',
+      exports: 'always-multiline',
+      functions: 'only-multiline',
+    }],
+
+    /* ---------- turn off ---------- */
+    '@typescript-eslint/no-extra-semi': 0,
+    '@typescript-eslint/no-use-before-define': 0,
+    '@typescript-eslint/explicit-member-accessibility': 0,
+    '@typescript-eslint/naming-convention': 0,
+    '@typescript-eslint/no-explicit-any': 0, // any is sometimes unavoidable
+    '@typescript-eslint/consistent-type-definitions': 0, // can use Type and Interface
+    '@typescript-eslint/explicit-function-return-type': 0, // type inference on return type is useful
+    '@typescript-eslint/no-parameter-properties': 0,
+    '@typescript-eslint/typedef': 0,
+    'no-unused-expressions': 0, // short ciucuit if
+    'max-lines': 0,
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    'sort-imports-es6-autofix/sort-imports-es6': 'warn',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    'no-useless-escape': 'off',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
+    'import/no-named-as-default-member': 'off',
+    'import/no-named-as-default': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        caughtErrorsIgnorePattern: '^_',
+      },
+    ],
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project: './tsconfig.json',
+      },
+    },
+  },
 };

.github/workflows/publish.yml

@@ -17,5 +17,6 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
           yarn install --immutable | grep -v 'YN0013'
-          yarn build:release
+          yarn build
+          yarn publish
 

.gitignore

@@ -71,3 +71,7 @@ build/
 
 *.tsbuildinfo
 CONTRIBUTORS
+
+**/metadata.json
+
+**/dist/

README.md

@@ -7,37 +7,31 @@ This library provides additional typing information for user to access Acala Net
 
 # Getting Started
 
-More documentation and examples on [wiki](https://github.com/AcalaNetwork/acala-types.js/wiki).
-
-- Install dependencies
+- install
 
 ```bash
 yarn add @polkadot/api @acala-network/api
 ```
 
-- Create API instance
+- import TS interfaces augmentation
+```ts
+// index.ts
+import '@acala-network/types';
+```
 
+- create and use api with Acala type definitions
 ```ts
 import { ApiPromise, WsProvider } from '@polkadot/api';
 import { options } from '@acala-network/api';
 
-async function main() {
-    const provider = new WsProvider('wss://karura.api.onfinality.io/public-ws');
-    const api = new ApiPromise(options({ provider }));
-    await api.isReady;
+const provider = new WsProvider('wss://karura.api.onfinality.io/public-ws');
+const api = new ApiPromise(options({ provider }));
+await api.isReady;
 
-    // use api
-}
-
-main()
-```
-
-- Use api to interact with node
-
-```ts
-// query and display account data
+// use api
 const data = await api.query.system.account('5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn');
 console.log(data.toHuman())
+
 ```
 
 # Packages

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.1.2-7",
+  "version": "1.0.0",
   "private": true,
   "bugs": "https://github.com/AcalaNetwork/acala-types.js/issues",
   "engines": {
@@ -16,31 +16,24 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "yarn build:interfaces; yarn workspaces foreach -pvit run build",
-    "build:interfaces": "ts-node -r tsconfig-paths/register packages/types/scripts/generateTypes.ts && ts-node -r tsconfig-paths/register packages/type-definitions/scripts/generate.ts",
-    "build:release": "./scripts/publish",
-    "check-deps": "./node_modules/@open-web3/util/scripts/check-deps.js yarn.lock @polkadot/ @open-web3/",
-    "clean": "polkadot-dev-clean-build",
-    "lint": "polkadot-dev-run-lint",
-    "postinstall": "polkadot-dev-yarn-only",
+    "build": "yarn workspaces foreach -pvit run build",
+    "lint": "eslint . --ext .ts",
     "test": "echo noop",
-    "update-metadata": "ts-node --project ./tsconfig.json packages/types/scripts/updateMetadata.ts",
-    "bump": "yarn workspaces foreach -vit --include '@acala-network/*' version",
-    "publish:manual": "yarn workspaces foreach -vit --include '@acala-network/*' npm publish --tolerate-republish"
+    "bump": "yarn workspaces foreach -vit version",
+    "publish": "yarn workspaces foreach -vit run publish:manual"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/register": "^7.21.0",
-    "@babel/runtime": "^7.21.5",
-    "@open-web3/util": "^2.0.1",
-    "@polkadot/api": "^10.5.1",
-    "@polkadot/dev": "^0.73.11",
-    "@polkadot/typegen": "^10.5.1",
-    "@types/jest": "^29.5.1",
-    "jest-config": "^29.5.0",
+    "@polkadot/api": "^10.9.1",
+    "@types/eslint": "^8",
+    "@types/node": "^20.4.9",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.5.0",
+    "eslint": "^8.48.0",
+    "eslint-import-resolver-typescript": "^3.6.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-sort-imports-es6-autofix": "^0.6.0",
     "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.2.2"
   },
   "packageManager": "[email protected]"
 }

packages/api-derive/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@acala-network/api-derive",
-  "version": "5.1.2",
+  "version": "6.0.0-34",
   "description": "Additional polkadot.js derives for Acala Network",
-  "main": "index.js",
   "author": "Acala Developers <[email protected]>",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -19,13 +18,19 @@
   },
   "homepage": "https://github.com/AcalaNetwork/acala-types.js",
   "scripts": {
-    "build": "tsc --build tsconfig.json"
+    "build": "rm -rf dist && tsc -b --verbose -f",
+    "publish:manual": "npm publish --tolerate-republish --access public"
   },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "dependencies": {
-    "@acala-network/types": "5.1.2"
+    "@acala-network/types": "6.0.0-34"
   },
   "peerDependencies": {
-    "@polkadot/api": "^10.5.1"
+    "@polkadot/api": "^10.9.1"
   },
   "devDependencies": {
     "typescript": "^5.0.4"

packages/api-derive/src/dex/pool.ts

@@ -1,12 +1,11 @@
-import type { Observable } from 'rxjs';
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { AcalaPrimitivesCurrencyCurrencyId, AcalaPrimitivesTradingPair } from '@polkadot/types/lookup';
-import type { DerivedDexPool } from '../types/dex';
-
-import primitivesConfig from '@acala-network/type-definitions/primitives';
 import { map } from 'rxjs/operators';
-
 import { memo } from '@polkadot/api-derive/util';
+import primitivesConfig from '@acala-network/types/interfaces/primitives/definitions';
+import type { AcalaPrimitivesCurrencyCurrencyId, AcalaPrimitivesTradingPair } from '@polkadot/types/lookup';
+import type { ApiInterfaceRx } from '@polkadot/api/types';
+import type { Observable } from 'rxjs';
+
+import type { DerivedDexPool } from '../types/dex';
 
 const TOKEN_SORT: Record<string, number> = primitivesConfig.types.TokenSymbol._enum;
 

packages/api-derive/src/homa/staking-pool.ts

@@ -1,9 +1,9 @@
-import type { BlockNumber, ExchangeRate } from '@acala-network/types/interfaces';
-import type { Observable } from 'rxjs';
-import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { EraIndex } from '@polkadot/types/interfaces';
 import type { AcalaPrimitivesCurrencyCurrencyId } from '@polkadot/types/lookup';
+import type { ApiInterfaceRx } from '@polkadot/api/types';
+import type { BlockNumber, ExchangeRate } from '@acala-network/types/interfaces';
 import type { DerivedStakingPool, DerivedStakingPoolConstants } from '../types/staking-pool';
+import type { EraIndex } from '@polkadot/types/interfaces';
+import type { Observable } from 'rxjs';
 
 import { combineLatest } from 'rxjs';
 import { map } from 'rxjs/operators';
@@ -16,7 +16,7 @@ function getConstants (api: ApiInterfaceRx): DerivedStakingPoolConstants {
     bondingDuration: api.consts.polkadotBridge.bondingDuration as EraIndex,
     eraLength: api.consts.polkadotBridge.eraLength as BlockNumber,
     stakingCurrency: api.consts.stakingPool.stakingCurrencyId as AcalaPrimitivesCurrencyCurrencyId,
-    liquidCurrency: api.consts.stakingPool.liquidCurrencyId as AcalaPrimitivesCurrencyCurrencyId
+    liquidCurrency: api.consts.stakingPool.liquidCurrencyId as AcalaPrimitivesCurrencyCurrencyId,
   };
 }
 
@@ -32,7 +32,7 @@ export function stakingPool (instanceId: string, api: ApiInterfaceRx): () => Obs
       api.query.stakingPool.currentEra(),
       api.query.stakingPool.stakingPoolLedger(),
       api.query.stakingPool.stakingPoolParams(),
-      api.query.tokens.totalIssuance(constants.liquidCurrency)
+      api.query.tokens.totalIssuance(constants.liquidCurrency),
     ]).pipe(
       map((result) => {
         const [currentEra, ledger, params, liquidIssuance] = result;
@@ -42,7 +42,7 @@ export function stakingPool (instanceId: string, api: ApiInterfaceRx): () => Obs
           ledger,
           params,
           liquidIssuance,
-          ...constants
+          ...constants,
         } as unknown as DerivedStakingPool;
       })
     );

packages/api-derive/src/index.ts

@@ -1,16 +1,15 @@
-import '@acala-network/types/augment/api';
-import '@acala-network/types/augment/api-consts';
+import '@acala-network/types';
 
 import type { DeriveCustom } from '@polkadot/api-base/types';
 
 import * as dex from './dex';
 import * as homa from './homa';
 import * as loan from './loan';
 
-export const derive: DeriveCustom = {
+export const acalaDerives: DeriveCustom = {
   loan: loan as unknown as DeriveCustom[string],
   dex: dex as unknown as DeriveCustom[string],
-  homa: homa as unknown as DeriveCustom[string]
+  homa: homa as unknown as DeriveCustom[string],
 };
 
 export * from './types';

packages/api-derive/src/loan/loan-type.ts

@@ -1,8 +1,8 @@
-import type { Balance, ExchangeRate, Rate, Ratio } from '@acala-network/types/interfaces';
-import type { Observable } from 'rxjs';
-import type { ApiInterfaceRx } from '@polkadot/api/types';
 import type { AcalaPrimitivesCurrencyCurrencyId, ModuleCdpEngineRiskManagementParams } from '@polkadot/types/lookup';
+import type { ApiInterfaceRx } from '@polkadot/api/types';
+import type { Balance, ExchangeRate, Rate, Ratio } from '@acala-network/types/interfaces';
 import type { DerivedLoanConstants, DerivedLoanOverView, DerivedLoanType } from '../types/loan';
+import type { Observable } from 'rxjs';
 
 import { combineLatest } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
@@ -20,7 +20,7 @@ function loanConstants (api: ApiInterfaceRx): DerivedLoanConstants {
     minimumDebitValue: api.consts.cdpEngine.minimumDebitValue as Balance,
     defaultDebitExchangeRate: api.consts.cdpEngine.defaultDebitExchangeRate as ExchangeRate,
     defaultLiquidationRatio: api.consts.cdpEngine.defaultLiquidationRatio as Ratio,
-    defaultLiquidationPenalty: api.consts.cdpEngine.defaultLiquidationPenalty as Rate
+    defaultLiquidationPenalty: api.consts.cdpEngine.defaultLiquidationPenalty as Rate,
   };
 }
 
@@ -36,7 +36,7 @@ export function loanType (
   return memo(instanceId, (currency: AcalaPrimitivesCurrencyCurrencyId) => {
     return combineLatest([
       api.query.cdpEngine.debitExchangeRate(currency),
-      api.query.cdpEngine.collateralParams(currency)
+      api.query.cdpEngine.collateralParams(currency),
     ]).pipe(
       map((result) => {
         const constants = loanConstants(api);
@@ -57,7 +57,7 @@ export function loanType (
           requiredCollateralRatio: collateralParams.requiredCollateralRatio,
           interestRatePerSec: collateralParams.interestRatePerSec,
           maximumTotalDebitValue: collateralParams.maximumTotalDebitValue,
-          minimumDebitValue: constants.minimumDebitValue
+          minimumDebitValue: constants.minimumDebitValue,
         };
       })
     );
@@ -97,7 +97,7 @@ export function loanOverview (
         return {
           currency,
           totalDebit: debit,
-          totalCollateral: collateral
+          totalCollateral: collateral,
         };
       })
     )

packages/api-derive/src/loan/loan.ts

@@ -1,8 +1,8 @@
+import type { AcalaPrimitivesCurrencyCurrencyId } from '@polkadot/types/lookup';
 import type { AccountId } from '@acala-network/types/interfaces';
-import type { Observable } from 'rxjs';
 import type { ApiInterfaceRx } from '@polkadot/api/types';
-import type { AcalaPrimitivesCurrencyCurrencyId } from '@polkadot/types/lookup';
 import type { DerivedUserLoan } from '../types/loan';
+import type { Observable } from 'rxjs';
 
 import { combineLatest } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
@@ -30,7 +30,7 @@ export function loan (
           account,
           currency,
           debit,
-          collateral
+          collateral,
         };
       })
     )