@xyo-network/witness-evm-abstract 2.84.9
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.
- package/LICENSE +165 -0
- package/README.md +13 -0
- package/dist/browser/Witness.d.cts +23 -0
- package/dist/browser/Witness.d.cts.map +1 -0
- package/dist/browser/Witness.d.mts +23 -0
- package/dist/browser/Witness.d.mts.map +1 -0
- package/dist/browser/Witness.d.ts +23 -0
- package/dist/browser/Witness.d.ts.map +1 -0
- package/dist/browser/index.cjs +162 -0
- package/dist/browser/index.cjs.map +1 -0
- package/dist/browser/index.d.cts +4 -0
- package/dist/browser/index.d.cts.map +1 -0
- package/dist/browser/index.d.mts +4 -0
- package/dist/browser/index.d.mts.map +1 -0
- package/dist/browser/index.d.ts +4 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +139 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/lib/checkIpfsUrl.d.cts +8 -0
- package/dist/browser/lib/checkIpfsUrl.d.cts.map +1 -0
- package/dist/browser/lib/checkIpfsUrl.d.mts +8 -0
- package/dist/browser/lib/checkIpfsUrl.d.mts.map +1 -0
- package/dist/browser/lib/checkIpfsUrl.d.ts +8 -0
- package/dist/browser/lib/checkIpfsUrl.d.ts.map +1 -0
- package/dist/browser/lib/getProviderFromEnv.d.cts +14 -0
- package/dist/browser/lib/getProviderFromEnv.d.cts.map +1 -0
- package/dist/browser/lib/getProviderFromEnv.d.mts +14 -0
- package/dist/browser/lib/getProviderFromEnv.d.mts.map +1 -0
- package/dist/browser/lib/getProviderFromEnv.d.ts +14 -0
- package/dist/browser/lib/getProviderFromEnv.d.ts.map +1 -0
- package/dist/browser/lib/index.d.cts +3 -0
- package/dist/browser/lib/index.d.cts.map +1 -0
- package/dist/browser/lib/index.d.mts +3 -0
- package/dist/browser/lib/index.d.mts.map +1 -0
- package/dist/browser/lib/index.d.ts +3 -0
- package/dist/browser/lib/index.d.ts.map +1 -0
- package/dist/browser/model.d.cts +9 -0
- package/dist/browser/model.d.cts.map +1 -0
- package/dist/browser/model.d.mts +9 -0
- package/dist/browser/model.d.mts.map +1 -0
- package/dist/browser/model.d.ts +9 -0
- package/dist/browser/model.d.ts.map +1 -0
- package/dist/node/Witness.d.cts +23 -0
- package/dist/node/Witness.d.cts.map +1 -0
- package/dist/node/Witness.d.mts +23 -0
- package/dist/node/Witness.d.mts.map +1 -0
- package/dist/node/Witness.d.ts +23 -0
- package/dist/node/Witness.d.ts.map +1 -0
- package/dist/node/index.cjs +172 -0
- package/dist/node/index.cjs.map +1 -0
- package/dist/node/index.d.cts +4 -0
- package/dist/node/index.d.cts.map +1 -0
- package/dist/node/index.d.mts +4 -0
- package/dist/node/index.d.mts.map +1 -0
- package/dist/node/index.d.ts +4 -0
- package/dist/node/index.d.ts.map +1 -0
- package/dist/node/index.js +139 -0
- package/dist/node/index.js.map +1 -0
- package/dist/node/lib/checkIpfsUrl.d.cts +8 -0
- package/dist/node/lib/checkIpfsUrl.d.cts.map +1 -0
- package/dist/node/lib/checkIpfsUrl.d.mts +8 -0
- package/dist/node/lib/checkIpfsUrl.d.mts.map +1 -0
- package/dist/node/lib/checkIpfsUrl.d.ts +8 -0
- package/dist/node/lib/checkIpfsUrl.d.ts.map +1 -0
- package/dist/node/lib/getProviderFromEnv.d.cts +14 -0
- package/dist/node/lib/getProviderFromEnv.d.cts.map +1 -0
- package/dist/node/lib/getProviderFromEnv.d.mts +14 -0
- package/dist/node/lib/getProviderFromEnv.d.mts.map +1 -0
- package/dist/node/lib/getProviderFromEnv.d.ts +14 -0
- package/dist/node/lib/getProviderFromEnv.d.ts.map +1 -0
- package/dist/node/lib/index.d.cts +3 -0
- package/dist/node/lib/index.d.cts.map +1 -0
- package/dist/node/lib/index.d.mts +3 -0
- package/dist/node/lib/index.d.mts.map +1 -0
- package/dist/node/lib/index.d.ts +3 -0
- package/dist/node/lib/index.d.ts.map +1 -0
- package/dist/node/model.d.cts +9 -0
- package/dist/node/model.d.cts.map +1 -0
- package/dist/node/model.d.mts +9 -0
- package/dist/node/model.d.mts.map +1 -0
- package/dist/node/model.d.ts +9 -0
- package/dist/node/model.d.ts.map +1 -0
- package/package.json +71 -0
- package/src/Witness.ts +64 -0
- package/src/index.ts +3 -0
- package/src/lib/checkIpfsUrl.ts +43 -0
- package/src/lib/getProviderFromEnv.ts +93 -0
- package/src/lib/index.ts +2 -0
- package/src/model.ts +13 -0
- package/typedoc.json +5 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
GNU LESSER GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 3, 29 June 2007
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
5
|
+
Everyone is permitted to copy and distribute verbatim copies
|
|
6
|
+
of this license document, but changing it is not allowed.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
This version of the GNU Lesser General Public License incorporates
|
|
10
|
+
the terms and conditions of version 3 of the GNU General Public
|
|
11
|
+
License, supplemented by the additional permissions listed below.
|
|
12
|
+
|
|
13
|
+
0. Additional Definitions.
|
|
14
|
+
|
|
15
|
+
As used herein, "this License" refers to version 3 of the GNU Lesser
|
|
16
|
+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
|
17
|
+
General Public License.
|
|
18
|
+
|
|
19
|
+
"The Library" refers to a covered work governed by this License,
|
|
20
|
+
other than an Application or a Combined Work as defined below.
|
|
21
|
+
|
|
22
|
+
An "Application" is any work that makes use of an interface provided
|
|
23
|
+
by the Library, but which is not otherwise based on the Library.
|
|
24
|
+
Defining a subclass of a class defined by the Library is deemed a mode
|
|
25
|
+
of using an interface provided by the Library.
|
|
26
|
+
|
|
27
|
+
A "Combined Work" is a work produced by combining or linking an
|
|
28
|
+
Application with the Library. The particular version of the Library
|
|
29
|
+
with which the Combined Work was made is also called the "Linked
|
|
30
|
+
Version".
|
|
31
|
+
|
|
32
|
+
The "Minimal Corresponding Source" for a Combined Work means the
|
|
33
|
+
Corresponding Source for the Combined Work, excluding any source code
|
|
34
|
+
for portions of the Combined Work that, considered in isolation, are
|
|
35
|
+
based on the Application, and not on the Linked Version.
|
|
36
|
+
|
|
37
|
+
The "Corresponding Application Code" for a Combined Work means the
|
|
38
|
+
object code and/or source code for the Application, including any data
|
|
39
|
+
and utility programs needed for reproducing the Combined Work from the
|
|
40
|
+
Application, but excluding the System Libraries of the Combined Work.
|
|
41
|
+
|
|
42
|
+
1. Exception to Section 3 of the GNU GPL.
|
|
43
|
+
|
|
44
|
+
You may convey a covered work under sections 3 and 4 of this License
|
|
45
|
+
without being bound by section 3 of the GNU GPL.
|
|
46
|
+
|
|
47
|
+
2. Conveying Modified Versions.
|
|
48
|
+
|
|
49
|
+
If you modify a copy of the Library, and, in your modifications, a
|
|
50
|
+
facility refers to a function or data to be supplied by an Application
|
|
51
|
+
that uses the facility (other than as an argument passed when the
|
|
52
|
+
facility is invoked), then you may convey a copy of the modified
|
|
53
|
+
version:
|
|
54
|
+
|
|
55
|
+
a) under this License, provided that you make a good faith effort to
|
|
56
|
+
ensure that, in the event an Application does not supply the
|
|
57
|
+
function or data, the facility still operates, and performs
|
|
58
|
+
whatever part of its purpose remains meaningful, or
|
|
59
|
+
|
|
60
|
+
b) under the GNU GPL, with none of the additional permissions of
|
|
61
|
+
this License applicable to that copy.
|
|
62
|
+
|
|
63
|
+
3. Object Code Incorporating Material from Library Header Files.
|
|
64
|
+
|
|
65
|
+
The object code form of an Application may incorporate material from
|
|
66
|
+
a header file that is part of the Library. You may convey such object
|
|
67
|
+
code under terms of your choice, provided that, if the incorporated
|
|
68
|
+
material is not limited to numerical parameters, data structure
|
|
69
|
+
layouts and accessors, or small macros, inline functions and templates
|
|
70
|
+
(ten or fewer lines in length), you do both of the following:
|
|
71
|
+
|
|
72
|
+
a) Give prominent notice with each copy of the object code that the
|
|
73
|
+
Library is used in it and that the Library and its use are
|
|
74
|
+
covered by this License.
|
|
75
|
+
|
|
76
|
+
b) Accompany the object code with a copy of the GNU GPL and this license
|
|
77
|
+
document.
|
|
78
|
+
|
|
79
|
+
4. Combined Works.
|
|
80
|
+
|
|
81
|
+
You may convey a Combined Work under terms of your choice that,
|
|
82
|
+
taken together, effectively do not restrict modification of the
|
|
83
|
+
portions of the Library contained in the Combined Work and reverse
|
|
84
|
+
engineering for debugging such modifications, if you also do each of
|
|
85
|
+
the following:
|
|
86
|
+
|
|
87
|
+
a) Give prominent notice with each copy of the Combined Work that
|
|
88
|
+
the Library is used in it and that the Library and its use are
|
|
89
|
+
covered by this License.
|
|
90
|
+
|
|
91
|
+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
|
92
|
+
document.
|
|
93
|
+
|
|
94
|
+
c) For a Combined Work that displays copyright notices during
|
|
95
|
+
execution, include the copyright notice for the Library among
|
|
96
|
+
these notices, as well as a reference directing the user to the
|
|
97
|
+
copies of the GNU GPL and this license document.
|
|
98
|
+
|
|
99
|
+
d) Do one of the following:
|
|
100
|
+
|
|
101
|
+
0) Convey the Minimal Corresponding Source under the terms of this
|
|
102
|
+
License, and the Corresponding Application Code in a form
|
|
103
|
+
suitable for, and under terms that permit, the user to
|
|
104
|
+
recombine or relink the Application with a modified version of
|
|
105
|
+
the Linked Version to produce a modified Combined Work, in the
|
|
106
|
+
manner specified by section 6 of the GNU GPL for conveying
|
|
107
|
+
Corresponding Source.
|
|
108
|
+
|
|
109
|
+
1) Use a suitable shared library mechanism for linking with the
|
|
110
|
+
Library. A suitable mechanism is one that (a) uses at run time
|
|
111
|
+
a copy of the Library already present on the user's computer
|
|
112
|
+
system, and (b) will operate properly with a modified version
|
|
113
|
+
of the Library that is interface-compatible with the Linked
|
|
114
|
+
Version.
|
|
115
|
+
|
|
116
|
+
e) Provide Installation Information, but only if you would otherwise
|
|
117
|
+
be required to provide such information under section 6 of the
|
|
118
|
+
GNU GPL, and only to the extent that such information is
|
|
119
|
+
necessary to install and execute a modified version of the
|
|
120
|
+
Combined Work produced by recombining or relinking the
|
|
121
|
+
Application with a modified version of the Linked Version. (If
|
|
122
|
+
you use option 4d0, the Installation Information must accompany
|
|
123
|
+
the Minimal Corresponding Source and Corresponding Application
|
|
124
|
+
Code. If you use option 4d1, you must provide the Installation
|
|
125
|
+
Information in the manner specified by section 6 of the GNU GPL
|
|
126
|
+
for conveying Corresponding Source.)
|
|
127
|
+
|
|
128
|
+
5. Combined Libraries.
|
|
129
|
+
|
|
130
|
+
You may place library facilities that are a work based on the
|
|
131
|
+
Library side by side in a single library together with other library
|
|
132
|
+
facilities that are not Applications and are not covered by this
|
|
133
|
+
License, and convey such a combined library under terms of your
|
|
134
|
+
choice, if you do both of the following:
|
|
135
|
+
|
|
136
|
+
a) Accompany the combined library with a copy of the same work based
|
|
137
|
+
on the Library, uncombined with any other library facilities,
|
|
138
|
+
conveyed under the terms of this License.
|
|
139
|
+
|
|
140
|
+
b) Give prominent notice with the combined library that part of it
|
|
141
|
+
is a work based on the Library, and explaining where to find the
|
|
142
|
+
accompanying uncombined form of the same work.
|
|
143
|
+
|
|
144
|
+
6. Revised Versions of the GNU Lesser General Public License.
|
|
145
|
+
|
|
146
|
+
The Free Software Foundation may publish revised and/or new versions
|
|
147
|
+
of the GNU Lesser General Public License from time to time. Such new
|
|
148
|
+
versions will be similar in spirit to the present version, but may
|
|
149
|
+
differ in detail to address new problems or concerns.
|
|
150
|
+
|
|
151
|
+
Each version is given a distinguishing version number. If the
|
|
152
|
+
Library as you received it specifies that a certain numbered version
|
|
153
|
+
of the GNU Lesser General Public License "or any later version"
|
|
154
|
+
applies to it, you have the option of following the terms and
|
|
155
|
+
conditions either of that published version or of any later version
|
|
156
|
+
published by the Free Software Foundation. If the Library as you
|
|
157
|
+
received it does not specify a version number of the GNU Lesser
|
|
158
|
+
General Public License, you may choose any version of the GNU Lesser
|
|
159
|
+
General Public License ever published by the Free Software Foundation.
|
|
160
|
+
|
|
161
|
+
If the Library as you received it specifies that a proxy can decide
|
|
162
|
+
whether future versions of the GNU Lesser General Public License shall
|
|
163
|
+
apply, that proxy's public statement of acceptance of any version is
|
|
164
|
+
permanent authorization for you to choose that version for the
|
|
165
|
+
Library.
|
package/README.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[![logo][]](https://xyo.network)
|
|
2
|
+
|
|
3
|
+
Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
|
|
4
|
+
|
|
5
|
+
## License
|
|
6
|
+
|
|
7
|
+
> See the [LICENSE](LICENSE) file for license details
|
|
8
|
+
|
|
9
|
+
## Credits
|
|
10
|
+
|
|
11
|
+
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
|
|
12
|
+
|
|
13
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Promisable } from '@xylabs/promise';
|
|
2
|
+
import { AbstractWitness } from '@xyo-network/abstract-witness';
|
|
3
|
+
import { AnyConfigSchema } from '@xyo-network/module-model';
|
|
4
|
+
import { EmptyObject, WithAdditional } from '@xyo-network/object';
|
|
5
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
6
|
+
import { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model';
|
|
7
|
+
import { Provider } from 'ethers';
|
|
8
|
+
export declare const EvmWitnessConfigSchema = "network.xyo.evm.witness";
|
|
9
|
+
export type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema;
|
|
10
|
+
export type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<TAdditional, TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema>;
|
|
11
|
+
export type AdditionalBlockchainWitnessParams = {
|
|
12
|
+
providers: Provider[];
|
|
13
|
+
};
|
|
14
|
+
export type BlockchainWitnessParams<TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig, TAdditionalParams extends EmptyObject | void = void> = WitnessParams<TConfig, WithAdditional<{
|
|
15
|
+
providers: () => Promisable<Provider[]>;
|
|
16
|
+
}, TAdditionalParams>>;
|
|
17
|
+
export declare abstract class AbstractBlockchainWitness<TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractWitness<TParams, TIn, TOut, TEventData> {
|
|
18
|
+
private _providers;
|
|
19
|
+
getProvider(cache?: boolean): Promise<Provider | undefined>;
|
|
20
|
+
getProvider(cache: boolean, error: string | true): Promise<Provider>;
|
|
21
|
+
getProviders(cache?: boolean): Promise<Provider[]>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=Witness.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAClH,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEjC,eAAO,MAAM,sBAAsB,4BAA4B,CAAA;AAC/D,MAAM,MAAM,6BAA6B,GAAG,OAAO,sBAAsB,CAAA;AAEzE,MAAM,MAAM,uBAAuB,CAAC,WAAW,SAAS,WAAW,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,aAAa,CAChJ,WAAW,EACX,OAAO,SAAS,IAAI,GAAG,CAAC,WAAW,SAAS,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,6BAA6B,CAAC,GAAG,OAAO,CACvH,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,eAAe,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,EAClF,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IACjD,aAAa,CACf,OAAO,EACP,cAAc,CACZ;IACE,SAAS,EAAE,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;CACxC,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,8BAAsB,yBAAyB,CAC7C,OAAO,SAAS,uBAAuB,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC,GAAG,uBAAuB,EAC3G,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,OAAO,CAAC,UAAU,CAAoC;IAEhD,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC3D,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYpE,YAAY,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAKvD"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Promisable } from '@xylabs/promise';
|
|
2
|
+
import { AbstractWitness } from '@xyo-network/abstract-witness';
|
|
3
|
+
import { AnyConfigSchema } from '@xyo-network/module-model';
|
|
4
|
+
import { EmptyObject, WithAdditional } from '@xyo-network/object';
|
|
5
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
6
|
+
import { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model';
|
|
7
|
+
import { Provider } from 'ethers';
|
|
8
|
+
export declare const EvmWitnessConfigSchema = "network.xyo.evm.witness";
|
|
9
|
+
export type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema;
|
|
10
|
+
export type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<TAdditional, TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema>;
|
|
11
|
+
export type AdditionalBlockchainWitnessParams = {
|
|
12
|
+
providers: Provider[];
|
|
13
|
+
};
|
|
14
|
+
export type BlockchainWitnessParams<TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig, TAdditionalParams extends EmptyObject | void = void> = WitnessParams<TConfig, WithAdditional<{
|
|
15
|
+
providers: () => Promisable<Provider[]>;
|
|
16
|
+
}, TAdditionalParams>>;
|
|
17
|
+
export declare abstract class AbstractBlockchainWitness<TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractWitness<TParams, TIn, TOut, TEventData> {
|
|
18
|
+
private _providers;
|
|
19
|
+
getProvider(cache?: boolean): Promise<Provider | undefined>;
|
|
20
|
+
getProvider(cache: boolean, error: string | true): Promise<Provider>;
|
|
21
|
+
getProviders(cache?: boolean): Promise<Provider[]>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=Witness.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAClH,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEjC,eAAO,MAAM,sBAAsB,4BAA4B,CAAA;AAC/D,MAAM,MAAM,6BAA6B,GAAG,OAAO,sBAAsB,CAAA;AAEzE,MAAM,MAAM,uBAAuB,CAAC,WAAW,SAAS,WAAW,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,aAAa,CAChJ,WAAW,EACX,OAAO,SAAS,IAAI,GAAG,CAAC,WAAW,SAAS,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,6BAA6B,CAAC,GAAG,OAAO,CACvH,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,eAAe,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,EAClF,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IACjD,aAAa,CACf,OAAO,EACP,cAAc,CACZ;IACE,SAAS,EAAE,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;CACxC,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,8BAAsB,yBAAyB,CAC7C,OAAO,SAAS,uBAAuB,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC,GAAG,uBAAuB,EAC3G,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,OAAO,CAAC,UAAU,CAAoC;IAEhD,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC3D,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYpE,YAAY,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAKvD"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Promisable } from '@xylabs/promise';
|
|
2
|
+
import { AbstractWitness } from '@xyo-network/abstract-witness';
|
|
3
|
+
import { AnyConfigSchema } from '@xyo-network/module-model';
|
|
4
|
+
import { EmptyObject, WithAdditional } from '@xyo-network/object';
|
|
5
|
+
import { Payload } from '@xyo-network/payload-model';
|
|
6
|
+
import { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model';
|
|
7
|
+
import { Provider } from 'ethers';
|
|
8
|
+
export declare const EvmWitnessConfigSchema = "network.xyo.evm.witness";
|
|
9
|
+
export type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema;
|
|
10
|
+
export type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<TAdditional, TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema>;
|
|
11
|
+
export type AdditionalBlockchainWitnessParams = {
|
|
12
|
+
providers: Provider[];
|
|
13
|
+
};
|
|
14
|
+
export type BlockchainWitnessParams<TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig, TAdditionalParams extends EmptyObject | void = void> = WitnessParams<TConfig, WithAdditional<{
|
|
15
|
+
providers: () => Promisable<Provider[]>;
|
|
16
|
+
}, TAdditionalParams>>;
|
|
17
|
+
export declare abstract class AbstractBlockchainWitness<TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractWitness<TParams, TIn, TOut, TEventData> {
|
|
18
|
+
private _providers;
|
|
19
|
+
getProvider(cache?: boolean): Promise<Provider | undefined>;
|
|
20
|
+
getProvider(cache: boolean, error: string | true): Promise<Provider>;
|
|
21
|
+
getProviders(cache?: boolean): Promise<Provider[]>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=Witness.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAClH,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEjC,eAAO,MAAM,sBAAsB,4BAA4B,CAAA;AAC/D,MAAM,MAAM,6BAA6B,GAAG,OAAO,sBAAsB,CAAA;AAEzE,MAAM,MAAM,uBAAuB,CAAC,WAAW,SAAS,WAAW,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,aAAa,CAChJ,WAAW,EACX,OAAO,SAAS,IAAI,GAAG,CAAC,WAAW,SAAS,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,6BAA6B,CAAC,GAAG,OAAO,CACvH,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC9C,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,uBAAuB,CACjC,OAAO,SAAS,eAAe,CAAC,uBAAuB,CAAC,GAAG,uBAAuB,EAClF,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,IACjD,aAAa,CACf,OAAO,EACP,cAAc,CACZ;IACE,SAAS,EAAE,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAA;CACxC,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,8BAAsB,yBAAyB,CAC7C,OAAO,SAAS,uBAAuB,CAAC,eAAe,CAAC,uBAAuB,CAAC,CAAC,GAAG,uBAAuB,EAC3G,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,OAAO,CAAC,UAAU,CAAoC;IAEhD,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC3D,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IAYpE,YAAY,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAKvD"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var src_exports = {};
|
|
22
|
+
__export(src_exports, {
|
|
23
|
+
AbstractBlockchainWitness: () => AbstractBlockchainWitness,
|
|
24
|
+
BlockchainAddressSchema: () => BlockchainAddressSchema,
|
|
25
|
+
EvmWitnessConfigSchema: () => EvmWitnessConfigSchema,
|
|
26
|
+
checkIpfsUrl: () => checkIpfsUrl,
|
|
27
|
+
getProviderFromEnv: () => getProviderFromEnv,
|
|
28
|
+
getProvidersFromEnv: () => getProvidersFromEnv,
|
|
29
|
+
getSharedProviderFromEnv: () => getSharedProviderFromEnv
|
|
30
|
+
});
|
|
31
|
+
module.exports = __toCommonJS(src_exports);
|
|
32
|
+
|
|
33
|
+
// src/lib/checkIpfsUrl.ts
|
|
34
|
+
var import_assert = require("@xylabs/assert");
|
|
35
|
+
var allowIpfsIoRepair = true;
|
|
36
|
+
var checkIpfsUrl = (urlToCheck, ipfsGateway) => {
|
|
37
|
+
try {
|
|
38
|
+
const url = new URL(urlToCheck);
|
|
39
|
+
let protocol = url.protocol;
|
|
40
|
+
let host = url.host;
|
|
41
|
+
let path = url.pathname;
|
|
42
|
+
const query = url.search;
|
|
43
|
+
if (protocol === "ipfs:") {
|
|
44
|
+
protocol = "https:";
|
|
45
|
+
host = (0, import_assert.assertEx)(ipfsGateway, "No ipfsGateway provided");
|
|
46
|
+
path = url.host === "ipfs" ? `ipfs${path}` : `ipfs/${url.host}${path}`;
|
|
47
|
+
const root = `${protocol}//${host}/${path}`;
|
|
48
|
+
return query?.length > 0 ? `${root}?${query}` : root;
|
|
49
|
+
} else if (allowIpfsIoRepair && protocol === "https" && host === "ipfs.io") {
|
|
50
|
+
protocol = "https:";
|
|
51
|
+
host = (0, import_assert.assertEx)(ipfsGateway, "No ipfsGateway provided");
|
|
52
|
+
const pathParts = path.split("/");
|
|
53
|
+
if (pathParts[0] === "ipfs") {
|
|
54
|
+
pathParts.shift();
|
|
55
|
+
}
|
|
56
|
+
path = pathParts.join("/");
|
|
57
|
+
const root = `${protocol}//${host}/${path}`;
|
|
58
|
+
return query?.length > 0 ? `${root}?${query}` : root;
|
|
59
|
+
} else {
|
|
60
|
+
return urlToCheck;
|
|
61
|
+
}
|
|
62
|
+
} catch {
|
|
63
|
+
return urlToCheck;
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
// src/lib/getProviderFromEnv.ts
|
|
68
|
+
var import_assert2 = require("@xylabs/assert");
|
|
69
|
+
var import_ethers = require("ethers");
|
|
70
|
+
var createInfuraRpc = (chainId) => {
|
|
71
|
+
const provider = process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new import_ethers.InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
|
|
72
|
+
return provider;
|
|
73
|
+
};
|
|
74
|
+
var createInfuraWss = (chainId) => {
|
|
75
|
+
const provider = process.env.INFURA_PROJECT_ID ? new import_ethers.InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
|
|
76
|
+
return provider;
|
|
77
|
+
};
|
|
78
|
+
var createQuicknodeWss = (chainId) => {
|
|
79
|
+
const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI;
|
|
80
|
+
const provider = quickNodeWSSUri ? new import_ethers.WebSocketProvider(quickNodeWSSUri, chainId) : void 0;
|
|
81
|
+
return provider;
|
|
82
|
+
};
|
|
83
|
+
var createQuicknodeRpc = (chainId) => {
|
|
84
|
+
const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI;
|
|
85
|
+
const provider = quickNodeHttpsUri ? new import_ethers.JsonRpcProvider(quickNodeHttpsUri, chainId) : void 0;
|
|
86
|
+
return provider;
|
|
87
|
+
};
|
|
88
|
+
var getProviderFromEnv = (chainId = 1, { providerSource = "infura", providerType = "rpc" } = {}) => {
|
|
89
|
+
let provider = void 0;
|
|
90
|
+
switch (providerSource) {
|
|
91
|
+
case "quicknode": {
|
|
92
|
+
switch (providerType) {
|
|
93
|
+
case "rpc": {
|
|
94
|
+
provider = createQuicknodeRpc(chainId);
|
|
95
|
+
break;
|
|
96
|
+
}
|
|
97
|
+
case "wss": {
|
|
98
|
+
provider = createQuicknodeWss(chainId);
|
|
99
|
+
break;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
break;
|
|
103
|
+
}
|
|
104
|
+
default:
|
|
105
|
+
case "infura": {
|
|
106
|
+
switch (providerType) {
|
|
107
|
+
case "wss": {
|
|
108
|
+
provider = createInfuraWss(chainId);
|
|
109
|
+
break;
|
|
110
|
+
}
|
|
111
|
+
case "rpc": {
|
|
112
|
+
provider = createInfuraRpc(chainId);
|
|
113
|
+
break;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
break;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
if (!provider) {
|
|
120
|
+
provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId);
|
|
121
|
+
}
|
|
122
|
+
return (0, import_assert2.assertEx)(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`);
|
|
123
|
+
};
|
|
124
|
+
var providers = {};
|
|
125
|
+
var getSharedProviderFromEnv = (chainId = 1, options) => {
|
|
126
|
+
const key = `${chainId}:${options ? JSON.stringify(options) : "default"}`;
|
|
127
|
+
providers[key] = providers[key] ?? getProviderFromEnv(chainId, options);
|
|
128
|
+
return providers[key];
|
|
129
|
+
};
|
|
130
|
+
var getProvidersFromEnv = (count = 1, chainId = 1, options = {}) => {
|
|
131
|
+
const result = [];
|
|
132
|
+
for (let i = 0; i < count; i++) {
|
|
133
|
+
result.push(getProviderFromEnv(chainId, options));
|
|
134
|
+
}
|
|
135
|
+
return result;
|
|
136
|
+
};
|
|
137
|
+
|
|
138
|
+
// src/model.ts
|
|
139
|
+
var BlockchainAddressSchema = "network.xyo.blockchain.address";
|
|
140
|
+
|
|
141
|
+
// src/Witness.ts
|
|
142
|
+
var import_abstract_witness = require("@xyo-network/abstract-witness");
|
|
143
|
+
var EvmWitnessConfigSchema = "network.xyo.evm.witness";
|
|
144
|
+
var AbstractBlockchainWitness = class extends import_abstract_witness.AbstractWitness {
|
|
145
|
+
_providers = void 0;
|
|
146
|
+
async getProvider(cache = false, error) {
|
|
147
|
+
const providers2 = await this.getProviders(cache);
|
|
148
|
+
if (providers2.length === 0) {
|
|
149
|
+
if (error) {
|
|
150
|
+
throw new Error(typeof error === "string" ? error : "No providers available");
|
|
151
|
+
}
|
|
152
|
+
return void 0;
|
|
153
|
+
}
|
|
154
|
+
return providers2[Date.now() % providers2.length];
|
|
155
|
+
}
|
|
156
|
+
async getProviders(cache = false) {
|
|
157
|
+
const cachedProviders = cache ? this._providers : void 0;
|
|
158
|
+
this._providers = cachedProviders ?? await this.params.providers();
|
|
159
|
+
return this._providers;
|
|
160
|
+
}
|
|
161
|
+
};
|
|
162
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts","../../src/lib/checkIpfsUrl.ts","../../src/lib/getProviderFromEnv.ts","../../src/model.ts","../../src/Witness.ts"],"sourcesContent":["export * from './lib'\nexport * from './model'\nexport * from './Witness'\n","import { assertEx } from '@xylabs/assert'\n\nconst allowIpfsIoRepair = true\n\n/**\n * Returns the equivalent IPFS gateway URL for the supplied URL.\n * @param urlToCheck The URL to check\n * @returns If the supplied URL is an IPFS URL, it converts the URL to the\n * equivalent IPFS gateway URL. Otherwise, returns the original URL.\n */\nexport const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {\n try {\n const url = new URL(urlToCheck)\n let protocol = url.protocol\n let host = url.host\n let path = url.pathname\n const query = url.search\n if (protocol === 'ipfs:') {\n protocol = 'https:'\n host = assertEx(ipfsGateway, 'No ipfsGateway provided')\n path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`\n const root = `${protocol}//${host}/${path}`\n return query?.length > 0 ? `${root}?${query}` : root\n } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {\n protocol = 'https:'\n host = assertEx(ipfsGateway, 'No ipfsGateway provided')\n const pathParts = path.split('/')\n if (pathParts[0] === 'ipfs') {\n pathParts.shift()\n }\n path = pathParts.join('/')\n const root = `${protocol}//${host}/${path}`\n return query?.length > 0 ? `${root}?${query}` : root\n } else {\n return urlToCheck\n }\n } catch {\n //const error = ex as Error\n //console.error(`${error.name}:${error.message} [${urlToCheck}]`)\n //console.log(error.stack)\n return urlToCheck\n }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider, Provider, WebSocketProvider } from 'ethers'\n\nexport type ProviderSource = 'infura' | 'quicknode'\nexport type ProviderType = 'rpc' | 'wss'\n\nexport interface GetProvidersFromEnvOptions {\n providerSource?: ProviderSource\n providerType?: ProviderType\n}\n\nconst createInfuraRpc = (chainId: number) => {\n const provider =\n process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined\n return provider\n}\n\nconst createInfuraWss = (chainId: number) => {\n const provider = process.env.INFURA_PROJECT_ID ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined\n return provider\n}\n\nconst createQuicknodeWss = (chainId: number) => {\n const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI\n const provider = quickNodeWSSUri ? new WebSocketProvider(quickNodeWSSUri, chainId) : undefined\n\n return provider\n}\n\nconst createQuicknodeRpc = (chainId: number) => {\n const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI\n const provider = quickNodeHttpsUri ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : undefined\n return provider\n}\n\nexport const getProviderFromEnv = (\n chainId: number = 0x01,\n { providerSource = 'infura', providerType = 'rpc' }: GetProvidersFromEnvOptions = {},\n): Provider => {\n let provider: Provider | undefined = undefined\n switch (providerSource) {\n case 'quicknode': {\n switch (providerType) {\n case 'rpc': {\n provider = createQuicknodeRpc(chainId)\n break\n }\n case 'wss': {\n provider = createQuicknodeWss(chainId)\n break\n }\n }\n break\n }\n default:\n case 'infura': {\n switch (providerType) {\n case 'wss': {\n provider = createInfuraWss(chainId)\n break\n }\n case 'rpc': {\n provider = createInfuraRpc(chainId)\n break\n }\n }\n break\n }\n }\n if (!provider) {\n provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId)\n }\n return assertEx(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`)\n}\n\nconst providers: Record<string, Provider> = {}\n\nexport const getSharedProviderFromEnv = (\n chainId: number = 0x01,\n options?: { providerSource?: ProviderSource; providerType?: ProviderType },\n): Provider => {\n const key = `${chainId}:${options ? JSON.stringify(options) : 'default'}`\n providers[key] = providers[key] ?? getProviderFromEnv(chainId, options)\n return providers[key]\n}\n\nexport const getProvidersFromEnv = (count: number = 1, chainId: number = 0x01, options: GetProvidersFromEnvOptions = {}): Provider[] => {\n const result: Provider[] = []\n for (let i = 0; i < count; i++) {\n result.push(getProviderFromEnv(chainId, options))\n }\n return result\n}\n","import { Payload } from '@xyo-network/payload-model'\n\nexport const BlockchainAddressSchema = 'network.xyo.blockchain.address'\nexport type BlockchainAddressSchema = typeof BlockchainAddressSchema\n\nexport type BlockchainAddress = Payload<\n {\n address?: string\n blockTag?: string | number\n chainId?: number\n },\n BlockchainAddressSchema\n>\n","import { Promisable } from '@xylabs/promise'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { EmptyObject, WithAdditional } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\nimport { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model'\nimport { Provider } from 'ethers'\n\nexport const EvmWitnessConfigSchema = 'network.xyo.evm.witness'\nexport type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema\n\nexport type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<\n TAdditional,\n TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema\n>\n\nexport type AdditionalBlockchainWitnessParams = {\n providers: Provider[]\n}\n\nexport type BlockchainWitnessParams<\n TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig,\n TAdditionalParams extends EmptyObject | void = void,\n> = WitnessParams<\n TConfig,\n WithAdditional<\n {\n providers: () => Promisable<Provider[]>\n },\n TAdditionalParams\n >\n>\n\nexport abstract class AbstractBlockchainWitness<\n TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams,\n TIn extends Payload = Payload,\n TOut extends Payload = Payload,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<\n WitnessInstance<TParams, TIn, TOut>,\n TIn,\n TOut\n >,\n> extends AbstractWitness<TParams, TIn, TOut, TEventData> {\n private _providers: Provider[] | undefined = undefined\n\n async getProvider(cache?: boolean): Promise<Provider | undefined>\n async getProvider(cache: boolean, error: string | true): Promise<Provider>\n async getProvider(cache = false, error?: string | boolean): Promise<Provider | undefined> {\n const providers = await this.getProviders(cache)\n if (providers.length === 0) {\n if (error) {\n throw new Error(typeof error === 'string' ? error : 'No providers available')\n }\n return undefined\n }\n return providers[Date.now() % providers.length] //pick a random provider\n }\n\n async getProviders(cache = false): Promise<Provider[]> {\n const cachedProviders = cache ? this._providers : undefined\n this._providers = cachedProviders ?? (await this.params.providers())\n return this._providers\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAyB;AAEzB,IAAM,oBAAoB;AAQnB,IAAM,eAAe,CAAC,YAAoB,gBAAiC;AAChF,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,UAAU;AAC9B,QAAI,WAAW,IAAI;AACnB,QAAI,OAAO,IAAI;AACf,QAAI,OAAO,IAAI;AACf,UAAM,QAAQ,IAAI;AAClB,QAAI,aAAa,SAAS;AACxB,iBAAW;AACX,iBAAO,wBAAS,aAAa,yBAAyB;AACtD,aAAO,IAAI,SAAS,SAAS,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI;AACpE,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,aAAO,OAAO,SAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,WAAW,qBAAqB,aAAa,WAAW,SAAS,WAAW;AAC1E,iBAAW;AACX,iBAAO,wBAAS,aAAa,yBAAyB;AACtD,YAAM,YAAY,KAAK,MAAM,GAAG;AAChC,UAAI,UAAU,CAAC,MAAM,QAAQ;AAC3B,kBAAU,MAAM;AAAA,MAClB;AACA,aAAO,UAAU,KAAK,GAAG;AACzB,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,aAAO,OAAO,SAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,QAAQ;AAIN,WAAO;AAAA,EACT;AACF;;;AC1CA,IAAAA,iBAAyB;AACzB,oBAAsG;AAUtG,IAAM,kBAAkB,CAAC,YAAoB;AAC3C,QAAM,WACJ,QAAQ,IAAI,qBAAqB,QAAQ,IAAI,wBAAwB,IAAI,6BAAe,SAAS,QAAQ,IAAI,iBAAiB,IAAI;AACpI,SAAO;AACT;AAEA,IAAM,kBAAkB,CAAC,YAAoB;AAC3C,QAAM,WAAW,QAAQ,IAAI,oBAAoB,IAAI,sCAAwB,SAAS,QAAQ,IAAI,iBAAiB,IAAI;AACvH,SAAO;AACT;AAEA,IAAM,qBAAqB,CAAC,YAAoB;AAC9C,QAAM,kBAAkB,QAAQ,IAAI;AACpC,QAAM,WAAW,kBAAkB,IAAI,gCAAkB,iBAAiB,OAAO,IAAI;AAErF,SAAO;AACT;AAEA,IAAM,qBAAqB,CAAC,YAAoB;AAC9C,QAAM,oBAAoB,QAAQ,IAAI;AACtC,QAAM,WAAW,oBAAoB,IAAI,8BAAgB,mBAAmB,OAAO,IAAI;AACvF,SAAO;AACT;AAEO,IAAM,qBAAqB,CAChC,UAAkB,GAClB,EAAE,iBAAiB,UAAU,eAAe,MAAM,IAAgC,CAAC,MACtE;AACb,MAAI,WAAiC;AACrC,UAAQ,gBAAgB;AAAA,IACtB,KAAK,aAAa;AAChB,cAAQ,cAAc;AAAA,QACpB,KAAK,OAAO;AACV,qBAAW,mBAAmB,OAAO;AACrC;AAAA,QACF;AAAA,QACA,KAAK,OAAO;AACV,qBAAW,mBAAmB,OAAO;AACrC;AAAA,QACF;AAAA,MACF;AACA;AAAA,IACF;AAAA,IACA;AAAA,IACA,KAAK,UAAU;AACb,cAAQ,cAAc;AAAA,QACpB,KAAK,OAAO;AACV,qBAAW,gBAAgB,OAAO;AAClC;AAAA,QACF;AAAA,QACA,KAAK,OAAO;AACV,qBAAW,gBAAgB,OAAO;AAClC;AAAA,QACF;AAAA,MACF;AACA;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,UAAU;AACb,eAAW,gBAAgB,OAAO,KAAK,gBAAgB,OAAO,KAAK,mBAAmB,OAAO;AAAA,EAC/F;AACA,aAAO,yBAAS,UAAU,8BAA8B,OAAO,MAAM,cAAc,IAAI,YAAY,EAAE;AACvG;AAEA,IAAM,YAAsC,CAAC;AAEtC,IAAM,2BAA2B,CACtC,UAAkB,GAClB,YACa;AACb,QAAM,MAAM,GAAG,OAAO,IAAI,UAAU,KAAK,UAAU,OAAO,IAAI,SAAS;AACvE,YAAU,GAAG,IAAI,UAAU,GAAG,KAAK,mBAAmB,SAAS,OAAO;AACtE,SAAO,UAAU,GAAG;AACtB;AAEO,IAAM,sBAAsB,CAAC,QAAgB,GAAG,UAAkB,GAAM,UAAsC,CAAC,MAAkB;AACtI,QAAM,SAAqB,CAAC;AAC5B,WAAS,IAAI,GAAG,IAAI,OAAO,KAAK;AAC9B,WAAO,KAAK,mBAAmB,SAAS,OAAO,CAAC;AAAA,EAClD;AACA,SAAO;AACT;;;AC1FO,IAAM,0BAA0B;;;ACDvC,8BAAgC;AAOzB,IAAM,yBAAyB;AAyB/B,IAAe,4BAAf,cASG,wCAAgD;AAAA,EAChD,aAAqC;AAAA,EAI7C,MAAM,YAAY,QAAQ,OAAO,OAAyD;AACxF,UAAMC,aAAY,MAAM,KAAK,aAAa,KAAK;AAC/C,QAAIA,WAAU,WAAW,GAAG;AAC1B,UAAI,OAAO;AACT,cAAM,IAAI,MAAM,OAAO,UAAU,WAAW,QAAQ,wBAAwB;AAAA,MAC9E;AACA,aAAO;AAAA,IACT;AACA,WAAOA,WAAU,KAAK,IAAI,IAAIA,WAAU,MAAM;AAAA,EAChD;AAAA,EAEA,MAAM,aAAa,QAAQ,OAA4B;AACrD,UAAM,kBAAkB,QAAQ,KAAK,aAAa;AAClD,SAAK,aAAa,mBAAoB,MAAM,KAAK,OAAO,UAAU;AAClE,WAAO,KAAK;AAAA,EACd;AACF;","names":["import_assert","providers"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA"}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
// src/lib/checkIpfsUrl.ts
|
|
2
|
+
import { assertEx } from "@xylabs/assert";
|
|
3
|
+
var allowIpfsIoRepair = true;
|
|
4
|
+
var checkIpfsUrl = (urlToCheck, ipfsGateway) => {
|
|
5
|
+
try {
|
|
6
|
+
const url = new URL(urlToCheck);
|
|
7
|
+
let protocol = url.protocol;
|
|
8
|
+
let host = url.host;
|
|
9
|
+
let path = url.pathname;
|
|
10
|
+
const query = url.search;
|
|
11
|
+
if (protocol === "ipfs:") {
|
|
12
|
+
protocol = "https:";
|
|
13
|
+
host = assertEx(ipfsGateway, "No ipfsGateway provided");
|
|
14
|
+
path = url.host === "ipfs" ? `ipfs${path}` : `ipfs/${url.host}${path}`;
|
|
15
|
+
const root = `${protocol}//${host}/${path}`;
|
|
16
|
+
return query?.length > 0 ? `${root}?${query}` : root;
|
|
17
|
+
} else if (allowIpfsIoRepair && protocol === "https" && host === "ipfs.io") {
|
|
18
|
+
protocol = "https:";
|
|
19
|
+
host = assertEx(ipfsGateway, "No ipfsGateway provided");
|
|
20
|
+
const pathParts = path.split("/");
|
|
21
|
+
if (pathParts[0] === "ipfs") {
|
|
22
|
+
pathParts.shift();
|
|
23
|
+
}
|
|
24
|
+
path = pathParts.join("/");
|
|
25
|
+
const root = `${protocol}//${host}/${path}`;
|
|
26
|
+
return query?.length > 0 ? `${root}?${query}` : root;
|
|
27
|
+
} else {
|
|
28
|
+
return urlToCheck;
|
|
29
|
+
}
|
|
30
|
+
} catch {
|
|
31
|
+
return urlToCheck;
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
// src/lib/getProviderFromEnv.ts
|
|
36
|
+
import { assertEx as assertEx2 } from "@xylabs/assert";
|
|
37
|
+
import { InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider, WebSocketProvider } from "ethers";
|
|
38
|
+
var createInfuraRpc = (chainId) => {
|
|
39
|
+
const provider = process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
|
|
40
|
+
return provider;
|
|
41
|
+
};
|
|
42
|
+
var createInfuraWss = (chainId) => {
|
|
43
|
+
const provider = process.env.INFURA_PROJECT_ID ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
|
|
44
|
+
return provider;
|
|
45
|
+
};
|
|
46
|
+
var createQuicknodeWss = (chainId) => {
|
|
47
|
+
const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI;
|
|
48
|
+
const provider = quickNodeWSSUri ? new WebSocketProvider(quickNodeWSSUri, chainId) : void 0;
|
|
49
|
+
return provider;
|
|
50
|
+
};
|
|
51
|
+
var createQuicknodeRpc = (chainId) => {
|
|
52
|
+
const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI;
|
|
53
|
+
const provider = quickNodeHttpsUri ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : void 0;
|
|
54
|
+
return provider;
|
|
55
|
+
};
|
|
56
|
+
var getProviderFromEnv = (chainId = 1, { providerSource = "infura", providerType = "rpc" } = {}) => {
|
|
57
|
+
let provider = void 0;
|
|
58
|
+
switch (providerSource) {
|
|
59
|
+
case "quicknode": {
|
|
60
|
+
switch (providerType) {
|
|
61
|
+
case "rpc": {
|
|
62
|
+
provider = createQuicknodeRpc(chainId);
|
|
63
|
+
break;
|
|
64
|
+
}
|
|
65
|
+
case "wss": {
|
|
66
|
+
provider = createQuicknodeWss(chainId);
|
|
67
|
+
break;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
break;
|
|
71
|
+
}
|
|
72
|
+
default:
|
|
73
|
+
case "infura": {
|
|
74
|
+
switch (providerType) {
|
|
75
|
+
case "wss": {
|
|
76
|
+
provider = createInfuraWss(chainId);
|
|
77
|
+
break;
|
|
78
|
+
}
|
|
79
|
+
case "rpc": {
|
|
80
|
+
provider = createInfuraRpc(chainId);
|
|
81
|
+
break;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
break;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
if (!provider) {
|
|
88
|
+
provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId);
|
|
89
|
+
}
|
|
90
|
+
return assertEx2(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`);
|
|
91
|
+
};
|
|
92
|
+
var providers = {};
|
|
93
|
+
var getSharedProviderFromEnv = (chainId = 1, options) => {
|
|
94
|
+
const key = `${chainId}:${options ? JSON.stringify(options) : "default"}`;
|
|
95
|
+
providers[key] = providers[key] ?? getProviderFromEnv(chainId, options);
|
|
96
|
+
return providers[key];
|
|
97
|
+
};
|
|
98
|
+
var getProvidersFromEnv = (count = 1, chainId = 1, options = {}) => {
|
|
99
|
+
const result = [];
|
|
100
|
+
for (let i = 0; i < count; i++) {
|
|
101
|
+
result.push(getProviderFromEnv(chainId, options));
|
|
102
|
+
}
|
|
103
|
+
return result;
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
// src/model.ts
|
|
107
|
+
var BlockchainAddressSchema = "network.xyo.blockchain.address";
|
|
108
|
+
|
|
109
|
+
// src/Witness.ts
|
|
110
|
+
import { AbstractWitness } from "@xyo-network/abstract-witness";
|
|
111
|
+
var EvmWitnessConfigSchema = "network.xyo.evm.witness";
|
|
112
|
+
var AbstractBlockchainWitness = class extends AbstractWitness {
|
|
113
|
+
_providers = void 0;
|
|
114
|
+
async getProvider(cache = false, error) {
|
|
115
|
+
const providers2 = await this.getProviders(cache);
|
|
116
|
+
if (providers2.length === 0) {
|
|
117
|
+
if (error) {
|
|
118
|
+
throw new Error(typeof error === "string" ? error : "No providers available");
|
|
119
|
+
}
|
|
120
|
+
return void 0;
|
|
121
|
+
}
|
|
122
|
+
return providers2[Date.now() % providers2.length];
|
|
123
|
+
}
|
|
124
|
+
async getProviders(cache = false) {
|
|
125
|
+
const cachedProviders = cache ? this._providers : void 0;
|
|
126
|
+
this._providers = cachedProviders ?? await this.params.providers();
|
|
127
|
+
return this._providers;
|
|
128
|
+
}
|
|
129
|
+
};
|
|
130
|
+
export {
|
|
131
|
+
AbstractBlockchainWitness,
|
|
132
|
+
BlockchainAddressSchema,
|
|
133
|
+
EvmWitnessConfigSchema,
|
|
134
|
+
checkIpfsUrl,
|
|
135
|
+
getProviderFromEnv,
|
|
136
|
+
getProvidersFromEnv,
|
|
137
|
+
getSharedProviderFromEnv
|
|
138
|
+
};
|
|
139
|
+
//# sourceMappingURL=index.js.map
|