@xyo-network/crypto-asset-plugin 4.2.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/crypto-asset-plugin",
-  "version": "4.2.0",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,23 +28,27 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.1",
-    "@xylabs/exists": "^4.15.1",
-    "@xyo-network/coingecko-crypto-market-payload-plugin": "^4.2.0",
-    "@xyo-network/crypto-asset-payload-plugin": "^4.2.0",
-    "@xyo-network/diviner-abstract": "^4.3.0",
-    "@xyo-network/diviner-model": "^4.3.0",
-    "@xyo-network/module-model": "^4.3.0",
-    "@xyo-network/payload-builder": "^4.3.0",
-    "@xyo-network/payload-model": "^4.3.0",
-    "@xyo-network/payloadset-plugin": "^4.3.0",
-    "@xyo-network/uniswap-crypto-market-payload-plugin": "^4.2.0"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/exists": "^5.0.0",
+    "@xyo-network/coingecko-crypto-market-payload-plugin": "^5.0.0",
+    "@xyo-network/crypto-asset-payload-plugin": "^5.0.0",
+    "@xyo-network/diviner-abstract": "^5.0.0",
+    "@xyo-network/diviner-model": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/uniswap-crypto-market-payload-plugin": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.1",
-    "@xylabs/tsconfig": "^7.0.1",
-    "@xylabs/vitest-extended": "^4.15.1",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/averaege.spec.ts

@@ -0,0 +1,37 @@
+import '@xylabs/vitest-extended'
+
+import type { AssetInfo, CryptoMarketAssetPayload } from '@xyo-network/crypto-asset-payload-plugin'
+import { CryptoMarketAssetSchema } from '@xyo-network/crypto-asset-payload-plugin'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { average } from '../average.ts'
+
+const schema = CryptoMarketAssetSchema
+
+const getPayloadWithPrice = (price: number): CryptoMarketAssetPayload => {
+  const assets: Record<string, AssetInfo> = { xyo: { value: { usd: price.toString() } } }
+  const timestamp = Date.now()
+  return new PayloadBuilder<CryptoMarketAssetPayload>({ schema }).fields({ assets, timestamp }).build()
+}
+
+describe('average', () => {
+  it('averages numbers', async () => {
+    const payloads = await Promise.all([getPayloadWithPrice(1), getPayloadWithPrice(2), getPayloadWithPrice(3)])
+    expect(average(...payloads)?.xyo?.value?.usd).toBe('2')
+  })
+  it('handles single value', () => {
+    const payloads = getPayloadWithPrice(1)
+    expect(average(payloads)?.xyo?.value?.usd).toBe('1')
+  })
+  it('handles no values', () => {
+    expect(average()?.xyo?.value?.usd).toBeUndefined()
+  })
+  it('handles undefined values', async () => {
+    const payloads = await Promise.all([getPayloadWithPrice(1), undefined, getPayloadWithPrice(3)])
+    expect(average(...payloads)?.xyo?.value?.usd).toBe('2')
+  })
+})

package/src/lib/spec/divineCoinGeckoPrices.spec.ts

@@ -0,0 +1,36 @@
+import '@xylabs/vitest-extended'
+
+import { assertEx } from '@xylabs/assert'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { sampleCoinGeckoPayload } from '../../test/index.ts'
+import { divineCoinGeckoPrices } from '../divineCoinGeckoPrices.ts'
+
+describe('divineCoinGeckoPrices', () => {
+  // eslint-disable-next-line complexity
+  it('divines prices from CoinGecko', () => {
+    const result = divineCoinGeckoPrices(sampleCoinGeckoPayload)
+    expect(result.assets).toBeObject()
+    const assets = assertEx(result.assets)
+    for (let [token, assetInfo] of Object.entries(assets)) {
+      expect(token).toBeString()
+      expect(assetInfo).toBeObject()
+      const value = assertEx(assetInfo?.value)
+      expect(value).toBeObject()
+      for (let [symbol, price] of Object.entries(value)) {
+        expect(symbol).toBeString()
+        expect(price).toBeString()
+        const parsed = Number.parseFloat(price)
+        expect(parsed).toBeNumber()
+        expect(Number.isNaN(parsed)).toBeFalse()
+      }
+    }
+    expect(result?.assets?.xyo?.value?.btc).toBe('6.28282e-7')
+    expect(result?.assets?.xyo?.value?.eth).toBe('0.00000885')
+    expect(result?.assets?.xyo?.value?.eur).toBe('0.01417995')
+    expect(result?.assets?.xyo?.value?.usd).toBe('0.01439307')
+  })
+})

package/src/lib/spec/divinePrices.spec.ts

@@ -0,0 +1,21 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { sampleCoinGeckoPayload, sampleUniswapPayload } from '../../test/index.ts'
+import { divinePrices } from '../divinePrices.ts'
+
+describe('divinePrices', () => {
+  it('divines prices', () => {
+    const result = divinePrices(sampleCoinGeckoPayload, sampleUniswapPayload)
+    expect(result).toBeObject()
+    expect(result.timestamp).toBeNumber()
+    expect(result.assets.xyo?.value.btc).toBe('6.415295e-7')
+    expect(result.assets.xyo?.value.eth).toBe('0.000008908865')
+    expect(result.assets.xyo?.value.eur).toBe('0.01417995')
+    expect(result.assets.xyo?.value.usd).toBe('0.014635635000000001')
+  })
+})

package/src/lib/spec/divineUniswapPrices.spec.ts

@@ -0,0 +1,20 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { sampleUniswapPayload } from '../../test/index.ts'
+import { divineUniswapPrices } from '../divineUniswapPrices.ts'
+
+describe('divineUniswapPrices', () => {
+  it('divines prices from Uniswap', () => {
+    const result = divineUniswapPrices(sampleUniswapPayload)
+    expect(result).toBeObject()
+    expect(result?.assets?.xyo?.value?.btc).toBe('6.54777e-7')
+    expect(result?.assets?.xyo?.value?.eth).toBe('0.00000896773')
+    expect(result?.assets?.xyo?.value?.eur).toBe(undefined)
+    expect(result?.assets?.xyo?.value?.usd).toBe('0.0148782')
+  })
+})

package/src/spec/Diviner.spec.ts

@@ -0,0 +1,39 @@
+import '@xylabs/vitest-extended'
+
+import type { CryptoMarketAssetPayload } from '@xyo-network/crypto-asset-payload-plugin'
+import { CryptoMarketAssetSchema } from '@xyo-network/crypto-asset-payload-plugin'
+import type { Payload } from '@xyo-network/payload-model'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { CryptoMarketAssetDiviner } from '../Diviner.ts'
+import { sampleCoinGeckoPayload, sampleUniswapPayload } from '../test/index.ts'
+
+const coinGeckoPayload = sampleCoinGeckoPayload
+const uniswapPayload = sampleUniswapPayload
+
+describe('Diviner', () => {
+  const cases: [input: string, expected: string, data: Payload[]][] = [
+    ['only CoinGecko Payload', 'observation', [coinGeckoPayload]],
+    ['only Uniswap Payload', 'observation', [uniswapPayload]],
+    ['CoinGecko & Uniswap Payload', 'observation', [coinGeckoPayload, uniswapPayload]],
+    ['no inputs', 'empty observation', []],
+  ]
+  test.each(cases)('with %s returns %s', async (_input: string, _expected: string, data: Payload[]) => {
+    const diviner = await CryptoMarketAssetDiviner.create({ account: 'random' })
+    const payloads = await diviner.divine(data)
+    expect(payloads).toBeArray()
+    expect(payloads.length).toBe(1)
+    for (let payload of payloads) {
+      if (payload?.schema === CryptoMarketAssetSchema) {
+        const assetPayload = payload as CryptoMarketAssetPayload
+        expect(assetPayload).toBeObject()
+        expect(assetPayload?.assets).toBeObject()
+        expect(assetPayload?.schema).toBe(CryptoMarketAssetSchema)
+        expect(assetPayload?.timestamp).toBeNumber()
+      }
+    }
+  })
+})

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,17 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { CryptoMarketAssetPlugin } from '../Plugin.ts'
+
+describe('CryptoMarketCoinGeckoPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = CryptoMarketAssetPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(resolver.resolve(plugin.set)).toBeDefined()
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config