add gha and linting (#72)

* add type aliases

* make example use env vars

* finish tests

* add types

* cleanup

* add gha

* clean up all files

* add prettier lint

* sep12 stuff linting

* cleanup

* move to devdeps

.eslintrc.js

@@ -0,0 +1,59 @@
+module.exports = {
+  ignorePatterns: ["lib/", "node_modules/", "docs/"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: ["tsconfig.json", "examples/tsconfig.json", "test/tsconfig.json"],
+    sourceType: "module",
+  },
+  plugins: ["@typescript-eslint", "jsdoc"],
+  extends: [
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  rules: {
+    // Off
+    "@typescript-eslint/no-unsafe-argument": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "@typescript-eslint/prefer-regexp-exec": "off",
+    "@typescript-eslint/restrict-template-expressions": "off",
+    "@typescript-eslint/no-inferrable-types": "off",
+    "@typescript-eslint/no-misused-promises": "off",
+    "@typescript-eslint/no-base-to-string": "off",
+
+    // Error
+    "@typescript-eslint/no-shadow": "error",
+    "@typescript-eslint/no-unused-expressions": "error",
+    "@typescript-eslint/no-var-requires": "error",
+    "@typescript-eslint/prefer-for-of": "error",
+    "@typescript-eslint/prefer-function-type": "error",
+    "@typescript-eslint/prefer-namespace-keyword": "error",
+    "@typescript-eslint/triple-slash-reference": [
+      "error",
+      {
+        path: "always",
+        types: "prefer-import",
+        lib: "always",
+      },
+    ],
+    "@typescript-eslint/unified-signatures": "error",
+    "@typescript-eslint/no-misused-new": "error",
+    "@typescript-eslint/no-empty-function": "error",
+    "@typescript-eslint/no-empty-interface": "error",
+    "jsdoc/check-alignment": "error",
+    "jsdoc/check-indentation": "error",
+  },
+  overrides: [
+    {
+      files: ["test/**", "examples/**"],
+      rules: {
+        "@typescript-eslint/no-shadow": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+      },
+    },
+  ],
+};

.github/workflows/runTests.yml

@@ -0,0 +1,14 @@
+name: Run Tests
+on: [pull_request]
+jobs:
+  test-ci:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18
+      - run: yarn install
+      - run: yarn build
+      - run: yarn test:ci

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 yarn pretty-quick --staged
+yarn lint-staged

examples/sep24/sep24.ts

@@ -49,7 +49,7 @@ const asset = new IssuedAssetId(assetCode, assetIssuer);
 const runSep24 = async () => {
   await createAccount();
   await runDeposit(anchor, kp);
-  await runDepositWatcher(anchor);
+  runDepositWatcher(anchor);
 
   while (!depositDone) {
     await new Promise((resolve) => setTimeout(resolve, 1000));
@@ -61,7 +61,7 @@ const runSep24 = async () => {
   }
 
   await runWithdraw(anchor, kp);
-  await runWithdrawWatcher(anchor, kp);
+  runWithdrawWatcher(anchor, kp);
 };
 
 // Create Account
@@ -118,7 +118,7 @@ export let depositDone = false;
 export const runDepositWatcher = (anchor: Anchor) => {
   console.log("\nstarting watcher ...");
 
-  let stop: Types.WatcherStopFunction;
+  const stop: Types.WatcherStopFunction;
   const onMessage = (m: Types.AnchorTransaction) => {
     console.log({ m });
     if (m.status === Types.TransactionStatus.completed) {
@@ -183,7 +183,7 @@ const sendWithdrawalTransaction = async (withdrawalTxn, kp) => {
 export const runWithdrawWatcher = (anchor, kp) => {
   console.log("\nstarting watcher ...");
 
-  let stop;
+  const stop;
   const onMessage = (m) => {
     console.log({ m });
 
@@ -219,6 +219,7 @@ const walletSigner = DefaultSigner;
 walletSigner.signWithDomainAccount = async ({
   transactionXDR,
   networkPassphrase,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   accountKp,
 }: Types.SignWithDomainAccountParams): Promise<Transaction> => {
   if (!clientSecret) {

examples/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "baseUrl": "./",
+    "outDir": "lib",
+    "declaration": true,
+    "declarationDir": "lib"
+  },
+  "include": ["./"]
+}

package.json

@@ -11,18 +11,22 @@
   "private": false,
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",
-    "@stellar/eslint-config": "^2.1.2",
     "@stellar/prettier-config": "^1.0.1",
     "@stellar/tsconfig": "^1.0.2",
     "@types/jest": "^29.4.0",
     "@types/lodash": "^4.14.194",
     "@types/sinon": "^10.0.15",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
     "babel-jest": "^29.4.1",
     "crypto-browserify": "^3.12.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-jsdoc": "^46.8.2",
     "husky": "^8.0.0",
     "jest": "^29.4.1",
+    "lint-staged": "^14.0.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
     "pretty-quick": "^2.0.1",
@@ -49,11 +53,18 @@
     "utility-types": "^3.10.0"
   },
   "scripts": {
+    "lint": "eslint . --ext .ts",
     "prepare": "husky install",
     "test": "jest --watchAll",
+    "test:ci": "jest --ci",
     "build:web": "webpack --config webpack.config.js",
     "build:node": "webpack --env NODE=true --config webpack.config.js",
     "build": "run-p build:web build:node",
     "example:sep24": "ts-node examples/sep24/sep24.ts"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "eslint --fix --max-warnings 0"
+    ]
   }
 }

src/walletSdk/Anchor/Sep24.ts

@@ -16,7 +16,6 @@ import {
   AnchorTransaction,
   GetTransactionParams,
   GetTransactionsParams,
-  TransactionStatus,
   AnchorServiceInfo,
 } from "../Types";
 import { Watcher } from "../Watcher";
@@ -106,7 +105,7 @@ export class Sep24 {
     if (!assets.includes(assetCode)) {
       throw new AssetNotSupportedError(type, assetCode);
     }
-    let memoMap = {};
+    const memoMap = {};
     if (destinationMemo) {
       memoMap["memo_type"] = destinationMemo.type;
       memoMap["memo"] = destinationMemo.value;

src/walletSdk/Asset/index.ts

@@ -1,4 +1,4 @@
-import StellarSdk from "stellar-sdk";
+import { Asset as StellarAsset } from "stellar-sdk";
 
 const STELLAR_SCHEME = "stellar";
 
@@ -18,11 +18,11 @@ export class StellarAssetId extends AssetId {
   issuer: string;
   scheme = STELLAR_SCHEME;
 
-  toAsset() {
+  toAsset(): StellarAsset {
     if (this.id === "native") {
-      return new StellarSdk.Asset("XLM");
+      return new StellarAsset("XLM");
     }
-    return new StellarSdk.Asset(this.code, this.issuer);
+    return new StellarAsset(this.code, this.issuer);
   }
 }
 

src/walletSdk/Auth/WalletSigner.ts

@@ -29,6 +29,7 @@ export const DefaultSigner: WalletSigner = {
     transaction.sign(accountKp.keypair);
     return transaction;
   },
+  // eslint-disable-next-line @typescript-eslint/require-await
   signWithDomainAccount: async () => {
     throw new Error(
       "The DefaultSigner can't sign transactions with domain account",
@@ -72,6 +73,7 @@ export class DomainSigner implements WalletSigner {
   async signWithDomainAccount({
     transactionXDR,
     networkPassphrase,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     accountKp,
   }: SignWithDomainAccountParams): Promise<Transaction> {
     const response = await this.client.post(

src/walletSdk/Customer/index.ts

@@ -3,10 +3,6 @@ import queryString from "query-string";
 import { Sep9InfoRequiredError, CustomerNotFoundError } from "../Exceptions";
 import {
   CustomerInfoMap,
-  Sep12Status,
-  Sep12Type,
-  Field,
-  ProvidedField,
   GetCustomerParams,
   GetCustomerResponse,
   AddCustomerResponse,
@@ -75,9 +71,12 @@ export class Sep12 {
     if (type) {
       customerMap = { type, ...customerMap };
     }
+    if (memo) {
+      customerMap["memo"] = memo;
+    }
 
     // Check if binary data given so can adjust headers
-    let includesBinary = sep9BinaryInfo && Object.keys(sep9BinaryInfo).length;
+    const includesBinary = sep9BinaryInfo && Object.keys(sep9BinaryInfo).length;
     const resp = await this.httpClient.put(
       `${this.baseUrl}/customer`,
       customerMap,
@@ -127,7 +126,7 @@ export class Sep12 {
     customerMap = { ...customerMap, ...sep9Info, ...sep9BinaryInfo };
 
     // Check if binary data given so can adjust headers
-    let includesBinary = sep9BinaryInfo && Object.keys(sep9BinaryInfo).length;
+    const includesBinary = sep9BinaryInfo && Object.keys(sep9BinaryInfo).length;
     const resp = await this.httpClient.put(
       `${this.baseUrl}/customer`,
       customerMap,

src/walletSdk/Exceptions/index.ts

@@ -69,7 +69,7 @@ export class AccountDoesNotExistError extends Error {
 
 export class TransactionSubmitFailedError extends Error {
   constructor(response: Horizon.SubmitTransactionResponse) {
-    super(`Submit transaction failed ${response}`);
+    super(`Submit transaction failed ${JSON.stringify(response)}`);
     Object.setPrototypeOf(this, TransactionSubmitFailedError.prototype);
   }
 }

src/walletSdk/Horizon/Stellar.ts

@@ -133,7 +133,7 @@ export class Stellar {
     }
 
     try {
-      const success = await this.submitTransaction(transaction);
+      await this.submitTransaction(transaction);
       return transaction;
     } catch (e) {
       const resultCode = getResultCode(e);

src/walletSdk/Horizon/Transaction/CommonTransactionBuilder.ts

@@ -19,7 +19,7 @@ export abstract class CommonTransactionBuilder<T> {
         source: this.sourceAddress,
       }),
     );
-    return this as any as T;
+    return this as unknown as T;
   }
 
   removeAssetSupport(asset: IssuedAssetId): T {
@@ -36,7 +36,7 @@ export abstract class CommonTransactionBuilder<T> {
         },
       }),
     );
-    return this as any as T;
+    return this as unknown as T;
   }
 
   removeAccountSigner(signerAddress: AccountKeypair): T {
@@ -50,7 +50,7 @@ export abstract class CommonTransactionBuilder<T> {
         masterWeight: 0,
       }),
     );
-    return this as any as T;
+    return this as unknown as T;
   }
 
   setThreshold({
@@ -70,6 +70,6 @@ export abstract class CommonTransactionBuilder<T> {
         highThreshold: high,
       }),
     );
-    return this as any as T;
+    return this as unknown as T;
   }
 }

src/walletSdk/Horizon/Transaction/SponsoringBuilder.ts

@@ -1,9 +1,4 @@
-import StellarSdk, {
-  TransactionBuilder as StellarTransactionBuilder,
-  Transaction,
-  xdr,
-} from "stellar-sdk";
-import { IssuedAssetId } from "../../Asset";
+import StellarSdk, { xdr } from "stellar-sdk";
 
 import { CommonTransactionBuilder } from "./CommonTransactionBuilder";
 import { AccountKeypair } from "../Account";

src/walletSdk/Recovery/AccountRecover.ts

@@ -146,7 +146,7 @@ export abstract class AccountRecover {
    * from the account will be recognized as the lost device key:
    * 1. Only signer that's not in [serverAuth]
    * 2. All signers in [serverAuth] have the same weight, and potential signer is
-   *    the only one with a different weight.
+   * the only one with a different weight.
    *
    * @param stellarAccount stellar account to lookup existing signers on account
    * @param serverAuth sap of recovery servers to use

src/walletSdk/Recovery/index.ts

@@ -201,20 +201,20 @@ export class Recovery extends AccountRecover {
 
     if (sponsorAddress) {
       if (accountInfo) {
-        const buildingFunction = (builder: SponsoringBuilder) =>
+        const buildingFunction = (_builder: SponsoringBuilder) =>
           this.register(
-            builder,
+            _builder,
             accountSigners,
             accountThreshold,
             builderExtra,
           ) as SponsoringBuilder;
 
         builder.sponsoring(sponsorAddress, buildingFunction);
       } else {
-        const buildingFunction = (builder: SponsoringBuilder) => {
-          builder.createAccount(account);
+        const buildingFunction = (_builder: SponsoringBuilder) => {
+          _builder.createAccount(account);
           return this.register(
-            builder,
+            _builder,
             accountSigners,
             accountThreshold,
             builderExtra,

src/walletSdk/Types/anchor.ts

@@ -60,6 +60,7 @@ export interface WithdrawTransaction extends ProcessingAnchorTransaction {
   withdraw_anchor_account: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface ErrorTransaction
   extends Optional<DepositTransaction & WithdrawTransaction> {}
 

src/walletSdk/Types/auth.ts

@@ -1,4 +1,4 @@
-import { Keypair, Transaction } from "stellar-sdk";
+import { Transaction } from "stellar-sdk";
 import { WalletSigner } from "../Auth/WalletSigner";
 import { AccountKeypair } from "../Horizon/Account";
 

src/walletSdk/Utils/camelToSnakeCase.ts

@@ -4,6 +4,7 @@ export const camelToSnakeCaseKey = (key: string): string =>
     (upperCaseLetter) => `_${upperCaseLetter.toLowerCase()}`,
   );
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const camelToSnakeCaseObject = (obj: any): any => {
   const snakeCasedObj = {};
   for (const key in obj) {