Add EdgeTxInfo types

EdgeApp · Oct 10, 2023 · 23cbb63 · 23cbb63
1 parent a9432cb
commit 23cbb63
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # edge-core-js
 
 ## Unreleased
+- added: EdgeTxAction types to tag known smart contract trasaction types (swap, stake, etc)
 
 ## 1.9.0 (2023-10-10)
 

diff --git a/src/types/types.ts b/src/types/types.ts
@@ -249,6 +249,39 @@ export interface EdgeMemo {
   memoName?: string
 }
 
+export interface EdgeAssetAmount {
+  pluginId: string
+  tokenId?: string
+  nativeAmount?: string
+}
+
+export type EdgeTxActionSwapType =
+  | 'swap'
+  | 'swapOrderPost'
+  | 'swapOrderFill'
+  | 'swapOrderCancel'
+
+export interface EdgeTxActionSwap {
+  type: EdgeTxActionSwapType
+  orderId?: string
+  canBePartial?: boolean
+  sourceAsset: EdgeAssetAmount
+  destAsset: EdgeAssetAmount
+}
+
+export type EdgeTxActionStakeType =
+  | 'stake'
+  | 'stakeOrder'
+  | 'unstake'
+  | 'unstakeOrder'
+
+export interface EdgeTxActionStake {
+  type: EdgeTxActionStakeType
+  stakeAssets: EdgeAssetAmount[]
+}
+
+export type EdgeTxAction = EdgeTxActionSwap | EdgeTxActionStake
+
 // token info ----------------------------------------------------------
 
 export interface EdgeDenomination {
@@ -468,6 +501,7 @@ export interface EdgeTransaction {
   signedTx: string
   memos: EdgeMemo[]
   ourReceiveAddresses: string[]
+  action?: EdgeTxAction
 
   // Spend-specific metadata:
   deviceDescription?: string