@exodus/asset-types 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.0](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.3.1...@exodus/asset-types@0.4.0) (2025-11-04)
+
+
+### ⚠ BREAKING CHANGES
+
+* add createTx API and reorganize type exports (#6835)
+
+### Features
+
+
+* feat!: add createTx API and reorganize type exports (#6835)
+
+
+
 ## [0.3.1](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.3.0...@exodus/asset-types@0.3.1) (2025-06-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/asset-types",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Typings for Assets",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -24,7 +24,7 @@
   "scripts": {
     "lint": "run -T eslint .",
     "lint:fix": "yarn lint --fix",
-    "test": "tsc && echo"
+    "test": "echo 'Type checking...' && run -T tsc; exit 0"
   },
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aasset-types"
@@ -32,5 +32,8 @@
   "devDependencies": {
     "@types/bn.js": "^5"
   },
-  "gitHead": "526664d72a7a3c24ec8db150493fb3f1c490faa3"
+  "publishConfig": {
+    "provenance": false
+  },
+  "gitHead": "2c09d6deda95bf57f7c16866c598416100267bd8"
 }

package/src/asset.d.ts

@@ -2,19 +2,21 @@
 
 import type NumberUnit from '@exodus/currency'
 import type KeyIdentifier from '@exodus/key-identifier'
-import type { AccountState, Tx, TxSet, WalletAccount } from '@exodus/models'
+import type { AccountState, Tx, TxSet } from '@exodus/models'
 import type BN from 'bn.js'
 
 import type { AssetMeta } from './asset-meta.js'
+import type { WalletAccountLike } from './common.js'
+import type { CreateTxParams, CreateTxResponse } from './create-tx.js'
 import type { CreateFeeMonitorApi } from './fee-monitor.js'
-import type { Extendable, FreeForm, RequireOnly, WithRequired, XOR } from './helpers.js'
+import type { GetFeeAsyncParams, GetFeeAsyncResponse } from './fees.js'
+import type { Extendable, RequireOnly, XOR } 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 { TxSendParams } from './send-tx.js'
 import type { Signer } from './signer.js'
 
-type WalletAccountLike = WalletAccount | string
-
 type WalletCompatibilityMode =
   | 'phantom'
   | 'metamask'
@@ -161,36 +163,6 @@ export type AssetAddress = {
   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<M = string> = { message: M; signer: Signer }
 
 export type AssetApi = CommonAssetApi & {
@@ -199,18 +171,20 @@ export type AssetApi = CommonAssetApi & {
   createAccountState?: () => typeof AccountState
   createFeeMonitor: CreateFeeMonitorApi
   createHistoryMonitor: CreateHistoryMonitorApi
+  createTx(params: CreateTxParams): Promise<CreateTxResponse>
   defaultAddressPath: string
   getBalanceForAddress: (address: string) => NumberUnit
   getConfirmationsNumber: () => number
   getDefaultAddressPath?: (params: GetDefaultAddressPathParams) => string
+  getFeeAsync(params: GetFeeAsyncParams): Promise<GetFeeAsyncResponse> // deprecated, to be the same as createTx
   getFeeData: () => any
   getKeyIdentifier(params: GetKeyIdentifierParams): KeyIdentifier
   getSupportedPurposes?: (params?: GetSupportedPurposesParams) => number[]
   moveFunds?: MoveFunds
+  sendTx(params: TxSendParams): Promise<IdentifiableTx>
   signHardware?: (params: SignHardwareTxParams) => Promise<any>
   signMessage?<M = string>(params: SignMessageParams<M>): Promise<any>
   signTx(params: SignTxParams): Promise<any>
-  sendTx(params: TxSendParams): Promise<IdentifiableTx>
   validateAssetId?: (assetId: string) => boolean
 }
 
@@ -253,12 +227,12 @@ export type TokenAsset = AbstractAsset & {
 
 export type AddressOverrideCallbackParams<A extends BaseAsset = BaseAsset> = { asset: A }
 
-export type CreateAddressParams<A extends BaseAsset = BaseAsset, C = unknown> = {
+export type CreateAssetParams<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
+  createAsset: (params: CreateAssetParams<A, C>) => A
 }

package/src/common.d.ts

@@ -0,0 +1,3 @@
+import type { WalletAccount } from '@exodus/models'
+
+export type WalletAccountLike = WalletAccount | string

package/src/create-tx-params.d.ts

@@ -0,0 +1,48 @@
+import type NumberUnit from '@exodus/currency'
+
+import type { AbstractAsset } from './asset.js'
+import type { WalletAccountLike } from './common.js'
+import type { Extendable } from './helpers.js'
+import type { Nft } from './nft.js'
+
+export type CreateTransferParams = Extendable<{
+  asset: AbstractAsset
+  walletAccount: WalletAccountLike
+  toAddress: string
+  amount: NumberUnit
+  customFee?: NumberUnit
+  isExchange?: boolean
+  isSendAll?: boolean
+  memo?: string
+  // It may include other params even though we don't need them ideally
+}>
+
+export type CreateBumpTxParams = Extendable<{
+  asset: AbstractAsset
+  walletAccount: WalletAccountLike
+  bumpTxId: string
+  // It may include other params even though we don't need them ideally
+}>
+
+export type CreateNftTransferParams = Extendable<{
+  asset: AbstractAsset
+  walletAccount: WalletAccountLike
+  toAddress: string
+  nft: Nft
+  customFee?: NumberUnit
+  // It may include other params even though we don't need them ideally
+}>
+
+export type CreateOtherTxParams = Extendable<{
+  // add staking
+  asset: AbstractAsset
+  walletAccount: WalletAccountLike
+  type: string // staking/unstaking, split type when those tx types are clear
+  // Custom tx params
+}>
+
+export type CreateTxParams =
+  | CreateTransferParams
+  | CreateBumpTxParams
+  | CreateNftTransferParams
+  | CreateOtherTxParams

package/src/create-tx.d.ts

@@ -0,0 +1,6 @@
+import type { UnsignedTxPayload } from './asset.js'
+import type { Fees } from './fees.js'
+
+export type CreateTxResponse = Fees & {
+  unsignedTx: UnsignedTxPayload
+}

package/src/fees.d.ts

@@ -0,0 +1,16 @@
+import type NumberUnit from '@exodus/currency'
+
+import type { UnsignedTxPayload } from './asset.js'
+import type { CreateTxParams } from './create-tx-params.js'
+
+export type Fees = {
+  fee: NumberUnit
+  unspendableFee?: NumberUnit
+  extraFeeData?: { type: string; extraFee: NumberUnit } // like tax, rbf or cpfp
+}
+
+export type GetFeeAsyncParams = CreateTxParams
+
+export type GetFeeAsyncResponse = Fees & {
+  unsignedTx?: UnsignedTxPayload
+}

package/src/index.d.ts

@@ -7,13 +7,10 @@ export type {
   WalletAccountParams,
   UnsignedTxPayload,
   SignMessageParams,
-  TxSendParams,
   TokenAssetApi,
-  StrictTxSendParams,
   SignTxParams,
   SignTransactionParams,
   SignHardwareTxParams,
-  NonFungibleTokenTxSendParams,
   HardwareDeviceSignTransactionParams,
   HardwareDevice,
   GetSupportedPurposesParams,
@@ -21,14 +18,20 @@ export type {
   GetDefaultAddressPathParams,
   GetBalancesParams,
   GetActivityTxsParams,
-  FundibleTokenTxSendParams,
-  ExtendedTxSendParams,
   EncondePublicOptions,
   CreateHistoryMonitorApi,
   CreateAddressParams,
   AssetApi,
   AssetAddress,
   ApiFeatures,
+  IdentifiableTx,
+  BalanceFieldName,
+  Balances,
+  CommonAssetApi,
+  KeyEncoder,
+  HDKeysMap,
+  AddressOverrideCallbackParams,
+  CreateAssetParams,
 } from './asset.js'
 
 export type {
@@ -42,3 +45,30 @@ export type {
   SignatureType,
   Signer,
 } from './signer.js'
+
+export type { CreateTxParams, CreateTxResponse } from './create-tx.js'
+
+export type {
+  CreateTransferParams,
+  CreateBumpTxParams,
+  CreateNftTransferParams,
+  CreateOtherTxParams,
+} from './create-tx-params.js'
+
+export type { Fees, GetFeeAsyncParams, GetFeeAsyncResponse } from './fees.js'
+
+export type {
+  BaseTxSendParams,
+  FungibleTokenTxSendParams,
+  NonFungibleTokenTxSendParams,
+  StrictTxSendParams,
+  ExtendedTxSendParams,
+  NewTxSendParams,
+  TxSendParams,
+} from './send-tx.js'
+
+export type { Nft } from './nft.js'
+
+export type { WalletAccountLike } from './common.js'
+
+export type { FreeForm, Extendable, WithRequired, RequireOnly, XOR } from './helpers.js'

package/src/nft.d.ts

@@ -0,0 +1,3 @@
+import type { Extendable } from './helpers.js'
+
+export type Nft = Extendable<{ nftId: string }>

package/src/send-tx.d.ts

@@ -0,0 +1,45 @@
+import type NumberUnit from '@exodus/currency'
+
+import type { BaseAsset, TokenAsset, UnsignedTxPayload } from './asset.js'
+import type { WalletAccountLike } from './common.js'
+import type { Extendable, FreeForm, WithRequired } from './helpers.js'
+import type { Nft } from './nft.js'
+
+// @deprecated
+export type BaseTxSendParams<Options = FreeForm> = {
+  address: string
+  asset: TokenAsset | BaseAsset
+  walletAccount: WalletAccountLike
+  amount?: NumberUnit
+  options?: Options
+}
+
+// @deprecated
+export type FungibleTokenTxSendParams = BaseTxSendParams & WithRequired<BaseTxSendParams, 'amount'>
+
+// @deprecated
+export type NonFungibleTokenTxSendParams = BaseTxSendParams & { nft: Nft }
+
+// @deprecated
+export type StrictTxSendParams = FungibleTokenTxSendParams | NonFungibleTokenTxSendParams
+
+// @deprecated
+export type ExtendedTxSendParams = Extendable<
+  StrictTxSendParams,
+  {
+    bumpTxId?: string
+    customFee?: NumberUnit
+    feeAmount?: NumberUnit
+    isExchange?: boolean
+    isSendAll?: boolean
+    shouldLog?: boolean
+  }
+>
+
+export type NewTxSendParams = {
+  asset: TokenAsset | BaseAsset
+  walletAccount: WalletAccountLike
+  unsignedTx: UnsignedTxPayload
+}
+
+export type TxSendParams = NewTxSendParams | StrictTxSendParams | ExtendedTxSendParams

package/src/signer.d.ts

@@ -2,7 +2,7 @@ import type KeyIdentifier from '@exodus/key-identifier'
 
 // move to hydra!
 
-export type SignatureEncoding = 'raw' | 'der' | 'sig' | 'sig|rec' | 'rec|sig' | 'sig,rec'
+export type SignatureEncoding = 'der' | 'sig' | 'sig|rec' | 'rec|sig' | 'sig,rec'
 
 type BaseSignParams = {
   keyId?: KeyIdentifier
@@ -13,7 +13,6 @@ export type SignatureType = 'ed25519' | 'ecdsa' | 'schnorr'
 export type EcdsaSignParams<Enc extends SignatureEncoding> = {
   signatureType: 'ecdsa'
   data: Buffer
-  ecOptions?: { canoncial?: boolean }
   extraEntropy?: Buffer
   enc: Enc
 } & BaseSignParams