feat!: add support for sponsor nonce in transactions (#1140)

* fix: add support for sponsor_nonce for txs and mempool transactions

* fix: fixed incorrect last executed nonce

* test: add test for nonces endpoint

* style: fixed style nit

* refactor: improve condition

* fix: fixed missing nonce to add support for sponsor_nonce

Author: asimm241

docs/entities/transactions/base-transaction.schema.json

@@ -31,6 +31,9 @@
       "type": "string",
       "description": "Address of the transaction initiator"
     },
+    "sponsor_nonce": {
+      "type": "integer"
+    },
     "sponsored": {
       "type": "boolean",
       "description": "Denotes whether the originating account is the same as the paying account"

docs/generated.d.ts

@@ -1081,6 +1081,7 @@ export interface BaseTransaction {
    * Address of the transaction initiator
    */
   sender_address: string;
+  sponsor_nonce?: number;
   /**
    * Denotes whether the originating account is the same as the paying account
    */

src/api/controllers/db-controller.ts

@@ -651,6 +651,7 @@ function parseDbBaseTx(dbTx: DbTx | DbMempoolTx): BaseTransaction {
   const tx: BaseTransaction = {
     tx_id: dbTx.tx_id,
     nonce: dbTx.nonce,
+    sponsor_nonce: dbTx.sponsor_nonce,
     fee_rate: dbTx.fee_rate.toString(10),
     sender_address: dbTx.sender_address,
     sponsored: dbTx.sponsored,

src/datastore/common.ts

@@ -136,7 +136,8 @@ export interface BaseTx {
   fee_rate: bigint;
   sender_address: string;
   sponsored: boolean;
-  sponsor_address: string | undefined;
+  sponsor_address?: string;
+  sponsor_nonce?: number;
   nonce: number;
   tx_id: string;
   anchor_mode: DbTxAnchorMode;
@@ -1077,6 +1078,10 @@ export function createDbMempoolTxFromCoreMsg(msg: {
   const dbTx: DbMempoolTx = {
     pruned: false,
     nonce: Number(msg.txData.auth.originCondition.nonce),
+    sponsor_nonce:
+      msg.txData.auth.typeId === TransactionAuthTypeID.Sponsored
+        ? Number(msg.txData.auth.sponsorCondition.nonce)
+        : undefined,
     tx_id: msg.txId,
     raw_tx: msg.rawTx,
     type_id: parseEnum(DbTxTypeId, msg.txData.payload.typeId as number),
@@ -1100,11 +1105,11 @@ export function createDbTxFromCoreMsg(msg: CoreNodeParsedTxMessage): DbTx {
   const dbTx: DbTx = {
     tx_id: coreTx.txid,
     tx_index: coreTx.tx_index,
-    nonce: Number(
+    nonce: Number(parsedTx.auth.originCondition.nonce),
+    sponsor_nonce:
       parsedTx.auth.typeId === TransactionAuthTypeID.Sponsored
-        ? parsedTx.auth.sponsorCondition.nonce
-        : parsedTx.auth.originCondition.nonce
-    ),
+        ? Number(parsedTx.auth.sponsorCondition.nonce)
+        : undefined,
     raw_tx: msg.raw_tx,
     index_block_hash: msg.index_block_hash,
     parent_index_block_hash: msg.parent_index_block_hash,

src/datastore/postgres-store.ts

@@ -324,7 +324,7 @@ function isPgConnectionError(error: any): string | false {
 const TX_COLUMNS = `
   -- required columns
   tx_id, raw_tx, tx_index, index_block_hash, parent_index_block_hash, block_hash, parent_block_hash, block_height, burn_block_time, parent_burn_block_time,
-  type_id, anchor_mode, status, canonical, post_conditions, nonce, fee_rate, sponsored, sponsor_address, sender_address, origin_hash_mode,
+  type_id, anchor_mode, status, canonical, post_conditions, nonce, fee_rate, sponsored, sponsor_nonce, sponsor_address, sender_address, origin_hash_mode,
   microblock_canonical, microblock_sequence, microblock_hash,
 
   -- token-transfer tx columns
@@ -355,7 +355,7 @@ const TX_COLUMNS = `
 const MEMPOOL_TX_COLUMNS = `
   -- required columns
   pruned, tx_id, raw_tx, type_id, anchor_mode, status, receipt_time, receipt_block_height,
-  post_conditions, nonce, fee_rate, sponsored, sponsor_address, sender_address, origin_hash_mode,
+  post_conditions, nonce, fee_rate, sponsored, sponsor_nonce, sponsor_address, sender_address, origin_hash_mode,
 
   -- token-transfer tx columns
   token_transfer_recipient_address, token_transfer_amount, token_transfer_memo,
@@ -416,6 +416,7 @@ function txColumns(tableName: string = 'txs'): string {
     'fee_rate',
     'sponsored',
     'sponsor_address',
+    'sponsor_nonce',
     'sender_address',
     'origin_hash_mode',
     'microblock_canonical',
@@ -520,6 +521,7 @@ interface MempoolTxQueryResult {
   tx_id: Buffer;
 
   nonce: number;
+  sponsor_nonce?: number;
   type_id: number;
   anchor_mode: number;
   status: number;
@@ -571,6 +573,7 @@ interface TxQueryResult {
   burn_block_time: number;
   parent_burn_block_time: number;
   nonce: number;
+  sponsor_nonce?: number;
   type_id: number;
   anchor_mode: number;
   status: number;
@@ -2008,22 +2011,55 @@ export class PgDataStore
         `
         SELECT MAX(nonce) nonce
         FROM txs
-        WHERE ((sender_address = $1 AND sponsored = false) OR (sponsor_address = $1 AND sponsored= true))
+        WHERE sender_address = $1
         AND canonical = true AND microblock_canonical = true
         `,
         [args.stxAddress]
       );
+
+      const executedTxSponsorNonce = await client.query<{ nonce: number | null }>(
+        `
+        SELECT MAX(sponsor_nonce) nonce
+        FROM txs
+        WHERE sponsor_address = $1 AND sponsored = true
+        AND canonical = true AND microblock_canonical = true
+        `,
+        [args.stxAddress]
+      );
+
       const mempoolTxNonce = await client.query<{ nonce: number | null }>(
         `
         SELECT MAX(nonce) nonce
         FROM mempool_txs
-        WHERE ((sender_address = $1 AND sponsored = false) OR (sponsor_address = $1 AND sponsored= true))
+        WHERE sender_address = $1
+        AND pruned = false
+        `,
+        [args.stxAddress]
+      );
+
+      const mempoolTxSponsorNonce = await client.query<{ nonce: number | null }>(
+        `
+        SELECT MAX(sponsor_nonce) nonce
+        FROM mempool_txs
+        WHERE sponsor_address = $1 AND sponsored= true
         AND pruned = false
         `,
         [args.stxAddress]
       );
-      const lastExecutedTxNonce = executedTxNonce.rows[0]?.nonce ?? null;
-      const lastMempoolTxNonce = mempoolTxNonce.rows[0]?.nonce ?? null;
+
+      let lastExecutedTxNonce = executedTxNonce.rows[0]?.nonce ?? null;
+      const lastExecutedTxSponsorNonce = executedTxSponsorNonce.rows[0]?.nonce ?? null;
+      if (lastExecutedTxNonce != null || lastExecutedTxSponsorNonce != null) {
+        lastExecutedTxNonce = Math.max(lastExecutedTxNonce ?? 0, lastExecutedTxSponsorNonce ?? 0);
+      }
+
+      let lastMempoolTxNonce = mempoolTxNonce.rows[0]?.nonce ?? null;
+      const lastMempoolTxSponsorNonce = mempoolTxSponsorNonce.rows[0]?.nonce ?? null;
+
+      if (lastMempoolTxNonce != null || lastMempoolTxSponsorNonce != null) {
+        lastMempoolTxNonce = Math.max(lastMempoolTxNonce ?? 0, lastMempoolTxSponsorNonce ?? 0);
+      }
+
       let possibleNextNonce = 0;
       if (lastExecutedTxNonce !== null || lastMempoolTxNonce !== null) {
         possibleNextNonce = Math.max(lastExecutedTxNonce ?? 0, lastMempoolTxNonce ?? 0) + 1;
@@ -2041,7 +2077,12 @@ export class PgDataStore
             `
             SELECT nonce
             FROM mempool_txs
-            WHERE ((sender_address = $1 AND sponsored = false) OR (sponsor_address = $1 AND sponsored= true)) AND nonce = ANY($2)
+            WHERE sender_address = $1 AND nonce = ANY($2)
+            AND pruned = false
+            UNION
+            SELECT sponsor_nonce as nonce
+            FROM mempool_txs
+            WHERE sponsor_address = $1 AND sponsored= true AND sponsor_nonce = ANY($2)
             AND pruned = false
             `,
             [args.stxAddress, expectedNonces]
@@ -3453,7 +3494,7 @@ export class PgDataStore
       ) values(
         $1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19,
         $20, $21, $22, $23, $24, $25, $26, $27, $28, $29, $30, $31, $32, $33, $34, $35, $36, $37,
-        $38, $39, $40, $41, $42
+        $38, $39, $40, $41, $42, $43
       )
       ON CONFLICT ON CONSTRAINT unique_tx_id_index_block_hash_microblock_hash DO NOTHING
       `,
@@ -3476,6 +3517,7 @@ export class PgDataStore
         tx.nonce,
         tx.fee_rate,
         tx.sponsored,
+        tx.sponsor_nonce,
         tx.sponsor_address,
         tx.sender_address,
         tx.origin_hash_mode,
@@ -3514,7 +3556,7 @@ export class PgDataStore
           `
           INSERT INTO mempool_txs(
             ${MEMPOOL_TX_COLUMNS}
-          ) values($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21, $22, $23, $24, $25, $26)
+          ) values($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21, $22, $23, $24, $25, $26, $27)
           ON CONFLICT ON CONSTRAINT unique_tx_id
           DO NOTHING
           `,
@@ -3531,6 +3573,7 @@ export class PgDataStore
             tx.nonce,
             tx.fee_rate,
             tx.sponsored,
+            tx.sponsor_nonce,
             tx.sponsor_address,
             tx.sender_address,
             tx.origin_hash_mode,
@@ -3587,6 +3630,7 @@ export class PgDataStore
       pruned: result.pruned,
       tx_id: bufferToHexPrefixString(result.tx_id),
       nonce: result.nonce,
+      sponsor_nonce: result.sponsor_nonce ?? undefined,
       raw_tx: result.raw_tx,
       type_id: result.type_id as DbTxTypeId,
       anchor_mode: result.anchor_mode as DbTxAnchorMode,
@@ -3623,6 +3667,7 @@ export class PgDataStore
       tx_id: bufferToHexPrefixString(result.tx_id),
       tx_index: result.tx_index,
       nonce: result.nonce,
+      sponsor_nonce: result.sponsor_nonce ?? undefined,
       raw_tx: result.raw_tx,
       index_block_hash: bufferToHexPrefixString(result.index_block_hash),
       parent_index_block_hash: bufferToHexPrefixString(result.parent_index_block_hash),

src/migrations/1584619633448_txs.ts

@@ -77,6 +77,9 @@ export async function up(pgm: MigrationBuilder): Promise<void> {
     sponsor_address: {
       type: 'string'
     },
+    sponsor_nonce: {
+      type: 'integer'
+    },
     sender_address: {
       type: 'string',
       notNull: true,

src/migrations/1591291822107_mempool_txs.ts

@@ -45,6 +45,9 @@ export async function up(pgm: MigrationBuilder): Promise<void> {
     sponsor_address: {
       type: 'string'
     },
+    sponsor_nonce: {
+      type: 'integer'
+    },
     sender_address: {
       type: 'string',
       notNull: true,