@xyo-network/xns-record-payload-plugins 3.1.1 → 3.2.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/dist/browser/Address/Payload.d.ts +7 -4
  2. package/dist/browser/Address/Payload.d.ts.map +1 -1
  3. package/dist/browser/DNS/Witness/Config.d.ts +12 -0
  4. package/dist/browser/DNS/Witness/Config.d.ts.map +1 -1
  5. package/dist/browser/DNS/Witness/Payload/Request.d.ts +15 -1
  6. package/dist/browser/DNS/Witness/Payload/Request.d.ts.map +1 -1
  7. package/dist/browser/DNS/Witness/Payload/Response.d.ts +9 -1
  8. package/dist/browser/DNS/Witness/Payload/Response.d.ts.map +1 -1
  9. package/dist/browser/DNS/types/Header.d.ts +33 -0
  10. package/dist/browser/DNS/types/Header.d.ts.map +1 -1
  11. package/dist/browser/DNS/types/Request.d.ts +10 -0
  12. package/dist/browser/DNS/types/Request.d.ts.map +1 -1
  13. package/dist/browser/Domain/Domain.d.ts +21 -3
  14. package/dist/browser/Domain/Domain.d.ts.map +1 -1
  15. package/dist/browser/Domain/DomainLease.d.ts +12 -3
  16. package/dist/browser/Domain/DomainLease.d.ts.map +1 -1
  17. package/dist/browser/DomainEstimate/DomainEstimate.d.ts +4 -4
  18. package/dist/browser/DomainEstimate/DomainEstimate.d.ts.map +1 -1
  19. package/dist/browser/DomainRegistration/DomainRegistration.d.ts +15 -3
  20. package/dist/browser/DomainRegistration/DomainRegistration.d.ts.map +1 -1
  21. package/dist/browser/DomainRegistration/DomainRegistrationLease.d.ts +12 -6
  22. package/dist/browser/DomainRegistration/DomainRegistrationLease.d.ts.map +1 -1
  23. package/dist/browser/Duration/Duration.d.ts +6 -0
  24. package/dist/browser/Duration/Duration.d.ts.map +1 -1
  25. package/dist/browser/Hash/Payload.d.ts +7 -4
  26. package/dist/browser/Hash/Payload.d.ts.map +1 -1
  27. package/dist/browser/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts +18 -3
  28. package/dist/browser/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts.map +1 -1
  29. package/dist/browser/diviner/DomainLeaseEstimateDiviner/Schema.d.ts.map +1 -1
  30. package/dist/browser/diviner/lib/parseEstimatesFromArray.d.ts +9 -4
  31. package/dist/browser/diviner/lib/parseEstimatesFromArray.d.ts.map +1 -1
  32. package/dist/browser/index.mjs +8 -50
  33. package/dist/browser/index.mjs.map +1 -1
  34. package/dist/neutral/Address/Payload.d.ts +7 -4
  35. package/dist/neutral/Address/Payload.d.ts.map +1 -1
  36. package/dist/neutral/DNS/Witness/Config.d.ts +12 -0
  37. package/dist/neutral/DNS/Witness/Config.d.ts.map +1 -1
  38. package/dist/neutral/DNS/Witness/Payload/Request.d.ts +15 -1
  39. package/dist/neutral/DNS/Witness/Payload/Request.d.ts.map +1 -1
  40. package/dist/neutral/DNS/Witness/Payload/Response.d.ts +9 -1
  41. package/dist/neutral/DNS/Witness/Payload/Response.d.ts.map +1 -1
  42. package/dist/neutral/DNS/types/Header.d.ts +33 -0
  43. package/dist/neutral/DNS/types/Header.d.ts.map +1 -1
  44. package/dist/neutral/DNS/types/Request.d.ts +10 -0
  45. package/dist/neutral/DNS/types/Request.d.ts.map +1 -1
  46. package/dist/neutral/Domain/Domain.d.ts +21 -3
  47. package/dist/neutral/Domain/Domain.d.ts.map +1 -1
  48. package/dist/neutral/Domain/DomainLease.d.ts +12 -3
  49. package/dist/neutral/Domain/DomainLease.d.ts.map +1 -1
  50. package/dist/neutral/DomainEstimate/DomainEstimate.d.ts +4 -4
  51. package/dist/neutral/DomainEstimate/DomainEstimate.d.ts.map +1 -1
  52. package/dist/neutral/DomainRegistration/DomainRegistration.d.ts +15 -3
  53. package/dist/neutral/DomainRegistration/DomainRegistration.d.ts.map +1 -1
  54. package/dist/neutral/DomainRegistration/DomainRegistrationLease.d.ts +12 -6
  55. package/dist/neutral/DomainRegistration/DomainRegistrationLease.d.ts.map +1 -1
  56. package/dist/neutral/Duration/Duration.d.ts +6 -0
  57. package/dist/neutral/Duration/Duration.d.ts.map +1 -1
  58. package/dist/neutral/Hash/Payload.d.ts +7 -4
  59. package/dist/neutral/Hash/Payload.d.ts.map +1 -1
  60. package/dist/neutral/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts +18 -3
  61. package/dist/neutral/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts.map +1 -1
  62. package/dist/neutral/diviner/DomainLeaseEstimateDiviner/Schema.d.ts.map +1 -1
  63. package/dist/neutral/diviner/lib/parseEstimatesFromArray.d.ts +9 -4
  64. package/dist/neutral/diviner/lib/parseEstimatesFromArray.d.ts.map +1 -1
  65. package/dist/neutral/index.mjs +8 -50
  66. package/dist/neutral/index.mjs.map +1 -1
  67. package/dist/node/Address/Payload.d.ts +7 -4
  68. package/dist/node/Address/Payload.d.ts.map +1 -1
  69. package/dist/node/DNS/Witness/Config.d.ts +12 -0
  70. package/dist/node/DNS/Witness/Config.d.ts.map +1 -1
  71. package/dist/node/DNS/Witness/Payload/Request.d.ts +15 -1
  72. package/dist/node/DNS/Witness/Payload/Request.d.ts.map +1 -1
  73. package/dist/node/DNS/Witness/Payload/Response.d.ts +9 -1
  74. package/dist/node/DNS/Witness/Payload/Response.d.ts.map +1 -1
  75. package/dist/node/DNS/types/Header.d.ts +33 -0
  76. package/dist/node/DNS/types/Header.d.ts.map +1 -1
  77. package/dist/node/DNS/types/Request.d.ts +10 -0
  78. package/dist/node/DNS/types/Request.d.ts.map +1 -1
  79. package/dist/node/Domain/Domain.d.ts +21 -3
  80. package/dist/node/Domain/Domain.d.ts.map +1 -1
  81. package/dist/node/Domain/DomainLease.d.ts +12 -3
  82. package/dist/node/Domain/DomainLease.d.ts.map +1 -1
  83. package/dist/node/DomainEstimate/DomainEstimate.d.ts +4 -4
  84. package/dist/node/DomainEstimate/DomainEstimate.d.ts.map +1 -1
  85. package/dist/node/DomainRegistration/DomainRegistration.d.ts +15 -3
  86. package/dist/node/DomainRegistration/DomainRegistration.d.ts.map +1 -1
  87. package/dist/node/DomainRegistration/DomainRegistrationLease.d.ts +12 -6
  88. package/dist/node/DomainRegistration/DomainRegistrationLease.d.ts.map +1 -1
  89. package/dist/node/Duration/Duration.d.ts +6 -0
  90. package/dist/node/Duration/Duration.d.ts.map +1 -1
  91. package/dist/node/Hash/Payload.d.ts +7 -4
  92. package/dist/node/Hash/Payload.d.ts.map +1 -1
  93. package/dist/node/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts +18 -3
  94. package/dist/node/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.d.ts.map +1 -1
  95. package/dist/node/diviner/DomainLeaseEstimateDiviner/Schema.d.ts.map +1 -1
  96. package/dist/node/diviner/lib/parseEstimatesFromArray.d.ts +9 -4
  97. package/dist/node/diviner/lib/parseEstimatesFromArray.d.ts.map +1 -1
  98. package/dist/node/index.mjs +8 -50
  99. package/dist/node/index.mjs.map +1 -1
  100. package/package.json +19 -16
  101. package/src/Address/Payload.ts +1 -2
  102. package/src/DNS/Witness/Payload/Request.ts +0 -6
  103. package/src/DNS/Witness/Payload/Response.ts +0 -6
  104. package/src/Domain/Domain.ts +1 -8
  105. package/src/Domain/DomainLease.ts +1 -8
  106. package/src/DomainEstimate/DomainEstimate.ts +4 -4
  107. package/src/DomainRegistration/DomainRegistration.ts +1 -8
  108. package/src/DomainRegistration/DomainRegistrationLease.ts +1 -12
  109. package/src/Hash/Payload.ts +1 -2
  110. package/src/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.ts +1 -9
  111. package/src/diviner/lib/parseEstimatesFromArray.ts +10 -13
@@ -1,16 +1,19 @@
1
1
  import type { Address } from '@xylabs/hex';
2
- import type { Payload, WithMeta } from '@xyo-network/payload-model';
2
+ import type { Payload } from '@xyo-network/payload-model';
3
3
  import type { DomainFields } from '../Domain/index.ts';
4
4
  export type AddressRecordSchema = 'network.xyo.ns.record.address';
5
5
  export declare const AddressRecordSchema: AddressRecordSchema;
6
6
  export interface AddressRecordFields extends DomainFields {
7
+ /**
8
+ * The address the record points to
9
+ */
7
10
  address: Address[];
8
11
  }
12
+ /**
13
+ * An address record points a domain to an address
14
+ */
9
15
  export type AddressRecord = Payload<AddressRecordFields, AddressRecordSchema>;
10
16
  export declare const isAddressRecord: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & AddressRecordFields & {
11
17
  schema: "network.xyo.ns.record.address";
12
18
  };
13
- export declare const isAddressRecordWithMeta: (x?: unknown | null) => x is WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & AddressRecordFields & {
14
- schema: "network.xyo.ns.record.address";
15
- }>;
16
19
  //# sourceMappingURL=Payload.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Address/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAGnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,CAAA;AACjE,eAAO,MAAM,mBAAmB,EAAE,mBAAqD,CAAA;AAEvF,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IAIvD,OAAO,EAAE,OAAO,EAAE,CAAA;CACnB;AAKD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAE7E,eAAO,MAAM,eAAe;;CAA4D,CAAA;AACxF,eAAO,MAAM,uBAAuB;;EAAsE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Address/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,CAAA;AACjE,eAAO,MAAM,mBAAmB,EAAE,mBAAqD,CAAA;AAEvF,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD;;OAEG;IACH,OAAO,EAAE,OAAO,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAE7E,eAAO,MAAM,eAAe;;CAA4D,CAAA"}
@@ -5,9 +5,21 @@ import { DNSSchema } from './Schema.ts';
5
5
  export type DNSWitnessConfigSchema = `${DNSSchema}.witness.config`;
6
6
  export declare const DNSWitnessConfigSchema: DNSWitnessConfigSchema;
7
7
  export type DNSWitnessConfig = WitnessConfig<{
8
+ /**
9
+ * The address record index diviner to be used to determine the address record index
10
+ */
8
11
  addressRecordIndexDiviner?: ModuleIdentifier;
12
+ /**
13
+ * The hash record index diviner to be used to determine the hash record index
14
+ */
9
15
  hashRecordIndexDiviner?: ModuleIdentifier;
16
+ /**
17
+ * The config schema for the DNS witness
18
+ */
10
19
  schema: DNSWitnessConfigSchema;
20
+ /**
21
+ * If supplied, the DNS witness will only support the specified resource record types
22
+ */
11
23
  supportedResources?: DNSResourceRecordType[];
12
24
  }>;
13
25
  //# sourceMappingURL=Config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../../src/DNS/Witness/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,MAAM,MAAM,sBAAsB,GAAG,GAAG,SAAS,iBAAiB,CAAA;AAClE,eAAO,MAAM,sBAAsB,EAAE,sBAAsD,CAAA;AAE3F,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC;IAI3C,yBAAyB,CAAC,EAAE,gBAAgB,CAAA;IAI5C,sBAAsB,CAAC,EAAE,gBAAgB,CAAA;IAIzC,MAAM,EAAE,sBAAsB,CAAA;IAI9B,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC7C,CAAC,CAAA"}
1
+ {"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../../src/DNS/Witness/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,MAAM,MAAM,sBAAsB,GAAG,GAAG,SAAS,iBAAiB,CAAA;AAClE,eAAO,MAAM,sBAAsB,EAAE,sBAAsD,CAAA;AAE3F,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC;IAC3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,gBAAgB,CAAA;IAC5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,gBAAgB,CAAA;IACzC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAA;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC7C,CAAC,CAAA"}
@@ -1,9 +1,23 @@
1
1
  import type { PayloadWithSources } from '@xyo-network/payload-model';
2
2
  import type { DNSRequestFields, DNSResourceRecordTypeValue } from '../../types/index.ts';
3
3
  import { DNSSchema } from '../Schema.ts';
4
+ /**
5
+ * The fields of a DNSRequest payload
6
+ */
4
7
  export type DNSRequest = PayloadWithSources<DNSRequestFields, DNSSchema>;
8
+ /**
9
+ * Identity function for determining if an object is a DNSRequest payload
10
+ */
5
11
  export declare const isDNSRequest: (x?: unknown | null) => x is DNSRequest;
12
+ /**
13
+ * Identity function for determining if an object is a DNSRequest payload with sources
14
+ */
6
15
  export declare const isDNSRequestWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<DNSRequest>;
7
- export declare const isDNSRequestWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<DNSRequest>;
16
+ /**
17
+ * Helper for generating a DNSRequest payload for a given domain and record type
18
+ * @param domain The domain to query
19
+ * @param type The record type to query
20
+ * @returns A DNSRequest payload
21
+ */
8
22
  export declare const getDnsRequestFor: (domain: string, type?: DNSResourceRecordTypeValue) => DNSRequest;
9
23
  //# sourceMappingURL=Request.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../../src/DNS/Witness/Payload/Request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAA;AAExF,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAKxC,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAA;AAKxE,eAAO,MAAM,YAAY,yCAA+C,CAAA;AAKxE,eAAO,MAAM,uBAAuB,2FAA0D,CAAA;AAK9F,eAAO,MAAM,oBAAoB,wFAAuD,CAAA;AAQxF,eAAO,MAAM,gBAAgB,WAAY,MAAM,SAAQ,0BAA0B,KAA8B,UAE9G,CAAA"}
1
+ {"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../../src/DNS/Witness/Payload/Request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAMpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAA;AAExF,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,YAAY,yCAA+C,CAAA;AAExE;;GAEG;AACH,eAAO,MAAM,uBAAuB,2FAA0D,CAAA;AAE9F;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,WAAY,MAAM,SAAQ,0BAA0B,KAA8B,UAE9G,CAAA"}
@@ -1,8 +1,16 @@
1
1
  import type { PayloadWithSources } from '@xyo-network/payload-model';
2
2
  import type { DNSResponseFields } from '../../types/index.ts';
3
3
  import { DNSSchema } from '../Schema.ts';
4
+ /**
5
+ * The fields of a DNSResponse payload
6
+ */
4
7
  export type DNSResponse = PayloadWithSources<DNSResponseFields, DNSSchema>;
8
+ /**
9
+ * Identity function for determining if an object is a DNSResponse payload
10
+ */
5
11
  export declare const isDNSResponse: (x?: unknown | null) => x is DNSResponse;
12
+ /**
13
+ * Identity function for determining if an object is a DNSResponse payload with sources
14
+ */
6
15
  export declare const isDNSResponseWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<DNSResponse>;
7
- export declare const isDNSResponseWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<DNSResponse>;
8
16
  //# sourceMappingURL=Response.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../../../../src/DNS/Witness/Payload/Response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAKxC,MAAM,MAAM,WAAW,GAAG,kBAAkB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAA;AAK1E,eAAO,MAAM,aAAa,0CAAgD,CAAA;AAK1E,eAAO,MAAM,wBAAwB,4FAA2D,CAAA;AAKhG,eAAO,MAAM,qBAAqB,yFAAwD,CAAA"}
1
+ {"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../../../../src/DNS/Witness/Payload/Response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAMpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAA;AAE1E;;GAEG;AACH,eAAO,MAAM,aAAa,0CAAgD,CAAA;AAE1E;;GAEG;AACH,eAAO,MAAM,wBAAwB,4FAA2D,CAAA"}
@@ -5,16 +5,49 @@ export type NumericBoolean = 0 | 1 | true | false;
5
5
  export type NumericBooleanFalsy = 0 | false;
6
6
  export type NumericBooleanTruthy = 1 | true;
7
7
  export interface DNSHeader {
8
+ /**
9
+ * Transaction ID, typically a random number. Integer whose value is 0 to 65535
10
+ */
8
11
  ID?: number;
12
+ /**
13
+ * Query/Response Flag (0 = Query, 1 = Response)
14
+ */
9
15
  QR?: NumericBoolean;
16
+ /**
17
+ * Operation Code (0 for standard query)
18
+ */
10
19
  Opcode?: DNSQueryOpcode;
20
+ /**
21
+ * Authoritative Answer (set in response)
22
+ */
11
23
  AA?: NumericBoolean;
24
+ /**
25
+ * Truncated Flag
26
+ */
12
27
  TC?: NumericBoolean;
28
+ /**
29
+ * Recursion Desired
30
+ */
13
31
  RD?: NumericBoolean;
32
+ /**
33
+ * Response Code (0 for no error, non-0 for errors)
34
+ */
14
35
  RCODE?: DNSRcode;
36
+ /**
37
+ * Number of questions in the query (usually 1)
38
+ */
15
39
  QDCOUNT?: number;
40
+ /**
41
+ * Number of answer records in the response
42
+ */
16
43
  ANCOUNT?: number;
44
+ /**
45
+ * Number of authority records in the response
46
+ */
17
47
  NSCOUNT?: number;
48
+ /**
49
+ * Number of additional records in the response
50
+ */
18
51
  ARCOUNT?: number;
19
52
  }
20
53
  export interface DNSRequestHeader extends DNSHeader {
@@ -1 +1 @@
1
- {"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../../../src/DNS/types/Header.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAmB,MAAM,qBAAqB,CAAA;AAC1E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAG9C,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK,CAAA;AACjD,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,KAAK,CAAA;AAC3C,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,CAAA;AAE3C,MAAM,WAAW,SAAS;IAIxB,EAAE,CAAC,EAAE,MAAM,CAAA;IAIX,EAAE,CAAC,EAAE,cAAc,CAAA;IAInB,MAAM,CAAC,EAAE,cAAc,CAAA;IAIvB,EAAE,CAAC,EAAE,cAAc,CAAA;IAInB,EAAE,CAAC,EAAE,cAAc,CAAA;IAInB,EAAE,CAAC,EAAE,cAAc,CAAA;IAInB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAIhB,OAAO,CAAC,EAAE,MAAM,CAAA;IAIhB,OAAO,CAAC,EAAE,MAAM,CAAA;IAIhB,OAAO,CAAC,EAAE,MAAM,CAAA;IAIhB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,EAAE,EAAE,mBAAmB,CAAA;IACvB,MAAM,EAAE,cAAc,CAAA;IACtB,EAAE,EAAE,mBAAmB,CAAA;IACvB,EAAE,EAAE,mBAAmB,CAAA;IACvB,KAAK,EAAE,OAAO,SAAS,CAAC,OAAO,CAAA;IAC/B,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,CAAC,CAAA;CACX;AAED,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,gBAAgB,CAY5D,CAAA;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,EAAE,EAAE,oBAAoB,CAAA;IACxB,MAAM,EAAE,cAAc,CAAA;IACtB,EAAE,EAAE,cAAc,CAAA;IAClB,EAAE,EAAE,cAAc,CAAA;IAClB,EAAE,EAAE,cAAc,CAAA;CACnB"}
1
+ {"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../../../src/DNS/types/Header.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,cAAc,EAAmB,MAAM,qBAAqB,CAAA;AAC1E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAG9C,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK,CAAA;AACjD,MAAM,MAAM,mBAAmB,GAAG,CAAC,GAAG,KAAK,CAAA;AAC3C,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,CAAA;AAE3C,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,EAAE,EAAE,mBAAmB,CAAA;IACvB,MAAM,EAAE,cAAc,CAAA;IACtB,EAAE,EAAE,mBAAmB,CAAA;IACvB,EAAE,EAAE,mBAAmB,CAAA;IACvB,KAAK,EAAE,OAAO,SAAS,CAAC,OAAO,CAAA;IAC/B,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,CAAC,CAAA;CACX;AAED,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,gBAAgB,CAY5D,CAAA;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,EAAE,EAAE,oBAAoB,CAAA;IACxB,MAAM,EAAE,cAAc,CAAA;IACtB,EAAE,EAAE,cAAc,CAAA;IAClB,EAAE,EAAE,cAAc,CAAA;IAClB,EAAE,EAAE,cAAc,CAAA;CACnB"}
@@ -8,6 +8,16 @@ export interface DNSQuestion {
8
8
  export interface DNSRequestFields extends DNSRequestHeader {
9
9
  Question: DNSQuestion[];
10
10
  }
11
+ /**
12
+ * Helper for generating a DNS request for a given domain and record type
13
+ * @param domain The domain to query
14
+ * @param type The record type to query
15
+ * @returns A DNS request
16
+ */
11
17
  export declare const getRequestFor: (domain: string, type?: DNSResourceRecordTypeValue) => DNSRequestFields;
18
+ /**
19
+ * Used to generate a random ID for a DNS request
20
+ * @returns A random number between 0 and 65,535
21
+ */
12
22
  export declare const getRandomId: () => number;
13
23
  //# sourceMappingURL=Request.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../src/DNS/types/Request.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gBAAgB,EAAyB,MAAM,aAAa,CAAA;AAC1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAGrE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,0BAA0B,CAAA;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,QAAQ,EAAE,WAAW,EAAE,CAAA;CACxB;AAQD,eAAO,MAAM,aAAa,WAAY,MAAM,SAAQ,0BAA0B,KAA8B,gBAQ3G,CAAA;AAMD,eAAO,MAAM,WAAW,QAAO,MAE9B,CAAA"}
1
+ {"version":3,"file":"Request.d.ts","sourceRoot":"","sources":["../../../../src/DNS/types/Request.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gBAAgB,EAAyB,MAAM,aAAa,CAAA;AAC1E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAGrE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,0BAA0B,CAAA;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,QAAQ,EAAE,WAAW,EAAE,CAAA;CACxB;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,WAAY,MAAM,SAAQ,0BAA0B,KAA8B,gBAQ3G,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAO,MAE9B,CAAA"}
@@ -1,19 +1,37 @@
1
1
  import type { Payload } from '@xyo-network/payload-model';
2
2
  export type DomainSchema = 'network.xyo.ns.domain';
3
3
  export declare const DomainSchema: DomainSchema;
4
+ /**
5
+ * The supported TLDs for XNS
6
+ */
4
7
  export type TopLevelDomain = 'xyo';
8
+ /**
9
+ * The fields for a domain record
10
+ */
5
11
  export interface DomainFields {
12
+ /**
13
+ * The XNS domain of the record
14
+ */
6
15
  domain: string;
16
+ /**
17
+ * The Top-Level Domain of the domain
18
+ */
7
19
  tld: TopLevelDomain;
8
20
  }
21
+ /**
22
+ * A domain record is a record of a domain
23
+ */
9
24
  export type Domain = Payload<DomainFields, DomainSchema>;
25
+ /**
26
+ * Identity function for Domain payload
27
+ */
10
28
  export declare const isDomain: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
11
29
  schema: "network.xyo.ns.domain";
12
30
  };
31
+ /**
32
+ * Identity function for Domain payload with sources
33
+ */
13
34
  export declare const isDomainWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
14
35
  schema: "network.xyo.ns.domain";
15
36
  }>;
16
- export declare const isDomainWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainFields & {
17
- schema: "network.xyo.ns.domain";
18
- }>;
19
37
  //# sourceMappingURL=Domain.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Domain.d.ts","sourceRoot":"","sources":["../../../src/Domain/Domain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,MAAM,MAAM,YAAY,GAAG,uBAAuB,CAAA;AAClD,eAAO,MAAM,YAAY,EAAE,YAAsC,CAAA;AAKjE,MAAM,MAAM,cAAc,GAAG,KAAK,CAAA;AAKlC,MAAM,WAAW,YAAY;IAI3B,MAAM,EAAE,MAAM,CAAA;IAKd,GAAG,EAAE,cAAc,CAAA;CACpB;AAKD,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAKxD,eAAO,MAAM,QAAQ;;CAA8C,CAAA;AAKnE,eAAO,MAAM,mBAAmB;;EAAyD,CAAA;AAKzF,eAAO,MAAM,gBAAgB;;EAAsD,CAAA"}
1
+ {"version":3,"file":"Domain.d.ts","sourceRoot":"","sources":["../../../src/Domain/Domain.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,MAAM,MAAM,YAAY,GAAG,uBAAuB,CAAA;AAClD,eAAO,MAAM,YAAY,EAAE,YAAsC,CAAA;AAEjE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAA;AAElC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,GAAG,EAAE,cAAc,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAExD;;GAEG;AACH,eAAO,MAAM,QAAQ;;CAA8C,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;EAAyD,CAAA"}
@@ -3,16 +3,25 @@ import type { DurationFields } from '../Duration/index.ts';
3
3
  import type { DomainFields } from './Domain.ts';
4
4
  export type DomainLeaseSchema = 'network.xyo.ns.domain.lease';
5
5
  export declare const DomainLeaseSchema: DomainLeaseSchema;
6
+ /**
7
+ * A domain is leased for a duration
8
+ */
6
9
  export interface DomainLeaseFields extends DomainFields, DurationFields {
7
10
  }
11
+ /**
12
+ * A domain lease is a record of a domain and the duration it is leased for
13
+ */
8
14
  export type DomainLease = Payload<DomainLeaseFields, DomainLeaseSchema>;
15
+ /**
16
+ * Identity function for DomainLease payload
17
+ */
9
18
  export declare const isDomainLease: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainLeaseFields & {
10
19
  schema: "network.xyo.ns.domain.lease";
11
20
  };
21
+ /**
22
+ * Identity function for DomainLease payload with sources
23
+ */
12
24
  export declare const isDomainLeaseWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainLeaseFields & {
13
25
  schema: "network.xyo.ns.domain.lease";
14
26
  }>;
15
- export declare const isDomainLeaseWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainLeaseFields & {
16
- schema: "network.xyo.ns.domain.lease";
17
- }>;
18
27
  //# sourceMappingURL=DomainLease.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DomainLease.d.ts","sourceRoot":"","sources":["../../../src/Domain/DomainLease.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,MAAM,iBAAiB,GAAG,6BAA6B,CAAA;AAC7D,eAAO,MAAM,iBAAiB,EAAE,iBAAiD,CAAA;AAKjF,MAAM,WAAW,iBAAkB,SAAQ,YAAY,EAAE,cAAc;CAAG;AAK1E,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAA;AAKvE,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAKlF,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAKxG,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}
1
+ {"version":3,"file":"DomainLease.d.ts","sourceRoot":"","sources":["../../../src/Domain/DomainLease.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,MAAM,iBAAiB,GAAG,6BAA6B,CAAA;AAC7D,eAAO,MAAM,iBAAiB,EAAE,iBAAiD,CAAA;AAEjF;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY,EAAE,cAAc;CAAG;AAE1E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAA;AAEvE;;GAEG;AACH,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAElF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;EAAmE,CAAA"}
@@ -1,10 +1,10 @@
1
1
  import type { BoundWitness } from '@xyo-network/boundwitness-model';
2
2
  import type { HashLeaseEstimate } from '@xyo-network/diviner-hash-lease';
3
- import type { WithOptionalMeta, WithSources } from '@xyo-network/payload-model';
3
+ import type { WithSources } from '@xyo-network/payload-model';
4
4
  import type { DomainRegistrationLease } from '../DomainRegistration/index.ts';
5
5
  export type DomainEstimate = [
6
- WithOptionalMeta<BoundWitness>,
7
- WithOptionalMeta<WithSources<HashLeaseEstimate>>,
8
- WithOptionalMeta<WithSources<DomainRegistrationLease>>
6
+ BoundWitness,
7
+ WithSources<HashLeaseEstimate>,
8
+ WithSources<DomainRegistrationLease>
9
9
  ];
10
10
  //# sourceMappingURL=DomainEstimate.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DomainEstimate.d.ts","sourceRoot":"","sources":["../../../src/DomainEstimate/DomainEstimate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAE7E,MAAM,MAAM,cAAc,GAAG;IAC3B,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAChD,gBAAgB,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;CACvD,CAAA"}
1
+ {"version":3,"file":"DomainEstimate.d.ts","sourceRoot":"","sources":["../../../src/DomainEstimate/DomainEstimate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE7D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAE7E,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY;IACZ,WAAW,CAAC,iBAAiB,CAAC;IAC9B,WAAW,CAAC,uBAAuB,CAAC;CACrC,CAAA"}
@@ -4,17 +4,29 @@ import type { DomainFields } from '../Domain/index.ts';
4
4
  export declare const DomainRegistrationSchema: "network.xyo.ns.domain.registration";
5
5
  export type DomainRegistrationSchema = typeof DomainRegistrationSchema;
6
6
  export interface DomainRegistrationFields extends DomainFields {
7
+ /**
8
+ * The registrant of the domain
9
+ */
7
10
  registrant: Address[];
11
+ /**
12
+ * The registrar of the domain
13
+ */
8
14
  registrar: Address[];
9
15
  }
16
+ /**
17
+ * Delegation of a domain to a registrar by a registrant
18
+ */
10
19
  export type DomainRegistration = Payload<DomainRegistrationFields, DomainRegistrationSchema>;
20
+ /**
21
+ * Identity function for DomainRegistration payload
22
+ */
11
23
  export declare const isDomainRegistration: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationFields & {
12
24
  schema: "network.xyo.ns.domain.registration";
13
25
  };
26
+ /**
27
+ * Identity function for DomainRegistration payload with sources
28
+ */
14
29
  export declare const isDomainRegistrationWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationFields & {
15
30
  schema: "network.xyo.ns.domain.registration";
16
31
  }>;
17
- export declare const isDomainRegistrationWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationFields & {
18
- schema: "network.xyo.ns.domain.registration";
19
- }>;
20
32
  //# sourceMappingURL=DomainRegistration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DomainRegistration.d.ts","sourceRoot":"","sources":["../../../src/DomainRegistration/DomainRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,eAAO,MAAM,wBAAwB,sCAA0C,CAAA;AAC/E,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAA;AAEtE,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAI5D,UAAU,EAAE,OAAO,EAAE,CAAA;IAIrB,SAAS,EAAE,OAAO,EAAE,CAAA;CACrB;AAKD,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,EAAE,wBAAwB,CAAC,CAAA;AAK5F,eAAO,MAAM,oBAAoB;;CAAsE,CAAA;AAKvG,eAAO,MAAM,+BAA+B;;EAAiF,CAAA;AAK7H,eAAO,MAAM,4BAA4B;;EAA8E,CAAA"}
1
+ {"version":3,"file":"DomainRegistration.d.ts","sourceRoot":"","sources":["../../../src/DomainRegistration/DomainRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,eAAO,MAAM,wBAAwB,sCAA0C,CAAA;AAC/E,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAA;AAEtE,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAA;IACrB;;OAEG;IACH,SAAS,EAAE,OAAO,EAAE,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,EAAE,wBAAwB,CAAC,CAAA;AAE5F;;GAEG;AACH,eAAO,MAAM,oBAAoB;;CAAsE,CAAA;AAEvG;;GAEG;AACH,eAAO,MAAM,+BAA+B;;EAAiF,CAAA"}
@@ -5,20 +5,26 @@ export declare const DomainRegistrationLeaseSchema: "network.xyo.ns.domain.regis
5
5
  export type DomainRegistrationLeaseSchema = typeof DomainRegistrationLeaseSchema;
6
6
  export interface DomainRegistrationLeaseFields extends DomainRegistrationFields, DurationFields {
7
7
  }
8
+ /**
9
+ * Temporal delegation of a domain to a registrar by a registrant
10
+ */
8
11
  export type DomainRegistrationLease = Payload<DomainRegistrationLeaseFields, DomainRegistrationLeaseSchema>;
12
+ /**
13
+ * Identity function for DomainRegistrationLease payload
14
+ */
9
15
  export declare const isDomainRegistrationLease: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationLeaseFields & {
10
16
  schema: "network.xyo.ns.domain.registration.lease";
11
17
  };
18
+ /**
19
+ * Identity function for DomainRegistrationLease payload with sources
20
+ */
12
21
  export declare const isDomainRegistrationLeaseWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationLeaseFields & {
13
22
  schema: "network.xyo.ns.domain.registration.lease";
14
23
  }>;
24
+ /**
25
+ * @deprecated Use isDomainRegistrationLeaseWithSources instead
26
+ */
15
27
  export declare const isDomainRegistrationLeaseSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationLeaseFields & {
16
28
  schema: "network.xyo.ns.domain.registration.lease";
17
29
  }>;
18
- export declare const isDomainRegistrationLeaseWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationLeaseFields & {
19
- schema: "network.xyo.ns.domain.registration.lease";
20
- }>;
21
- export declare const isDomainRegistrationLeaseMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & DomainRegistrationLeaseFields & {
22
- schema: "network.xyo.ns.domain.registration.lease";
23
- }>;
24
30
  //# sourceMappingURL=DomainRegistrationLease.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"DomainRegistrationLease.d.ts","sourceRoot":"","sources":["../../../src/DomainRegistration/DomainRegistrationLease.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAGvE,eAAO,MAAM,6BAA6B,4CAA+C,CAAA;AACzF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA;AAEhF,MAAM,WAAW,6BAA8B,SAAQ,wBAAwB,EAAE,cAAc;CAAG;AAKlG,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,6BAA6B,EAAE,6BAA6B,CAAC,CAAA;AAK3G,eAAO,MAAM,yBAAyB;;CAAgF,CAAA;AAKtH,eAAO,MAAM,oCAAoC;;EAA2F,CAAA;AAI5I,eAAO,MAAM,gCAAgC;;EAAuC,CAAA;AAKpF,eAAO,MAAM,iCAAiC;;EAAwF,CAAA;AAItI,eAAO,MAAM,6BAA6B;;EAAoC,CAAA"}
1
+ {"version":3,"file":"DomainRegistrationLease.d.ts","sourceRoot":"","sources":["../../../src/DomainRegistration/DomainRegistrationLease.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAGvE,eAAO,MAAM,6BAA6B,4CAA+C,CAAA;AACzF,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA;AAEhF,MAAM,WAAW,6BAA8B,SAAQ,wBAAwB,EAAE,cAAc;CAAG;AAElG;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,6BAA6B,EAAE,6BAA6B,CAAC,CAAA;AAE3G;;GAEG;AACH,eAAO,MAAM,yBAAyB;;CAAgF,CAAA;AAEtH;;GAEG;AACH,eAAO,MAAM,oCAAoC;;EAA2F,CAAA;AAC5I;;GAEG;AACH,eAAO,MAAM,gCAAgC;;EAAuC,CAAA"}
@@ -1,5 +1,11 @@
1
1
  export interface DurationFields {
2
+ /**
3
+ * A timestamp that indicates the expiration time of the record
4
+ */
2
5
  exp: number;
6
+ /**
7
+ * A timestamp that indicates the time before which the record is not valid
8
+ */
3
9
  nbf: number;
4
10
  }
5
11
  //# sourceMappingURL=Duration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Duration.d.ts","sourceRoot":"","sources":["../../../src/Duration/Duration.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAI7B,GAAG,EAAE,MAAM,CAAA;IAKX,GAAG,EAAE,MAAM,CAAA;CACZ"}
1
+ {"version":3,"file":"Duration.d.ts","sourceRoot":"","sources":["../../../src/Duration/Duration.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ"}
@@ -1,16 +1,19 @@
1
1
  import type { Hash } from '@xylabs/hex';
2
- import type { Payload, WithMeta } from '@xyo-network/payload-model';
2
+ import type { Payload } from '@xyo-network/payload-model';
3
3
  import type { DomainFields } from '../Domain/index.ts';
4
4
  export type HashRecordSchema = 'network.xyo.ns.record.hash';
5
5
  export declare const HashRecordSchema: HashRecordSchema;
6
6
  export interface HashRecordFields extends DomainFields {
7
+ /**
8
+ * The hash the record points to
9
+ */
7
10
  hash: Hash[];
8
11
  }
12
+ /**
13
+ * An hash record points a domain to an hash
14
+ */
9
15
  export type HashRecord = Payload<HashRecordFields, HashRecordSchema>;
10
16
  export declare const isHashRecord: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & HashRecordFields & {
11
17
  schema: "network.xyo.ns.record.hash";
12
18
  };
13
- export declare const isHashRecordWithMeta: (x?: unknown | null) => x is WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & HashRecordFields & {
14
- schema: "network.xyo.ns.record.hash";
15
- }>;
16
19
  //# sourceMappingURL=Payload.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Hash/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAGnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAA;AAC3D,eAAO,MAAM,gBAAgB,EAAE,gBAA+C,CAAA;AAE9E,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IAIpD,IAAI,EAAE,IAAI,EAAE,CAAA;CACb;AAKD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;AAEpE,eAAO,MAAM,YAAY;;CAAsD,CAAA;AAC/E,eAAO,MAAM,oBAAoB;;EAAgE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Hash/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAA;AAC3D,eAAO,MAAM,gBAAgB,EAAE,gBAA+C,CAAA;AAE9E,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAA;CACb;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;AAEpE,eAAO,MAAM,YAAY;;CAAsD,CAAA"}
@@ -2,21 +2,36 @@ import type { Payload } from '@xyo-network/payload-model';
2
2
  import { DomainLeaseEstimateDivinerValidationErrorDetailsSchema } from '../Schema.ts';
3
3
  export interface ErrorDetails<TErrorCode extends string | undefined = string | undefined> {
4
4
  [key: string]: any;
5
+ /**
6
+ * A string code indicating the error type.
7
+ */
5
8
  code: TErrorCode;
9
+ /**
10
+ * A human-readable explanation specific to this occurrence of the problem
11
+ */
6
12
  detail?: string;
13
+ /**
14
+ * A short, human-readable summary of the problem type.
15
+ */
7
16
  title?: string;
8
17
  }
9
18
  export type ErrorDetailsDictionary<T extends number = number> = {
10
19
  readonly [K in T]: ErrorDetails<`${K}`>;
11
20
  };
21
+ /**
22
+ * A payment authorization token payload
23
+ */
12
24
  export type DomainLeaseEstimateDivinerValidationErrorDetails<TErrorCode extends string | undefined = string> = Payload<ErrorDetails<TErrorCode>, DomainLeaseEstimateDivinerValidationErrorDetailsSchema>;
25
+ /**
26
+ * Identity function for DomainLeaseEstimateDivinerValidationErrorDetails payload
27
+ */
13
28
  export declare const isDomainLeaseEstimateDivinerValidationErrorDetails: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & ErrorDetails<string> & {
14
29
  schema: "network.xyo.diviner.ns.domain.registration.lease.estimate.validation.error.details";
15
30
  };
31
+ /**
32
+ * Identity function for DomainLeaseEstimateDivinerValidationErrorDetails payload with sources
33
+ */
16
34
  export declare const isDomainLeaseEstimateDivinerValidationErrorDetailsWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & ErrorDetails<string> & {
17
35
  schema: "network.xyo.diviner.ns.domain.registration.lease.estimate.validation.error.details";
18
36
  }>;
19
- export declare const isDomainLeaseEstimateDivinerValidationErrorDetailsWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & ErrorDetails<string> & {
20
- schema: "network.xyo.diviner.ns.domain.registration.lease.estimate.validation.error.details";
21
- }>;
22
37
  //# sourceMappingURL=Payload.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,sDAAsD,EAAE,MAAM,cAAc,CAAA;AAErF,MAAM,WAAW,YAAY,CAAC,UAAU,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAEtF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAIlB,IAAI,EAAE,UAAU,CAAA;IAIhB,MAAM,CAAC,EAAE,MAAM,CAAA;IAIf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAC9D,QAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;CACxC,CAAA;AAKD,MAAM,MAAM,gDAAgD,CAAC,UAAU,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,IAAI,OAAO,CACpH,YAAY,CAAC,UAAU,CAAC,EACxB,sDAAsD,CACvD,CAAA;AAKD,eAAO,MAAM,kDAAkD;;CAE9D,CAAA;AAKD,eAAO,MAAM,6DAA6D;;EACoE,CAAA;AAK9I,eAAO,MAAM,0DAA0D;;EACoE,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/diviner/DomainLeaseEstimateDiviner/ErrorDetails/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,EAAE,sDAAsD,EAAE,MAAM,cAAc,CAAA;AAErF,MAAM,WAAW,YAAY,CAAC,UAAU,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAEtF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAC9D,QAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gDAAgD,CAAC,UAAU,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,IAAI,OAAO,CACpH,YAAY,CAAC,UAAU,CAAC,EACxB,sDAAsD,CACvD,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kDAAkD;;CAE9D,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,6DAA6D;;EACoE,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../../src/diviner/DomainLeaseEstimateDiviner/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sDAAsD,sFAC8B,CAAA;AAEjG,MAAM,MAAM,sDAAsD,GAAG,OAAO,sDAAsD,CAAA"}
1
+ {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../../src/diviner/DomainLeaseEstimateDiviner/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sDAAsD,EAC/D,oFAA6F,CAAA;AAEjG,MAAM,MAAM,sDAAsD,GAAG,OAAO,sDAAsD,CAAA"}
@@ -1,11 +1,16 @@
1
1
  import { type BoundWitness } from '@xyo-network/boundwitness-model';
2
2
  import { type HashLeaseEstimate } from '@xyo-network/diviner-hash-lease';
3
- import type { Payload, WithOptionalMeta, WithSources } from '@xyo-network/payload-model';
3
+ import type { Payload, WithSources } from '@xyo-network/payload-model';
4
4
  import { type DomainRegistrationLease } from '../../DomainRegistration/index.ts';
5
5
  export type Estimate = [
6
- WithOptionalMeta<BoundWitness>,
7
- WithOptionalMeta<WithSources<HashLeaseEstimate>>,
8
- WithOptionalMeta<WithSources<DomainRegistrationLease>>
6
+ BoundWitness,
7
+ WithSources<HashLeaseEstimate>,
8
+ WithSources<DomainRegistrationLease>
9
9
  ];
10
+ /**
11
+ * Parses a generic array of payloads into estimates
12
+ * @param payloads An array of payloads
13
+ * @returns Parsed estimates
14
+ */
10
15
  export declare const parseEstimatesFromArray: (payloads?: Payload[]) => Promise<Estimate[]>;
11
16
  //# sourceMappingURL=parseEstimatesFromArray.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parseEstimatesFromArray.d.ts","sourceRoot":"","sources":["../../../../src/diviner/lib/parseEstimatesFromArray.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,EAAkB,MAAM,iCAAiC,CAAA;AACnF,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,iCAAiC,CAAA;AAExC,OAAO,KAAK,EACV,OAAO,EAAY,gBAAgB,EAAE,WAAW,EACjD,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EACL,KAAK,uBAAuB,EAC7B,MAAM,mCAAmC,CAAA;AAE1C,MAAM,MAAM,QAAQ,GAAG;IACrB,gBAAgB,CAAC,YAAY,CAAC;IAC9B,gBAAgB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAChD,gBAAgB,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;CACvD,CAAA;AAOD,eAAO,MAAM,uBAAuB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,QAAQ,EAAE,CA0BtF,CAAA"}
1
+ {"version":3,"file":"parseEstimatesFromArray.d.ts","sourceRoot":"","sources":["../../../../src/diviner/lib/parseEstimatesFromArray.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,YAAY,EAAkB,MAAM,iCAAiC,CAAA;AACnF,OAAO,EACL,KAAK,iBAAiB,EACvB,MAAM,iCAAiC,CAAA;AAExC,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAEtE,OAAO,EACL,KAAK,uBAAuB,EAC7B,MAAM,mCAAmC,CAAA;AAE1C,MAAM,MAAM,QAAQ,GAAG;IACrB,YAAY;IACZ,WAAW,CAAC,iBAAiB,CAAC;IAC9B,WAAW,CAAC,uBAAuB,CAAC;CACrC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,cAAqB,OAAO,EAAE,KAAG,OAAO,CAAC,QAAQ,EAAE,CA0BtF,CAAA"}