Use discriminated unions to allow checking for tx broadcast success

[aryzing]

Problem

The way the types are currently constructed for TxBroadcastResult,

stacks.js/packages/transactions/src/types.ts

Line 156 in 50399dc

export type TxBroadcastResult = TxBroadcastResultOk | TxBroadcastResultRejected;

makes it "impossible" to check for success or error with TS. The union only has the txid prop common among all possible types, and therefore it's the only prop TS allows checking:

const res = broadcastTransaction(tx);

console.log(res.txid); // ok

if (res.error) {} // TS Error, prop `error` doesn't exist on all instances of TxBroadcastResult

Solution

Use discriminated unions for success vs error, and for each of the error types. Perhaps something like:

type TxBroadcastResult = // Key `"type"` is the discriminator
  | { type: "success"; txid: string }
  | { type: "error"; detail: ErrorDetail };

type ErrorDetail = // Key `"reason"` is the discriminator
  | {
      reason: "Serialization";
      txid: string;
      // other useful fields
    }
  | {
      reason: "SignatureValidation";
      txid: string;
      // other useful fields
    };
// ... other error types

Additional context

[janniks]

Ran into the same issue. Not sure why this wasn't a problem before. The idiomatic solution is to check for error using `'error' in res', but we can think about adding a type discriminator as well (that would however add additional synthetic information that the node isn't responding with)