@cityofzion/blockchain-service 3.1.7 → 3.1.9

package/dist/functions.d.ts

@@ -8,8 +8,8 @@ export declare function hasLedger<N extends string, A extends TBSNetworkId>(serv
 export declare function hasNeo3NeoXBridge<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is N extends TBSBridgeName ? IBlockchainService<N, A> & IBSWithNeo3NeoXBridge<N> : never;
 export declare function hasEncryption<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithEncryption<N>;
 export declare function hasWalletConnect<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithWalletConnect<N>;
-export declare function hasFullTransactions<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFullTransactions;
-export declare function hasFaucet<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFaucet;
+export declare function hasFullTransactions<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFullTransactions<N>;
+export declare function hasFaucet<N extends string, A extends TBSNetworkId>(service: IBlockchainService<N, A>): service is IBlockchainService<N, A> & IBSWithFaucet<N>;
 /**
  * @deprecated use `waitForAccountTransaction` instead
  */

package/dist/interfaces.d.ts

@@ -52,7 +52,7 @@ export interface IBlockchainService<N extends string, A extends string = string>
     readonly availableNetworks: TBSNetwork<A>[];
     readonly isCustomNetworkSupported: boolean;
     exchangeDataService: IExchangeDataService;
-    blockchainDataService: IBlockchainDataService;
+    blockchainDataService: IBlockchainDataService<N>;
     tokenService: ITokenService;
     setNetwork(network: TBSNetwork<A>): void;
     pingNetwork(url?: string): Promise<TPingNetworkResponse>;
@@ -60,7 +60,7 @@ export interface IBlockchainService<N extends string, A extends string = string>
     generateAccountFromKey(key: string): Promise<TBSAccount<N>>;
     validateAddress(address: string): boolean;
     validateKey(key: string): boolean;
-    transfer(params: TTransferParams<N>): Promise<TTransaction[]>;
+    transfer(params: TTransferParams<N>): Promise<TTransaction<N>[]>;
 }
 export interface IBSWithEncryption<N extends string> {
     decrypt(keyOrJson: string, password: string): Promise<TBSAccount<N>>;
@@ -90,11 +90,11 @@ export interface IBSWithLedger<N extends string> {
 export interface IBSWithWalletConnect<N extends string> {
     walletConnectService: IWalletConnectService<N>;
 }
-export interface IBSWithFullTransactions {
-    fullTransactionsDataService: IFullTransactionsDataService;
+export interface IBSWithFullTransactions<N extends string> {
+    fullTransactionsDataService: IFullTransactionsDataService<N>;
 }
-export interface IBSWithFaucet {
-    faucet(address: string): Promise<TTransaction>;
+export interface IBSWithFaucet<N extends string> {
+    faucet(address: string): Promise<TTransaction<N>>;
 }
 export type TContractParameter = {
     name: string;
@@ -131,7 +131,7 @@ export type TTransactionUtxoInputOutput = {
     amount: string;
     token: TBSToken;
 };
-type TTransactionBase = {
+export type TTransactionBase = {
     txId: string;
     txIdUrl?: string;
     block?: number;
@@ -142,12 +142,17 @@ type TTransactionBase = {
     systemFeeAmount?: string;
     data?: any;
 };
+export type TTransactionFullBase<N extends string> = TTransactionBase & {
+    isPending: boolean;
+    blockchain: N;
+    relatedAddress?: string;
+};
 export type TTransactionDefaultEvent = TTransactionDefaultNftEvent | TTransactionDefaultTokenEvent | TTransactionDefaultGenericEvent;
-export type TTransactionDefault = TTransactionBase & {
+export type TTransactionDefault<N extends string> = TTransactionFullBase<N> & {
     view: 'default';
     events: TTransactionDefaultEvent[];
 };
-export type TTransactionUtxo = TTransactionBase & {
+export type TTransactionUtxo<N extends string> = TTransactionFullBase<N> & {
     view: 'utxo';
     hex: string;
     totalAmount: string;
@@ -155,8 +160,8 @@ export type TTransactionUtxo = TTransactionBase & {
     inputs: TTransactionUtxoInputOutput[];
     outputs: TTransactionUtxoInputOutput[];
 };
-export type TTransaction = TTransactionDefault | TTransactionUtxo;
-export type TGetTransactionsByAddressResponse<T extends TTransaction = TTransaction> = {
+export type TTransaction<N extends string> = TTransactionDefault<N> | TTransactionUtxo<N>;
+export type TGetTransactionsByAddressResponse<N extends string, T extends TTransaction<N> = TTransaction<N>> = {
     nextPageParams?: any;
     transactions: T[];
 };
@@ -173,10 +178,10 @@ export type TBalanceResponse = {
     amount: string;
     token: TBSToken;
 };
-export interface IBlockchainDataService {
+export interface IBlockchainDataService<N extends string> {
     readonly maxTimeToConfirmTransactionInMs: number;
-    getTransaction(transactionId: string): Promise<TTransaction>;
-    getTransactionsByAddress(params: TGetTransactionsByAddressParams): Promise<TGetTransactionsByAddressResponse>;
+    getTransaction(transactionId: 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 +199,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 type TClaimServiceTransactionData = {
@@ -205,8 +210,8 @@ export interface IClaimService<N extends string> {
     readonly claimToken: TBSToken;
     getUnclaimed(address: string): Promise<string>;
     calculateFee(account: TBSAccount<N>): Promise<string>;
-    claim(account: TBSAccount<N>): Promise<TTransactionDefault>;
-    getTransactionData(transaction: TTransaction): TClaimServiceTransactionData | undefined;
+    claim(account: TBSAccount<N>): Promise<TTransactionDefault<N>>;
+    getTransactionData(transaction: TTransactionBase): TClaimServiceTransactionData | undefined;
 }
 export type TTokenPricesResponse = {
     usdPrice: number;
@@ -331,9 +336,9 @@ export type TSwapOrchestratorEvents<N extends string> = {
     availableTokensToReceive: (tokens: TSwapLoadableValue<TSwapToken<N>[]>) => void | Promise<void>;
     error: (error: string) => void | Promise<void>;
 };
-export type TSwapResponse = {
+export type TSwapResponse<N extends string> = {
     id: string;
-    transaction?: TTransaction;
+    transaction?: TTransaction<N>;
     log?: string;
 };
 export type TSwapServiceStatusResponse = {
@@ -353,7 +358,7 @@ export interface ISwapOrchestrator<N extends string> {
     setTokenToReceive(token: TSwapToken<N> | null): Promise<void>;
     setAddressToReceive(address: string | null): Promise<void>;
     setExtraIdToReceive(extraId: string | null): Promise<void>;
-    swap(): Promise<TSwapResponse>;
+    swap(): Promise<TSwapResponse<N>>;
     calculateFee(): Promise<string>;
 }
 export type TBSBridgeName = 'neo3' | 'neox';
@@ -436,7 +441,7 @@ export interface INeo3NeoXBridgeService<N extends TBSBridgeName> {
     getNonce(params: TNeo3NeoXBridgeServiceGetNonceParams<N>): Promise<string>;
     getTransactionHashByNonce(params: TNeo3NeoXBridgeServiceGetTransactionHashByNonceParams<N>): Promise<string>;
     getTokenByMultichainId(multichainId: string): TBridgeToken<N> | undefined;
-    getTransactionData(transaction: TTransaction): TNeo3NeoXBridgeTransactionData<N> | undefined;
+    getTransactionData(transaction: TTransactionBase): TNeo3NeoXBridgeTransactionData<N> | undefined;
 }
 export type TTokenServicePredicateParams = {
     hash: string;
@@ -472,4 +477,3 @@ export interface IWalletConnectService<N extends string> {
     calculateRequestFee(args: TWalletConnectServiceRequestMethodParams<N>): Promise<string>;
     [methodName: string]: any | TWalletConnectServiceRequestMethod<N>;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/blockchain-service",
-  "version": "3.1.7",
+  "version": "3.1.9",
   "repository": "https://github.com/CityOfZion/blockchain-services",
   "license": "GPL-3.0-only",
   "author": "Coz",