@xyo-network/xl1-network-model 1.27.1 → 1.28.2

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 +82 -6
  2. package/package.json +51 -51
package/README.md CHANGED
@@ -1,24 +1,100 @@
1
+ [![logo][]][logo-link]
2
+
1
3
  # @xyo-network/xl1-network-model
2
4
 
3
- [![npm][npm-badge]][npm-link]
4
- [![license][license-badge]][license-link]
5
+ [![npm-badge][]][npm-link]
6
+ [![license-badge][]][license-link]
7
+
8
+ > XL1 network metadata — default networks, datalake URLs, network icons, and module descriptors.
9
+
10
+ ## About
11
+
12
+ This package defines the canonical list of XL1 networks (mainnet, sequence/testnet, local) along with their RPC endpoints, datalake URLs, branding icons, and module descriptors. It's the source of truth that browser dApps, Node services, and CLIs use to look up "which RPC do I hit for the sequence testnet?".
5
13
 
6
- > XYO Layer One API
14
+ It's typically pulled in via [`@xyo-network/xl1-protocol`](https://www.npmjs.com/package/@xyo-network/xl1-protocol) or [`@xyo-network/xl1-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-sdk). Install directly if you only need network metadata and want to keep dependencies thin.
7
15
 
8
16
  ## Install
9
17
 
18
+ Using npm:
19
+
20
+ ```sh
21
+ npm i --save @xyo-network/xl1-network-model
22
+ ```
23
+
24
+ Using yarn:
25
+
26
+ ```sh
27
+ yarn add @xyo-network/xl1-network-model
28
+ ```
29
+
30
+ Using pnpm:
31
+
10
32
  ```sh
11
- {{pm}} add {{name}}
33
+ pnpm add @xyo-network/xl1-network-model
12
34
  ```
13
35
 
36
+ Using bun:
37
+
38
+ ```sh
39
+ bun add @xyo-network/xl1-network-model
40
+ ```
41
+
42
+ ## What's Inside
43
+
44
+ - **`DefaultNetworks`** — the canonical network list (mainnet, sequence, local) with id, name, RPC URL, and datalake endpoint
45
+ - **`NetworkDataLakeUrls`** — published datalake endpoints keyed by network id
46
+ - **Network icons** — branding assets for use in dApp UIs
47
+ - **Module descriptors** — metadata about which protocol modules are deployed per network
48
+ - **Lib utilities** — helpers for parsing, formatting, and comparing network references
49
+
50
+ ## Building Locally
51
+
52
+ ```sh
53
+ xy build @xyo-network/xl1-network-model
54
+ xy test @xyo-network/xl1-network-model
55
+ xy lint @xyo-network/xl1-network-model
56
+ ```
57
+
58
+ ## Maintainers
59
+
60
+ <table>
61
+ <tr>
62
+ <td align="center" valign="top" width="120">
63
+ <a href="https://github.com/arietrouw">
64
+ <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
65
+ <sub><b>Arie Trouw</b></sub>
66
+ </a>
67
+ <br />
68
+ <a href="https://arietrouw.com">arietrouw.com</a>
69
+ </td>
70
+ <td align="center" valign="top" width="120">
71
+ <a href="https://github.com/jonesmac">
72
+ <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
73
+ <sub><b>Matt Jones</b></sub>
74
+ </a>
75
+ </td>
76
+ <td align="center" valign="top" width="120">
77
+ <a href="https://github.com/JoelBCarter">
78
+ <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
79
+ <sub><b>Joel Carter</b></sub>
80
+ </a>
81
+ </td>
82
+ </tr>
83
+ </table>
14
84
 
15
85
  ## License
16
86
 
17
- See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
87
+ See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
88
+
89
+ ## Credits
18
90
 
91
+ [Made with 🔥 and ❄️ by XYO](https://xyo.network)
19
92
 
93
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
94
+ [logo-link]: https://xyo.network
20
95
 
21
96
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-network-model.svg
22
97
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-network-model
98
+
23
99
  [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-network-model.svg
24
- [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
100
+ [license-link]: ./LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xl1-network-model",
3
- "version": "1.27.1",
3
+ "version": "1.28.2",
4
4
  "description": "XYO Layer One API",
5
5
  "homepage": "https://xylabs.com",
6
6
  "bugs": {
@@ -43,7 +43,7 @@
43
43
  "README.md"
44
44
  ],
45
45
  "dependencies": {
46
- "@xyo-network/xl1-protocol-lib": "~1.27.1"
46
+ "@xyo-network/xl1-protocol-lib": "~1.28.2"
47
47
  },
48
48
  "devDependencies": {
49
49
  "@bitauth/libauth": "~3.0.0",
@@ -55,8 +55,8 @@
55
55
  "@xylabs/geo": "^5.1.1",
56
56
  "@xylabs/sdk-js": "^5.1.1",
57
57
  "@xylabs/threads": "~5.1.1",
58
- "@xylabs/toolchain": "~7.13.4",
59
- "@xylabs/tsconfig": "~7.13.4",
58
+ "@xylabs/toolchain": "~7.13.13",
59
+ "@xylabs/tsconfig": "~7.13.13",
60
60
  "@xyo-network/account": "~5.6.1",
61
61
  "@xyo-network/account-model": "~5.6.2",
62
62
  "@xyo-network/api": "~5.6.1",
@@ -75,7 +75,7 @@
75
75
  "@xyo-network/sdk-js": "^5.6.3",
76
76
  "@xyo-network/sdk-protocol-js": "~5.6.2",
77
77
  "@xyo-network/wallet": "~5.6.1",
78
- "@xyo-network/wallet-model": "~5.6.2",
78
+ "@xyo-network/wallet-model": "^5.6.2",
79
79
  "ajv": "^8.20.0",
80
80
  "async-mutex": "^0.5.0",
81
81
  "bn.js": "^5.2.3",
@@ -90,7 +90,7 @@
90
90
  "lru-cache": "^11.3.6",
91
91
  "mapbox-gl": "^3.23.1",
92
92
  "observable-fns": "~0.6.1",
93
- "pako": "~2.1.0",
93
+ "pako": "^2.1.0",
94
94
  "store2": "~2.14.4",
95
95
  "typescript": "~5.9.3",
96
96
  "vite": "^8.0.10",
@@ -100,51 +100,51 @@
100
100
  "zod": "~4.4.3"
101
101
  },
102
102
  "peerDependencies": {
103
- "@bitauth/libauth": ">=3.0.0 <3.1",
104
- "@metamask/providers": ">=22.1.1 <23",
105
- "@opentelemetry/api": ">=1.9.1 <2",
106
- "@opentelemetry/sdk-trace-base": ">=2.7.1 <3",
107
- "@scure/base": ">=2.2.0 <2.3",
108
- "@scure/bip39": ">=2.2.0 <2.3",
109
- "@xylabs/geo": ">=5.1.1 <6",
110
- "@xylabs/sdk-js": ">=5.1.1 <6",
111
- "@xylabs/threads": ">=5.1.1 <5.2",
112
- "@xyo-network/account": ">=5.6.1 <5.7",
113
- "@xyo-network/account-model": ">=5.6.2 <5.7",
114
- "@xyo-network/api": ">=5.6.1 <5.7",
115
- "@xyo-network/api-models": ">=5.6.2 <5.7",
116
- "@xyo-network/boundwitness-builder": ">=5.6.1 <5.7",
117
- "@xyo-network/boundwitness-model": ">=5.6.2 <5.7",
118
- "@xyo-network/boundwitness-wrapper": ">=5.6.1 <5.7",
119
- "@xyo-network/config-payload-plugin": ">=5.6.2 <5.7",
120
- "@xyo-network/huri": ">=5.6.1 <5.7",
121
- "@xyo-network/manifest-model": ">=5.6.2 <5.7",
122
- "@xyo-network/payload-builder": ">=5.6.1 <5.7",
123
- "@xyo-network/payload-model": ">=5.6.2 <5.7",
124
- "@xyo-network/payload-plugin": ">=5.6.2 <5.7",
125
- "@xyo-network/payload-wrapper": ">=5.6.1 <5.7",
126
- "@xyo-network/query-payload-plugin": ">=5.6.2 <5.7",
127
- "@xyo-network/sdk-js": ">=5.6.3 <6",
128
- "@xyo-network/sdk-protocol-js": ">=5.6.2 <5.7",
129
- "@xyo-network/wallet": ">=5.6.1 <5.7",
130
- "@xyo-network/wallet-model": ">=5.6.2 <5.7",
131
- "ajv": ">=8.20.0 <9",
132
- "async-mutex": ">=0.5.0 <1",
133
- "bn.js": ">=5.2.3 <6",
134
- "buffer": ">=6.0.3 <7",
135
- "chalk": ">=5.6.2 <6",
136
- "debug": ">=4.4.3 <4.5",
137
- "ethers": ">=6.16.0 <7",
138
- "hash-wasm": ">=4.12.0 <4.13",
139
- "idb": ">=8.0.3 <9",
140
- "lru-cache": ">=11.3.6 <12",
141
- "mapbox-gl": ">=3.23.1 <4",
142
- "observable-fns": ">=0.6.1 <0.7",
143
- "pako": ">=2.1.0 <2.2",
144
- "store2": ">=2.14.4 <2.15",
145
- "wasm-feature-detect": ">=1.8.0 <1.9",
146
- "webextension-polyfill": ">=0.12.0 <1",
147
- "zod": ">=4.4.3 <4.5"
103
+ "@bitauth/libauth": "~3.0",
104
+ "@metamask/providers": "^22.1",
105
+ "@opentelemetry/api": "^1.9",
106
+ "@opentelemetry/sdk-trace-base": "^2.7",
107
+ "@scure/base": "~2.2",
108
+ "@scure/bip39": "~2.2",
109
+ "@xylabs/geo": "^5.1",
110
+ "@xylabs/sdk-js": "^5.1",
111
+ "@xylabs/threads": "~5.1",
112
+ "@xyo-network/account": "~5.6",
113
+ "@xyo-network/account-model": "~5.6",
114
+ "@xyo-network/api": "~5.6",
115
+ "@xyo-network/api-models": "~5.6",
116
+ "@xyo-network/boundwitness-builder": "~5.6",
117
+ "@xyo-network/boundwitness-model": "~5.6",
118
+ "@xyo-network/boundwitness-wrapper": "~5.6",
119
+ "@xyo-network/config-payload-plugin": "~5.6",
120
+ "@xyo-network/huri": "~5.6",
121
+ "@xyo-network/manifest-model": "~5.6",
122
+ "@xyo-network/payload-builder": "~5.6",
123
+ "@xyo-network/payload-model": "~5.6",
124
+ "@xyo-network/payload-plugin": "~5.6",
125
+ "@xyo-network/payload-wrapper": "~5.6",
126
+ "@xyo-network/query-payload-plugin": "~5.6",
127
+ "@xyo-network/sdk-js": "^5.6",
128
+ "@xyo-network/sdk-protocol-js": "~5.6",
129
+ "@xyo-network/wallet": "~5.6",
130
+ "@xyo-network/wallet-model": "^5.6",
131
+ "ajv": "^8.20",
132
+ "async-mutex": "^0.5",
133
+ "bn.js": "^5.2",
134
+ "buffer": "^6.0",
135
+ "chalk": "^5.6",
136
+ "debug": "~4.4",
137
+ "ethers": "^6.16",
138
+ "hash-wasm": "~4.12",
139
+ "idb": "^8.0",
140
+ "lru-cache": "^11.3",
141
+ "mapbox-gl": "^3.23",
142
+ "observable-fns": "~0.6",
143
+ "pako": "^2.1",
144
+ "store2": "~2.14",
145
+ "wasm-feature-detect": "~1.8",
146
+ "webextension-polyfill": "^0.12",
147
+ "zod": "~4.4"
148
148
  },
149
149
  "engines": {
150
150
  "node": ">=22"