@xyo-network/xl1-protocol-sdk 1.7.10 → 1.7.12

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 (2) hide show
  1. package/README.md +48 -1
  2. package/package.json +19 -19
package/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
 
11
11
  XYO Layer One SDK Protocol
12
12
 
13
- ## Documentation
13
+
14
14
 
15
15
  ## Reference
16
16
 
@@ -90,6 +90,7 @@ XYO Layer One SDK Protocol
90
90
  - [hashFromBlockNumber](#functions/hashFromBlockNumber)
91
91
  - [isBalancesStepSummaryWithStorageMeta](#functions/isBalancesStepSummaryWithStorageMeta)
92
92
  - [getDefaultConfig](#functions/getDefaultConfig)
93
+ - [hasMongoConfig](#functions/hasMongoConfig)
93
94
  - [netBalancesForPayloads](#functions/netBalancesForPayloads)
94
95
  - [buildTransaction](#functions/buildTransaction)
95
96
  - [tryHydrateTransaction](#functions/tryHydrateTransaction)
@@ -670,6 +671,52 @@ function getUrl(host, port): string;
670
671
 
671
672
  `string`
672
673
 
674
+ ### <a id="hasMongoConfig"></a>hasMongoConfig
675
+
676
+ [**@xyo-network/xl1-protocol-sdk**](#../README)
677
+
678
+ ***
679
+
680
+ ```ts
681
+ function hasMongoConfig(config?): config is Required<{ connectionString?: string; database?: string; domain?: string; password?: string; username?: string }>;
682
+ ```
683
+
684
+ Checks if the provided MongoDB configuration contains all necessary fields
685
+ for establishing a connection.
686
+
687
+ ## Parameters
688
+
689
+ ### config?
690
+
691
+ MongoDB configuration object
692
+
693
+ ### connectionString?
694
+
695
+ `string` = `...`
696
+
697
+ ### database?
698
+
699
+ `string` = `...`
700
+
701
+ ### domain?
702
+
703
+ `string` = `...`
704
+
705
+ ### password?
706
+
707
+ `string` = `...`
708
+
709
+ ### username?
710
+
711
+ `string` = `...`
712
+
713
+ ## Returns
714
+
715
+ `config is Required<{ connectionString?: string; database?: string; domain?: string; password?: string; username?: string }>`
716
+
717
+ True if the configuration contains all necessary fields for
718
+ establishing a connection
719
+
673
720
  ### <a id="hashFromBlockNumber"></a>hashFromBlockNumber
674
721
 
675
722
  [**@xyo-network/xl1-protocol-sdk**](#../README)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package.json",
3
3
  "name": "@xyo-network/xl1-protocol-sdk",
4
- "version": "1.7.10",
4
+ "version": "1.7.12",
5
5
  "description": "XYO Layer One SDK Protocol",
6
6
  "homepage": "https://xylabs.com",
7
7
  "bugs": {
@@ -36,27 +36,27 @@
36
36
  "src"
37
37
  ],
38
38
  "dependencies": {
39
- "@xylabs/array": "^4.13.21",
40
- "@xylabs/assert": "^4.13.21",
41
- "@xylabs/hex": "^4.13.21",
42
- "@xylabs/logger": "^4.13.21",
43
- "@xylabs/object": "^4.13.21",
44
- "@xylabs/promise": "^4.13.21",
45
- "@xylabs/typeof": "^4.13.21",
46
- "@xyo-network/account-model": "^4.1.6",
47
- "@xyo-network/archivist-model": "^4.1.6",
48
- "@xyo-network/boundwitness-builder": "^4.1.6",
49
- "@xyo-network/boundwitness-model": "^4.1.6",
50
- "@xyo-network/payload-builder": "^4.1.6",
51
- "@xyo-network/payload-model": "^4.1.6",
52
- "@xyo-network/wallet-model": "^4.1.6",
53
- "@xyo-network/xl1-protocol": "^1.7.10",
39
+ "@xylabs/array": "^4.13.23",
40
+ "@xylabs/assert": "^4.13.23",
41
+ "@xylabs/hex": "^4.13.23",
42
+ "@xylabs/logger": "^4.13.23",
43
+ "@xylabs/object": "^4.13.23",
44
+ "@xylabs/promise": "^4.13.23",
45
+ "@xylabs/typeof": "^4.13.23",
46
+ "@xyo-network/account-model": "^4.1.7",
47
+ "@xyo-network/archivist-model": "^4.1.7",
48
+ "@xyo-network/boundwitness-builder": "^4.1.7",
49
+ "@xyo-network/boundwitness-model": "^4.1.7",
50
+ "@xyo-network/payload-builder": "^4.1.7",
51
+ "@xyo-network/payload-model": "^4.1.7",
52
+ "@xyo-network/wallet-model": "^4.1.7",
53
+ "@xyo-network/xl1-protocol": "^1.7.19",
54
54
  "zod": "^3.25.76"
55
55
  },
56
56
  "devDependencies": {
57
- "@types/node": "^24.0.15",
58
- "@xylabs/ts-scripts-yarn3": "^7.0.0",
59
- "@xylabs/tsconfig": "^7.0.0",
57
+ "@types/node": "^24.1.0",
58
+ "@xylabs/ts-scripts-yarn3": "^7.0.1",
59
+ "@xylabs/tsconfig": "^7.0.1",
60
60
  "knip": "^5.62.0",
61
61
  "typescript": "^5.8.3",
62
62
  "vitest": "^3.2.4"