feat: add payload type assertions (#1395)

Adds assertion methods (i.e. type predicates) for the Payload type: `isTokenTransferPayload`, `isContractCallPayload`, `isSmartContractPayload`, `isPoisonPayload`, `isCoinbasePayload` — Thanks to @edu-stx
hirosystems · Nov 23, 2022 · cdd32e9 · cdd32e9 · vercel · Nov 23, 2022
1 parent a2a7128
commit cdd32e9
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/packages/transactions/src/index.ts b/packages/transactions/src/index.ts
@@ -18,6 +18,11 @@ export {
   PoisonPayload,
   CoinbasePayload,
   serializePayload,
+  isTokenTransferPayload,
+  isContractCallPayload,
+  isSmartContractPayload,
+  isPoisonPayload,
+  isCoinbasePayload,
 } from './payload';
 
 export {

diff --git a/packages/transactions/src/payload.ts b/packages/transactions/src/payload.ts
@@ -24,6 +24,22 @@ export type Payload =
   | PoisonPayload
   | CoinbasePayload;
 
+export function isTokenTransferPayload(p: Payload): p is TokenTransferPayload {
+  return p.payloadType === PayloadType.TokenTransfer;
+}
+export function isContractCallPayload(p: Payload): p is ContractCallPayload {
+  return p.payloadType === PayloadType.ContractCall;
+}
+export function isSmartContractPayload(p: Payload): p is SmartContractPayload {
+  return p.payloadType === PayloadType.SmartContract;
+}
+export function isPoisonPayload(p: Payload): p is PoisonPayload {
+  return p.payloadType === PayloadType.PoisonMicroblock;
+}
+export function isCoinbasePayload(p: Payload): p is CoinbasePayload {
+  return p.payloadType === PayloadType.Coinbase;
+}
+
 export interface TokenTransferPayload {
   readonly type: StacksMessageType.Payload;
   readonly payloadType: PayloadType.TokenTransfer;