@xyo-network/xns-record-payload-plugins 2.89.1

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Address/Payload.ts","../../src/Domain/Domain.ts","../../src/Domain/DomainLease.ts","../../src/DomainRegistration/Payload.ts","../../src/Duration/validation/validateBoundWitness.ts","../../src/Duration/validation/validateBoundWitnessAndDuration.ts","../../src/Duration/validation/validateDuration.ts","../../src/Duration/validation/validateBoundWitnessWithDuration.ts"],"sourcesContent":["import { Address } from '@xylabs/hex'\nimport { isPayloadOfSchemaType, Payload, WithMeta } from '@xyo-network/payload-model'\n\nimport { DomainFields } from '../Domain'\n\nexport type AddressRecordSchema = 'network.xyo.ns.record.address'\nexport const AddressRecordSchema: AddressRecordSchema = 'network.xyo.ns.record.address'\n\nexport interface AddressRecordFields extends DomainFields {\n  /**\n   * The address the record points to\n   */\n  address: Address[]\n}\n\n/**\n * An address record points a domain to an address\n */\nexport type AddressRecord = Payload<AddressRecordFields, AddressRecordSchema>\n\nexport const isAddressRecord = isPayloadOfSchemaType<AddressRecord>(AddressRecordSchema)\nexport const isAddressRecordWithMeta = isPayloadOfSchemaType<WithMeta<AddressRecord>>(AddressRecordSchema)\n","import { Payload } from '@xyo-network/payload-model'\n\nexport type DomainSchema = 'network.xyo.ns.domain'\nexport const DomainSchema: DomainSchema = 'network.xyo.ns.domain'\n\nexport interface DomainFields {\n  /**\n   * The XNS domain of the record\n   */\n  domain: string\n}\n\n/**\n * A domain record is a record of a domain\n */\nexport type Domain = Payload<DomainFields, DomainSchema>\n","import { Payload } from '@xyo-network/payload-model'\n\nimport { DurationFields } from '../Duration'\nimport { DomainFields } from './Domain'\n\nexport type DomainLeaseSchema = 'network.xyo.ns.domain.lease'\nexport const DomainLeaseSchema: DomainLeaseSchema = 'network.xyo.ns.domain.lease'\n\n/**\n * A domain is leased for a duration\n */\nexport interface DomainLeaseFields extends DomainFields, DurationFields {}\n\n/**\n * A domain lease is a record of a domain and the duration it is leased for\n */\nexport type DomainLease = Payload<DomainLeaseFields, DomainLeaseSchema>\n","import { Address } from '@xylabs/hex'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { DomainLeaseFields, DomainSchema } from '../Domain'\n\nexport const DomainRegistrationSchema = `${DomainSchema}.registration` as const\nexport type DomainRegistrationSchema = typeof DomainRegistrationSchema\n\nexport interface DomainRegistrationFields extends DomainLeaseFields {\n  /**\n   * The registrant of the domain\n   */\n  registrant: Address[]\n  /**\n   * The registrar of the domain\n   */\n  registrar: Address[]\n}\n\n/**\n * A WHOIS record is a record of a domain identifying its registrant, registrar and nameservers\n */\nexport type DomainRegistration = Payload<DomainRegistrationFields, DomainRegistrationSchema>\n","import { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'\n\n// BW Validations\nexport const validateBoundWitness = async (recordBw: BoundWitness, requiredSchemas: string[] = []): Promise<boolean> => {\n  // If the BW does not include all of the required schemas\n  if (!requiredSchemas.every((requiredSchema) => recordBw.payload_schemas.includes(requiredSchema))) return false\n  // If the BW is valid (does not include any errors)\n  const validator = new BoundWitnessValidator(recordBw)\n  const errors = await validator.validate()\n  return errors.length === 0\n}\n","import { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { DurationFields } from '../Duration'\n\n// BW & Record Validations\nexport const validateBoundWitnessAndDuration = async (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): Promise<boolean> => {\n  if (!(await recordIsInBoundWitness(recordBw, recordPayload))) return false\n  if (!recordIsTemporallyValidToBoundWitness(recordBw, recordPayload)) return false\n  return true\n}\n\nconst recordIsInBoundWitness = async (recordBw: BoundWitness, recordPayload: Payload): Promise<boolean> => {\n  const hash = await PayloadBuilder.dataHash(recordPayload)\n  return recordBw.payload_hashes.includes(hash)\n}\n\nconst recordIsTemporallyValidToBoundWitness = (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): boolean => {\n  const { timestamp } = recordBw\n  const { exp } = recordPayload\n  return exp > timestamp\n}\n","// import { isAddress } from '@xylabs/hex'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { DurationFields } from '../Duration'\n\n// Record Validations\nexport const validateDuration = (recordPayload: Payload<DurationFields>): boolean => {\n  // if (!isValidAddress(recordPayload)) return false\n  if (!isWithinDelegatedTimeframe(recordPayload)) return false\n  return true\n}\n\n// const isValidAddress = (recordPayload: Payload<DomainLeaseFields>): boolean => {\n//   return isAddress(recordPayload.nameserver, { prefix: false })\n// }\n\nconst isWithinDelegatedTimeframe = (recordPayload: Payload<DurationFields>, now = Date.now()): boolean => {\n  // nbf < now < exp\n  return recordPayload.nbf < now && now < recordPayload.exp\n}\n","import { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { Payload } from '@xyo-network/payload-model'\n\nimport { DurationFields } from '../Duration'\nimport { validateBoundWitness } from './validateBoundWitness'\nimport { validateBoundWitnessAndDuration } from './validateBoundWitnessAndDuration'\nimport { validateDuration } from './validateDuration'\n\nexport const validateBoundWitnessWithDuration = async (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): Promise<boolean> => {\n  // Validate the BW\n  if (!(await validateBoundWitness(recordBw, [recordPayload.schema]))) return false\n  // Validate the record\n  if (!validateDuration(recordPayload)) return false\n  // Validate the record relative to the BW\n  if (!(await validateBoundWitnessAndDuration(recordBw, recordPayload))) return false\n  return true\n}\n"],"mappings":";AACA,SAAS,6BAAgD;AAKlD,IAAM,sBAA2C;AAcjD,IAAM,kBAAkB,sBAAqC,mBAAmB;AAChF,IAAM,0BAA0B,sBAA+C,mBAAmB;;;AClBlG,IAAM,eAA6B;;;ACGnC,IAAM,oBAAuC;;;ACD7C,IAAM,2BAA2B,GAAG,YAAY;;;ACJvD,SAAS,6BAA6B;AAG/B,IAAM,uBAAuB,OAAO,UAAwB,kBAA4B,CAAC,MAAwB;AAEtH,MAAI,CAAC,gBAAgB,MAAM,CAAC,mBAAmB,SAAS,gBAAgB,SAAS,cAAc,CAAC;AAAG,WAAO;AAE1G,QAAM,YAAY,IAAI,sBAAsB,QAAQ;AACpD,QAAM,SAAS,MAAM,UAAU,SAAS;AACxC,SAAO,OAAO,WAAW;AAC3B;;;ACVA,SAAS,sBAAsB;AAMxB,IAAM,kCAAkC,OAAO,UAAwB,kBAA6D;AACzI,MAAI,CAAE,MAAM,uBAAuB,UAAU,aAAa;AAAI,WAAO;AACrE,MAAI,CAAC,sCAAsC,UAAU,aAAa;AAAG,WAAO;AAC5E,SAAO;AACT;AAEA,IAAM,yBAAyB,OAAO,UAAwB,kBAA6C;AACzG,QAAM,OAAO,MAAM,eAAe,SAAS,aAAa;AACxD,SAAO,SAAS,eAAe,SAAS,IAAI;AAC9C;AAEA,IAAM,wCAAwC,CAAC,UAAwB,kBAAoD;AACzH,QAAM,EAAE,UAAU,IAAI;AACtB,QAAM,EAAE,IAAI,IAAI;AAChB,SAAO,MAAM;AACf;;;AChBO,IAAM,mBAAmB,CAAC,kBAAoD;AAEnF,MAAI,CAAC,2BAA2B,aAAa;AAAG,WAAO;AACvD,SAAO;AACT;AAMA,IAAM,6BAA6B,CAAC,eAAwC,MAAM,KAAK,IAAI,MAAe;AAExG,SAAO,cAAc,MAAM,OAAO,MAAM,cAAc;AACxD;;;ACXO,IAAM,mCAAmC,OAAO,UAAwB,kBAA6D;AAE1I,MAAI,CAAE,MAAM,qBAAqB,UAAU,CAAC,cAAc,MAAM,CAAC;AAAI,WAAO;AAE5E,MAAI,CAAC,iBAAiB,aAAa;AAAG,WAAO;AAE7C,MAAI,CAAE,MAAM,gCAAgC,UAAU,aAAa;AAAI,WAAO;AAC9E,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@xyo-network/xns-record-payload-plugins",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/plugins/issues"
+  },
+  "dependencies": {
+    "@xylabs/hex": "^3.0.15",
+    "@xyo-network/boundwitness-model": "^2.92.8",
+    "@xyo-network/boundwitness-validator": "^2.92.8",
+    "@xyo-network/payload-builder": "^2.92.8",
+    "@xyo-network/payload-model": "^2.92.8"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.5.2",
+    "@xylabs/tsconfig": "^3.5.2",
+    "@xyo-network/account": "^2.92.8",
+    "@xyo-network/boundwitness-builder": "^2.92.8",
+    "typescript": "^5.4.2"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "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",
+  "types": "dist/node/index.d.ts",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "sideEffects": false,
+  "version": "2.89.1",
+  "type": "module"
+}

package/src/Address/Payload.ts

@@ -0,0 +1,22 @@
+import { Address } from '@xylabs/hex'
+import { isPayloadOfSchemaType, Payload, WithMeta } from '@xyo-network/payload-model'
+
+import { DomainFields } from '../Domain'
+
+export type AddressRecordSchema = 'network.xyo.ns.record.address'
+export const AddressRecordSchema: AddressRecordSchema = 'network.xyo.ns.record.address'
+
+export interface AddressRecordFields extends DomainFields {
+  /**
+   * The address the record points to
+   */
+  address: Address[]
+}
+
+/**
+ * An address record points a domain to an address
+ */
+export type AddressRecord = Payload<AddressRecordFields, AddressRecordSchema>
+
+export const isAddressRecord = isPayloadOfSchemaType<AddressRecord>(AddressRecordSchema)
+export const isAddressRecordWithMeta = isPayloadOfSchemaType<WithMeta<AddressRecord>>(AddressRecordSchema)

package/src/Address/index.ts

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

package/src/Domain/Domain.ts

@@ -0,0 +1,16 @@
+import { Payload } from '@xyo-network/payload-model'
+
+export type DomainSchema = 'network.xyo.ns.domain'
+export const DomainSchema: DomainSchema = 'network.xyo.ns.domain'
+
+export interface DomainFields {
+  /**
+   * The XNS domain of the record
+   */
+  domain: string
+}
+
+/**
+ * A domain record is a record of a domain
+ */
+export type Domain = Payload<DomainFields, DomainSchema>

package/src/Domain/DomainLease.ts

@@ -0,0 +1,17 @@
+import { Payload } from '@xyo-network/payload-model'
+
+import { DurationFields } from '../Duration'
+import { DomainFields } from './Domain'
+
+export type DomainLeaseSchema = 'network.xyo.ns.domain.lease'
+export const DomainLeaseSchema: DomainLeaseSchema = 'network.xyo.ns.domain.lease'
+
+/**
+ * A domain is leased for a duration
+ */
+export interface DomainLeaseFields extends DomainFields, DurationFields {}
+
+/**
+ * A domain lease is a record of a domain and the duration it is leased for
+ */
+export type DomainLease = Payload<DomainLeaseFields, DomainLeaseSchema>

package/src/Domain/index.ts

@@ -0,0 +1,2 @@
+export * from './Domain'
+export * from './DomainLease'

package/src/DomainRegistration/Payload.ts

@@ -0,0 +1,23 @@
+import { Address } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { DomainLeaseFields, DomainSchema } from '../Domain'
+
+export const DomainRegistrationSchema = `${DomainSchema}.registration` as const
+export type DomainRegistrationSchema = typeof DomainRegistrationSchema
+
+export interface DomainRegistrationFields extends DomainLeaseFields {
+  /**
+   * The registrant of the domain
+   */
+  registrant: Address[]
+  /**
+   * The registrar of the domain
+   */
+  registrar: Address[]
+}
+
+/**
+ * A WHOIS record is a record of a domain identifying its registrant, registrar and nameservers
+ */
+export type DomainRegistration = Payload<DomainRegistrationFields, DomainRegistrationSchema>

package/src/DomainRegistration/index.ts

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

package/src/Duration/Duration.ts

@@ -0,0 +1,11 @@
+export interface DurationFields {
+  /**
+   * A timestamp that indicates the expiration time of the record
+   */
+  exp: number
+
+  /**
+   * A timestamp that indicates the time before which the record is not valid
+   */
+  nbf: number
+}

package/src/Duration/index.ts

@@ -0,0 +1,2 @@
+export * from './Duration'
+export * from './validation'

package/src/Duration/validation/index.ts

@@ -0,0 +1,2 @@
+export * from './validateBoundWitnessWithDuration'
+export * from './validateDuration'

package/src/Duration/validation/validateBoundWitness.ts

@@ -0,0 +1,12 @@
+import { BoundWitness } from '@xyo-network/boundwitness-model'
+import { BoundWitnessValidator } from '@xyo-network/boundwitness-validator'
+
+// BW Validations
+export const validateBoundWitness = async (recordBw: BoundWitness, requiredSchemas: string[] = []): Promise<boolean> => {
+  // If the BW does not include all of the required schemas
+  if (!requiredSchemas.every((requiredSchema) => recordBw.payload_schemas.includes(requiredSchema))) return false
+  // If the BW is valid (does not include any errors)
+  const validator = new BoundWitnessValidator(recordBw)
+  const errors = await validator.validate()
+  return errors.length === 0
+}

package/src/Duration/validation/validateBoundWitnessAndDuration.ts

@@ -0,0 +1,23 @@
+import { BoundWitness } from '@xyo-network/boundwitness-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import { Payload } from '@xyo-network/payload-model'
+
+import { DurationFields } from '../Duration'
+
+// BW & Record Validations
+export const validateBoundWitnessAndDuration = async (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): Promise<boolean> => {
+  if (!(await recordIsInBoundWitness(recordBw, recordPayload))) return false
+  if (!recordIsTemporallyValidToBoundWitness(recordBw, recordPayload)) return false
+  return true
+}
+
+const recordIsInBoundWitness = async (recordBw: BoundWitness, recordPayload: Payload): Promise<boolean> => {
+  const hash = await PayloadBuilder.dataHash(recordPayload)
+  return recordBw.payload_hashes.includes(hash)
+}
+
+const recordIsTemporallyValidToBoundWitness = (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): boolean => {
+  const { timestamp } = recordBw
+  const { exp } = recordPayload
+  return exp > timestamp
+}

package/src/Duration/validation/validateBoundWitnessWithDuration.ts

@@ -0,0 +1,17 @@
+import { BoundWitness } from '@xyo-network/boundwitness-model'
+import { Payload } from '@xyo-network/payload-model'
+
+import { DurationFields } from '../Duration'
+import { validateBoundWitness } from './validateBoundWitness'
+import { validateBoundWitnessAndDuration } from './validateBoundWitnessAndDuration'
+import { validateDuration } from './validateDuration'
+
+export const validateBoundWitnessWithDuration = async (recordBw: BoundWitness, recordPayload: Payload<DurationFields>): Promise<boolean> => {
+  // Validate the BW
+  if (!(await validateBoundWitness(recordBw, [recordPayload.schema]))) return false
+  // Validate the record
+  if (!validateDuration(recordPayload)) return false
+  // Validate the record relative to the BW
+  if (!(await validateBoundWitnessAndDuration(recordBw, recordPayload))) return false
+  return true
+}

package/src/Duration/validation/validateDuration.ts

@@ -0,0 +1,20 @@
+// import { isAddress } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { DurationFields } from '../Duration'
+
+// Record Validations
+export const validateDuration = (recordPayload: Payload<DurationFields>): boolean => {
+  // if (!isValidAddress(recordPayload)) return false
+  if (!isWithinDelegatedTimeframe(recordPayload)) return false
+  return true
+}
+
+// const isValidAddress = (recordPayload: Payload<DomainLeaseFields>): boolean => {
+//   return isAddress(recordPayload.nameserver, { prefix: false })
+// }
+
+const isWithinDelegatedTimeframe = (recordPayload: Payload<DurationFields>, now = Date.now()): boolean => {
+  // nbf < now < exp
+  return recordPayload.nbf < now && now < recordPayload.exp
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './Address'
+export * from './Domain'
+export * from './DomainRegistration'
+export * from './Duration'

package/typedoc.json

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