@exodus/asset-types 0.2.3 → 0.3.0

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.3.0](https://github.com/ExodusMovement/assets/compare/@exodus/asset-types@0.2.4...@exodus/asset-types@0.3.0) (2025-03-31)
+
+
+### Features
+
+
+* feat: add types for schnorr signing (#5352)
+
+
+
+## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/asset-types",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "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": "6cac727a12afc44b363ab1c5e82b32bbed71d1f0"
+  "gitHead": "c5a19c29bd6066318ca6fc83e86ba9d3c0ef5bbb"
 }

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

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>>)

package/src/index.d.ts

@@ -30,3 +30,15 @@ export type {
   AssetAddress,
   ApiFeatures,
 } from './asset.js'
+
+export type {
+  EcdsaSignParams,
+  Ed25519SignParams,
+  EncodedEcdsaSignature,
+  SchnorrSignParams,
+  SignParams,
+  SignReturnValue,
+  SignatureEncoding,
+  SignatureType,
+  Signer,
+} from './signer.js'

package/src/signer.d.ts

@@ -8,28 +8,36 @@ type BaseSignParams = {
   keyId?: KeyIdentifier
 }
 
-export enum SignatureType {
-  Ed25519 = 'ed25519',
-  Ecdsa = 'ecdsa',
-}
+export type SignatureType = 'ed25519' | 'ecdsa' | 'schnorr'
 
 export type EcdsaSignParams<Enc extends SignatureEncoding> = {
-  signatureType: SignatureType.Ecdsa
+  signatureType: 'ecdsa'
   data: Buffer
   ecOptions?: { canoncial?: boolean }
   extraEntropy?: Buffer
   enc: Enc
 } & BaseSignParams
 
+export type SchnorrSignParams = {
+  signatureType: 'schnorr'
+  data: Buffer
+  extraEntropy?: Buffer
+  tweak?: Buffer
+} & BaseSignParams
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type EncodedEcdsaSignature<Enc extends SignatureEncoding> = Enc extends 'der' ? Buffer : any
 
 export type Ed25519SignParams = {
-  signatureType: SignatureType.Ed25519
+  signatureType: 'ed25519'
   data: Buffer
 } & BaseSignParams
 
-export type SignParams<Enc extends SignatureEncoding> = EcdsaSignParams<Enc> | Ed25519SignParams
+export type SignParams<Enc extends SignatureEncoding> =
+  | EcdsaSignParams<Enc>
+  | Ed25519SignParams
+  | SchnorrSignParams
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type SignReturnValue<T extends SignParams<any>> =
   T extends EcdsaSignParams<infer Enc> ? EncodedEcdsaSignature<Enc> : Buffer