feat: update to stacks codec, support stacks 3.4 (#2487)

rafa-stacks · web-flow · commit 61ab19f59470 · 2026-03-12T14:21:42.000-06:00
diff --git a/client/src/generated/schema.d.ts b/client/src/generated/schema.d.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -97,9 +97,9 @@
     "@fastify/swagger": "8.15.0",
     "@fastify/type-provider-typebox": "4.0.0",
     "@hirosystems/api-toolkit": "1.12.0",
-    "@hirosystems/stacks-encoding-native-js": "1.3.0",
     "@scure/base": "1.1.1",
     "@sinclair/typebox": "0.32.35",
+    "@stacks/codec": "1.6.0",
     "@stacks/common": "6.10.0",
     "@stacks/encryption": "6.13.1",
     "@stacks/network": "6.11.3",
diff --git a/src/api/controllers/db-controller.ts b/src/api/controllers/db-controller.ts
@@ -9,7 +9,7 @@ import {
   decodeClarityValueToRepr,
   decodeClarityValueToTypeName,
   decodePostConditions,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 
 import {
   RosettaBlock,
diff --git a/src/api/routes/address.ts b/src/api/routes/address.ts
@@ -14,7 +14,7 @@ import {
   parseDbTx,
 } from '../controllers/db-controller';
 import { InvalidRequestError, InvalidRequestErrorType, NotFoundError } from '../../errors';
-import { decodeClarityValueToRepr } from '@hirosystems/stacks-encoding-native-js';
+import { decodeClarityValueToRepr } from '@stacks/codec';
 import {
   handlePrincipalCache,
   handlePrincipalMempoolCache,
diff --git a/src/api/routes/debug.ts b/src/api/routes/debug.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { stacksToBitcoinAddress } from '@hirosystems/stacks-encoding-native-js';
+import { stacksToBitcoinAddress } from '@stacks/codec';
 import { htmlEscape } from 'escape-goat';
 import {
   makeSTXTokenTransfer,
diff --git a/src/api/routes/rosetta/construction.ts b/src/api/routes/rosetta/construction.ts
@@ -52,7 +52,7 @@ import {
   uintCV,
 } from '@stacks/transactions';
 import * as express from 'express';
-import { bitcoinToStacksAddress } from '@hirosystems/stacks-encoding-native-js';
+import { bitcoinToStacksAddress } from '@stacks/codec';
 import { StacksCoreRpcClient, getCoreNodeEndpoint } from '../../../core-rpc/client';
 import { DbBlock } from '../../../datastore/common';
 import { PgStore } from '../../../datastore/pg-store';
diff --git a/src/api/routes/tokens.ts b/src/api/routes/tokens.ts
@@ -1,6 +1,6 @@
 import { getPagingQueryLimit, parsePagingQueryInput, ResourceType } from '../pagination';
 import { isValidPrincipal } from '../../helpers';
-import { decodeClarityValueToRepr } from '@hirosystems/stacks-encoding-native-js';
+import { decodeClarityValueToRepr } from '@stacks/codec';
 import { getAssetEventTypeString, parseDbTx } from '../controllers/db-controller';
 import { handleChainTipCache } from '../controllers/cache-controller';
 import { has0xPrefix } from '@hirosystems/api-toolkit';
diff --git a/src/api/routes/v2/helpers.ts b/src/api/routes/v2/helpers.ts
@@ -16,7 +16,7 @@ import {
   getTxStatusString,
   parseDbTx,
 } from '../../../api/controllers/db-controller';
-import { decodeClarityValueToRepr } from '@hirosystems/stacks-encoding-native-js';
+import { decodeClarityValueToRepr } from '@stacks/codec';
 import { TransactionVersion, getAddressFromPublicKey } from '@stacks/transactions';
 import { SmartContractStatusList } from '../../schemas/entities/smart-contracts';
 import { AddressTransaction, AddressTransactionEvent } from '../../schemas/entities/addresses';
diff --git a/src/api/schemas/entities/post-conditions.ts b/src/api/schemas/entities/post-conditions.ts
@@ -1,6 +1,10 @@
 import { Static, Type } from '@sinclair/typebox';
 
-export const PostConditionModeSchema = Type.Union([Type.Literal('allow'), Type.Literal('deny')]);
+export const PostConditionModeSchema = Type.Union([
+  Type.Literal('allow'),
+  Type.Literal('deny'),
+  Type.Literal('originator'),
+]);
 
 const PostConditionPrincipalSchema = Type.Union([
   Type.Object({
@@ -46,7 +50,11 @@ const PostConditionFungibleAssetSchema = Type.Object({
 
 const PostConditionNonFungibleAssetSchema = Type.Object({
   principal: PostConditionPrincipalSchema,
-  condition_code: Type.Union([Type.Literal('sent'), Type.Literal('not_sent')]),
+  condition_code: Type.Union([
+    Type.Literal('sent'),
+    Type.Literal('not_sent'),
+    Type.Literal('maybe_sent'),
+  ]),
   type: Type.Literal('non_fungible'),
   asset_value: Type.Object({
     hex: Type.String(),
diff --git a/src/api/serializers/post-conditions.ts b/src/api/serializers/post-conditions.ts
@@ -3,7 +3,8 @@ import {
   PostConditionAssetInfoID,
   PostConditionPrincipal,
   PostConditionPrincipalTypeID,
-} from '@hirosystems/stacks-encoding-native-js';
+  PostConditionModeID,
+} from '@stacks/codec';
 
 const assetPrincipalTypeMap = {
   [PostConditionPrincipalTypeID.Origin]: 'principal_origin',
@@ -75,12 +76,13 @@ export function serializePostCondition(pc: TxPostCondition) {
   }
 }
 
-export function serializePostConditionMode(byte: number) {
-  switch (byte) {
-    case 1:
+export function serializePostConditionMode(mode: PostConditionModeID) {
+  switch (mode) {
+    case PostConditionModeID.Allow:
       return 'allow';
-    case 2:
+    case PostConditionModeID.Deny:
       return 'deny';
+    case PostConditionModeID.Originator:
+      return 'originator';
   }
-  throw new Error(`PostConditionMode byte must be either 1 or 2 but was ${byte}`);
 }
diff --git a/src/c32-addr-cache.ts b/src/c32-addr-cache.ts
@@ -9,7 +9,7 @@ and for now this approach is much easier and faster.
 
 import * as c32check from 'c32check';
 import * as LruCache from 'lru-cache';
-import { stacksAddressFromParts } from '@hirosystems/stacks-encoding-native-js';
+import { stacksAddressFromParts } from '@stacks/codec';
 
 type c32AddressFn = typeof c32check.c32address;
 
diff --git a/src/datastore/helpers.ts b/src/datastore/helpers.ts
@@ -58,7 +58,7 @@ import {
   PostConditionAuthFlag,
   PrincipalTypeID,
   TxPayloadTypeID,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import { getTxSenderAddress } from '../event-stream/reader';
 import postgres = require('postgres');
 import * as prom from 'prom-client';
diff --git a/src/event-stream/bns/bns-helpers.ts b/src/event-stream/bns/bns-helpers.ts
@@ -21,7 +21,7 @@ import {
   ClarityValueTuple,
   ClarityValueUInt,
   TxPayloadTypeID,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import { SmartContractEvent } from '../core-node-message';
 import { DbBnsNamespace, DbBnsName } from '../../datastore/common';
 import { hexToBuffer, hexToUtf8String } from '@hirosystems/api-toolkit';
diff --git a/src/event-stream/core-node-message.ts b/src/event-stream/core-node-message.ts
@@ -1,4 +1,4 @@
-import { DecodedTxResult } from '@hirosystems/stacks-encoding-native-js';
+import { DecodedTxResult } from '@stacks/codec';
 import { ClarityAbi } from './contract-abi';
 
 export enum CoreNodeEventType {
diff --git a/src/event-stream/event-server.ts b/src/event-stream/event-server.ts
@@ -59,7 +59,7 @@ import {
   ClarityValueStringAscii,
   ClarityValueTuple,
   TxPayloadTypeID,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import { BnsContractIdentifier } from './bns/bns-constants';
 import {
   parseNameFromContractEvent,
diff --git a/src/event-stream/pox-event-parsing.ts b/src/event-stream/pox-event-parsing.ts
@@ -29,7 +29,7 @@ import {
   ClarityValueTuple,
   ClarityValueUInt,
   decodeClarityValue,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import { poxAddressToBtcAddress } from '@stacks/stacking';
 import { SyntheticPoxEventName } from '../pox-helpers';
 import { logger } from '../logger';
diff --git a/src/event-stream/reader.ts b/src/event-stream/reader.ts
@@ -34,7 +34,7 @@ import {
   TxSpendingConditionSingleSigHashMode,
   decodeClarityValueList,
   ClarityValueBuffer,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import {
   DbMicroblockPartial,
   DbPoxSyntheticDelegateStxEvent,
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -4,10 +4,7 @@ import * as btc from 'bitcoinjs-lib';
 import * as dotenv from 'dotenv-flow';
 import * as http from 'http';
 import * as path from 'path';
-import {
-  isValidStacksAddress,
-  stacksToBitcoinAddress,
-} from '@hirosystems/stacks-encoding-native-js';
+import { isValidStacksAddress, stacksToBitcoinAddress } from '@stacks/codec';
 import * as stream from 'stream';
 import * as ecc from 'tiny-secp256k1';
 import * as util from 'util';
diff --git a/src/import-v1/index.ts b/src/import-v1/index.ts
@@ -5,7 +5,7 @@ import * as util from 'util';
 import * as readline from 'readline';
 import * as path from 'path';
 import * as zlib from 'zlib';
-import { bitcoinToStacksAddress } from '@hirosystems/stacks-encoding-native-js';
+import { bitcoinToStacksAddress } from '@stacks/codec';
 import * as split2 from 'split2';
 import {
   DataStoreBnsBlockTxData,
diff --git a/src/inspector-util.ts b/src/inspector-util.ts
@@ -9,7 +9,7 @@ import { Socket } from 'net';
 import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs';
-import { startProfiler, stopProfiler } from '@hirosystems/stacks-encoding-native-js';
+import { startProfiler, stopProfiler } from '@stacks/codec';
 import { logger } from './logger';
 import { stopwatch, Stopwatch, timeout } from '@hirosystems/api-toolkit';
 
diff --git a/src/rosetta/rosetta-helpers.ts b/src/rosetta/rosetta-helpers.ts
@@ -65,7 +65,7 @@ import {
   decodeClarityValueList,
   ClarityValue,
   ClarityValueList,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import { PgStore } from '../datastore/pg-store';
 import { poxAddressToBtcAddress } from '@stacks/stacking';
 import { parseRecoverableSignatureVrs } from '@stacks/common';
diff --git a/tests/2.5/pox-4-burnchain-delegate-stx.test.ts b/tests/2.5/pox-4-burnchain-delegate-stx.test.ts
@@ -31,7 +31,7 @@ import { StacksNetwork } from '@stacks/network';
 import { RPCClient } from 'rpc-bitcoin';
 import * as supertest from 'supertest';
 import { PoxContractIdentifier } from '../../src/pox-helpers';
-import { ClarityValueUInt, decodeClarityValue } from '@hirosystems/stacks-encoding-native-js';
+import { ClarityValueUInt, decodeClarityValue } from '@stacks/codec';
 import { decodeBtcAddress, poxAddressToBtcAddress } from '@stacks/stacking';
 import { timeout } from '@hirosystems/api-toolkit';
 import { AddressStxBalance } from '../../src/api/schemas/entities/addresses';
diff --git a/tests/2.5/pox-4-burnchain-stack-stx.test.ts b/tests/2.5/pox-4-burnchain-stack-stx.test.ts
@@ -30,7 +30,7 @@ import { ApiServer } from '../../src/api/init';
 import { StacksNetwork } from '@stacks/network';
 import { RPCClient } from 'rpc-bitcoin';
 import * as supertest from 'supertest';
-import { ClarityValueUInt, decodeClarityValue } from '@hirosystems/stacks-encoding-native-js';
+import { ClarityValueUInt, decodeClarityValue } from '@stacks/codec';
 import { decodeBtcAddress, poxAddressToTuple } from '@stacks/stacking';
 import { timeout } from '@hirosystems/api-toolkit';
 import { hexToBytes } from '@stacks/common';
diff --git a/tests/2.5/pox-4-delegate-aggregation.test.ts b/tests/2.5/pox-4-delegate-aggregation.test.ts
@@ -33,7 +33,7 @@ import {
   ClarityValueTuple,
   ClarityValueUInt,
   decodeClarityValue,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import * as assert from 'assert';
 import { hexToBytes } from '@stacks/common';
 import { StackingClient } from '@stacks/stacking';
diff --git a/tests/2.5/pox-4-delegate-revoked-stacking.test.ts b/tests/2.5/pox-4-delegate-revoked-stacking.test.ts
@@ -13,11 +13,7 @@ import {
   standardPrincipalCV,
   uintCV,
 } from '@stacks/transactions';
-import {
-  ClarityValueTuple,
-  ClarityValueUInt,
-  decodeClarityValue,
-} from '@hirosystems/stacks-encoding-native-js';
+import { ClarityValueTuple, ClarityValueUInt, decodeClarityValue } from '@stacks/codec';
 import { testnetKeys } from '../../src/api/routes/debug';
 import { CoreRpcPoxInfo } from '../../src/core-rpc/client';
 import { DbTxStatus } from '../../src/datastore/common';
diff --git a/tests/2.5/pox-4-delegate-stacking.test.ts b/tests/2.5/pox-4-delegate-stacking.test.ts
@@ -24,7 +24,7 @@ import {
   standardPrincipalCV,
   uintCV,
 } from '@stacks/transactions';
-import { ClarityValueTuple, ClarityValueUInt } from '@hirosystems/stacks-encoding-native-js';
+import { ClarityValueTuple, ClarityValueUInt } from '@stacks/codec';
 import * as assert from 'assert';
 import { StackingClient } from '@stacks/stacking';
 import { getPublicKeyFromPrivate } from '@stacks/encryption';
diff --git a/tests/api/address.test.ts b/tests/api/address.test.ts
@@ -12,7 +12,7 @@ import {
   serializeCV,
 } from '@stacks/transactions';
 import { createClarityValueArray } from '../../src/stacks-encoding-helpers';
-import { decodeTransaction } from '@hirosystems/stacks-encoding-native-js';
+import { decodeTransaction } from '@stacks/codec';
 import {
   DbBlock,
   DbTxTypeId,
diff --git a/tests/api/helpers.test.ts b/tests/api/helpers.test.ts
@@ -1,9 +1,6 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import * as c32check from 'c32check';
-import {
-  bitcoinToStacksAddress,
-  stacksToBitcoinAddress,
-} from '@hirosystems/stacks-encoding-native-js';
+import { bitcoinToStacksAddress, stacksToBitcoinAddress } from '@stacks/codec';
 import * as c32AddrCache from '../../src/c32-addr-cache';
 import { ADDR_CACHE_ENV_VAR } from '../../src/c32-addr-cache';
 import { isValidBitcoinAddress, getUintEnvOrDefault, BitVec } from '../../src/helpers';
diff --git a/tests/api/import-genesis.test.ts b/tests/api/import-genesis.test.ts
@@ -1,5 +1,5 @@
 import { importV1TokenOfferingData } from '../../src/import-v1';
-import { bitcoinToStacksAddress } from '@hirosystems/stacks-encoding-native-js';
+import { bitcoinToStacksAddress } from '@stacks/codec';
 import { PgWriteStore } from '../../src/datastore/pg-write-store';
 import { migrate } from '../utils/test-helpers';
 
diff --git a/tests/api/parse-db-tx.test.ts b/tests/api/parse-db-tx.test.ts
@@ -1,6 +1,6 @@
 import { migrate } from '../utils/test-helpers';
 import { importEventsFromTsv } from '../../src/event-replay/event-replay';
-import { decodeClarityValueList } from '@hirosystems/stacks-encoding-native-js';
+import { decodeClarityValueList } from '@stacks/codec';
 import * as fs from 'fs';
 import * as readline from 'readline';
 import { PgSqlClient, timeout } from '@hirosystems/api-toolkit';
diff --git a/tests/api/synthetic-stx-txs.test.ts b/tests/api/synthetic-stx-txs.test.ts
@@ -1,7 +1,7 @@
 import { ChainID } from '@stacks/transactions';
 import * as fs from 'fs';
 import * as path from 'path';
-import { DecodedTxResult, TxPayloadTypeID } from '@hirosystems/stacks-encoding-native-js';
+import { DecodedTxResult, TxPayloadTypeID } from '@stacks/codec';
 import { CoreNodeBlockMessage } from '../../src/event-stream/core-node-message';
 import { CoreNodeMsgBlockData, parseMessageTransaction } from '../../src/event-stream/reader';
 import { parseNewBlockMessage } from '../../src/event-stream/event-server';
diff --git a/tests/api/tx.test.ts b/tests/api/tx.test.ts
@@ -21,10 +21,7 @@ import {
   stringAsciiCV,
 } from '@stacks/transactions';
 import { createClarityValueArray } from '../../src/stacks-encoding-helpers';
-import {
-  decodeTransaction,
-  TxPayloadVersionedSmartContract,
-} from '@hirosystems/stacks-encoding-native-js';
+import { decodeTransaction, TxPayloadVersionedSmartContract } from '@stacks/codec';
 import { getTxFromDataStore, TransactionType } from '../../src/api/controllers/db-controller';
 import {
   DbBlock,
diff --git a/tests/subnets/subnet.test.ts b/tests/subnets/subnet.test.ts
@@ -25,7 +25,7 @@ import {
 } from '@stacks/transactions';
 import { StacksCoreRpcClient } from '../../src/core-rpc/client';
 import { StacksTestnet } from '@stacks/network';
-import { ClarityTypeID, decodeClarityValue } from '@hirosystems/stacks-encoding-native-js';
+import { ClarityTypeID, decodeClarityValue } from '@stacks/codec';
 import { timeout } from '@hirosystems/api-toolkit';
 import {
   TransactionEventsResponse,
diff --git a/tests/utils/test-helpers.ts b/tests/utils/test-helpers.ts
@@ -37,7 +37,7 @@ import {
   ClarityTypeID,
   ClarityValue as NativeClarityValue,
   decodeClarityValue,
-} from '@hirosystems/stacks-encoding-native-js';
+} from '@stacks/codec';
 import * as supertest from 'supertest';
 import { ApiServer } from '../../src/api/init';
 import { testnetKeys } from '../../src/api/routes/debug';
