@xyo-network/coingecko-crypto-market-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,34 +1,6 @@
-import { CryptoAsset, AssetSymbol } from '@xyo-network/coingecko-crypto-market-payload-plugin';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-type CoingeckoCryptoMarketWitnessConfigSchema = 'network.xyo.crypto.market.coingecko.witness.config';
-declare const CoingeckoCryptoMarketWitnessConfigSchema: CoingeckoCryptoMarketWitnessConfigSchema;
-
-type CoingeckoCryptoMarketWitnessConfig = WitnessConfig<{
-    coins?: CryptoAsset[];
-    currencies?: CryptoAsset[];
-    schema: CoingeckoCryptoMarketWitnessConfigSchema;
-}>;
-
-declare const coingeckoCoinToAssetMap: Record<string, AssetSymbol>;
-
-declare const defaultCoins: CryptoAsset[];
-declare const defaultCurrencies: CryptoAsset[];
-
-declare const pricesFromCoingecko: (coins: CryptoAsset[], currencies: CryptoAsset[]) => Promise<Partial<Record<string, Partial<Record<string, number> | undefined>>>>;
-
-type CoingeckoCryptoMarketWitnessParams = WitnessParams<AnyConfigSchema<CoingeckoCryptoMarketWitnessConfig>>;
-declare class CoingeckoCryptoMarketWitness<TParams extends CoingeckoCryptoMarketWitnessParams = CoingeckoCryptoMarketWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected observeHandler(): Promise<Payload[]>;
-}
-
-declare const CoingeckoCryptoMarketPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<CoingeckoCryptoMarketWitness<CoingeckoCryptoMarketWitnessParams>>;
-
-export { CoingeckoCryptoMarketPlugin, CoingeckoCryptoMarketWitness, CoingeckoCryptoMarketWitnessConfigSchema, coingeckoCoinToAssetMap, CoingeckoCryptoMarketPlugin as default, defaultCoins, defaultCurrencies, pricesFromCoingecko };
-export type { CoingeckoCryptoMarketWitnessConfig, CoingeckoCryptoMarketWitnessParams };
+export * from './Config.ts';
+export * from './lib/index.ts';
+export { CoingeckoCryptoMarketPlugin, CoingeckoCryptoMarketPlugin as default } from './Plugin.ts';
+export * from './Schema.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/coingecko-crypto-market-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,21 +28,24 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/axios": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/coingecko-crypto-market-payload-plugin": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7",
-    "@xyo-network/witness-model": "^4.1.7"
+    "@xylabs/axios": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/coingecko-crypto-market-payload-plugin": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/payload-wrapper": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/pricesFromCoingecko.spec.ts

@@ -0,0 +1,16 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { defaultCoins, defaultCurrencies } from '../defaults.ts'
+import { pricesFromCoingecko } from '../pricesFromCoingecko.ts'
+
+describe('pricesFromCoingecko', () => {
+  test('observe', async () => {
+    const assets = await pricesFromCoingecko(defaultCoins, defaultCurrencies)
+    expect(assets.btc?.btc).toBe(1)
+  })
+})

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 { CoingeckoCryptoMarketPlugin } from '../Plugin.ts'
+
+describe('CryptoMarketCoinGeckoPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = CoingeckoCryptoMarketPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(await resolver.resolve(plugin.set)).toBeDefined()
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,46 @@
+import '@xylabs/vitest-extended'
+
+import type { CoingeckoCryptoMarketPayload } from '@xyo-network/coingecko-crypto-market-payload-plugin'
+import { CoingeckoCryptoMarketSchema } from '@xyo-network/coingecko-crypto-market-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { defaultCoins, defaultCurrencies } from '../lib/index.ts'
+import { CoingeckoCryptoMarketWitnessConfigSchema } from '../Schema.ts'
+import { CoingeckoCryptoMarketWitness } from '../Witness.ts'
+
+describe('CoingeckoCryptoMarketWitness', () => {
+  test('returns observation', async () => {
+    const sut = await CoingeckoCryptoMarketWitness.create({
+      account: 'random',
+      config: {
+        coins: defaultCoins,
+        currencies: defaultCurrencies,
+        schema: CoingeckoCryptoMarketWitnessConfigSchema,
+      },
+    })
+    const [actual] = await sut.observe()
+    expect(actual.schema).toBe(CoingeckoCryptoMarketSchema)
+    const answerWrapper = PayloadWrapper.wrap(actual) as PayloadWrapper<CoingeckoCryptoMarketPayload>
+    expect(await answerWrapper.getValid()).toBe(true)
+    expect(answerWrapper.payload.assets).toBeObject()
+    const assets = Object.keys(answerWrapper.payload.assets)
+    expect(assets).toBeArray()
+    expect(assets.length).toBeGreaterThan(0)
+  })
+
+  test('returns observation [no config]', async () => {
+    const sut = await CoingeckoCryptoMarketWitness.create({ account: 'random' })
+    const [actual] = await sut.observe()
+    expect(actual.schema).toBe(CoingeckoCryptoMarketSchema)
+    const answerWrapper = PayloadWrapper.wrap(actual) as PayloadWrapper<CoingeckoCryptoMarketPayload>
+    expect(await answerWrapper.getValid()).toBe(true)
+    expect(answerWrapper.payload.assets).toBeObject()
+    const assets = Object.keys(answerWrapper.payload.assets)
+    expect(assets).toBeArray()
+    expect(assets.length).toBe(0)
+  })
+})

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