@stacks/codec 2.0.0-pox5.3 → 2.0.0-pox5.5

package/index.d.ts

@@ -2,7 +2,7 @@ import * as bindings from './loader.js';
 export * from './loader.js';
 export declare const StacksNativeEncodingBindings: typeof bindings;
 export default StacksNativeEncodingBindings;
-export type TxPostCondition = PostConditionStx | PostConditionFungible | PostConditionNonfungible;
+export type TxPostCondition = PostConditionStx | PostConditionFungible | PostConditionNonfungible | PostConditionStaking | PostConditionPox;
 export interface DecodedPostConditionsResult {
     post_condition_mode: PostConditionModeID;
     post_conditions: TxPostCondition[];
@@ -23,7 +23,9 @@ export interface DecodedTxResult {
 export declare enum PostConditionAssetInfoID {
     STX = 0,
     FungibleAsset = 1,
-    NonfungibleAsset = 2
+    NonfungibleAsset = 2,
+    Staking = 3,
+    Pox = 4
 }
 export interface PostConditionStx {
     asset_info_id: PostConditionAssetInfoID.STX;
@@ -48,11 +50,44 @@ export interface PostConditionNonfungible {
     condition_code: PostConditionNonfungibleConditionCodeID;
     condition_name: PostConditionNonFungibleConditionName;
 }
+/**
+ * Constrains how much STX a principal may stake (lock for PoX) during the
+ * transaction. Only valid in Stacks epoch 4.0 and later.
+ */
+export interface PostConditionStaking {
+    asset_info_id: PostConditionAssetInfoID.Staking;
+    principal: PostConditionPrincipal;
+    condition_code: PostConditionFungibleConditionCodeID;
+    condition_name: PostConditionFungibleConditionCodeName;
+    amount: string;
+}
+/**
+ * Constrains whether a principal may perform a position-altering PoX
+ * operation (`unstake`, `unstake-sbtc`, `update-bond-registration`,
+ * `announce-l1-early-exit`) during the transaction. Only valid in Stacks
+ * epoch 4.0 and later.
+ */
+export interface PostConditionPox {
+    asset_info_id: PostConditionAssetInfoID.Pox;
+    principal: PostConditionPrincipal;
+    condition_code: PostConditionPoxConditionCodeID;
+    condition_name: PostConditionPoxConditionCodeName;
+}
 export interface PostConditionAssetInfo {
     contract_address: string;
     contract_name: string;
     asset_name: string;
 }
+export declare enum PostConditionPoxConditionCodeID {
+    NotPerformed = 48,
+    MaybePerformed = 49,
+    Performed = 50
+}
+export declare enum PostConditionPoxConditionCodeName {
+    NotPerformed = "not_performed",
+    MaybePerformed = "maybe_performed",
+    Performed = "performed"
+}
 export declare enum PostConditionNonfungibleConditionCodeID {
     Sent = 16,
     NotSent = 17,
@@ -803,6 +838,23 @@ export interface Pox5EventAddToAllowlist extends Pox5EventBase {
         bond_index: string;
     };
 }
+/** One proven L1 output in a `register-for-bond` `btc_lockup`. */
+export interface Pox5BtcLockupTx {
+    /** Reversed (big-endian) txid as a `0x`-prefixed hex string. */
+    txid: string;
+    /** String-quoted unsigned integer */
+    output_index: string;
+}
+/** The `btc_lockup` sub-object of a `register-for-bond` event. */
+export interface Pox5BtcLockup {
+    /** `'l1'` for a Bitcoin L1 lockup, `'l2'` for an sBTC lockup. */
+    type: string;
+    /**
+     * The proven L1 outputs for an `'l1'` lockup, or `null` for an `'l2'`
+     * (sBTC) lockup.
+     */
+    txs: Pox5BtcLockupTx[] | null;
+}
 export interface Pox5EventRegisterForBond extends Pox5EventBase {
     name: Pox5EventName.RegisterForBond;
     data: {
@@ -824,6 +876,8 @@ export interface Pox5EventRegisterForBond extends Pox5EventBase {
         unlock_cycle: string;
         /** True if the participant proved an L1 BTC lockup; false if they locked sBTC. */
         is_l1_lock: boolean;
+        /** How the BTC was locked (L1 proof outputs vs. sBTC). */
+        btc_lockup: Pox5BtcLockup;
     };
 }
 export interface Pox5EventUpdateBondRegistration extends Pox5EventBase {

package/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pox5EventName = exports.Pox4EventName = exports.ClarityTypeID = exports.PostConditionModeID = exports.AnchorModeID = exports.TransactionVersion = exports.TxPublicKeyEncoding = exports.TxAuthFieldTypeID = exports.ClarityVersion = exports.TxSpendingConditionMultiSigHashMode = exports.TxSpendingConditionSingleSigHashMode = exports.PostConditionAuthFlag = exports.TxPayloadTypeID = exports.TenureChangeCause = exports.PrincipalTypeID = exports.PostConditionPrincipalTypeID = exports.PostConditionFungibleConditionCodeName = exports.PostConditionFungibleConditionCodeID = exports.PostConditionNonFungibleConditionName = exports.PostConditionNonfungibleConditionCodeID = exports.PostConditionAssetInfoID = exports.StacksNativeEncodingBindings = void 0;
+exports.Pox5EventName = exports.Pox4EventName = exports.ClarityTypeID = exports.PostConditionModeID = exports.AnchorModeID = exports.TransactionVersion = exports.TxPublicKeyEncoding = exports.TxAuthFieldTypeID = exports.ClarityVersion = exports.TxSpendingConditionMultiSigHashMode = exports.TxSpendingConditionSingleSigHashMode = exports.PostConditionAuthFlag = exports.TxPayloadTypeID = exports.TenureChangeCause = exports.PrincipalTypeID = exports.PostConditionPrincipalTypeID = exports.PostConditionFungibleConditionCodeName = exports.PostConditionFungibleConditionCodeID = exports.PostConditionNonFungibleConditionName = exports.PostConditionNonfungibleConditionCodeID = exports.PostConditionPoxConditionCodeName = exports.PostConditionPoxConditionCodeID = exports.PostConditionAssetInfoID = exports.StacksNativeEncodingBindings = void 0;
 const bindings = __importStar(require("./loader.js"));
 __exportStar(require("./loader.js"), exports);
 exports.StacksNativeEncodingBindings = bindings;
@@ -46,7 +46,21 @@ var PostConditionAssetInfoID;
     PostConditionAssetInfoID[PostConditionAssetInfoID["STX"] = 0] = "STX";
     PostConditionAssetInfoID[PostConditionAssetInfoID["FungibleAsset"] = 1] = "FungibleAsset";
     PostConditionAssetInfoID[PostConditionAssetInfoID["NonfungibleAsset"] = 2] = "NonfungibleAsset";
+    PostConditionAssetInfoID[PostConditionAssetInfoID["Staking"] = 3] = "Staking";
+    PostConditionAssetInfoID[PostConditionAssetInfoID["Pox"] = 4] = "Pox";
 })(PostConditionAssetInfoID || (exports.PostConditionAssetInfoID = PostConditionAssetInfoID = {}));
+var PostConditionPoxConditionCodeID;
+(function (PostConditionPoxConditionCodeID) {
+    PostConditionPoxConditionCodeID[PostConditionPoxConditionCodeID["NotPerformed"] = 48] = "NotPerformed";
+    PostConditionPoxConditionCodeID[PostConditionPoxConditionCodeID["MaybePerformed"] = 49] = "MaybePerformed";
+    PostConditionPoxConditionCodeID[PostConditionPoxConditionCodeID["Performed"] = 50] = "Performed";
+})(PostConditionPoxConditionCodeID || (exports.PostConditionPoxConditionCodeID = PostConditionPoxConditionCodeID = {}));
+var PostConditionPoxConditionCodeName;
+(function (PostConditionPoxConditionCodeName) {
+    PostConditionPoxConditionCodeName["NotPerformed"] = "not_performed";
+    PostConditionPoxConditionCodeName["MaybePerformed"] = "maybe_performed";
+    PostConditionPoxConditionCodeName["Performed"] = "performed";
+})(PostConditionPoxConditionCodeName || (exports.PostConditionPoxConditionCodeName = PostConditionPoxConditionCodeName = {}));
 var PostConditionNonfungibleConditionCodeID;
 (function (PostConditionNonfungibleConditionCodeID) {
     PostConditionNonfungibleConditionCodeID[PostConditionNonfungibleConditionCodeID["Sent"] = 16] = "Sent";

package/index.mjs

@@ -6,8 +6,22 @@ var PostConditionAssetInfoID = /* @__PURE__ */ ((PostConditionAssetInfoID2) => {
   PostConditionAssetInfoID2[PostConditionAssetInfoID2["STX"] = 0] = "STX";
   PostConditionAssetInfoID2[PostConditionAssetInfoID2["FungibleAsset"] = 1] = "FungibleAsset";
   PostConditionAssetInfoID2[PostConditionAssetInfoID2["NonfungibleAsset"] = 2] = "NonfungibleAsset";
+  PostConditionAssetInfoID2[PostConditionAssetInfoID2["Staking"] = 3] = "Staking";
+  PostConditionAssetInfoID2[PostConditionAssetInfoID2["Pox"] = 4] = "Pox";
   return PostConditionAssetInfoID2;
 })(PostConditionAssetInfoID || {});
+var PostConditionPoxConditionCodeID = /* @__PURE__ */ ((PostConditionPoxConditionCodeID2) => {
+  PostConditionPoxConditionCodeID2[PostConditionPoxConditionCodeID2["NotPerformed"] = 48] = "NotPerformed";
+  PostConditionPoxConditionCodeID2[PostConditionPoxConditionCodeID2["MaybePerformed"] = 49] = "MaybePerformed";
+  PostConditionPoxConditionCodeID2[PostConditionPoxConditionCodeID2["Performed"] = 50] = "Performed";
+  return PostConditionPoxConditionCodeID2;
+})(PostConditionPoxConditionCodeID || {});
+var PostConditionPoxConditionCodeName = /* @__PURE__ */ ((PostConditionPoxConditionCodeName2) => {
+  PostConditionPoxConditionCodeName2["NotPerformed"] = "not_performed";
+  PostConditionPoxConditionCodeName2["MaybePerformed"] = "maybe_performed";
+  PostConditionPoxConditionCodeName2["Performed"] = "performed";
+  return PostConditionPoxConditionCodeName2;
+})(PostConditionPoxConditionCodeName || {});
 var PostConditionNonfungibleConditionCodeID = /* @__PURE__ */ ((PostConditionNonfungibleConditionCodeID2) => {
   PostConditionNonfungibleConditionCodeID2[PostConditionNonfungibleConditionCodeID2["Sent"] = 16] = "Sent";
   PostConditionNonfungibleConditionCodeID2[PostConditionNonfungibleConditionCodeID2["NotSent"] = 17] = "NotSent";
@@ -190,6 +204,8 @@ export {
   PostConditionModeID,
   PostConditionNonFungibleConditionName,
   PostConditionNonfungibleConditionCodeID,
+  PostConditionPoxConditionCodeID,
+  PostConditionPoxConditionCodeName,
   PostConditionPrincipalTypeID,
   Pox4EventName,
   Pox5EventName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/codec",
-  "version": "2.0.0-pox5.3",
+  "version": "2.0.0-pox5.5",
   "author": "Stacks Labs",
   "license": "GPL-3.0",
   "description": "Encoding & decoding functions for the Stacks blockchain exposed as a fast native Node.js addon",