@xyo-network/witness-blockchain 5.3.29 → 5.4.0

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 +0 -176
  2. package/package.json +5 -9
package/README.md CHANGED
@@ -38,182 +38,6 @@ bun add {{name}}
38
38
 
39
39
  See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
40
40
 
41
- ## Reference
42
-
43
- ### packages
44
-
45
- ### modules
46
-
47
- ### packages
48
-
49
- ### witness
50
-
51
- ### packages
52
-
53
- ### blockchain
54
-
55
- ### .temp-typedoc
56
-
57
- ### interfaces
58
-
59
- ### <a id="GetProvidersFromEnvOptions"></a>GetProvidersFromEnvOptions
60
-
61
- [**@xyo-network/witness-blockchain**](#../README)
62
-
63
- ***
64
-
65
- ## Properties
66
-
67
- ### providerSource?
68
-
69
- ```ts
70
- optional providerSource?: ProviderSource;
71
- ```
72
-
73
- ***
74
-
75
- ### providerType?
76
-
77
- ```ts
78
- optional providerType?: ProviderType;
79
- ```
80
-
81
- ### type-aliases
82
-
83
- ### <a id="ProviderSource"></a>ProviderSource
84
-
85
- [**@xyo-network/witness-blockchain**](#../README)
86
-
87
- ***
88
-
89
- ```ts
90
- type ProviderSource = "infura" | "quicknode";
91
- ```
92
-
93
- ### <a id="ProviderType"></a>ProviderType
94
-
95
- [**@xyo-network/witness-blockchain**](#../README)
96
-
97
- ***
98
-
99
- ```ts
100
- type ProviderType = "rpc" | "wss";
101
- ```
102
-
103
- ### variables
104
-
105
- ### <a id="checkIpfsUrl"></a>checkIpfsUrl
106
-
107
- [**@xyo-network/witness-blockchain**](#../README)
108
-
109
- ***
110
-
111
- ```ts
112
- const checkIpfsUrl: (urlToCheck, ipfsGateway?) => string;
113
- ```
114
-
115
- Returns the equivalent IPFS gateway URL for the supplied URL.
116
-
117
- ## Parameters
118
-
119
- ### urlToCheck
120
-
121
- `string`
122
-
123
- The URL to check
124
-
125
- ### ipfsGateway?
126
-
127
- `string`
128
-
129
- ## Returns
130
-
131
- `string`
132
-
133
- If the supplied URL is an IPFS URL, it converts the URL to the
134
- equivalent IPFS gateway URL. Otherwise, returns the original URL.
135
-
136
- ### <a id="getProviderFromEnv"></a>getProviderFromEnv
137
-
138
- [**@xyo-network/witness-blockchain**](#../README)
139
-
140
- ***
141
-
142
- ```ts
143
- const getProviderFromEnv: (chainId?, { providerSource, providerType }?) => Provider;
144
- ```
145
-
146
- ## Parameters
147
-
148
- ### chainId?
149
-
150
- `number`
151
-
152
- ### \{ providerSource, providerType \}?
153
-
154
- [`GetProvidersFromEnvOptions`](#../interfaces/GetProvidersFromEnvOptions)
155
-
156
- ## Returns
157
-
158
- `Provider`
159
-
160
- ### <a id="getProvidersFromEnv"></a>getProvidersFromEnv
161
-
162
- [**@xyo-network/witness-blockchain**](#../README)
163
-
164
- ***
165
-
166
- ```ts
167
- const getProvidersFromEnv: (count?, chainId?, options?) => Provider[];
168
- ```
169
-
170
- ## Parameters
171
-
172
- ### count?
173
-
174
- `number`
175
-
176
- ### chainId?
177
-
178
- `number`
179
-
180
- ### options?
181
-
182
- [`GetProvidersFromEnvOptions`](#../interfaces/GetProvidersFromEnvOptions)
183
-
184
- ## Returns
185
-
186
- `Provider`[]
187
-
188
- ### <a id="getSharedProviderFromEnv"></a>getSharedProviderFromEnv
189
-
190
- [**@xyo-network/witness-blockchain**](#../README)
191
-
192
- ***
193
-
194
- ```ts
195
- const getSharedProviderFromEnv: (chainId?, options?) => Provider;
196
- ```
197
-
198
- ## Parameters
199
-
200
- ### chainId?
201
-
202
- `number`
203
-
204
- ### options?
205
-
206
- ### providerSource?
207
-
208
- [`ProviderSource`](#../type-aliases/ProviderSource)
209
-
210
- ### providerType?
211
-
212
- [`ProviderType`](#../type-aliases/ProviderType)
213
-
214
- ## Returns
215
-
216
- `Provider`
217
41
 
218
42
 
219
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/witness-blockchain",
3
- "version": "5.3.29",
3
+ "version": "5.4.0",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,12 +22,10 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
- "import": "./dist/neutral/index.mjs",
26
25
  "default": "./dist/neutral/index.mjs"
27
26
  },
28
27
  "./package.json": "./package.json"
29
28
  },
30
- "types": "dist/neutral/index.d.ts",
31
29
  "files": [
32
30
  "dist",
33
31
  "!**/*.bench.*",
@@ -36,15 +34,13 @@
36
34
  "README.md"
37
35
  ],
38
36
  "dependencies": {
39
- "@xyo-network/witness-blockchain-abstract": "~5.3.29"
37
+ "@xyo-network/witness-blockchain-abstract": "~5.4.0"
40
38
  },
41
39
  "devDependencies": {
42
40
  "@opentelemetry/api": "^1.9.1",
43
- "@xylabs/sdk-js": "^5.0.95",
44
- "@xylabs/ts-scripts-common": "~7.8.4",
45
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
46
- "@xylabs/tsconfig": "~7.8.4",
47
- "axios": "^1.14.0",
41
+ "@xylabs/sdk-js": "^5.0.97",
42
+ "@xylabs/toolchain": "~7.10.8",
43
+ "@xylabs/tsconfig": "~7.10.8",
48
44
  "ethers": "^6.16.0",
49
45
  "pako": "~2.1.0",
50
46
  "typescript": "~5.9.3",