@cityofzion/blockchain-service 1.23.0 → 3.0.0

package/dist/functions.d.ts

@@ -7,8 +7,8 @@ export declare function hasExplorerService<N extends string = string, A extends
 export declare function hasLedger<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithLedger<N>;
 export declare function hasNeo3NeoXBridge<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithNeo3NeoXBridge<N>;
 export declare function hasEncryption<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithEncryption<N>;
-export declare function hasWalletConnect<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithWalletConnect;
-export declare function hasFullTransactions<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFullTransactions;
+export declare function hasWalletConnect<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithWalletConnect<N>;
+export declare function hasFullTransactions<N extends string = string, A extends string = string>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFullTransactions<N>;
 /**
  * @deprecated use `waitForAccountTransaction` instead
  */

package/dist/functions.js

@@ -85,7 +85,7 @@ function waitForAccountTransaction(params) {
             yield BSUtilsHelper_1.BSUtilsHelper.wait(60000);
             try {
                 const response = yield service.blockchainDataService.getTransactionsByAddress({ address });
-                const isTransactionConfirmed = response.data.some(transaction => transaction.txId === txId);
+                const isTransactionConfirmed = response.transactions.some(transaction => transaction.txId === txId);
                 if (isTransactionConfirmed)
                     return true;
             }
@@ -105,10 +105,10 @@ function fetchAccounts(service, initialIndex, getAccountCallback) {
         while (!shouldBreak) {
             const generatedAccount = yield getAccountCallback(service, index);
             try {
-                const { data } = yield service.blockchainDataService.getTransactionsByAddress({
+                const { transactions } = yield service.blockchainDataService.getTransactionsByAddress({
                     address: generatedAccount.address,
                 });
-                if (!data || data.length <= 0)
+                if (!transactions || transactions.length <= 0)
                     shouldBreak = true;
             }
             catch (_a) {

package/dist/interfaces.d.ts

@@ -1,8 +1,8 @@
 import Transport from '@ledgerhq/hw-transport';
 import TypedEmitter from 'typed-emitter';
 import { BSError } from './error';
-export type TUntilIndexRecord<N extends string = string> = Partial<Record<N, Record<string, number>>>;
-export type TBSAccount<N extends string = string> = {
+export type TUntilIndexRecord<N extends string> = Partial<Record<N, Record<string, number>>>;
+export type TBSAccount<N extends string> = {
     key: string;
     type: 'wif' | 'privateKey' | 'publicKey';
     address: string;
@@ -29,7 +29,7 @@ export type TIntentTransferParam = {
     amount: string;
     token: TBSToken;
 };
-export type TTransferParam<N extends string = string> = {
+export type TTransferParam<N extends string> = {
     senderAccount: TBSAccount<N>;
     intents: TIntentTransferParam[];
     priorityFee?: string;
@@ -39,7 +39,7 @@ export type TPingNetworkResponse = {
     url: string;
     height: number;
 };
-export interface IBlockchainService<N extends string = string, A extends string = string> {
+export interface IBlockchainService<N extends string, A extends string = string> {
     readonly name: N;
     readonly bip44DerivationPath: string;
     readonly feeToken: TBSToken;
@@ -52,7 +52,7 @@ export interface IBlockchainService<N extends string = string, A extends string
     readonly defaultNetwork: TBSNetwork<A>;
     readonly availableNetworks: TBSNetwork<A>[];
     exchangeDataService: IExchangeDataService;
-    blockchainDataService: IBlockchainDataService;
+    blockchainDataService: IBlockchainDataService<N>;
     tokenService: ITokenService;
     pingNode(url: string): Promise<TPingNetworkResponse>;
     setNetwork(network: TBSNetwork<A>): void;
@@ -62,15 +62,15 @@ export interface IBlockchainService<N extends string = string, A extends string
     validateKey(key: string): boolean;
     transfer(param: TTransferParam<N>): Promise<string[]>;
 }
-export interface IBSWithEncryption<N extends string = string> {
+export interface IBSWithEncryption<N extends string> {
     decrypt(keyOrJson: string, password: string): Promise<TBSAccount<N>>;
     encrypt(key: string, password: string): Promise<string>;
     validateEncrypted(keyOrJson: string): boolean;
 }
-export interface IBSWithFee<N extends string = string> {
+export interface IBSWithFee<N extends string> {
     calculateTransferFee(param: TTransferParam<N>): Promise<string>;
 }
-export interface IBSWithClaim<N extends string = string> {
+export interface IBSWithClaim<N extends string> {
     readonly claimToken: TBSToken;
     readonly burnToken: TBSToken;
     claimDataService: IClaimDataService;
@@ -86,15 +86,15 @@ export interface IBSWithExplorer {
 export interface IBSWithNft {
     nftDataService: INftDataService;
 }
-export interface IBSWithLedger<N extends string = string> {
+export interface IBSWithLedger<N extends string> {
     ledgerService: ILedgerService<N>;
     generateAccountFromPublicKey(publicKey: string): TBSAccount<N>;
 }
-export interface IBSWithWalletConnect {
-    walletConnectService: IWalletConnectService;
+export interface IBSWithWalletConnect<N extends string> {
+    walletConnectService: IWalletConnectService<N>;
 }
-export interface IBSWithFullTransactions {
-    fullTransactionsDataService: IFullTransactionsDataService;
+export interface IBSWithFullTransactions<N extends string> {
+    fullTransactionsDataService: IFullTransactionsDataService<N>;
 }
 export type TContractParameter = {
     name: string;
@@ -137,15 +137,15 @@ export type TTransactionTokenEvent = {
 type TTransactionDefault = {
     type: 'default';
 };
-export type TTransactionBridgeNeo3NeoX = {
+export type TTransactionBridgeNeo3NeoX<N extends string> = {
     type: 'bridgeNeo3NeoX';
     data: {
         amount: string;
-        token: TBridgeToken;
+        tokenToUse: TBridgeToken<N>;
         receiverAddress: string;
     };
 };
-export type TTransaction = {
+export type TTransactionBase = {
     txId: string;
     txIdUrl?: string;
     block: number;
@@ -155,10 +155,11 @@ export type TTransaction = {
     networkFeeAmount?: string;
     systemFeeAmount?: string;
     events: (TTransactionTokenEvent | TTransactionNftEvent)[];
-} & (TTransactionDefault | TTransactionBridgeNeo3NeoX);
-export type TGetTransactionsByAddressResponse = {
+};
+export type TTransaction<N extends string> = TTransactionBase & (TTransactionDefault | TTransactionBridgeNeo3NeoX<N>);
+export type TGetTransactionsByAddressResponse<N extends string> = {
     nextPageParams?: any;
-    data: TTransaction[];
+    transactions: TTransaction<N>[];
 };
 export type TContractMethod = {
     name: string;
@@ -173,10 +174,10 @@ export type TBalanceResponse = {
     amount: string;
     token: TBSToken;
 };
-export interface IBlockchainDataService {
+export interface IBlockchainDataService<N extends string> {
     readonly maxTimeToConfirmTransactionInMs: number;
-    getTransaction(txid: string): Promise<TTransaction>;
-    getTransactionsByAddress(params: TGetTransactionsByAddressParams): Promise<TGetTransactionsByAddressResponse>;
+    getTransaction(txid: string): Promise<TTransaction<N>>;
+    getTransactionsByAddress(params: TGetTransactionsByAddressParams): Promise<TGetTransactionsByAddressResponse<N>>;
     getContract(contractHash: string): Promise<TContractResponse>;
     getTokenInfo(tokenHash: string): Promise<TBSToken>;
     getBalance(address: string): Promise<TBalanceResponse[]>;
@@ -194,8 +195,8 @@ export type TExportFullTransactionsByAddressParams = {
     dateFrom: string;
     dateTo: string;
 };
-export interface IFullTransactionsDataService {
-    getFullTransactionsByAddress(params: TGetFullTransactionsByAddressParams): Promise<TGetTransactionsByAddressResponse>;
+export interface IFullTransactionsDataService<N extends string> {
+    getFullTransactionsByAddress(params: TGetFullTransactionsByAddressParams): Promise<TGetTransactionsByAddressResponse<N>>;
     exportFullTransactionsByAddress(params: TExportFullTransactionsByAddressParams): Promise<string>;
 }
 export interface IClaimDataService {
@@ -281,14 +282,14 @@ export type TLedgerServiceEmitter = TypedEmitter<{
     getSignatureStart(): void | Promise<void>;
     getSignatureEnd(): void | Promise<void>;
 }>;
-export type TGetLedgerTransport<N extends string = string> = (account: TBSAccount<N>) => Promise<Transport>;
-export interface ILedgerService<N extends string = string> {
+export type TGetLedgerTransport<N extends string> = (account: TBSAccount<N>) => Promise<Transport>;
+export interface ILedgerService<N extends string> {
     emitter: TLedgerServiceEmitter;
     getLedgerTransport?: TGetLedgerTransport<N>;
     getAccounts(transport: Transport, getUntilIndex?: TUntilIndexRecord<N>): Promise<TBSAccount<N>[]>;
     getAccount(transport: Transport, index: number): Promise<TBSAccount<N>>;
 }
-export type TSwapToken<N extends string = string> = {
+export type TSwapToken<N extends string> = {
     id: string;
     blockchain?: N;
     imageUrl?: string;
@@ -312,7 +313,7 @@ export type TSwapMinMaxAmount = {
     min: string;
     max: string | null;
 };
-export type TSwapOrchestratorEvents<N extends string = string> = {
+export type TSwapOrchestratorEvents<N extends string> = {
     accountToUse: (account: TSwapValidateValue<TBSAccount<N>>) => void | Promise<void>;
     amountToUse: (amount: TSwapLoadableValue<string>) => void | Promise<void>;
     amountToUseMinMax: (minMax: TSwapLoadableValue<TSwapMinMaxAmount>) => void | Promise<void>;
@@ -339,7 +340,7 @@ export type TSwapServiceStatusResponse = {
 export interface ISwapService {
     getStatus(id: string): Promise<TSwapServiceStatusResponse>;
 }
-export interface ISwapOrchestrator<N extends string = string> {
+export interface ISwapOrchestrator<N extends string> {
     eventEmitter: TypedEmitter<TSwapOrchestratorEvents<N>>;
     setTokenToUse(token: TSwapToken<N> | null): Promise<void>;
     setAccountToUse(account: TBSAccount<N> | null): Promise<void>;
@@ -350,7 +351,7 @@ export interface ISwapOrchestrator<N extends string = string> {
     swap(): Promise<TSwapResult>;
     calculateFee(): Promise<string>;
 }
-export type TBridgeToken<N extends string = string> = TBSToken & {
+export type TBridgeToken<N extends string> = TBSToken & {
     blockchain: N;
     multichainId: string;
 };
@@ -362,7 +363,7 @@ export type TBridgeValue<T> = {
 export type TBridgeValidateValue<T> = TBridgeValue<T> & {
     valid: boolean | null;
 };
-export type TBridgeOrchestratorEvents<N extends string = string> = {
+export type TBridgeOrchestratorEvents<N extends string> = {
     accountToUse: (account: TBridgeValue<TBSAccount<N>>) => void | Promise<void>;
     amountToUse: (amount: TBridgeValidateValue<string>) => void | Promise<void>;
     amountToUseMin: (max: TBridgeValue<string>) => void | Promise<void>;
@@ -375,7 +376,7 @@ export type TBridgeOrchestratorEvents<N extends string = string> = {
     tokenToUseBalance: (balance: TBridgeValue<TBalanceResponse | undefined>) => void | Promise<void>;
     bridgeFee: (fee: TBridgeValue<string>) => void | Promise<void>;
 };
-export interface IBridgeOrchestrator<N extends string = string> {
+export interface IBridgeOrchestrator<N extends string> {
     eventEmitter: TypedEmitter<TBridgeOrchestratorEvents<N>>;
     setTokenToUse(token: TBridgeToken<N> | null): Promise<void>;
     setAccountToUse(account: TBSAccount<N> | null): Promise<void>;
@@ -385,7 +386,7 @@ export interface IBridgeOrchestrator<N extends string = string> {
     switchTokens(): Promise<void>;
     bridge(): Promise<string>;
 }
-export interface IBSWithNeo3NeoXBridge<N extends string = string> {
+export interface IBSWithNeo3NeoXBridge<N extends string> {
     neo3NeoXBridgeService: INeo3NeoXBridgeService<N>;
 }
 export type TNeo3NeoXBridgeServiceConstants = {
@@ -393,34 +394,35 @@ export type TNeo3NeoXBridgeServiceConstants = {
     bridgeMaxAmount: string;
     bridgeMinAmount: string;
 };
-export type TNeo3NeoXBridgeServiceBridgeParam<N extends string = string> = {
+export type TNeo3NeoXBridgeServiceBridgeParam<N extends string> = {
     account: TBSAccount<N>;
     receiverAddress: string;
     amount: string;
     token: TBridgeToken<N>;
     bridgeFee: string;
 };
-export type TNeo3NeoXBridgeServiceGetApprovalParam<N extends string = string> = {
+export type TNeo3NeoXBridgeServiceGetApprovalParam<N extends string> = {
     account: TBSAccount<N>;
     amount: string;
     token: TBridgeToken<N>;
 };
-export type TNeo3NeoXBridgeServiceGetNonceParams<N extends string = string> = {
+export type TNeo3NeoXBridgeServiceGetNonceParams<N extends string> = {
     token: TBridgeToken<N>;
     transactionHash: string;
 };
-export type TNeo3NeoXBridgeServiceGetTransactionHashByNonceParams<N extends string = string> = {
+export type TNeo3NeoXBridgeServiceGetTransactionHashByNonceParams<N extends string> = {
     token: TBridgeToken<N>;
     nonce: string;
 };
-export interface INeo3NeoXBridgeService<N extends string = string> {
+export interface INeo3NeoXBridgeService<N extends string> {
     readonly gasToken: TBridgeToken<N>;
     readonly neoToken: TBridgeToken<N>;
-    getApprovalFee(params: TNeo3NeoXBridgeServiceGetApprovalParam): Promise<string>;
-    getBridgeConstants(token: TBridgeToken): Promise<TNeo3NeoXBridgeServiceConstants>;
+    getApprovalFee(params: TNeo3NeoXBridgeServiceGetApprovalParam<N>): Promise<string>;
+    getBridgeConstants(token: TBridgeToken<N>): Promise<TNeo3NeoXBridgeServiceConstants>;
     bridge(params: TNeo3NeoXBridgeServiceBridgeParam<N>): Promise<string>;
     getNonce(params: TNeo3NeoXBridgeServiceGetNonceParams<N>): Promise<string>;
     getTransactionHashByNonce(params: TNeo3NeoXBridgeServiceGetTransactionHashByNonceParams<N>): Promise<string>;
+    getTokenByMultichainId(multichainId: string): TBridgeToken<N> | undefined;
 }
 export type TTokenServicePredicateParams = {
     hash: string;
@@ -439,19 +441,19 @@ export interface ITokenService {
     normalizeToken<T extends TBSToken | TBSToken[]>(token: T): T;
     normalizeHash(hash: string): string;
 }
-export type TWalletConnectServiceRequestMethodParams<N extends string = string> = {
+export type TWalletConnectServiceRequestMethodParams<N extends string> = {
     account: TBSAccount<N>;
     params: any;
 };
-export type TWalletConnectServiceRequestMethod = (params: TWalletConnectServiceRequestMethodParams) => Promise<any>;
-export interface IWalletConnectService {
+export type TWalletConnectServiceRequestMethod<N extends string> = (params: TWalletConnectServiceRequestMethodParams<N>) => Promise<any>;
+export interface IWalletConnectService<N extends string> {
     readonly namespace: string;
     readonly chain: string;
     readonly supportedMethods: string[];
     readonly supportedEvents: string[];
     readonly calculableMethods: string[];
     readonly autoApproveMethods: string[];
-    calculateRequestFee(args: TWalletConnectServiceRequestMethodParams): Promise<string>;
-    [methodName: string]: any | TWalletConnectServiceRequestMethod;
+    calculateRequestFee(args: TWalletConnectServiceRequestMethodParams<N>): Promise<string>;
+    [methodName: string]: any | TWalletConnectServiceRequestMethod<N>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/blockchain-service",
-  "version": "1.23.0",
+  "version": "3.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/CityOfZion/blockchain-services",
@@ -33,10 +33,11 @@
     "typescript": "5.9.2"
   },
   "scripts": {
-    "build": "rm -rf ./dist && tsc --project tsconfig.build.json",
+    "build": "rm -rf ./dist && npm run typecheck && tsc --project tsconfig.build.json",
     "test": "jest -i --config jest.config.ts",
     "lint": "eslint .",
     "format": "eslint --fix",
-    "package": "npm run build && npm pack"
+    "package": "npm run build && npm pack",
+    "typecheck": "tsc --noEmit"
   }
 }