@exodus/asset-types 0.0.0

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@exodus/asset-types",
+  "version": "0.0.0",
+  "description": "Typings for Assets",
+  "author": "Exodus Movement, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/assets.git"
+  },
+  "homepage": "https://github.com/ExodusMovement/assets/tree/master/shield/asset-types",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "src/index.d.ts",
+  "files": [
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@exodus/currency": "^6.0.1",
+    "@exodus/key-identifier": "^1.3.0",
+    "@exodus/models": "^12.2.0"
+  },
+  "scripts": {
+    "lint": "run -T eslint .",
+    "lint:fix": "yarn lint --fix"
+  },
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Aasset-types"
+  },
+  "gitHead": "0ff44cf074103d3aee53b875d7026fae26bde5fc"
+}

package/src/asset-meta.d.ts

@@ -0,0 +1,40 @@
+import type { UnitType } from '@exodus/currency'
+
+export type GradientCoords = {
+  x1: string
+  y1: string
+  x2: string
+  y2: string
+}
+
+export type Info = {
+  description?: string
+  reddit?: string
+  twitter?: string
+  website?: string
+  telegram?: string
+}
+
+export type AssetMeta = {
+  assetType: string
+  baseAssetName: string
+  blockExplorer: {
+    txUrl: (txId: string) => Promise<string>
+    addressUrl: (address: string) => Promise<string>
+  }
+  chainBadgeColors: string[]
+  currency: UnitType
+  displayNetworkName: string
+  displayNetworkTicker: string
+  displayTicker: string
+  gradientColors: string[]
+  gradientCoords: GradientCoords
+  tokenAssetType?: string
+  info?: Info
+  primaryColor: string
+  displayName: string
+  name: string
+  ticker: string
+  decimals?: number
+  mintAddress?: string
+}

package/src/asset.d.ts

@@ -0,0 +1,167 @@
+/* eslint @typescript-eslint/no-explicit-any: 0 */ // --> OFF
+
+import type NumberUnit from '@exodus/currency'
+import type KeyIdentifier from '@exodus/key-identifier'
+import type { AccountState, Tx, TxSet, WalletAccount } from '@exodus/models'
+
+import type { AssetMeta } from './asset-meta.js'
+import type { CreateFeeMonitorApi } from './fee-monitor.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'
+
+export type CreateHistoryMonitorApi = (args: {
+  asset: BaseAsset
+  runner: () => void
+  yieldToUI: () => void
+  logger: Logger
+}) => HistoryMonitor
+
+export type ApiFeatures = {
+  accountState?: boolean
+  customTokens?: boolean
+  feeMonitor?: boolean
+  feesApi?: boolean
+  isMaxFeeAsset?: boolean
+  isTestnet?: boolean
+  nfts?: boolean
+  noHistory?: boolean
+  signWithSigner?: boolean
+  signMessageWithSigner?: boolean
+}
+
+export type BalanceFieldName =
+  | 'total'
+  | 'balance'
+  | 'spendable'
+  | 'spendableBalance'
+  | 'unconfirmedSent'
+  | 'unconfirmedReceived'
+  | 'unspendable'
+  | 'walletReserve'
+  | 'networkReserve'
+  | 'staking'
+  | 'staked'
+  | 'stakable'
+  | 'unstaking'
+  | 'unstaked'
+  | 'rewards'
+  | 'frozen'
+
+export type Balances = Record<BalanceFieldName, NumberUnit>
+
+export type CommonAssetApi = {
+  features: ApiFeatures
+  getActivityTxs?: (params: { txs: Tx[] }) => Tx[]
+  getBalances: (args: {
+    asset: AbstractAsset
+    accountState: AccountState
+    txLog: TxSet
+  }) => 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 AssetApi = CommonAssetApi & {
+  addressHasHistory?: (address: string) => Promise<boolean>
+  broadcastTx: (rawTx: Buffer) => Promise<any>
+  createAccountState?: () => typeof AccountState
+  createFeeMonitor: CreateFeeMonitorApi
+  createHistoryMonitor: CreateHistoryMonitorApi
+  defaultAddressPath: string
+  getBalanceForAddress: (address: string) => NumberUnit
+  getConfirmationsNumber: () => number
+  getDefaultAddressPath?: (args: {
+    walletAccount: WalletAccount
+    compatibilityMode?: string
+  }) => string
+  getFeeData: () => any
+  getKeyIdentifier(params: {
+    purpose: number
+    accountIndex: number
+    chainIndex?: number
+    addressIndex?: number
+    compatibilityMode?: string
+  }): KeyIdentifier
+  getSupportedPurposes?: (params?: { compatibilityMode?: string; isMultisig?: boolean }) => 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 }>
+  validateAssetId?: (assetId: string) => boolean
+}
+
+export type TokenAssetApi = {
+  getBalances: (params: {
+    asset: AbstractAsset
+    accountState: AccountState
+    txLog: TxSet
+  }) => Balances
+}
+
+export type AbstractAsset = AssetMeta & {
+  baseAsset: BaseAsset
+  feeAsset: AbstractAsset
+  isBuiltIn?: boolean
+  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>
+  }
+}
+
+export type CombinedAsset<A extends BaseAsset | TokenAsset = BaseAsset | TokenAsset> = AssetMeta & {
+  isCombined: true
+  combinedAssets: A[]
+  combinedAssetNames: A['name'][]
+}
+
+export type BaseAsset = AbstractAsset & {
+  api: AssetApi
+}
+
+export type TokenAsset = AbstractAsset & {
+  assetId?: string
+  api: CommonAssetApi
+}
+
+export type AssetPlugin<A = BaseAsset, C = unknown> = {
+  createAsset: (params: {
+    assetClientInterface: any
+    // extract interface
+    config: C
+    overrideCallback?: ({ asset: A }) => A
+  }) => A
+}

package/src/fee-monitor.d.ts

@@ -0,0 +1,14 @@
+import type NumberUnit from '@exodus/currency'
+
+export type FeeMonitor = {
+  start: () => Promise<void>
+  stop: () => Promise<void>
+  tick: () => Promise<void>
+}
+
+export type CreateFeeMonitorApi = (params: {
+  updateFee: (
+    assetName: string,
+    feeDataToUpdate: Record<string, number | string | NumberUnit>
+  ) => Promise<void>
+}) => FeeMonitor

package/src/history-monitor.d.ts

@@ -0,0 +1,15 @@
+/* eslint @typescript-eslint/no-explicit-any: 0 */ // --> OFF
+
+export type HookEvent = ['start', 'stop', 'update', 'tick', 'tick-multiple-wallet-accounts']
+
+export type HistoryMonitor = {
+  start: (params?: any) => Promise<void>
+  stop: () => Promise<void>
+  addHook: (event: HookEvent, callback: (params: any) => Promise<void>) => void
+  update: (args?: {
+    walletAccount: string
+    refresh?: boolean
+    highPriority?: boolean
+    assetName?: string
+  }) => Promise<void>
+}

package/src/index.d.ts

@@ -0,0 +1,8 @@
+export type {
+  //
+  AbstractAsset,
+  AssetPlugin,
+  BaseAsset,
+  CombinedAsset,
+  TokenAsset,
+} from './asset.js'

package/src/logger.d.ts

@@ -0,0 +1,8 @@
+// compied from hydra, share!
+export type Args = [unknown, ...unknown[]]
+
+export type LogLevel = 'trace' | 'debug' | 'log' | 'info' | 'warn' | 'error'
+
+export type LogFn = (...args: Args) => void
+
+export type Logger = Record<LogLevel, LogFn>

package/src/move-funds.d.ts

@@ -0,0 +1,35 @@
+import type NumberUnit from '@exodus/currency'
+
+export type MoveFunds = {
+  prepareSendFundsTx: (params: {
+    assetName: string
+    walletAccount: string
+    input: string
+    toAddress: string
+    MoveFundsError: typeof Error
+  }) => Promise<{
+    amount: NumberUnit
+    fee: NumberUnit
+    fromAddress: string
+    privateKey: string
+    toAddress: string
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    unsignedTx: any
+  }>
+  sendFunds: (params: {
+    amount: NumberUnit
+    assetName: string
+    fee: NumberUnit
+    fromAddress: string
+    privateKey: string
+    toAddress: string
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    unsignedTx: any
+  }) => Promise<{
+    amount: NumberUnit
+    fee: NumberUnit
+    fromAddress: string
+    toAddress: string
+    txId: string
+  }>
+}

package/src/signer.d.ts

@@ -0,0 +1,46 @@
+import type KeyIdentifier from '@exodus/key-identifier'
+
+// move to hydra!
+
+export type SignatureEncoding = 'raw' | 'der' | 'sig' | 'sig|rec' | 'rec|sig' | 'sig,rec'
+
+type BaseSignParams = {
+  keyId?: KeyIdentifier
+}
+
+export enum SignatureType {
+  Ed25519 = 'ed25519',
+  Ecdsa = 'ecdsa',
+}
+
+export type EcdsaSignParams<Enc extends SignatureEncoding> = {
+  signatureType: SignatureType.Ecdsa
+  data: Buffer
+  ecOptions?: { canoncial?: boolean }
+  extraEntropy?: Buffer
+  enc: Enc
+} & 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
+  data: Buffer
+} & BaseSignParams
+
+export type SignParams<Enc extends SignatureEncoding> = EcdsaSignParams<Enc> | Ed25519SignParams
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type SignReturnValue<T extends SignParams<any>> =
+  T extends EcdsaSignParams<infer Enc> ? EncodedEcdsaSignature<Enc> : Buffer
+
+export type GetPublicKeyParams = {
+  keyId?: KeyIdentifier
+}
+
+export interface Signer {
+  getPublicKey(params?: GetPublicKeyParams): Promise<Buffer>
+  sign<Enc extends SignatureEncoding>(
+    signParams: SignParams<Enc>
+  ): Promise<SignReturnValue<typeof signParams>>
+}