@exodus/asset-types 0.2.2 → 0.2.4

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.4](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.2.3...@exodus/asset-types@0.2.4) (2025-02-07)
+
+
+### Bug Fixes
+
+
+* fix: require either signer or private key (#5016)
+
+
+
+## [0.2.3](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.2.2...@exodus/asset-types@0.2.3) (2025-02-07)
+
+
+### Bug Fixes
+
+
+* fix: allow asset specific messages (#5010)
+
+
+
 ## [0.2.2](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.2.1...@exodus/asset-types@0.2.2) (2025-02-06)
 
 **Note:** Version bump only for package @exodus/asset-types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/asset-types",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Typings for Assets",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -23,7 +23,8 @@
   },
   "scripts": {
     "lint": "run -T eslint .",
-    "lint:fix": "yarn lint --fix"
+    "lint:fix": "yarn lint --fix",
+    "test": "tsc && echo"
   },
   "bugs": {
     "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aasset-types"
@@ -31,5 +32,5 @@
   "devDependencies": {
     "@types/bn.js": "^5"
   },
-  "gitHead": "581302b29426b95bfe5d45b486d96ea0ecda6346"
+  "gitHead": "fb14012ea166f96ea8eb3f7bc9038bdcb10a71be"
 }

package/src/asset-meta.d.ts

@@ -40,5 +40,6 @@ export type AssetMeta = {
   decimals?: number
   mintAddress?: string
   units: Record<string, number>
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [prop: string]: any // allow additional chain specific properties
 }

package/src/asset.d.ts

@@ -7,7 +7,7 @@ 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 { Extendable, FreeForm, RequireOnly, WithRequired, XOR } from './helpers.js'
 import type { HistoryMonitor } from './history-monitor.js'
 import type { Logger } from './logger.js'
 import type { MoveFunds } from './move-funds.js'
@@ -138,9 +138,8 @@ export type SignTxParams = Extendable<{
   txHex?: string
   partialSign?: boolean
   hdkeys?: HDKeysMap
-  privateKey: string
-  signer?: Signer
-}>
+}> &
+  XOR<{ privateKey: string }, { signer: Signer }>
 
 export type CommonAssetApi = {
   features: ApiFeatures
@@ -192,7 +191,7 @@ export type ExtendedTxSendParams = Extendable<
 
 export type TxSendParams = StrictTxSendParams | ExtendedTxSendParams
 
-export type SignMessageParams = { message: string; signer: Signer }
+export type SignMessageParams<M = string> = { message: M; signer: Signer }
 
 export type AssetApi = CommonAssetApi & {
   addressHasHistory?: (address: string) => Promise<boolean>
@@ -209,7 +208,7 @@ export type AssetApi = CommonAssetApi & {
   getSupportedPurposes?: (params?: GetSupportedPurposesParams) => number[]
   moveFunds?: MoveFunds
   signHardware?: (params: SignHardwareTxParams) => Promise<any>
-  signMessage?(params: SignMessageParams): Promise<any>
+  signMessage?<M = string>(params: SignMessageParams<M>): Promise<any>
   signTx(params: SignTxParams): Promise<any>
   sendTx(params: TxSendParams): Promise<IdentifiableTx>
   validateAssetId?: (assetId: string) => boolean

package/src/helpers.d.ts

@@ -15,3 +15,10 @@ 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>
+
+/**
+ * Exclusive OR
+ */
+export type XOR<T, U> =
+  | (T & Partial<Record<Exclude<keyof U, keyof T>, never>>)
+  | (U & Partial<Record<Exclude<keyof T, keyof U>, never>>)