Add type annotations

swlodarski-sumoheavy · swlodarski-sumoheavy · commit 93557c778ef4 · 2026-04-13T10:25:55.000+02:00
diff --git a/src/Client.ts b/src/Client.ts
@@ -737,7 +737,7 @@ export class Client {
     return this.keyUtils.load_keypair(Buffer.from(value).toString().trim());
   }
 
-  private getEcKeyByConfig(envConfig: object) {
+  private getEcKeyByConfig(envConfig: Record<string, any>) {
     const privateKeyPath = envConfig['PrivateKeyPath'].toString().replace('"', '');
     const keyHex = envConfig['PrivateKey'].toString().replace('"', '');
 
diff --git a/src/Client/BillClient.ts b/src/Client/BillClient.ts
@@ -1,8 +1,8 @@
-import { BitPayClient } from './BitPayClient';
-import { TokenContainer } from '../TokenContainer';
-import { BillInterface } from '../Model';
-import { Facade } from '../Facade';
 import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
+import { Facade } from '../Facade';
+import { BillInterface } from '../Model';
+import { TokenContainer } from '../TokenContainer';
+import { BitPayClient } from './BitPayClient';
 
 export class BillClient {
   private bitPayClient: BitPayClient;
@@ -66,7 +66,7 @@ export class BillClient {
    * @throws BitPayApiException BitPayApiException
    */
   public async getBills(status: string | null): Promise<BillInterface[]> {
-    const params = { token: this.tokenContainer.getToken(Facade.Merchant) };
+    const params: { token: string; status?: string } = { token: this.tokenContainer.getToken(Facade.Merchant) };
     if (status) {
       params['status'] = status;
     }
diff --git a/src/Client/InvoiceClient.ts b/src/Client/InvoiceClient.ts
@@ -95,7 +95,7 @@ export class InvoiceClient {
    * @throws BitPayApiException BitPayApiException class
    * @throws BitPayGenericException BitPayGenericException class
    */
-  public async getInvoices(params: object): Promise<InvoiceInterface[]> {
+  public async getInvoices(params: { [key: string]: any }): Promise<InvoiceInterface[]> {
     params['token'] = this.tokenContainer.getToken(Facade.Merchant);
 
     const result = await this.bitPayClient.get('invoices', params, true);
@@ -114,8 +114,9 @@ export class InvoiceClient {
    * @returns
    */
   public async getInvoiceEventToken(invoiceId: string): Promise<InvoiceEventTokenInterface> {
-    const params = {};
-    params['token'] = this.tokenContainer.getToken(Facade.Merchant);
+    const params = {
+      token: this.tokenContainer.getToken(Facade.Merchant)
+    };
 
     const result = await this.bitPayClient.get('invoices/' + invoiceId + '/events', params, true);
 
@@ -136,7 +137,7 @@ export class InvoiceClient {
    * @throws BitPayApiException BitPayApiException class
    * @throws BitPayGenericException BitPayGenericException class
    */
-  public async update(invoiceId: string, params: object): Promise<InvoiceInterface> {
+  public async update(invoiceId: string, params: { [key: string]: any }): Promise<InvoiceInterface> {
     params['token'] = this.tokenContainer.getToken(Facade.Merchant);
 
     const result = await this.bitPayClient.put('invoices/' + invoiceId, params);
diff --git a/src/Client/LedgerClient.ts b/src/Client/LedgerClient.ts
@@ -1,8 +1,8 @@
-import { BitPayClient } from './BitPayClient';
-import { TokenContainer } from '../TokenContainer';
-import { LedgerEntryInterface, LedgerInterface } from '../Model';
-import { Facade } from '../Facade';
 import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
+import { Facade } from '../Facade';
+import { LedgerEntryInterface, LedgerInterface } from '../Model';
+import { TokenContainer } from '../TokenContainer';
+import { BitPayClient } from './BitPayClient';
 
 export class LedgerClient {
   private bitPayClient: BitPayClient;
@@ -41,7 +41,7 @@ export class LedgerClient {
    * @throws BitPayApiException BitPayApiException class
    * @throws BitPayGenericException BitPayGenericException class
    */
-  public async getEntries(currency: string, params: object): Promise<LedgerEntryInterface[]> {
+  public async getEntries(currency: string, params: { [key: string]: any }): Promise<LedgerEntryInterface[]> {
     params['token'] = this.tokenContainer.getToken(Facade.Merchant);
 
     const result = await this.bitPayClient.get('ledgers/' + currency, params, true);
diff --git a/src/Client/PayoutClient.ts b/src/Client/PayoutClient.ts
@@ -1,10 +1,10 @@
-import { BitPayClient } from './BitPayClient';
-import { TokenContainer } from '../TokenContainer';
-import { GuidGenerator } from '../util/GuidGenerator';
+import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
 import { Facade } from '../Facade';
 import { PayoutInterface } from '../Model';
+import { TokenContainer } from '../TokenContainer';
 import { BitPayResponseParser } from '../util/BitPayResponseParser';
-import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
+import { GuidGenerator } from '../util/GuidGenerator';
+import { BitPayClient } from './BitPayClient';
 
 export class PayoutClient {
   private bitPayClient: BitPayClient;
@@ -63,7 +63,7 @@ export class PayoutClient {
    * @returns Payout[]
    * @throws PayoutQueryException
    */
-  public async getPayouts(params: object): Promise<PayoutInterface[]> {
+  public async getPayouts(params: { [key: string]: any }): Promise<PayoutInterface[]> {
     params['token'] = this.tokenContainer.getToken(Facade.Payout);
     const result = await this.bitPayClient.get('payouts', params, true);
 
diff --git a/src/Client/PayoutRecipientClient.ts b/src/Client/PayoutRecipientClient.ts
@@ -1,10 +1,10 @@
-import { BitPayClient } from './BitPayClient';
-import { TokenContainer } from '../TokenContainer';
-import { GuidGenerator } from '../util/GuidGenerator';
-import { PayoutRecipientInterface, PayoutRecipients } from '../Model';
-import { BitPayResponseParser } from '../util/BitPayResponseParser';
 import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
 import { Facade } from '../index';
+import { PayoutRecipientInterface, PayoutRecipients } from '../Model';
+import { TokenContainer } from '../TokenContainer';
+import { BitPayResponseParser } from '../util/BitPayResponseParser';
+import { GuidGenerator } from '../util/GuidGenerator';
+import { BitPayClient } from './BitPayClient';
 
 export class PayoutRecipientClient {
   private bitPayClient: BitPayClient;
@@ -90,7 +90,7 @@ export class PayoutRecipientClient {
    * @throws BitPayApiException  BitPayApiException class
    * @throws BitPayGenericException BitPayGenericException class
    */
-  public async getByFilters(params: object): Promise<PayoutRecipientInterface[]> {
+  public async getByFilters(params: { [key: string]: any }): Promise<PayoutRecipientInterface[]> {
     params['token'] = this.tokenContainer.getToken(Facade.Payout);
 
     const result = await this.bitPayClient.get('recipients', params, true);
diff --git a/src/Client/RefundClient.ts b/src/Client/RefundClient.ts
@@ -33,9 +33,9 @@ export class RefundClient {
       currency: refund.currency,
       preview: refund.preview,
       immediate: refund.immediate,
-      buyerPaysRefundFee: refund.buyerPaysRefundFee
+      buyerPaysRefundFee: refund.buyerPaysRefundFee,
+      guid: refund.guid ? refund.guid : this.guidGenerator.execute()
     };
-    params['guid'] = refund.guid ? refund.guid : this.guidGenerator.execute();
 
     ParamsRemover.removeNullValuesFromObject(params);
 
diff --git a/src/Client/SettlementClient.ts b/src/Client/SettlementClient.ts
@@ -1,8 +1,8 @@
-import { BitPayClient } from './BitPayClient';
-import { TokenContainer } from '../TokenContainer';
+import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
 import { SettlementInterface } from '../Model/Settlement/Settlement';
+import { TokenContainer } from '../TokenContainer';
 import { Facade } from '../index';
-import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
+import { BitPayClient } from './BitPayClient';
 
 export class SettlementClient {
   private bitPayClient: BitPayClient;
@@ -41,7 +41,7 @@ export class SettlementClient {
    * @throws BitPayApiException BitPayApiException class
    * @throws BitPayGenericException BitPayGenericException class
    */
-  public async getSettlements(params: object): Promise<SettlementInterface[]> {
+  public async getSettlements(params: { [key: string]: any }): Promise<SettlementInterface[]> {
     params['token'] = this.tokenContainer.getToken(Facade.Merchant);
 
     const result = await this.bitPayClient.get('settlements', params, true);
diff --git a/src/Currency.ts b/src/Currency.ts
@@ -179,7 +179,7 @@ export class Currency {
   static ZMW = 'ZMW';
   static ZWL = 'ZWL';
 
-  static isValid(value) {
+  static isValid(value: string) {
     try {
       return this.hasOwnProperty.call(this, value);
     } catch (ex) {
diff --git a/src/setup/BitPaySetup.ts b/src/setup/BitPaySetup.ts
@@ -1,19 +1,20 @@
+import { ec } from 'elliptic';
 import * as fs from 'fs';
-import * as BitPaySDK from '../index';
 import * as readline from 'readline';
+import * as BitPaySDK from '../index';
 
 const keyUtils = new BitPaySDK.KeyUtils();
 let configFilePath = process.cwd();
-let keyPair;
-let ecKey;
-let environment;
+let keyPair: ec.KeyPair;
+let ecKey: ec.KeyPair;
+let environment: string;
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 let storeFile = true;
-let apiUrl;
-let merchantToken;
-let merchantPairCode;
-let payoutToken;
-let payoutPairCode;
+let apiUrl: string;
+let merchantToken: string;
+let merchantPairCode: string;
+let payoutToken: string;
+let payoutPairCode: string;
 let keyPath = '';
 let keyPlain = '';
 
@@ -48,7 +49,7 @@ const selectEnv = async () => {
     console.log(e);
   }
 };
-const setEnv = async (env) => {
+const setEnv = async (env: string) => {
   if (env == 'Test') {
     apiUrl = 'https://test.bitpay.com';
     return;
@@ -84,7 +85,7 @@ const createNewKey = async () => {
     console.log(e);
   }
 };
-const loadKey = async (privateKey) => {
+const loadKey = async (privateKey: string) => {
   try {
     if (fs.existsSync(privateKey)) {
       console.log('Loading private key... \n');
@@ -205,11 +206,11 @@ const selectTokens = async () => {
     console.log(e);
   }
 };
-const requestTokens = async (option) => {
+const requestTokens = async (option: string) => {
   async function requestMerchantToken(options: {
     headers: { 'Content-type': string; 'x-accept-version': string };
     method: string;
-    body: { id: string };
+    body: { id: string; facade?: string };
     url: string;
   }) {
     console.log('Requesting Merchant token... \n');
@@ -237,7 +238,7 @@ const requestTokens = async (option) => {
   async function requestPayoutToken(options: {
     headers: { 'Content-type': string; 'x-accept-version': string };
     method: string;
-    body: { id: string };
+    body: { id: string; facade?: string };
     url: string;
   }) {
     console.log('Requesting Payout token... \n');
@@ -345,7 +346,7 @@ const updateConfigFile = async () => {
   process.exit();
 };
 
-function sleep(ms) {
+function sleep(ms: number) {
   return new Promise((resolve) => {
     setTimeout(resolve, ms);
   });
diff --git a/src/util/BitPayResponseParser.ts b/src/util/BitPayResponseParser.ts
@@ -1,8 +1,8 @@
-import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
 import { BitPayApiException } from '../Exceptions/BitPayApiException';
+import { BitPayExceptionProvider } from '../Exceptions/BitPayExceptionProvider';
 
 export class BitPayResponseParser {
-  public async getJsonDataFromJsonResponse(responseObj: object) {
+  public async getJsonDataFromJsonResponse(responseObj: { [key: string]: any }) {
     if (responseObj === null) {
       BitPayExceptionProvider.throwApiExceptionWithMessage('HTTP response is null', null);
     }
@@ -30,7 +30,7 @@ export class BitPayResponseParser {
 
       if (Object.prototype.hasOwnProperty.call(responseObj, 'errors')) {
         let result = '';
-        responseObj['errors'].forEach((error, index) => {
+        responseObj['errors'].forEach((error: { [key: string]: any }, index: number) => {
           if (index !== 0) {
             result += ' ';
           }
diff --git a/src/util/KeyUtils.ts b/src/util/KeyUtils.ts
@@ -1,6 +1,6 @@
-import * as elliptic from 'elliptic';
 import bs58 from 'bs58';
 import * as crypto from 'crypto';
+import * as elliptic from 'elliptic';
 
 const ec = new elliptic.ec('secp256k1');
 
@@ -10,7 +10,7 @@ export class KeyUtils {
     return kp;
   }
 
-  public load_keypair(buf: Buffer | string): elliptic.ec.KeyPair {
+  public load_keypair(buf: Buffer | string | elliptic.ec.KeyPair): elliptic.ec.KeyPair {
     return ec.keyFromPrivate(buf);
   }
 
@@ -33,7 +33,7 @@ export class KeyUtils {
     return Buffer.from(privkey.sign(hashBuffer).toDER()).toString('hex');
   }
 
-  public getPublicKeyFromPrivateKey(privkey) {
+  public getPublicKeyFromPrivateKey(privkey: string | Buffer | elliptic.ec.KeyPair): string {
     const ecKey = this.load_keypair(privkey);
 
     return ecKey.getPublic().encodeCompressed('hex');
diff --git a/tsconfig.json b/tsconfig.json
@@ -16,8 +16,7 @@
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": false,
     "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "noImplicitAny": false
+    "resolveJsonModule": true
   },
   "lib": [
     "es2021",

Original file line number	Diff line number	Diff line change
`@@ -737,7 +737,7 @@ export class Client {`
`737`	`737`	`return this.keyUtils.load_keypair(Buffer.from(value).toString().trim());`
`738`	`738`	`}`
`739`	`739`
`740`		`- private getEcKeyByConfig(envConfig: object) {`
	`740`	`+ private getEcKeyByConfig(envConfig: Record<string, any>) {`
`741`	`741`	`const privateKeyPath = envConfig['PrivateKeyPath'].toString().replace('"', '');`
`742`	`742`	`const keyHex = envConfig['PrivateKey'].toString().replace('"', '');`
`743`	`743`