@xyo-network/xl1-providers 1.28.0 → 1.28.3

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 +92 -6
  2. package/package.json +56 -56
package/README.md CHANGED
@@ -1,24 +1,110 @@
1
+ [![logo][]][logo-link]
2
+
1
3
  # @xyo-network/xl1-providers
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
+ > Concrete provider implementations for XL1 — viewers, runners, signers, and locator/builder helpers.
5
9
 
6
- > XYO Layer One API
10
+ ## About
11
+
12
+ This package contains the production provider implementations that fulfill the contracts defined in [`@xyo-network/xl1-protocol-lib`](https://www.npmjs.com/package/@xyo-network/xl1-protocol-lib). Use it directly when you're composing your own gateway from individual providers; for the typical "build a gateway, talk to XL1" path, prefer [`@xyo-network/xl1-gateway`](https://www.npmjs.com/package/@xyo-network/xl1-gateway) (which wraps these into a `GatewayBuilder`) or the aggregate [`@xyo-network/xl1-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-sdk).
7
13
 
8
14
  ## Install
9
15
 
16
+ Using npm:
17
+
18
+ ```sh
19
+ npm i --save @xyo-network/xl1-providers
20
+ ```
21
+
22
+ Using yarn:
23
+
24
+ ```sh
25
+ yarn add @xyo-network/xl1-providers
26
+ ```
27
+
28
+ Using pnpm:
29
+
30
+ ```sh
31
+ pnpm add @xyo-network/xl1-providers
32
+ ```
33
+
34
+ Using bun:
35
+
10
36
  ```sh
11
- {{pm}} add {{name}}
37
+ bun add @xyo-network/xl1-providers
12
38
  ```
13
39
 
40
+ ## What's Inside
41
+
42
+ **Builders & locators**
43
+
44
+ - `buildProviderLocator`, `buildProviderLocatorV2` — assemble a `ProviderLocator` keyed by moniker
45
+ - `buildSimpleXyoSignerV2` — opinionated signer factory
46
+ - `creators/` and `locators/` — provider factory and lookup primitives
47
+
48
+ **Concrete providers**
49
+
50
+ - `NodeXyoRunner`, `NodeXyoViewer` — Node-side composite runner/viewer
51
+ - `SimpleXyoConnectionRunner`, `SimpleXyoConnectionViewer` — full read/write connection with all viewers/runners wired up
52
+ - `SimpleXyoViewer` — composite read-only viewer
53
+ - `SimpleStepViewer`, `SimpleStepRewards/*` — step-tier viewers and reward shards (by-position, by-staker, by-step, total)
54
+ - `SimpleNetworkStakeViewer`, `SimpleDeadLetterQueueRunner`, `SimpleDeadLetterQueueViewer` — supporting providers
55
+
56
+ **Utilities**
57
+
58
+ - `registerHelpers` — provider registration helpers for `CreatableProvider`
59
+
60
+ ## Building Locally
61
+
62
+ ```sh
63
+ xy build @xyo-network/xl1-providers
64
+ xy test @xyo-network/xl1-providers
65
+ xy lint @xyo-network/xl1-providers
66
+ ```
67
+
68
+ ## Maintainers
69
+
70
+ <table>
71
+ <tr>
72
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
73
+ <a href="https://github.com/arietrouw">
74
+ <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
75
+ <sub><b>Arie Trouw</b></sub>
76
+ </a>
77
+ <br />
78
+ <a href="https://arietrouw.com">arietrouw.com</a>
79
+ </td>
80
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
81
+ <a href="https://github.com/jonesmac">
82
+ <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
83
+ <sub><b>Matt Jones</b></sub>
84
+ </a>
85
+ </td>
86
+ <td align="center" valign="top" width="120" bgcolor="#000000" style="background-color:#000000;">
87
+ <a href="https://github.com/JoelBCarter">
88
+ <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
89
+ <sub><b>Joel Carter</b></sub>
90
+ </a>
91
+ </td>
92
+ </tr>
93
+ </table>
14
94
 
15
95
  ## License
16
96
 
17
- See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
97
+ See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
98
+
99
+ ## Credits
18
100
 
101
+ [Made with 🔥 and ❄️ by XYO](https://xyo.network)
19
102
 
103
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
104
+ [logo-link]: https://xyo.network
20
105
 
21
106
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-providers.svg
22
107
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-providers
108
+
23
109
  [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-providers.svg
24
- [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
110
+ [license-link]: ./LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xl1-providers",
3
- "version": "1.28.0",
3
+ "version": "1.28.3",
4
4
  "description": "XYO Layer One API",
5
5
  "homepage": "https://xylabs.com",
6
6
  "bugs": {
@@ -44,9 +44,9 @@
44
44
  "README.md"
45
45
  ],
46
46
  "dependencies": {
47
- "@xyo-network/xl1-protocol-lib": "~1.28.0",
48
- "@xyo-network/xl1-protocol-sdk": "~1.28.0",
49
- "@xyo-network/xl1-rpc": "~1.28.0"
47
+ "@xyo-network/xl1-protocol-sdk": "~1.28.3",
48
+ "@xyo-network/xl1-protocol-lib": "~1.28.3",
49
+ "@xyo-network/xl1-rpc": "~1.28.3"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@bitauth/libauth": "~3.0.0",
@@ -61,8 +61,8 @@
61
61
  "@xylabs/geo": "^5.1.1",
62
62
  "@xylabs/sdk-js": "^5.1.1",
63
63
  "@xylabs/threads": "~5.1.1",
64
- "@xylabs/toolchain": "~7.13.8",
65
- "@xylabs/tsconfig": "~7.13.8",
64
+ "@xylabs/toolchain": "~7.13.13",
65
+ "@xylabs/tsconfig": "~7.13.13",
66
66
  "@xylabs/vitest-extended": "^5.1.1",
67
67
  "@xyo-network/account": "~5.6.1",
68
68
  "@xyo-network/account-model": "~5.6.2",
@@ -110,56 +110,56 @@
110
110
  "zod": "~4.4.3"
111
111
  },
112
112
  "peerDependencies": {
113
- "@bitauth/libauth": ">=3.0.0 <3.1",
114
- "@metamask/json-rpc-engine": ">=10.3.0 <11",
115
- "@metamask/providers": ">=22.1.1 <23",
116
- "@metamask/utils": ">=11.11.0 <12",
117
- "@opentelemetry/api": ">=1.9.1 <2",
118
- "@opentelemetry/sdk-trace-base": ">=2.7.1 <3",
119
- "@scure/base": ">=2.2.0 <2.3",
120
- "@scure/bip39": ">=2.2.0 <2.3",
121
- "@xylabs/fetch": ">=5.1.1 <6",
122
- "@xylabs/geo": ">=5.1.1 <6",
123
- "@xylabs/sdk-js": ">=5.1.1 <6",
124
- "@xylabs/threads": ">=5.1.1 <5.2",
125
- "@xyo-network/account": ">=5.6.1 <5.7",
126
- "@xyo-network/account-model": ">=5.6.2 <5.7",
127
- "@xyo-network/api": ">=5.6.1 <5.7",
128
- "@xyo-network/api-models": ">=5.6.2 <5.7",
129
- "@xyo-network/boundwitness-builder": ">=5.6.1 <5.7",
130
- "@xyo-network/boundwitness-model": ">=5.6.2 <5.7",
131
- "@xyo-network/boundwitness-wrapper": ">=5.6.1 <5.7",
132
- "@xyo-network/config-payload-plugin": ">=5.6.2 <5.7",
133
- "@xyo-network/huri": ">=5.6.1 <5.7",
134
- "@xyo-network/manifest-model": ">=5.6.2 <5.7",
135
- "@xyo-network/payload-builder": ">=5.6.1 <5.7",
136
- "@xyo-network/payload-model": ">=5.6.2 <5.7",
137
- "@xyo-network/payload-plugin": ">=5.6.2 <5.7",
138
- "@xyo-network/payload-wrapper": ">=5.6.1 <5.7",
139
- "@xyo-network/query-payload-plugin": ">=5.6.2 <5.7",
140
- "@xyo-network/sdk-js": ">=5.6.3 <6",
141
- "@xyo-network/sdk-protocol-js": ">=5.6.2 <5.7",
142
- "@xyo-network/wallet": ">=5.6.1 <5.7",
143
- "@xyo-network/wallet-model": ">=5.6.2 <6",
144
- "ajv": ">=8.20.0 <9",
145
- "async-mutex": ">=0.5.0 <1",
146
- "bn.js": ">=5.2.3 <6",
147
- "buffer": ">=6.0.3 <7",
148
- "chalk": ">=5.6.2 <6",
149
- "cosmiconfig": ">=9.0.1 <10",
150
- "debug": ">=4.4.3 <4.5",
151
- "ethers": ">=6.16.0 <7",
152
- "hash-wasm": ">=4.12.0 <4.13",
153
- "idb": ">=8.0.3 <9",
154
- "lru-cache": ">=11.3.6 <12",
155
- "mapbox-gl": ">=3.23.1 <4",
156
- "observable-fns": ">=0.6.1 <0.7",
157
- "pako": ">=2.1.0 <3",
158
- "store2": ">=2.14.4 <2.15",
159
- "uuid": ">=14.0.0 <14.1",
160
- "wasm-feature-detect": ">=1.8.0 <1.9",
161
- "webextension-polyfill": ">=0.12.0 <1",
162
- "zod": ">=4.4.3 <4.5"
113
+ "@bitauth/libauth": "~3.0",
114
+ "@metamask/json-rpc-engine": "^10.3",
115
+ "@metamask/providers": "^22.1",
116
+ "@metamask/utils": "^11.11",
117
+ "@opentelemetry/api": "^1.9",
118
+ "@opentelemetry/sdk-trace-base": "^2.7",
119
+ "@scure/base": "~2.2",
120
+ "@scure/bip39": "~2.2",
121
+ "@xylabs/fetch": "^5.1",
122
+ "@xylabs/geo": "^5.1",
123
+ "@xylabs/sdk-js": "^5.1",
124
+ "@xylabs/threads": "~5.1",
125
+ "@xyo-network/account": "~5.6",
126
+ "@xyo-network/account-model": "~5.6",
127
+ "@xyo-network/api": "~5.6",
128
+ "@xyo-network/api-models": "~5.6",
129
+ "@xyo-network/boundwitness-builder": "~5.6",
130
+ "@xyo-network/boundwitness-model": "~5.6",
131
+ "@xyo-network/boundwitness-wrapper": "~5.6",
132
+ "@xyo-network/config-payload-plugin": "~5.6",
133
+ "@xyo-network/huri": "~5.6",
134
+ "@xyo-network/manifest-model": "~5.6",
135
+ "@xyo-network/payload-builder": "~5.6",
136
+ "@xyo-network/payload-model": "~5.6",
137
+ "@xyo-network/payload-plugin": "~5.6",
138
+ "@xyo-network/payload-wrapper": "~5.6",
139
+ "@xyo-network/query-payload-plugin": "~5.6",
140
+ "@xyo-network/sdk-js": "^5.6",
141
+ "@xyo-network/sdk-protocol-js": "~5.6",
142
+ "@xyo-network/wallet": "~5.6",
143
+ "@xyo-network/wallet-model": "^5.6",
144
+ "ajv": "^8.20",
145
+ "async-mutex": "^0.5",
146
+ "bn.js": "^5.2",
147
+ "buffer": "^6.0",
148
+ "chalk": "^5.6",
149
+ "cosmiconfig": "^9.0",
150
+ "debug": "~4.4",
151
+ "ethers": "^6.16",
152
+ "hash-wasm": "~4.12",
153
+ "idb": "^8.0",
154
+ "lru-cache": "^11.3",
155
+ "mapbox-gl": "^3.23",
156
+ "observable-fns": "~0.6",
157
+ "pako": "^2.1",
158
+ "store2": "~2.14",
159
+ "uuid": "~14.0",
160
+ "wasm-feature-detect": "~1.8",
161
+ "webextension-polyfill": "^0.12",
162
+ "zod": "~4.4"
163
163
  },
164
164
  "engines": {
165
165
  "node": ">=22"