@hirosystems/orchestra-types - npm Package Compare versions

Comparing version 1.0.1-beta.0 to 1.0.1-beta.1

dist/index.d.ts

 export interface BitcoinChainEvent {
     apply: BitcoinApply[];
-    chainhook: Chainhook;
+    chainhook: {
+        uuid: string;
+        predicate: BitcoinPredicate;
+    };
 }
 export interface StacksChainEvent {
     apply: StacksApply[];
-    chainhook: Chainhook;
+    chainhook: {
+        uuid: string;
+        predicate: StacksPredicate;
+    };
 }
@@ -21,6 +27,70 @@ export interface BitcoinApply {
 }
-export interface Chainhook {
+export interface StacksChainhook {
     uuid: string;
-    predicate: any;
+    predicate: StacksPredicate;
 }
+export interface StacksPredicate {
+    type: StacksPredicateType;
+    rule: StacksContractCallBasedPredicate | StacksPrintEventBasedPredicate | StacksFtEventBasedPredicate | StacksNftEventBasedPredicate | StacksStxEventBasedPredicate;
+}
+export declare enum StacksPredicateType {
+    ContractCall = "contract_call",
+    PrintEvent = "print_event",
+    FtEvent = "ft_event",
+    NftEvent = "nft_event",
+    StxEvent = "stx_event"
+}
+export interface BitcoinChainhook {
+    uuid: string;
+    predicate: BitcoinPredicate;
+}
+export declare enum BitcoinPredicateScope {
+    Inputs = "inputs",
+    Outputs = "outputs"
+}
+export interface BitcoinPredicate {
+    scope: BitcoinPredicateScope;
+    type: BitcoinPredicateType;
+    rule: BitcoinPredicateMatchingRule;
+}
+export declare enum BitcoinPredicateType {
+    Hex = "hex",
+    P2pkh = "p2pkh",
+    P2sh = "p2sh",
+    P2wpkh = "p2wpkh",
+    P2wsh = "p2wsh",
+    Script = "script"
+}
+export interface BitcoinPredicateMatchingRule {
+    equals?: string;
+    starts_with?: string;
+    ends_with?: string;
+}
+export interface StacksPrintEventBasedPredicate {
+    contract_identifier: string;
+    contains: string;
+}
+export interface StacksFtEventBasedPredicate {
+    asset_identifier: string;
+    actions: string[];
+}
+export interface StacksContractCallBasedPredicate {
+    contract_identifier: string;
+    method: string;
+}
+export interface StacksPrintEventBasedPredicate {
+    contract_identifier: string;
+    contains: string;
+}
+export interface StacksFtEventBasedPredicate {
+    asset_identifier: string;
+    actions: string[];
+}
+export interface StacksNftEventBasedPredicate {
+    asset_identifier: string;
+    actions: string[];
+}
+export interface StacksStxEventBasedPredicate {
+    actions: string[];
+}
 /**
@@ -33,3 +103,2 @@ * In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.
     /**
-     *
      * @type {string}
@@ -40,3 +109,2 @@ * @memberof SubNetworkIdentifier
     /**
-     *
      * @type {object}
@@ -54,3 +122,2 @@ * @memberof SubNetworkIdentifier
     /**
-     *
      * @type {string}
@@ -67,3 +134,2 @@ * @memberof NetworkIdentifier
     /**
-     *
      * @type {SubNetworkIdentifier}
@@ -90,3 +156,2 @@ * @memberof NetworkIdentifier
     /**
-     *
      * @type {NetworkIdentifier}
@@ -97,3 +162,2 @@ * @memberof RelatedTransaction
     /**
-     *
      * @type {TransactionIdentifier}
@@ -104,3 +168,2 @@ * @memberof RelatedTransaction
     /**
-     *
      * @type {Direction}
@@ -131,3 +194,2 @@ * @memberof RelatedTransaction
     /**
-     *
      * @type {boolean}
@@ -138,3 +200,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string}
@@ -145,3 +206,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string[]}
@@ -152,3 +212,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string}
@@ -159,3 +218,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {boolean}
@@ -166,3 +224,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string}
@@ -173,3 +230,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string}
@@ -180,3 +236,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {number}
@@ -187,3 +242,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {StacksTransactionKind}
@@ -194,3 +248,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {StacksTransactionReceipt}
@@ -201,3 +254,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {StacksTransactionExecutionCost}
@@ -210,3 +262,2 @@ * @memberof StacksTransactionMetadata
     /**
-     *
      * @type {string[]}
@@ -217,3 +268,2 @@ * @memberof StacksTransactionReceipt
     /**
-     *
      * @type {string[]}
@@ -224,3 +274,2 @@ * @memberof StacksTransactionReceipt
     /**
-     *
      * @type {StacksTransactionEvent[]}
@@ -237,3 +286,2 @@ * @memberof StacksTransactionReceipt
     /**
-     *
      * @type {string}
@@ -244,3 +292,2 @@ * @memberof StacksContractDeploymentData
     /**
-     *
      * @type {string[]}
@@ -253,3 +300,2 @@ * @memberof StacksContractDeploymentData
     /**
-     *
      * @type {number}
@@ -260,3 +306,2 @@ * @memberof StacksTransactionExecutionCost
     /**
-     *
      * @type {number}
@@ -267,3 +312,2 @@ * @memberof StacksTransactionExecutionCost
     /**
-     *
      * @type {number}
@@ -274,3 +318,2 @@ * @memberof StacksTransactionExecutionCost
     /**
-     *
      * @type {number}
@@ -281,3 +324,2 @@ * @memberof StacksTransactionExecutionCost
     /**
-     *
      * @type {number}
@@ -415,3 +457,2 @@ * @memberof StacksTransactionExecutionCost
     /**
-     *
      * @type {TransactionIdentifier}
@@ -422,3 +463,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<Operation>}
@@ -429,3 +469,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<RelatedTransaction>}
@@ -449,3 +488,2 @@ * @memberof Transaction
     /**
-     *
      * @type {TransactionIdentifier}
@@ -456,3 +494,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<Operation>}
@@ -463,3 +500,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<RelatedTransaction>}
@@ -483,3 +519,2 @@ * @memberof Transaction
     /**
-     *
      * @type {TransactionIdentifier}
@@ -490,3 +525,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<Operation>}
@@ -497,3 +531,2 @@ * @memberof Transaction
     /**
-     *
      * @type {Array<RelatedTransaction>}
@@ -517,3 +550,2 @@ * @memberof Transaction
     /**
-     *
      * @type {BlockIdentifier}
@@ -524,3 +556,2 @@ * @memberof StacksBlockMetadata
     /**
-     *
      * @type {number}
@@ -531,3 +562,2 @@ * @memberof StacksBlockMetadata
     /**
-     *
      * @type {number}
@@ -538,3 +568,2 @@ * @memberof StacksBlockMetadata
     /**
-     *
      * @type {number}
@@ -565,3 +594,2 @@ * @memberof StacksBlockMetadata
     /**
-     *
      * @type {string}
@@ -579,3 +607,2 @@ * @memberof BlockIdentifier
     /**
-     *
      * @type {BlockIdentifier}
@@ -586,3 +613,2 @@ * @memberof Block
     /**
-     *
      * @type {BlockIdentifier}
@@ -599,3 +625,2 @@ * @memberof Block
     /**
-     *
      * @type {Array<Transaction>}
@@ -606,3 +631,2 @@ * @memberof Block
     /**
-     *
      * @type {object}
@@ -645,3 +669,2 @@ * @memberof Block
     /**
-     *
      * @type {SubAccountIdentifier}
@@ -684,3 +707,2 @@ * @memberof AccountIdentifier
     /**
-     *
      * @type {OperationIdentifier}
@@ -709,3 +731,2 @@ * @memberof Operation
     /**
-     *
      * @type {AccountIdentifier}
@@ -716,3 +737,2 @@ * @memberof Operation
     /**
-     *
      * @type {Amount}
@@ -723,3 +743,2 @@ * @memberof Operation
     /**
-     *
      * @type {CoinChange}
@@ -730,3 +749,2 @@ * @memberof Operation
     /**
-     *
      * @type {object}
@@ -750,3 +768,2 @@ * @memberof Operation
     /**
-     *
      * @type {Currency}
@@ -757,3 +774,2 @@ * @memberof Amount
     /**
-     *
      * @type {object}
@@ -809,3 +825,2 @@ * @memberof Amount
     /**
-     *
      * @type {CoinIdentifier}
@@ -816,3 +831,2 @@ * @memberof CoinChange
     /**
-     *
      * @type {CoinAction}
@@ -819,0 +833,0 @@ * @memberof CoinChange

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoinAction = exports.StacksTransactionEventType = exports.StacksTransactionKind = exports.Direction = void 0;
+exports.CoinAction = exports.StacksTransactionEventType = exports.StacksTransactionKind = exports.Direction = exports.BitcoinPredicateType = exports.BitcoinPredicateScope = exports.StacksPredicateType = void 0;
+var StacksPredicateType;
+(function (StacksPredicateType) {
+    StacksPredicateType["ContractCall"] = "contract_call";
+    StacksPredicateType["PrintEvent"] = "print_event";
+    StacksPredicateType["FtEvent"] = "ft_event";
+    StacksPredicateType["NftEvent"] = "nft_event";
+    StacksPredicateType["StxEvent"] = "stx_event";
+})(StacksPredicateType = exports.StacksPredicateType || (exports.StacksPredicateType = {}));
+var BitcoinPredicateScope;
+(function (BitcoinPredicateScope) {
+    BitcoinPredicateScope["Inputs"] = "inputs";
+    BitcoinPredicateScope["Outputs"] = "outputs";
+})(BitcoinPredicateScope = exports.BitcoinPredicateScope || (exports.BitcoinPredicateScope = {}));
+var BitcoinPredicateType;
+(function (BitcoinPredicateType) {
+    BitcoinPredicateType["Hex"] = "hex";
+    BitcoinPredicateType["P2pkh"] = "p2pkh";
+    BitcoinPredicateType["P2sh"] = "p2sh";
+    BitcoinPredicateType["P2wpkh"] = "p2wpkh";
+    BitcoinPredicateType["P2wsh"] = "p2wsh";
+    BitcoinPredicateType["Script"] = "script";
+})(BitcoinPredicateType = exports.BitcoinPredicateType || (exports.BitcoinPredicateType = {}));
 /**
@@ -5,0 +27,0 @@ * Used by RelatedTransaction to indicate the direction of the relation (i.e. cross-shard/cross-network sends may reference `backward` to an earlier transaction and async execution may reference `forward`). Can be used to indicate if a transaction relation is from child to parent or the reverse.

package.json

 {
   "name": "@hirosystems/orchestra-types",
-  "version": "1.0.1-beta.0",
+  "version": "1.0.1-beta.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/index.ts

 export interface BitcoinChainEvent {
   apply: BitcoinApply[];
-  chainhook: Chainhook;
+  chainhook: {
+    uuid: string;
+    predicate: BitcoinPredicate;
+  };
 }
@@ -8,3 +11,6 @@
   apply: StacksApply[];
-  chainhook: Chainhook;
+  chainhook: {
+    uuid: string;
+    predicate: StacksPredicate;
+  };
 }
@@ -26,7 +32,90 @@
 
-export interface Chainhook {
+export interface StacksChainhook {
   uuid: string;
-  predicate: any;
+  predicate: StacksPredicate;
 }
 
+export interface StacksPredicate {
+  type: StacksPredicateType;
+  rule:
+    | StacksContractCallBasedPredicate
+    | StacksPrintEventBasedPredicate
+    | StacksFtEventBasedPredicate
+    | StacksNftEventBasedPredicate
+    | StacksStxEventBasedPredicate;
+}
+
+export enum StacksPredicateType {
+  ContractCall = "contract_call",
+  PrintEvent = "print_event",
+  FtEvent = "ft_event",
+  NftEvent = "nft_event",
+  StxEvent = "stx_event",
+}
+
+export interface BitcoinChainhook {
+  uuid: string;
+  predicate: BitcoinPredicate;
+}
+
+export enum BitcoinPredicateScope {
+  Inputs = "inputs",
+  Outputs = "outputs",
+}
+
+export interface BitcoinPredicate {
+  scope: BitcoinPredicateScope;
+  type: BitcoinPredicateType;
+  rule: BitcoinPredicateMatchingRule;
+}
+
+export enum BitcoinPredicateType {
+  Hex = "hex",
+  P2pkh = "p2pkh",
+  P2sh = "p2sh",
+  P2wpkh = "p2wpkh",
+  P2wsh = "p2wsh",
+  Script = "script",
+}
+
+export interface BitcoinPredicateMatchingRule {
+  equals?: string;
+  starts_with?: string;
+  ends_with?: string;
+}
+
+export interface StacksPrintEventBasedPredicate {
+  contract_identifier: string;
+  contains: string;
+}
+
+export interface StacksFtEventBasedPredicate {
+  asset_identifier: string;
+  actions: string[];
+}
+
+export interface StacksContractCallBasedPredicate {
+  contract_identifier: string;
+  method: string;
+}
+
+export interface StacksPrintEventBasedPredicate {
+  contract_identifier: string;
+  contains: string;
+}
+
+export interface StacksFtEventBasedPredicate {
+  asset_identifier: string;
+  actions: string[];
+}
+
+export interface StacksNftEventBasedPredicate {
+  asset_identifier: string;
+  actions: string[];
+}
+
+export interface StacksStxEventBasedPredicate {
+  actions: string[];
+}
+
 /**
@@ -37,5 +126,4 @@ * In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.
  */
- export interface SubNetworkIdentifier {
+export interface SubNetworkIdentifier {
   /**
-   *
    * @type {string}
@@ -46,3 +134,2 @@ * @memberof SubNetworkIdentifier
   /**
-   *
    * @type {object}
@@ -61,3 +148,2 @@ * @memberof SubNetworkIdentifier
   /**
-   *
    * @type {string}
@@ -74,3 +160,2 @@ * @memberof NetworkIdentifier
   /**
-   *
    * @type {SubNetworkIdentifier}
@@ -99,3 +184,2 @@ * @memberof NetworkIdentifier
   /**
-   *
    * @type {NetworkIdentifier}
@@ -106,3 +190,2 @@ * @memberof RelatedTransaction
   /**
-   *
    * @type {TransactionIdentifier}
@@ -113,3 +196,2 @@ * @memberof RelatedTransaction
   /**
-   *
    * @type {Direction}
@@ -142,3 +224,2 @@ * @memberof RelatedTransaction
   /**
-   *
    * @type {boolean}
@@ -149,3 +230,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string}
@@ -156,3 +236,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string[]}
@@ -163,3 +242,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string}
@@ -170,3 +248,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {boolean}
@@ -177,3 +254,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string}
@@ -184,3 +260,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string}
@@ -191,3 +266,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {number}
@@ -198,3 +272,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {StacksTransactionKind}
@@ -205,3 +278,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {StacksTransactionReceipt}
@@ -212,3 +284,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {StacksTransactionExecutionCost}
@@ -222,3 +293,2 @@ * @memberof StacksTransactionMetadata
   /**
-   *
    * @type {string[]}
@@ -229,3 +299,2 @@ * @memberof StacksTransactionReceipt
   /**
-   *
    * @type {string[]}
@@ -236,3 +305,2 @@ * @memberof StacksTransactionReceipt
   /**
-   *
    * @type {StacksTransactionEvent[]}
@@ -245,18 +313,19 @@ * @memberof StacksTransactionReceipt
 export interface StacksTransactionEvent {
-  type: StacksTransactionEventType,
-  data: StacksSTXTransferEventData
-      | StacksSTXMintEventData
-      | StacksSTXLockEventData
-      | StacksSTXBurnEventData
-      | StacksNFTTransferEventData
-      | StacksNFTMintEventData
-      | StacksNFTBurnEventData
-      | StacksFTTransferEventData
-      | StacksFTMintEventData
-      | StacksFTBurnEventData
-      | StacksDataVarSetEventData
-      | StacksDataMapInsertEventData
-      | StacksDataMapUpdateEventData
-      | StacksDataMapDeleteEventData
-      | StacksSmartContractEventData;
+  type: StacksTransactionEventType;
+  data:
+    | StacksSTXTransferEventData
+    | StacksSTXMintEventData
+    | StacksSTXLockEventData
+    | StacksSTXBurnEventData
+    | StacksNFTTransferEventData
+    | StacksNFTMintEventData
+    | StacksNFTBurnEventData
+    | StacksFTTransferEventData
+    | StacksFTMintEventData
+    | StacksFTBurnEventData
+    | StacksDataVarSetEventData
+    | StacksDataMapInsertEventData
+    | StacksDataMapUpdateEventData
+    | StacksDataMapDeleteEventData
+    | StacksSmartContractEventData;
 }
@@ -266,3 +335,2 @@
   /**
-   *
    * @type {string}
@@ -273,3 +341,2 @@ * @memberof StacksContractDeploymentData
   /**
-   *
    * @type {string[]}
@@ -283,3 +350,2 @@ * @memberof StacksContractDeploymentData
   /**
-   *
    * @type {number}
@@ -290,3 +356,2 @@ * @memberof StacksTransactionExecutionCost
   /**
-   *
    * @type {number}
@@ -297,3 +362,2 @@ * @memberof StacksTransactionExecutionCost
   /**
-   *
    * @type {number}
@@ -304,3 +368,2 @@ * @memberof StacksTransactionExecutionCost
   /**
-   *
    * @type {number}
@@ -311,3 +374,2 @@ * @memberof StacksTransactionExecutionCost
   /**
-   *
    * @type {number}
@@ -449,9 +511,9 @@ * @memberof StacksTransactionExecutionCost
   previous_output: string;
-  script_sig:      string;
-  sequence:        number;
-  witness:         any[];
+  script_sig: string;
+  sequence: number;
+  witness: any[];
 }
 
 export interface Output {
-  value:         number;
+  value: number;
   script_pubkey: string;
@@ -465,5 +527,4 @@ }
  */
- export interface StacksTransaction {
+export interface StacksTransaction {
   /**
-   *
    * @type {TransactionIdentifier}
@@ -474,3 +535,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<Operation>}
@@ -481,3 +541,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<RelatedTransaction>}
@@ -500,5 +559,4 @@ * @memberof Transaction
  */
- export interface BitcoinTransaction {
+export interface BitcoinTransaction {
   /**
-   *
    * @type {TransactionIdentifier}
@@ -509,3 +567,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<Operation>}
@@ -516,3 +573,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<RelatedTransaction>}
@@ -530,3 +586,2 @@ * @memberof Transaction
 
-
 /**
@@ -539,3 +594,2 @@ * Transactions contain an array of Operations that are attributable to the same TransactionIdentifier.
   /**
-   *
    * @type {TransactionIdentifier}
@@ -546,3 +600,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<Operation>}
@@ -553,3 +606,2 @@ * @memberof Transaction
   /**
-   *
    * @type {Array<RelatedTransaction>}
@@ -574,3 +626,2 @@ * @memberof Transaction
   /**
-   *
    * @type {BlockIdentifier}
@@ -581,3 +632,2 @@ * @memberof StacksBlockMetadata
   /**
-   *
    * @type {number}
@@ -588,3 +638,2 @@ * @memberof StacksBlockMetadata
   /**
-   *
    * @type {number}
@@ -595,3 +644,2 @@ * @memberof StacksBlockMetadata
   /**
-   *
    * @type {number}
@@ -623,3 +671,2 @@ * @memberof StacksBlockMetadata
   /**
-   *
    * @type {string}
@@ -638,3 +685,2 @@ * @memberof BlockIdentifier
   /**
-   *
    * @type {BlockIdentifier}
@@ -645,3 +691,2 @@ * @memberof Block
   /**
-   *
    * @type {BlockIdentifier}
@@ -658,3 +703,2 @@ * @memberof Block
   /**
-   *
    * @type {Array<Transaction>}
@@ -665,3 +709,2 @@ * @memberof Block
   /**
-   *
    * @type {object}
@@ -706,3 +749,2 @@ * @memberof Block
   /**
-   *
    * @type {SubAccountIdentifier}
@@ -747,3 +789,2 @@ * @memberof AccountIdentifier
   /**
-   *
    * @type {OperationIdentifier}
@@ -772,3 +813,2 @@ * @memberof Operation
   /**
-   *
    * @type {AccountIdentifier}
@@ -779,3 +819,2 @@ * @memberof Operation
   /**
-   *
    * @type {Amount}
@@ -786,3 +825,2 @@ * @memberof Operation
   /**
-   *
    * @type {CoinChange}
@@ -793,3 +831,2 @@ * @memberof Operation
   /**
-   *
    * @type {object}
@@ -814,3 +851,2 @@ * @memberof Operation
   /**
-   *
    * @type {Currency}
@@ -821,3 +857,2 @@ * @memberof Amount
   /**
-   *
    * @type {object}
@@ -876,3 +911,2 @@ * @memberof Amount
   /**
-   *
    * @type {CoinIdentifier}
@@ -883,3 +917,2 @@ * @memberof CoinChange
   /**
-   *
    * @type {CoinAction}
@@ -886,0 +919,0 @@ * @memberof CoinChange

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79080

increased by8.17%

Lines of code

1951

increased by2.96%

No dependency changes