@kinetiq-research/asset-metadata 1.1.1

package/force-release.md

@@ -0,0 +1 @@
+Mar 18, 2026 v2

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@kinetiq-research/asset-metadata",
+  "version": "1.1.1",
+  "description": "Asset metadata (descriptions, oracle references) for Kinetiq markets",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    "./get-asset-metadata": "./src/get-asset-metadata.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "format": "oxfmt .",
+    "lint": "concurrently \"pnpm format\" \"pnpm lint:oxlint\" \"pnpm type-check\"",
+    "lint:oxlint": "oxlint --format unix --fix-dangerously .",
+    "type-check": "tsc -b",
+    "type-check:watch": "pnpm type-check -w --preserveWatchOutput"
+  },
+  "devDependencies": {
+    "@kinetiq-research/tsconfig": "workspace:*"
+  }
+}

package/src/asset-metadata.ts

@@ -0,0 +1,164 @@
+export const assetMetadata: Record<
+  string,
+  {
+    description: string
+    descriptionShort: string
+    oracleName: string
+    oracleUrl: string
+  }
+> = {
+  'km:aapl': {
+    description:
+      'Apple, Inc. engages in the design, manufacture, and sale of smartphones, personal computers, tablets, wearables and accessories, and other varieties of related services.',
+    descriptionShort: 'Apple, Inc.',
+    oracleName: 'NASDAQ: AAPL',
+    oracleUrl: 'https://www.google.com/finance/quote/AAPL:NASDAQ',
+  },
+  'km:baba': {
+    description:
+      'Alibaba Group Holding Ltd. is a Chinese multinational technology conglomerate operating across e-commerce, cloud computing, digital media, and financial services.',
+    descriptionShort: 'Alibaba Group Holding Ltd.',
+    oracleName: 'NYSE: BABA',
+    oracleUrl: 'https://www.google.com/finance/quote/BABA:NYSE',
+  },
+  'km:bmnr': {
+    description:
+      'Bitmine Immersion Technologies, Inc. is a technology company focused on acquiring, holding, and actively managing ETH as its primary treasury reserve asset.',
+    descriptionShort: 'Bitmine Immersion Technologies, Inc',
+    oracleName: 'NYSEAMERICAN: BMNR',
+    oracleUrl: 'https://www.google.com/finance/quote/BMNR:NYSEAMERICAN',
+  },
+  'km:gldmine': {
+    description:
+      'Tracks a market-cap-weighted index of global companies tied to gold and silver mining activities.',
+    descriptionShort: 'Tracks gold and silver mining companies',
+    oracleName: 'NYSEARCA: GDX',
+    oracleUrl: 'https://www.google.com/finance/quote/GDX:NYSEARCA',
+  },
+  'km:gold': {
+    description:
+      'Tracks the gold spot price, less expenses and liabilities, using gold bars held in London vaults.',
+    descriptionShort: 'Tracks gold spot price',
+    oracleName: 'NYSEARCA: GLD',
+    oracleUrl: 'https://www.google.com/finance/quote/GLD:NYSEARCA',
+  },
+  'km:googl': {
+    description:
+      'Alphabet, Inc (Class A). is a holding company, which engages in software, health care, transportation, and other technologies.',
+    descriptionShort: 'Alphabet, Inc Class A',
+    oracleName: 'NASDAQ: GOOGL',
+    oracleUrl: 'https://www.google.com/finance/quote/GOOGL:NASDAQ',
+  },
+  'km:jpn225': {
+    description:
+      "Tracks Japan's top 225 blue-chip stocks on the Tokyo Stock Exchange.",
+    descriptionShort: "Tracks Japan's top 225 blue-chip stocks",
+    oracleName: 'INDEXNIKKEI: NI225',
+    oracleUrl: 'https://www.google.com/finance/quote/NI225:INDEXNIKKEI',
+  },
+  'km:mu': {
+    description:
+      'Micron Technology, Inc. engages in the provision of innovative memory and storage solutions.',
+    descriptionShort: 'Micron Technology, Inc.',
+    oracleName: 'NASDAQ: MU',
+    oracleUrl: 'https://www.google.com/finance/quote/MU:NASDAQ',
+  },
+  'km:nvda': {
+    description:
+      'NVIDIA Corporation engages in the design and manufacture of computer graphics processors, chipsets, and related multimedia software.',
+    descriptionShort: 'NVIDIA Corporation',
+    oracleName: 'NASDAQ: NVDA',
+    oracleUrl: 'https://www.google.com/finance/quote/NVDA:NASDAQ',
+  },
+  'km:pltr': {
+    description:
+      'Palantir Technologies, Inc. engages in the business of building and deploying software platforms that serve as the central operating systems for its customers.',
+    descriptionShort: 'Palantir Technologies, Inc.',
+    oracleName: 'NASDAQ: PLTR',
+    oracleUrl: 'https://www.google.com/finance/quote/PLTR:NASDAQ',
+  },
+  'km:rtx': {
+    description:
+      'RTX Corporation is an aerospace and defense company, which engages in the provision of aerospace and defense systems and services for commercial, military, and government customers.',
+    descriptionShort: 'RTX Corporation',
+    oracleName: 'NYSE: RTX',
+    oracleUrl: 'https://www.google.com/finance/quote/RTX:NYSE',
+  },
+  'km:semi': {
+    description:
+      'Tracks a modified market-cap-weighted index of 30 US-listed semiconductor companies.',
+    descriptionShort: 'Tracks 30 US-listed semiconductor companies',
+    oracleName: 'NASDAQ: SOXX',
+    oracleUrl: 'https://www.google.com/finance/quote/SOXX:NASDAQ',
+  },
+  'km:silver': {
+    description:
+      'Tracks the silver spot price, less expenses and liabilities, using silver bullion held in London.',
+    descriptionShort: 'Tracks silver spot price',
+    oracleName: 'NYSEARCA: SLV',
+    oracleUrl: 'https://www.google.com/finance/quote/SLV:NYSEARCA',
+  },
+  'km:small2000': {
+    description:
+      'Tracks a market-cap-weighted index of US small-cap stocks. The index selects stocks ranked 1,001-3,000 by market cap.',
+    descriptionShort: 'Tracks 2000 US small-cap stocks',
+    oracleName: 'NYSEARCA: IWM',
+    oracleUrl: 'https://www.google.com/finance/quote/IWM:NYSEARCA',
+  },
+  'km:tencent': {
+    description:
+      'Tencent Holdings Ltd. is a leading multinational technology conglomerate and the world\'s largest video game publisher. It operates a vast ecosystem, including the WeChat "super-app" (1.3 billion+ users), FinTech, cloud services, and online advertising.',
+    descriptionShort: 'Tencent Holdings Ltd.',
+    oracleName: 'HKG: 0700',
+    oracleUrl: 'https://www.google.com/finance/quote/0700:HKG',
+  },
+  'km:tsla': {
+    description:
+      'Tesla, Inc. engages in the design, development, manufacture, and sale of electric vehicles and energy generation and storage systems.',
+    descriptionShort: 'Tesla, Inc.',
+    oracleName: 'NASDAQ: TSLA',
+    oracleUrl: 'https://www.google.com/finance/quote/TSLA:NASDAQ',
+  },
+  'km:us500': {
+    description:
+      'Tracks a market cap-weighted index of the 500 largest US large- and mid-cap stocks.',
+    descriptionShort: 'Tracks 500 leading US large-cap stocks',
+    oracleName: 'NYSEARCA: SPY',
+    oracleUrl: 'https://www.google.com/finance/quote/SPY:NYSEARCA',
+  },
+  'km:usbond': {
+    description:
+      'Tracks a market-weighted index of debt issued by the US Treasury with remaining maturities of 20 years or more.',
+    descriptionShort: 'Tracks long-duration US Treasury bonds',
+    oracleName: 'NASDAQ: TLT',
+    oracleUrl: 'https://www.google.com/finance/quote/TLT:NASDAQ',
+  },
+  'km:usenergy': {
+    description:
+      'Tracks a market-cap-weighted index of US energy companies in the S&P 500.',
+    descriptionShort: 'Tracks US energy company stocks',
+    oracleName: 'NYSEARCA: XLE',
+    oracleUrl: 'https://www.google.com/finance/quote/XLE:NYSEARCA',
+  },
+  'km:usoil': {
+    description:
+      'Tracks predominantly short-term futures contracts on WTI crude oil.',
+    descriptionShort: 'Tracks crude oil short-term futures',
+    oracleName: 'NYSEARCA: USO',
+    oracleUrl: 'https://www.google.com/finance/quote/USO:NYSEARCA',
+  },
+  'km:ustech': {
+    description:
+      'Tracks a modified-market-cap-weighted index of 100 NASDAQ-listed stocks.',
+    descriptionShort: 'Tracks 100 leading NASDAQ stocks',
+    oracleName: 'NASDAQ: QQQ',
+    oracleUrl: 'https://www.google.com/finance/quote/QQQ:NASDAQ',
+  },
+  'km:xiaomi': {
+    description:
+      'Xiaomi Corporation engages in the design, manufacture and sale of smartphone, hardware and software products.',
+    descriptionShort: 'Xiaomi Corporation',
+    oracleName: 'HKG: 1810',
+    oracleUrl: 'https://www.google.com/finance/quote/1810:HKG',
+  },
+}

package/src/get-asset-metadata.ts

@@ -0,0 +1,21 @@
+import { assetMetadata } from './asset-metadata'
+
+export interface AssetMetadata {
+  description: string | undefined
+  descriptionShort: string | undefined
+  oracleName: string | undefined
+  oracleUrl: string | undefined
+}
+
+const EMPTY_METADATA: AssetMetadata = {
+  description: undefined,
+  descriptionShort: undefined,
+  oracleName: undefined,
+  oracleUrl: undefined,
+}
+
+export const getAssetMetadata = ({
+  symbol,
+}: {
+  symbol: string
+}): AssetMetadata => assetMetadata[symbol.toLowerCase()] ?? EMPTY_METADATA

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./"
+  },
+  "exclude": ["dist", "node_modules"],
+  "extends": "@kinetiq-research/tsconfig/base.json",
+  "include": ["."]
+}