@exodus/asset-types 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.1](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.2.0...@exodus/asset-types@0.2.1) (2025-02-06)
+
+
+### Bug Fixes
+
+
+* fix: add missing types (#5001)
+
+
+
+## [0.2.0](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.0.0...@exodus/asset-types@0.2.0) (2025-01-22)
+
+
+### Features
+
+
+* feat: improve assets type definitions (#4897)
+
+
+
 ## 0.1.0 (2024-12-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/asset-types",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Typings for Assets",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -28,5 +28,8 @@
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aasset-types"
   },
-  "gitHead": "e1ca2b674078f1c19b08a4b99a50e55a851ec453"
+  "devDependencies": {
+    "@types/bn.js": "^5"
+  },
+  "gitHead": "4bf0b4efd938c60fc9ef8af756030442bda18f70"
 }

package/src/asset-meta.d.ts

@@ -15,13 +15,15 @@ export type Info = {
   telegram?: string
 }
 
+export type BlockExplorer = {
+  txUrl: (txId: string) => Promise<string>
+  addressUrl: (address: string) => Promise<string>
+}
+
 export type AssetMeta = {
   assetType: string
   baseAssetName: string
-  blockExplorer: {
-    txUrl: (txId: string) => Promise<string>
-    addressUrl: (address: string) => Promise<string>
-  }
+  blockExplorer: BlockExplorer
   chainBadgeColors: string[]
   currency: UnitType
   displayNetworkName: string
@@ -37,4 +39,6 @@ export type AssetMeta = {
   ticker: string
   decimals?: number
   mintAddress?: string
+  units: Record<string, number>
+  [prop: string]: any // allow additional chain specific properties
 }

package/src/asset.d.ts

@@ -3,14 +3,28 @@
 import type NumberUnit from '@exodus/currency'
 import type KeyIdentifier from '@exodus/key-identifier'
 import type { AccountState, Tx, TxSet, WalletAccount } from '@exodus/models'
+import type BN from 'bn.js'
 
 import type { AssetMeta } from './asset-meta.js'
 import type { CreateFeeMonitorApi } from './fee-monitor.js'
+import type { Extendable, FreeForm, RequireOnly, WithRequired } from './helpers.js'
 import type { HistoryMonitor } from './history-monitor.js'
 import type { Logger } from './logger.js'
 import type { MoveFunds } from './move-funds.js'
 import type { Signer } from './signer.js'
 
+type WalletAccountLike = WalletAccount | string
+
+type WalletCompatibilityMode =
+  | 'phantom'
+  | 'metamask'
+  | 'trust'
+  | 'mathwallet'
+  | 'ordinals86'
+  | 'ordinals84'
+  // Hack to allow any string without breaking intelisense
+  | (string & NonNullable<unknown>)
+
 export type CreateHistoryMonitorApi = (args: {
   asset: BaseAsset
   runner: () => void
@@ -18,6 +32,8 @@ export type CreateHistoryMonitorApi = (args: {
   logger: Logger
 }) => HistoryMonitor
 
+export type IdentifiableTx = RequireOnly<Tx, 'txId'>
+
 export type ApiFeatures = {
   accountState?: boolean
   customTokens?: boolean
@@ -51,37 +67,132 @@ export type BalanceFieldName =
 
 export type Balances = Record<BalanceFieldName, NumberUnit>
 
+export type UnsignedTxPayload<NumberValue = BN | string> = Extendable<{
+  txData: Extendable<{
+    to: string
+    amount: NumberValue
+    fee: NumberValue
+    gasPrice: NumberValue
+    gasLimit: NumberValue
+    nonce: NumberValue
+  }>
+  txMeta: Extendable<{
+    assetName: string
+  }>
+}>
+
+export type SignTransactionParams = Extendable<{
+  assetName: string
+  unsignedTx: UnsignedTxPayload
+  walletAccount: WalletAccountLike
+}>
+
+export type HardwareDeviceSignTransactionParams = Extendable<{
+  assetName: string
+  signableTransaction: Buffer
+  derivationPaths: string[]
+}>
+
+export type HardwareDevice = Extendable<{
+  signTransaction: (tx: HardwareDeviceSignTransactionParams) => Promise<void>
+}>
+
+export type WalletAccountParams = Extendable<{
+  asset: AbstractAsset
+  accountState: AccountState
+  txLog: TxSet
+}>
+
+export type GetActivityTxsParams = Extendable<{ txs: Tx[] }>
+
+export type GetDefaultAddressPathParams = Extendable<{
+  walletAccount: WalletAccountLike
+  compatibilityMode?: WalletCompatibilityMode
+}>
+
+export type GetKeyIdentifierParams = Extendable<{
+  purpose: number
+  accountIndex: number
+  chainIndex?: number
+  addressIndex?: number
+  compatibilityMode?: WalletCompatibilityMode
+}>
+
+export type GetSupportedPurposesParams = Extendable<{
+  compatibilityMode?: WalletCompatibilityMode
+  isMultisig?: boolean
+}>
+
+export type SignHardwareTxParams = Extendable<{
+  unsignedTx: UnsignedTxPayload
+  accountIndex: number
+  hardwareDevice: HardwareDevice
+}>
+
+/** Purpose -> BIP32 instance */
+export type HDKeysMap = Record<number, unknown>
+
+export type SignTxParams = Extendable<{
+  unsignedTx?: UnsignedTxPayload
+  accountIndex?: number
+  txHex?: string
+  partialSign?: boolean
+  hdkeys?: HDKeysMap
+  privateKey: string
+  signer?: Signer
+}>
+
 export type CommonAssetApi = {
   features: ApiFeatures
-  getActivityTxs?: (params: { txs: Tx[] }) => Tx[]
-  getBalances: (args: {
-    asset: AbstractAsset
-    accountState: AccountState
-    txLog: TxSet
-  }) => Balances
+  getActivityTxs?: (params: GetActivityTxsParams) => Tx[]
+  getBalances: (params: WalletAccountParams) => Balances
   getTxLogFilter?: (tx: Tx) => boolean
   hasFeature: (feature: keyof ApiFeatures) => boolean // @deprecated use api.features instead
 }
 
-/// Not all assets txsend can handle all params. This needs to be improved!
-type TxSendParams = any
-// for future reference
-// type TxSendParams = {
-//   address: string
-//   amount?: NumberUnit
-//   asset: TokenAsset | BaseAsset
-//   bumpTxId?: string
-//   customFee?: NumberUnit
-//   feeAmount?: NumberUnit
-//   feeOpts?: { [key: string]: any } // eth, move out!
-//   isExchange?: boolean
-//   isSendAll?: boolean
-//   nft?: { nftId: string; [key: string]: any }
-//   options: { [key: string]: any }
-//   shouldLog?: boolean
-//   walletAccount: string
-//   [key: string]: any
-// }
+export type EncondePublicOptions = Extendable<{ purpose?: number }>
+
+export type KeyEncoder = {
+  encodePrivate: (key: Buffer) => string
+  encodePublic: (key: Buffer, options?: EncondePublicOptions) => string
+}
+
+export type AssetAddress = {
+  validate: (address: string) => boolean
+  resolvePurpose?: (address: string) => Promise<number>
+}
+
+export type Nft = Extendable<{ nftId: string }>
+
+export type BaseTxSendParams<Options = FreeForm> = {
+  address: string
+  asset: TokenAsset | BaseAsset
+  walletAccount: WalletAccountLike
+  amount?: NumberUnit
+  options?: Options
+}
+
+export type FundibleTokenTxSendParams = BaseTxSendParams & WithRequired<BaseTxSendParams, 'amount'>
+export type NonFungibleTokenTxSendParams = BaseTxSendParams & { nft: Nft }
+
+export type StrictTxSendParams = FundibleTokenTxSendParams | NonFungibleTokenTxSendParams
+
+export type ExtendedTxSendParams = Extendable<
+  StrictTxSendParams,
+  {
+    bumpTxId?: string
+    customFee?: NumberUnit
+    feeAmount?: NumberUnit
+    feeOpts?: { [key: string]: any }
+    isExchange?: boolean
+    isSendAll?: boolean
+    shouldLog?: boolean
+  }
+>
+
+export type TxSendParams = StrictTxSendParams | ExtendedTxSendParams
+
+export type SignMessageParams = { message: string; signer: Signer }
 
 export type AssetApi = CommonAssetApi & {
   addressHasHistory?: (address: string) => Promise<boolean>
@@ -92,37 +203,26 @@ export type AssetApi = CommonAssetApi & {
   defaultAddressPath: string
   getBalanceForAddress: (address: string) => NumberUnit
   getConfirmationsNumber: () => number
-  getDefaultAddressPath?: (args: {
-    walletAccount: WalletAccount
-    compatibilityMode?: string
-  }) => string
+  getDefaultAddressPath?: (params: GetDefaultAddressPathParams) => string
   getFeeData: () => any
-  getKeyIdentifier(params: {
-    purpose: number
-    accountIndex: number
-    chainIndex?: number
-    addressIndex?: number
-    compatibilityMode?: string
-  }): KeyIdentifier
-  getSupportedPurposes?: (params?: { compatibilityMode?: string; isMultisig?: boolean }) => number[]
+  getKeyIdentifier(params: GetKeyIdentifierParams): KeyIdentifier
+  getSupportedPurposes?: (params?: GetSupportedPurposesParams) => number[]
   moveFunds?: MoveFunds
-  signHardware?: (params: {
-    unsignedTx: any
-    hardwareDevice: any
-    accountIndex: number
-  }) => Promise<any>
-  signMessage?(params: { message: any; signer: Signer }): Promise<any>
-  signTx(params: { unsignedTx: any; signer: Signer }): Promise<any>
-  sendTx(params: TxSendParams): Promise<{ txId: string }>
+  signHardware?: (params: SignHardwareTxParams) => Promise<any>
+  signMessage?(params: SignMessageParams): Promise<any>
+  signTx(params: SignTxParams): Promise<any>
+  sendTx(params: TxSendParams): Promise<IdentifiableTx>
   validateAssetId?: (assetId: string) => boolean
 }
 
+export type GetBalancesParams = {
+  asset: AbstractAsset
+  accountState: AccountState
+  txLog: TxSet
+}
+
 export type TokenAssetApi = {
-  getBalances: (params: {
-    asset: AbstractAsset
-    accountState: AccountState
-    txLog: TxSet
-  }) => Balances
+  getBalances: (params: GetBalancesParams) => Balances
 }
 
 export type AbstractAsset = AssetMeta & {
@@ -132,14 +232,9 @@ export type AbstractAsset = AssetMeta & {
   isCustomToken?: boolean
   isCombined?: boolean
   lifecycleStatus?: string
-  keys: {
-    encodePrivate: (key: Buffer) => string
-    encodePublic: (key: Buffer, options?: { purpose?: number }) => string
-  }
-  address: {
-    validate: (address: string) => boolean
-    resolvePurpose?: (address: string) => Promise<number>
-  }
+  keys: KeyEncoder
+  address: AssetAddress
+  toString(): string
 }
 
 export type CombinedAsset<A extends BaseAsset | TokenAsset = BaseAsset | TokenAsset> = AssetMeta & {
@@ -157,11 +252,14 @@ export type TokenAsset = AbstractAsset & {
   api: CommonAssetApi
 }
 
-export type AssetPlugin<A = BaseAsset, C = unknown> = {
-  createAsset: (params: {
-    assetClientInterface: any
-    // extract interface
-    config: C
-    overrideCallback?: ({ asset: A }) => A
-  }) => A
+export type AddressOverrideCallbackParams<A extends BaseAsset = BaseAsset> = { asset: A }
+
+export type CreateAddressParams<A extends BaseAsset = BaseAsset, C = unknown> = {
+  assetClientInterface: any
+  config: C
+  overrideCallback?: (params: AddressOverrideCallbackParams) => A
+}
+
+export type AssetPlugin<A extends BaseAsset = BaseAsset, C = unknown> = {
+  createAsset: (params: CreateAddressParams<A, C>) => A
 }

package/src/fee-monitor.d.ts

@@ -6,9 +6,10 @@ export type FeeMonitor = {
   tick: () => Promise<void>
 }
 
+export type FeeDataValue = number | string | NumberUnit
+
+export type FeeData = Record<string, FeeDataValue>
+
 export type CreateFeeMonitorApi = (params: {
-  updateFee: (
-    assetName: string,
-    feeDataToUpdate: Record<string, number | string | NumberUnit>
-  ) => Promise<void>
+  updateFee: (assetName: string, feeDataToUpdate: FeeData) => Promise<void>
 }) => FeeMonitor

package/src/helpers.d.ts

@@ -0,0 +1,17 @@
+export type FreeForm = Record<string | number | symbol, unknown>
+
+/**
+ * Helper that allows extending a type as a union type
+ * while also providing syntactic sugar for extending a type with FreeForm
+ */
+export type Extendable<T, Ext = FreeForm> = Ext & T
+
+/**
+ * Mark the given keys of target type as required
+ */
+export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }
+
+/*
+ * Make a set of keys of a given target type required, while making all other optional
+ */
+export type RequireOnly<T, Keys extends keyof T> = Partial<T> & Pick<WithRequired<T, Keys>, Keys>

package/src/index.d.ts

@@ -1,8 +1,32 @@
 export type {
-  //
   AbstractAsset,
   AssetPlugin,
   BaseAsset,
   CombinedAsset,
   TokenAsset,
+  WalletAccountParams,
+  UnsignedTxPayload,
+  SignMessageParams,
+  TxSendParams,
+  TokenAssetApi,
+  StrictTxSendParams,
+  SignTxParams,
+  SignTransactionParams,
+  SignHardwareTxParams,
+  NonFungibleTokenTxSendParams,
+  HardwareDeviceSignTransactionParams,
+  HardwareDevice,
+  GetSupportedPurposesParams,
+  GetKeyIdentifierParams,
+  GetDefaultAddressPathParams,
+  GetBalancesParams,
+  GetActivityTxsParams,
+  FundibleTokenTxSendParams,
+  ExtendedTxSendParams,
+  EncondePublicOptions,
+  CreateHistoryMonitorApi,
+  CreateAddressParams,
+  AssetApi,
+  AssetAddress,
+  ApiFeatures,
 } from './asset.js'