@xyo-network/sdk-js 2.102.5

package/docker/grafana/provisioning/dashboards/dashboard.yml

@@ -0,0 +1,12 @@
+apiVersion: 1
+
+providers:
+  - name: "Prometheus"
+    orgId: 1
+    folder: ""
+    type: file
+    disableDeletion: false
+    editable: true
+    allowUiUpdates: true
+    options:
+      path: /etc/grafana/provisioning/dashboards

package/docker/grafana/provisioning/datasources/datasource.yml

@@ -0,0 +1,11 @@
+apiVersion: 1
+
+datasources:
+  - name: Prometheus
+    type: prometheus
+    access: proxy
+    orgId: 1
+    url: http://prometheus:9090
+    basicAuth: false
+    isDefault: true
+    editable: true

package/docker/prometheus/prometheus.yml

@@ -0,0 +1,14 @@
+global:
+  scrape_interval: 15s
+  evaluation_interval: 15s
+
+# Load and evaluate rules in this file every 'evaluation_interval' seconds.
+rule_files:
+  - "alert.rules"
+
+# A scrape configuration containing exactly one endpoint to scrape.
+scrape_configs:
+  - job_name: "xyo"
+    scrape_interval: 10s
+    static_configs:
+      - targets: ["host.docker.internal:8080"]

package/docker-compose.metrics.yml

@@ -0,0 +1,33 @@
+version: "3.8"
+
+services:
+  prometheus:
+    image: prom/prometheus:v2.37.6
+    container_name: prometheus
+    volumes:
+      - ./docker/prometheus:/etc/prometheus
+      - prometheus_data:/prometheus
+    command:
+      - "--config.file=/etc/prometheus/prometheus.yml"
+      - "--storage.tsdb.path=/prometheus"
+      - "--web.console.libraries=/etc/prometheus/console_libraries"
+      - "--web.console.templates=/etc/prometheus/consoles"
+      - "--storage.tsdb.retention.time=200h"
+      - "--web.enable-lifecycle"
+    restart: unless-stopped
+    ports:
+      - "9090:9090"
+
+  grafana:
+    image: grafana/grafana:9.4.3
+    container_name: grafana
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./docker/grafana/provisioning:/etc/grafana/provisioning
+    environment:
+      - GF_SECURITY_ADMIN_USER=${ADMIN_USER:-admin}
+      - GF_SECURITY_ADMIN_PASSWORD=${ADMIN_PASSWORD:-admin}
+      - GF_USERS_ALLOW_SIGN_UP=false
+    restart: unless-stopped
+    ports:
+      - "3000:3000"

package/docker-compose.yml

@@ -0,0 +1,62 @@
+version: "3.8"
+
+services:
+  mongo:
+    container_name: mongo
+    image: mongo:6.0.3
+    restart: always
+    ports:
+      - "27017:27017"
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: example
+      MONGO_INITDB_DATABASE: archivist
+    healthcheck:
+      test:
+        [
+          "CMD",
+          "/usr/bin/mongosh",
+          "-u",
+          "root",
+          "-p",
+          "example",
+          "--quiet",
+          "/opt/mongo/joinReplicaSet.js",
+        ]
+      interval: 5s
+      timeout: 10s
+      retries: 3
+      start_period: 1s
+    volumes:
+      - ./scripts/mongo/opt/mongo:/opt/mongo
+      - ./scripts/mongo/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
+    command:
+      [
+        "--auth",
+        "--bind_ip_all",
+        "--keyFile",
+        "/tmp/mongodb.key",
+        "--replSet",
+        "dbrs",
+      ]
+
+  # ipfs:
+  #   image: ipfs/kubo:latest
+  #   container_name: ipfs
+  #   restart: unless-stopped
+  # environment:
+  # IPFS_PROFILE: server
+  # IPFS_PROFILE: default-networking
+  # IPFS_PROFILE: flatfs
+  # ports:
+  #   - "4001:4001"
+  #   - "5001:5001"
+  #   - "8080:8080"
+  # ipfs-gateway:
+  #   image: ipfs/bifrost-gateway:release
+  #   container_name: ipfs-gateway
+  #   restart: unless-stopped
+  #   environment:
+  #     PROXY_GATEWAY_URL: http://ipfs:8080
+  #   ports:
+  #     - "8081:8081"

package/jest.config.ts

@@ -0,0 +1,31 @@
+const generateJestConfig = ({ esModules }: { esModules: string[] }) => {
+  const esModulesList = Array.isArray(esModules) ? esModules.join('|') : esModules
+  return {
+    coveragePathIgnorePatterns: ['<rootDir>/(.*)/dist'],
+    globalSetup: './jestSetup/globalSetup.ts',
+    globalTeardown: './jestSetup/globalTeardown.ts',
+    moduleNameMapper: {
+      '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    preset: 'ts-jest/presets/default-esm',
+    setupFiles: ['dotenv/config'],
+    setupFilesAfterEnv: ['jest-sorted', 'jest-extended/all', './jestSetup/setupFiles.ts'],
+    testRegex: String.raw`(/__tests__/.*|(\.|/)((!perf\.)test|spec))\.tsx?$`,
+    testTimeout: 200_000,
+    transform: {
+      [`(${esModulesList}).+\\.js$`]: 'babel-jest',
+      '^.+\\.tsx?$': [
+        'ts-jest',
+        {
+          tsconfig: 'tsconfig.test.json',
+        },
+      ],
+    },
+    transformIgnorePatterns: [`./node_modules/(?!${esModulesList})`],
+  }
+}
+
+const config = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid', 'lodash-es', 'quick-lru'] })
+
+// eslint-disable-next-line import/no-default-export
+export default config

package/jestSetup/globalSetup.ts

@@ -0,0 +1,19 @@
+/* eslint-disable no-var */
+import { config } from 'dotenv'
+config()
+import { Config } from 'jest'
+import { SuperTest, Test } from 'supertest'
+
+// Augment global scope with shared variables (must be var)
+declare global {
+  var req: SuperTest<Test>
+}
+
+/**
+ * Jest global setup method runs before any tests are run
+ * https://jestjs.io/docs/configuration#globalsetup-string
+ */
+
+const setup = async (_globalConfig: Config, _projectConfig: Config) => {}
+
+module.exports = setup

package/jestSetup/globalTeardown.ts

@@ -0,0 +1,12 @@
+import { config } from 'dotenv'
+config()
+import { Config } from 'jest'
+
+/**
+ * Jest global teardown method runs after all tests are run
+ * https://jestjs.io/docs/configuration#globalteardown-string
+ */
+
+const teardown = async (_globalConfig: Config, _projectConfig: Config) => {}
+
+module.exports = teardown

package/jestSetup/setupFiles.ts

@@ -0,0 +1,10 @@
+import { ForgetPromise } from '@xylabs/forget'
+
+beforeAll(() => {
+  // Can be async, before each test file
+})
+
+afterAll(async () => {
+  // Can be async, after each test file
+  await ForgetPromise.awaitInactive()
+})

package/package.json

@@ -0,0 +1,126 @@
+{
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "workspaces": [
+    "packages/**/*"
+  ],
+  "dependencies": {
+    "@xyo-network/core-payload-plugins": "~2.102.5",
+    "@xyo-network/manifest": "~2.102.5",
+    "@xyo-network/modules": "~2.102.5",
+    "@xyo-network/protocol": "~2.102.5",
+    "@xyo-network/sdk-utils": "~2.102.5",
+    "@xyo-network/shared": "~2.102.5"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/supertest": "^6.0.2",
+    "@xylabs/eslint-config": "^3.10.4",
+    "@xylabs/forget": "^3.3.3",
+    "@xylabs/ts-scripts-yarn3": "^3.10.4",
+    "@xylabs/tsconfig": "^3.10.4",
+    "@xylabs/tsconfig-dom-jest": "^3.10.4",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "jest": "^29.7.0",
+    "jest-docblock": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-extended": "^4.0.2",
+    "jest-runner": "^29.7.0",
+    "jest-runner-groups": "^2.2.0",
+    "jest-sorted": "^1.0.15",
+    "reflect-metadata": "^0.2.2",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13",
+    "typedoc-material-theme": "^1.0.2",
+    "typescript": "^5.4.5"
+  },
+  "resolutions": {
+    "axios": "^1",
+    "bn.js": "^5",
+    "ethers": "6.11.0",
+    "fake-indexeddb": "^4",
+    "quick-lru": "^5"
+  },
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json",
+    "./README.md": "./README.md"
+  },
+  "main": "./dist/node/index.cjs",
+  "module": "./dist/node/index.js",
+  "types": "./dist/node/index.d.cts",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "name": "@xyo-network/sdk-js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "scripts": {
+    "coverage": "yarn jest --coverage --forceExit",
+    "compile": "./scripts/clear-scrollback-buffer.sh && yarn xy compile",
+    "build": "xy build && xy statics",
+    "deploy": "xy deploy",
+    "lint-pkg": "npmPkgJsonLint .",
+    "perf": "yarn jest -c jest.config.perf.cjs",
+    "test-esm": "node $(yarn jest --no-cache --forceExit)",
+    "test": "jest --no-cache --forceExit",
+    "test:no-slow": "jest . --passWithNoTests --forceExit -- --group=-slow",
+    "test:module": "jest . --passWithNoTests --forceExit -- --group=module",
+    "test:sentinel": "jest . --passWithNoTests --forceExit -- --group=sentinel",
+    "test:thumbnail": "jest . --passWithNoTests --forceExit -- --group=thumbnail",
+    "test:no-mongo": "jest ${0} --passWithNoTests --forceExit -c ./jest.config.no-mongo.ts -- --group=-mongo",
+    "testx": "jest ${0} --passWithNoTests --forceExit -c ./jest.config.no-mongo.ts -- --group=-mongo",
+    "test:hash-perf": "jest packages/protocol/packages/core/packages/hash/src/spec/PayloadHasher.bigobj.perf.spec.ts -c ./jest.config.no-mongo.ts",
+    "test:hash-perf-parallel": "jest packages/protocol/packages/core/packages/hash/src/spec/PayloadHasher.bigobj-parallel.perf.spec.ts -c ./jest.config.no-mongo.ts",
+    "test:ci": "jest --runInBand --coverage --forceExit --passWithNoTests",
+    "free-8080": "kill -9 $(lsof -t -i :8080)",
+    "free-3033": "kill -9 $(lsof -t -i :3033)",
+    "free-mongo": "kill -9 $(lsof -t -i :55391) && kill -9 $(lsof -t -i :55393)",
+    "build-typedoc-site": "typedoc"
+  },
+  "sideEffects": false,
+  "version": "2.102.5",
+  "packageManager": "yarn@4.2.2",
+  "volta": {
+    "node": "20.12.0",
+    "yarn": "1.22.19"
+  },
+  "type": "module"
+}

package/scripts/clear-scrollback-buffer.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+clear
+printf '\e[3J'

package/scripts/mongo/README.md

@@ -0,0 +1,33 @@
+# MongoDB Scripts
+
+The following scripts exist to initialize the local MongoDB instance
+appropriately. From [their docs](https://hub.docker.com/_/mongo):
+
+> When a container is started for the first time it will execute files with
+> extensions `.sh` and `.js` that are found in `/docker-entrypoint-initdb.d`.
+> Files will be executed in alphabetical order. `.js` files will be executed by
+> mongo using the database specified by the `MONGO_INITDB_DATABASE` variable,
+> if it is present, or test otherwise. You may also switch databases within the
+> `.js` script.
+
+It doesn't look like they support:
+
+-   `await`
+-   `console`
+
+so be sure to code your scripts accordingly.
+
+## Debugging
+
+For debugging with `mongosh` you can connect with something similar to the
+following:
+
+```shell
+mongosh --authenticationDatabase admin mongodb://root:example@localhost:27017/archivist
+```
+
+From the mongo shell, to seed the DB with test data you can run:
+
+```shell
+load('./scripts/mongo/test/seed.js')
+```

package/scripts/mongo/docker-entrypoint-initdb.d/00-create-key.sh

@@ -0,0 +1,5 @@
+#!/bin/bash -eux
+
+cd /tmp
+openssl rand -base64 756 > mongodb.key
+chmod 400 mongodb.key

package/scripts/mongo/opt/mongo/joinReplicaSet.js

@@ -0,0 +1,14 @@
+/* eslint-disable no-undef */
+const config = {
+  _id: 'dbrs',
+  members: [
+    {
+      _id: 0,
+      host: '127.0.0.1:27017',
+      priority: 1,
+    },
+  ],
+  version: 1,
+}
+rs.initiate(config, { force: true })
+rs.status()

package/src/index.ts

@@ -0,0 +1,7 @@
+/* eslint-disable no-restricted-imports */
+export * from '@xyo-network/core-payload-plugins'
+export * from '@xyo-network/manifest'
+export * from '@xyo-network/modules'
+export * from '@xyo-network/protocol'
+export * from '@xyo-network/sdk-utils'
+export * from '@xyo-network/shared'