@rosen-bridge/tx-pot 0.1.0 → 1.0.1

package/dist/network/AbstractPotChainManager.d.ts

@@ -1,36 +1,39 @@
 import { SigningStatus } from '../transaction/types';
 export declare abstract class AbstractPotChainManager {
-    /**
-     * gets the blockchain current height
-     */
-    abstract getHeight: () => Promise<number>;
-    /**
-     * returns required number of confirmation
-     * @param txType
-     */
-    abstract getTxRequiredConfirmation: (txType: string) => number;
-    /**
-     * gets number of confirmation for a tx
-     *  returns -1 if tx is not in the blockchain
-     * @param txId
-     */
-    abstract getTxConfirmation: (txId: string) => Promise<number>;
-    /**
-     * checks if a tx is still valid and can be sent to the network
-     * @param serializedTx
-     * @param signingStatus
-     */
-    abstract isTxValid: (serializedTx: string, signingStatus: SigningStatus) => Promise<boolean>;
-    /**
-     * submits a tx to the blockchain
-     * @param serializedTx
-     */
-    abstract submitTransaction: (serializedTx: string) => Promise<void>;
-    /**
-     * checks if a tx is in mempool
-     *  returns false if the chain has no mempool
-     * @param txId
-     */
-    abstract isTxInMempool: (txId: string) => Promise<boolean>;
+  /**
+   * gets the blockchain current height
+   */
+  abstract getHeight: () => Promise<number>;
+  /**
+   * returns required number of confirmation
+   * @param txType
+   */
+  abstract getTxRequiredConfirmation: (txType: string) => number;
+  /**
+   * gets number of confirmation for a tx
+   *  returns -1 if tx is not in the blockchain
+   * @param txId
+   */
+  abstract getTxConfirmation: (txId: string) => Promise<number>;
+  /**
+   * checks if a tx is still valid and can be sent to the network
+   * @param serializedTx
+   * @param signingStatus
+   */
+  abstract isTxValid: (
+    serializedTx: string,
+    signingStatus: SigningStatus
+  ) => Promise<boolean>;
+  /**
+   * submits a tx to the blockchain
+   * @param serializedTx
+   */
+  abstract submitTransaction: (serializedTx: string) => Promise<void>;
+  /**
+   * checks if a tx is in mempool
+   *  returns false if the chain has no mempool
+   * @param txId
+   */
+  abstract isTxInMempool: (txId: string) => Promise<boolean>;
 }
-//# sourceMappingURL=AbstractPotChainManager.d.ts.map
+//# sourceMappingURL=AbstractPotChainManager.d.ts.map

package/dist/transaction/TxPot.d.ts

@@ -1,14 +1,15 @@
 import { DataSource, Repository } from 'typeorm';
 import { TransactionEntity } from '../db/entities/TransactionEntity';
-import { AbstractLogger } from '@rosen-bridge/logger-interface';
+import { AbstractLogger } from '@rosen-bridge/abstract-logger';
 import { CallbackFunction, TransactionStatus, TxOptions, ValidatorFunction } from './types';
 import { AbstractPotChainManager } from '../network/AbstractPotChainManager';
 export declare class TxPot {
     protected static instance: TxPot;
     protected readonly txRepository: Repository<TransactionEntity>;
     protected chains: Map<string, AbstractPotChainManager>;
-    protected validators: Map<string, Map<string, ValidatorFunction>>;
-    protected txTypeCallbacks: Map<string, Map<TransactionStatus, CallbackFunction>>;
+    protected validators: Map<string, Map<string, Map<string, ValidatorFunction>>>;
+    protected txTypeCallbacks: Map<string, Map<TransactionStatus, Map<string, CallbackFunction>>>;
+    protected submissionAllowance: Map<string, Map<string, ValidatorFunction>>;
     protected logger: AbstractLogger;
     protected constructor(dataSource: DataSource, logger?: AbstractLogger);
     /**
@@ -33,18 +34,47 @@ export declare class TxPot {
      * registers a validator function
      * @param chain
      * @param txType
+     * @param id
      * @param validator
      */
-    registerValidator: (chain: string, txType: string, validator: ValidatorFunction) => void;
+    registerValidator: (chain: string, txType: string, id: string, validator: ValidatorFunction) => void;
+    /**
+     * removes a validator function
+     * @param chain
+     * @param txType
+     * @param id
+     */
+    unregisterValidator: (chain: string, txType: string, id: string) => void;
+    /**
+     * registers a submit validator function
+     * @param chain
+     * @param id
+     * @param validator
+     */
+    registerSubmitValidator: (chain: string, id: string, validator: ValidatorFunction) => void;
+    /**
+     * removes a submit validator function
+     * @param chain
+     * @param id
+     */
+    unregisterSubmitValidator: (chain: string, id: string) => void;
     /**
      * registers a callback function
      *  the callback will be called when status of any transactions
      *  of given type changes to given status
      * @param txType
      * @param status
+     * @param id
      * @param callback
      */
-    registerCallback: (txType: string, status: TransactionStatus, callback: CallbackFunction) => void;
+    registerCallback: (txType: string, status: TransactionStatus, id: string, callback: CallbackFunction) => void;
+    /**
+     * removes a callback function
+     * @param txType
+     * @param status
+     * @param id
+     */
+    unregisterCallback: (txType: string, status: TransactionStatus, id: string) => void;
     /**
      * returns chain manager for given chain
      *  throws error if no manager is registered for it
@@ -63,6 +93,13 @@ export declare class TxPot {
      * @param tx
      */
     protected validateTx: (tx: TransactionEntity) => Promise<boolean>;
+    /**
+     * checks a transaction for submission
+     * returns true if no validator functions is set or all validators allow tx to submit
+     * otherwise returns false
+     * @param tx
+     */
+    protected isSubmitAllowed: (tx: TransactionEntity) => Promise<boolean>;
     /**
      * updates the status of a tx
      * @param txKey tx id and chain
@@ -98,15 +135,18 @@ export declare class TxPot {
     getTxsByStatus: (status: TransactionStatus, validate?: boolean) => Promise<Array<TransactionEntity>>;
     /**
      * inserts a new transaction into db
+     *   Note: make sure to set `lastCheck` field if initialStatus is `signed` or `sent`
      * @param txId
      * @param chain
      * @param txType
      * @param requiredSign
      * @param serializedTx
      * @param initialStatus
-     * @param lastCheck
+     * @param lastCheck last blockchain height that tx was valid
+     * @param extra
+     * @param extra2
      */
-    addTx: (txId: string, chain: string, txType: string, requiredSign: number, serializedTx: string, initialStatus?: TransactionStatus, lastCheck?: number) => Promise<void>;
+    addTx: (txId: string, chain: string, txType: string, requiredSign: number, serializedTx: string, initialStatus?: TransactionStatus, lastCheck?: number, extra?: string | null, extra2?: string | null) => Promise<void>;
     /**
      * updates the status of a tx
      * @param txId
@@ -160,5 +200,13 @@ export declare class TxPot {
      * @returns the transactions with valid status
      */
     getTxsQuery: (options?: Array<TxOptions>) => Promise<TransactionEntity[]>;
+    /**
+     * updates extra fields of a transaction
+     * @param txId
+     * @param chain
+     * @param extra
+     * @param extra2
+     */
+    updateExtra: (txId: string, chain: string, extra?: string | null, extra2?: string | null) => Promise<void>;
 }
 //# sourceMappingURL=TxPot.d.ts.map

package/dist/transaction/TxPot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxPot.d.ts","sourceRoot":"","sources":["../../lib/transaction/TxPot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAe,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAEhB,iBAAiB,EACjB,SAAS,EAET,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,qBAAa,KAAK;IAChB,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAC/D,SAAS,CAAC,MAAM,uCAA8C;IAC9D,SAAS,CAAC,UAAU,8CAAqD;IACzE,SAAS,CAAC,eAAe,wDAGrB;IACJ,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAEjC,SAAS,aAAa,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,cAAc;IAMrE;;;;;OAKG;IACH,OAAc,KAAK,eACL,UAAU,WACb,cAAc,KACtB,KAAK,CAGN;IAEF;;;OAGG;IACH,OAAc,WAAW,QAAO,KAAK,CAGnC;IAEF;;;;OAIG;IACH,aAAa,UACJ,MAAM,gBACC,uBAAuB,KACpC,IAAI,CAKL;IAEF;;;;;OAKG;IACH,iBAAiB,UACR,MAAM,UACL,MAAM,aACH,iBAAiB,KAC3B,IAAI,CAWL;IAEF;;;;;;;OAOG;IACH,gBAAgB,WACN,MAAM,UACN,iBAAiB,YACf,gBAAgB,KACzB,IAAI,CAWL;IAEF;;;;OAIG;IACH,SAAS,CAAC,eAAe,UAAW,MAAM,KAAG,uBAAuB,CAOlE;IAEF;;;OAGG;IACH,SAAS,CAAC,uBAAuB,OAC3B,iBAAiB,KACpB,QAAQ,IAAI,CAAC,CAkBd;IAEF;;;;;OAKG;IACH,SAAS,CAAC,UAAU,OAAc,iBAAiB,KAAG,QAAQ,OAAO,CAAC,CAapE;IAEF;;;;OAIG;IACH,SAAS,CAAC,WAAW,OACf,iBAAiB,UACb,iBAAiB,KACxB,QAAQ,IAAI,CAAC,CAuBd;IAEF;;OAEG;IACH,SAAS,CAAC,WAAW,eAA+C;IAEpE;;;OAGG;IACH,SAAS,CAAC,eAAe,OAAc,iBAAiB,KAAG,QAAQ,IAAI,CAAC,CAWtE;IAEF;;;OAGG;IACH,SAAS,CAAC,eAAe,OAAc,iBAAiB,KAAG,QAAQ,IAAI,CAAC,CAyCtE;IAEF;;;;OAIG;IACH,MAAM,QAAa,QAAQ,IAAI,CAAC,CAgC9B;IAEF;;;;;OAKG;IACH,cAAc,WACJ,iBAAiB,yBAExB,QAAQ,MAAM,iBAAiB,CAAC,CAAC,CAclC;IAEF;;;;;;;;;OASG;IACH,KAAK,SACG,MAAM,SACL,MAAM,UACL,MAAM,gBACA,MAAM,gBACN,MAAM,4DAGnB,QAAQ,IAAI,CAAC,CAad;IAEF;;;;;OAKG;IACH,eAAe,SACP,MAAM,SACL,MAAM,UACL,iBAAiB,KACxB,QAAQ,IAAI,CAAC,CAKd;IAEF;;;;OAIG;IACH,iBAAiB,SAAgB,MAAM,SAAS,MAAM,KAAG,QAAQ,IAAI,CAAC,CAcpE;IAEF;;;;;;;;OAQG;IACH,aAAa,SACL,MAAM,SACL,MAAM,gBACC,MAAM,iBACL,MAAM,UACb,MAAM,WACL,MAAM,KACd,QAAQ,IAAI,CAAC,CAWd;IAEF;;;;;OAKG;IACH,iBAAiB,SACT,MAAM,SACL,MAAM,iBACE,MAAM,KACpB,QAAQ,IAAI,CAAC,CAKd;IAEF;;;;OAIG;IACH,iBAAiB,SAAgB,MAAM,SAAS,MAAM,KAAG,QAAQ,IAAI,CAAC,CAOpE;IAEF;;;;;OAKG;IACH,kBAAkB,SACV,MAAM,SACL,MAAM,gBACC,MAAM,KACnB,QAAQ,IAAI,CAAC,CAOd;IAEF;;;;OAIG;IACH,UAAU,SACF,MAAM,SACL,MAAM,KACZ,QAAQ,iBAAiB,GAAG,IAAI,CAAC,CAIlC;IAEF;;OAEG;IACH,WAAW,aACA,MAAM,SAAS,CAAC,KACxB,QAAQ,iBAAiB,EAAE,CAAC,CAI7B;CACH"}
+{"version":3,"file":"TxPot.d.ts","sourceRoot":"","sources":["../../lib/transaction/TxPot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,cAAc,EAAe,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EACL,gBAAgB,EAEhB,iBAAiB,EACjB,SAAS,EAET,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,qBAAa,KAAK;IAChB,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC;IACjC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAC/D,SAAS,CAAC,MAAM,uCAA8C;IAC9D,SAAS,CAAC,UAAU,2DAGhB;IACJ,SAAS,CAAC,eAAe,qEAGrB;IACJ,SAAS,CAAC,mBAAmB,8CAGzB;IACJ,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAEjC,SAAS,aAAa,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,cAAc;IAMrE;;;;;OAKG;IACH,OAAc,KAAK,eACL,UAAU,WACb,cAAc,KACtB,KAAK,CAGN;IAEF;;;OAGG;IACH,OAAc,WAAW,QAAO,KAAK,CAGnC;IAEF;;;;OAIG;IACH,aAAa,UACJ,MAAM,gBACC,uBAAuB,KACpC,IAAI,CAKL;IAEF;;;;;;OAMG;IACH,iBAAiB,UACR,MAAM,UACL,MAAM,MACV,MAAM,aACC,iBAAiB,KAC3B,IAAI,CAuBL;IAEF;;;;;OAKG;IACH,mBAAmB,UAAW,MAAM,UAAU,MAAM,MAAM,MAAM,KAAG,IAAI,CAarE;IAEF;;;;;OAKG;IACH,uBAAuB,UACd,MAAM,MACT,MAAM,aACC,iBAAiB,KAC3B,IAAI,CAkBL;IAEF;;;;OAIG;IACH,yBAAyB,UAAW,MAAM,MAAM,MAAM,KAAG,IAAI,CAa3D;IAEF;;;;;;;;OAQG;IACH,gBAAgB,WACN,MAAM,UACN,iBAAiB,MACrB,MAAM,YACA,gBAAgB,KACzB,IAAI,CA2BL;IAEF;;;;;OAKG;IACH,kBAAkB,WACR,MAAM,UACN,iBAAiB,MACrB,MAAM,KACT,IAAI,CAaL;IAEF;;;;OAIG;IACH,SAAS,CAAC,eAAe,UAAW,MAAM,KAAG,uBAAuB,CAOlE;IAEF;;;OAGG;IACH,SAAS,CAAC,uBAAuB,OAC3B,iBAAiB,KACpB,QAAQ,IAAI,CAAC,CAkBd;IAEF;;;;;OAKG;IACH,SAAS,CAAC,UAAU,OAAc,iBAAiB,KAAG,QAAQ,OAAO,CAAC,CAmBpE;IAEF;;;;;OAKG;IACH,SAAS,CAAC,eAAe,OACnB,iBAAiB,KACpB,QAAQ,OAAO,CAAC,CAkBjB;IAEF;;;;OAIG;IACH,SAAS,CAAC,WAAW,OACf,iBAAiB,UACb,iBAAiB,KACxB,QAAQ,IAAI,CAAC,CAyBd;IAEF;;OAEG;IACH,SAAS,CAAC,WAAW,eAA+C;IAEpE;;;OAGG;IACH,SAAS,CAAC,eAAe,OAAc,iBAAiB,KAAG,QAAQ,IAAI,CAAC,CAYtE;IAEF;;;OAGG;IACH,SAAS,CAAC,eAAe,OAAc,iBAAiB,KAAG,QAAQ,IAAI,CAAC,CAoDtE;IAEF;;;;OAIG;IACH,MAAM,QAAa,QAAQ,IAAI,CAAC,CAkC9B;IAEF;;;;;OAKG;IACH,cAAc,WACJ,iBAAiB,yBAExB,QAAQ,MAAM,iBAAiB,CAAC,CAAC,CAclC;IAEF;;;;;;;;;;;;OAYG;IACH,KAAK,SACG,MAAM,SACL,MAAM,UACL,MAAM,gBACA,MAAM,gBACN,MAAM,iEAGZ,MAAM,GAAG,IAAI,WACZ,MAAM,GAAG,IAAI,KACrB,QAAQ,IAAI,CAAC,CAed;IAEF;;;;;OAKG;IACH,eAAe,SACP,MAAM,SACL,MAAM,UACL,iBAAiB,KACxB,QAAQ,IAAI,CAAC,CAKd;IAEF;;;;OAIG;IACH,iBAAiB,SAAgB,MAAM,SAAS,MAAM,KAAG,QAAQ,IAAI,CAAC,CAcpE;IAEF;;;;;;;;OAQG;IACH,aAAa,SACL,MAAM,SACL,MAAM,gBACC,MAAM,iBACL,MAAM,UACb,MAAM,WACL,MAAM,KACd,QAAQ,IAAI,CAAC,CAWd;IAEF;;;;;OAKG;IACH,iBAAiB,SACT,MAAM,SACL,MAAM,iBACE,MAAM,KACpB,QAAQ,IAAI,CAAC,CAKd;IAEF;;;;OAIG;IACH,iBAAiB,SAAgB,MAAM,SAAS,MAAM,KAAG,QAAQ,IAAI,CAAC,CAOpE;IAEF;;;;;OAKG;IACH,kBAAkB,SACV,MAAM,SACL,MAAM,gBACC,MAAM,KACnB,QAAQ,IAAI,CAAC,CAOd;IAEF;;;;OAIG;IACH,UAAU,SACF,MAAM,SACL,MAAM,KACZ,QAAQ,iBAAiB,GAAG,IAAI,CAAC,CAIlC;IAEF;;OAEG;IACH,WAAW,aACA,MAAM,SAAS,CAAC,KACxB,QAAQ,iBAAiB,EAAE,CAAC,CAI7B;IAEF;;;;;;OAMG;IACH,WAAW,SACH,MAAM,SACL,MAAM,UACL,MAAM,GAAG,IAAI,WACZ,MAAM,GAAG,IAAI,KACrB,QAAQ,IAAI,CAAC,CAGd;CACH"}