@xyo-network/xl1-gateway 1.28.0 → 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 +94 -6
  2. package/package.json +57 -57
package/README.md CHANGED
@@ -1,24 +1,112 @@
1
+ [![logo][]][logo-link]
2
+
1
3
  # @xyo-network/xl1-gateway
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
+ > Fluent gateway builder for the XL1 blockchain — read-only viewers, transacting runners, and signer wrapping.
9
+
10
+ ## About
11
+
12
+ This package gives you `GatewayBuilder`, the fluent factory most XL1 applications use to construct a gateway. Calling `.build()` produces an `XyoGateway` (read-only) or — when a signer is attached — an `XyoGatewayRunner` that can submit transactions.
5
13
 
6
- > XYO Layer One Gateway SDK — fluent gateway builder for browsers, Node, and the XL1 Wallet
14
+ It's bundled into the [`@xyo-network/xl1-sdk`](https://www.npmjs.com/package/@xyo-network/xl1-sdk) aggregate. Install it directly when you only need gateway construction and want to avoid pulling in the full SDK.
7
15
 
8
16
  ## Install
9
17
 
18
+ Using npm:
19
+
20
+ ```sh
21
+ npm i --save @xyo-network/xl1-gateway
22
+ ```
23
+
24
+ Using yarn:
25
+
26
+ ```sh
27
+ yarn add @xyo-network/xl1-gateway
28
+ ```
29
+
30
+ Using pnpm:
31
+
32
+ ```sh
33
+ pnpm add @xyo-network/xl1-gateway
34
+ ```
35
+
36
+ Using bun:
37
+
38
+ ```sh
39
+ bun add @xyo-network/xl1-gateway
40
+ ```
41
+
42
+ ## Quick Start
43
+
44
+ ```ts
45
+ import { GatewayBuilder } from '@xyo-network/xl1-gateway'
46
+
47
+ const gateway = await new GatewayBuilder()
48
+ .rpcUrl('https://beta.api.chain.xyo.network/rpc')
49
+ .build()
50
+
51
+ const blockNumber = await gateway.connection.viewer.block.currentBlockNumber()
52
+ console.log(`Current block: ${blockNumber}`)
53
+ ```
54
+
55
+ Attach a signer to promote the result to an `XyoGatewayRunner` capable of submitting transactions.
56
+
57
+ ## What's Inside
58
+
59
+ - **`GatewayBuilder`** — fluent builder; configures RPC URL, datalake endpoint, signer, and provider overrides
60
+ - **`XyoSignerWrapper`** — wraps an external signer (e.g. a wallet extension) to satisfy the `XyoSigner` contract
61
+
62
+ ## Building Locally
63
+
10
64
  ```sh
11
- {{pm}} add {{name}}
65
+ xy build @xyo-network/xl1-gateway
66
+ xy test @xyo-network/xl1-gateway
67
+ xy lint @xyo-network/xl1-gateway
12
68
  ```
13
69
 
70
+ ## Maintainers
71
+
72
+ <table>
73
+ <tr>
74
+ <td align="center" valign="top" width="120">
75
+ <a href="https://github.com/arietrouw">
76
+ <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
77
+ <sub><b>Arie Trouw</b></sub>
78
+ </a>
79
+ <br />
80
+ <a href="https://arietrouw.com">arietrouw.com</a>
81
+ </td>
82
+ <td align="center" valign="top" width="120">
83
+ <a href="https://github.com/jonesmac">
84
+ <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
85
+ <sub><b>Matt Jones</b></sub>
86
+ </a>
87
+ </td>
88
+ <td align="center" valign="top" width="120">
89
+ <a href="https://github.com/JoelBCarter">
90
+ <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
91
+ <sub><b>Joel Carter</b></sub>
92
+ </a>
93
+ </td>
94
+ </tr>
95
+ </table>
14
96
 
15
97
  ## License
16
98
 
17
- See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
99
+ See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
18
100
 
101
+ ## Credits
19
102
 
103
+ [Made with 🔥 and ❄️ by XYO](https://xyo.network)
104
+
105
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
106
+ [logo-link]: https://xyo.network
20
107
 
21
108
  [npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-gateway.svg
22
109
  [npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-gateway
110
+
23
111
  [license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-gateway.svg
24
- [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
112
+ [license-link]: ./LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/xl1-gateway",
3
- "version": "1.28.0",
3
+ "version": "1.28.2",
4
4
  "description": "XYO Layer One Gateway SDK",
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-providers": "~1.28.0"
47
+ "@xyo-network/xl1-protocol-lib": "~1.28.2",
48
+ "@xyo-network/xl1-providers": "~1.28.2",
49
+ "@xyo-network/xl1-protocol-sdk": "~1.28.2"
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",
@@ -107,59 +107,59 @@
107
107
  "wasm-feature-detect": "~1.8.0",
108
108
  "webextension-polyfill": "^0.12.0",
109
109
  "zod": "~4.4.3",
110
- "@xyo-network/xl1-network-model": "~1.28.0"
110
+ "@xyo-network/xl1-network-model": "~1.28.2"
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"