@xyo-network/diviner-hash-lease 2.92.2

package/dist/node/reservedBrands.d.cts

@@ -0,0 +1,5 @@
+export declare const reservedBrands: {
+    name: string;
+    value: number;
+}[];
+//# sourceMappingURL=reservedBrands.d.ts.map

package/dist/node/reservedBrands.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedBrands.d.ts","sourceRoot":"","sources":["../../src/reservedBrands.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc;;;GAi9D1B,CAAA"}

package/dist/node/reservedBrands.d.mts

@@ -0,0 +1,5 @@
+export declare const reservedBrands: {
+    name: string;
+    value: number;
+}[];
+//# sourceMappingURL=reservedBrands.d.ts.map

package/dist/node/reservedBrands.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedBrands.d.ts","sourceRoot":"","sources":["../../src/reservedBrands.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc;;;GAi9D1B,CAAA"}

package/dist/node/reservedBrands.d.ts

@@ -0,0 +1,5 @@
+export declare const reservedBrands: {
+    name: string;
+    value: number;
+}[];
+//# sourceMappingURL=reservedBrands.d.ts.map

package/dist/node/reservedBrands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedBrands.d.ts","sourceRoot":"","sources":["../../src/reservedBrands.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc;;;GAi9D1B,CAAA"}

package/dist/node/reservedCryptos.d.cts

@@ -0,0 +1,6 @@
+export interface Crypto {
+    name: string;
+    symbol: string;
+}
+export declare const reservedCryptos: Crypto[];
+//# sourceMappingURL=reservedCryptos.d.ts.map

package/dist/node/reservedCryptos.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedCryptos.d.ts","sourceRoot":"","sources":["../../src/reservedCryptos.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,EAAkF,CAAA"}

package/dist/node/reservedCryptos.d.mts

@@ -0,0 +1,6 @@
+export interface Crypto {
+    name: string;
+    symbol: string;
+}
+export declare const reservedCryptos: Crypto[];
+//# sourceMappingURL=reservedCryptos.d.ts.map

package/dist/node/reservedCryptos.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedCryptos.d.ts","sourceRoot":"","sources":["../../src/reservedCryptos.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,EAAkF,CAAA"}

package/dist/node/reservedCryptos.d.ts

@@ -0,0 +1,6 @@
+export interface Crypto {
+    name: string;
+    symbol: string;
+}
+export declare const reservedCryptos: Crypto[];
+//# sourceMappingURL=reservedCryptos.d.ts.map

package/dist/node/reservedCryptos.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedCryptos.d.ts","sourceRoot":"","sources":["../../src/reservedCryptos.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,eAAe,EAAE,MAAM,EAAkF,CAAA"}

package/dist/node/reservedDomains.d.cts

@@ -0,0 +1,4 @@
+export declare const reservedDomains: {
+    name: string;
+}[];
+//# sourceMappingURL=reservedDomains.d.ts.map

package/dist/node/reservedDomains.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedDomains.d.ts","sourceRoot":"","sources":["../../src/reservedDomains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe;;GAy7F3B,CAAA"}

package/dist/node/reservedDomains.d.mts

@@ -0,0 +1,4 @@
+export declare const reservedDomains: {
+    name: string;
+}[];
+//# sourceMappingURL=reservedDomains.d.ts.map

package/dist/node/reservedDomains.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedDomains.d.ts","sourceRoot":"","sources":["../../src/reservedDomains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe;;GAy7F3B,CAAA"}

package/dist/node/reservedDomains.d.ts

@@ -0,0 +1,4 @@
+export declare const reservedDomains: {
+    name: string;
+}[];
+//# sourceMappingURL=reservedDomains.d.ts.map

package/dist/node/reservedDomains.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservedDomains.d.ts","sourceRoot":"","sources":["../../src/reservedDomains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe;;GAy7F3B,CAAA"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@xyo-network/diviner-hash-lease",
+  "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"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^3.0.11",
+    "@xyo-network/archivist-model": "~2.92.2",
+    "@xyo-network/diviner-abstract": "~2.92.2",
+    "@xyo-network/diviner-model": "~2.92.2",
+    "@xyo-network/module-model": "~2.92.2",
+    "@xyo-network/payload-builder": "~2.92.2",
+    "@xyo-network/payload-model": "~2.92.2"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.5.2",
+    "@xylabs/tsconfig": "^3.5.2",
+    "typescript": "^5.4.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "types": "dist/node/index.d.ts",
+  "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"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.92.2",
+  "type": "module"
+}

package/src/Diviner.ts

@@ -0,0 +1,130 @@
+import { assertEx } from '@xylabs/assert'
+import { ArchivistParams } from '@xyo-network/archivist-model'
+import { AbstractDiviner } from '@xyo-network/diviner-abstract'
+import { DivinerConfig } from '@xyo-network/diviner-model'
+import { AnyConfigSchema, creatableModule } from '@xyo-network/module-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import { isPayloadOfSchemaTypeWithMeta, Payload, WithSources } from '@xyo-network/payload-model'
+
+import { reservedBrands } from './reservedBrands'
+import { reservedCryptos } from './reservedCryptos'
+import { reservedDomains } from './reservedDomains'
+
+const ONE_YEAR = 1000 * 60 * 60 * 24 * 365
+
+export const HashLeaseEstimateDivinerConfigSchema = 'network.xyo.diviner.hash.lease.estimate.config'
+export type HashLeaseEstimateDivinerConfigSchema = typeof HashLeaseEstimateDivinerConfigSchema
+
+export type HashLeaseEstimateDivinerConfig = DivinerConfig<
+  {
+    baseMonthlyPrice?: number
+    characterLengthFactor?: number
+    minNameLength?: number
+  },
+  HashLeaseEstimateDivinerConfigSchema
+>
+
+export type HashLeaseEstimateDivinerParams<
+  TConfig extends AnyConfigSchema<HashLeaseEstimateDivinerConfig> = AnyConfigSchema<HashLeaseEstimateDivinerConfig>,
+> = ArchivistParams<TConfig>
+
+export const NameSchema = 'network.xyo.name'
+export type NameSchema = typeof NameSchema
+
+export type Name = Payload<{ name: string }, NameSchema>
+
+export const HashLeaseSchema = 'network.xyo.hash.lease'
+export type HashLeaseSchema = typeof HashLeaseSchema
+
+export type HashLease = Payload<
+  {
+    expire: number
+  },
+  HashLeaseSchema
+>
+
+export const HashLeaseEstimateSchema = 'network.xyo.hash.lease.estimate'
+export type HashLeaseEstimateSchema = typeof HashLeaseEstimateSchema
+
+export type HashLeaseEstimate = Payload<{ price: number }, HashLeaseEstimateSchema>
+
+@creatableModule()
+export class HashLeaseEstimateDiviner<
+  TParams extends HashLeaseEstimateDivinerParams = HashLeaseEstimateDivinerParams,
+  TIn extends WithSources<HashLease> | Name = WithSources<HashLease> | Name,
+> extends AbstractDiviner<TParams, TIn, HashLeaseEstimate> {
+  static override targetSchema = HashLeaseEstimateSchema
+
+  private _reservedFragments: string[] = ['xyo', 'xy', 'coin', 'lifehash', 'foreventry']
+
+  private _reservedStrings?: string[]
+
+  get baseMonthlyPrice() {
+    return this.config.baseMonthlyPrice ?? 4
+  }
+
+  get characterLengthFactor() {
+    return this.config.characterLengthFactor ?? 10
+  }
+
+  get minNameLength() {
+    return this.config.minNameLength ?? 3
+  }
+
+  get reservedStrings() {
+    this._reservedStrings =
+      this._reservedStrings ??
+      [
+        reservedBrands.map(({ name }) => name),
+        ...reservedDomains.map(({ name }) => name.split('.')),
+        ...reservedCryptos.map(({ name, symbol }) => [name, symbol]),
+      ]
+        .flat()
+        .map((item) => item.toLowerCase())
+    return this._reservedStrings
+  }
+
+  protected override async divineHandler(payloads: TIn[] = []): Promise<WithSources<HashLeaseEstimate>[]> {
+    const leases = await PayloadBuilder.build(
+      payloads.filter(isPayloadOfSchemaTypeWithMeta<WithSources<HashLease>>(HashLeaseSchema)) as WithSources<HashLease>[],
+    )
+    const payloadMap = await PayloadBuilder.toDataHashMap(payloads)
+    return leases.map((lease) => {
+      const sources = lease.sources ?? []
+      assertEx(sources.length === 1, 'Must pass single source')
+      const leaseSource = assertEx(sources.at(0), 'Failed to load lease source')
+      const sourcePayload = assertEx(payloadMap[leaseSource], 'Hash lease payload not provided')
+      assertEx(sourcePayload.schema === NameSchema, () => `Invalid source schema [${sourcePayload.schema}]`)
+      const sourceName = sourcePayload as Name
+
+      const duration = lease.expire - Date.now()
+
+      assertEx(duration <= ONE_YEAR, 'Max expiration may be one year in the future')
+      assertEx(duration >= ONE_YEAR / 2, 'Min expiration must be half year in the future')
+
+      //check if all lowercase
+      assertEx(sourceName.name.toLowerCase() === sourceName.name, 'name must be lowercase')
+
+      //check if min length
+      assertEx(sourceName.name.length >= this.minNameLength, 'name must be at least 3 characters')
+
+      //check if in one of the reserved name lists
+      assertEx(!this.reservedStrings.includes(sourceName.name), 'Reserved name')
+
+      //check if any of our fragments are in the name
+      for (const reserved of this._reservedFragments) {
+        assertEx(!sourceName.name.includes(reserved), 'Reserved name fragment')
+      }
+      const price = this.calculateLengthCost(sourceName.name, duration)
+      return { price, schema: HashLeaseEstimateSchema, sources: [lease.$hash] }
+    })
+  }
+
+  private calculateLengthCost(name: string, duration: number) {
+    const exponent = this.characterLengthFactor / name.length
+    const rawMonthlyCost = Math.pow(this.baseMonthlyPrice, exponent)
+    const months = (duration / ONE_YEAR) * 12
+    const proratedAnnualPrice = months * rawMonthlyCost
+    return Math.floor(proratedAnnualPrice)
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './Diviner'