forked from phantom/synpress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
helpers.js
276 lines (261 loc) · 8.55 KB
/
helpers.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
const log = require('debug')('synpress:helpers');
const axios = require('axios');
const fs = require('fs').promises;
const path = require('path');
const { ethers } = require('ethers');
const download = require('download');
const packageJson = require('./package.json');
const chains = require('viem/chains');
const appRoot = require('app-root-path');
const os = require('os');
const unzipCrx = require('unzip-crx-3');
let currentNetwork = chains.mainnet;
// list of added networks to metamask
let addedNetworks = [chains.mainnet, chains.goerli, chains.sepolia];
module.exports = {
async resetState() {
log('Resetting state of helpers');
currentNetwork = chains.mainnet;
addedNetworks = [chains.mainnet, chains.goerli, chains.sepolia];
},
// set currently active network
async setNetwork(network) {
log('Setting network to', network);
currentNetwork = network;
},
// find network in presets
async findNetwork(network) {
if (typeof network === 'object') {
network = network.name || network.network;
}
network = network.toLowerCase();
log('[findNetwork] Trying to find following network', network);
let chain;
for (const [key, value] of Object.entries(chains)) {
const { name, network: chainNetwork } = value;
const lcName = name ? name.toLowerCase() : undefined;
const lcChainNetwork = chainNetwork
? chainNetwork.toLowerCase()
: undefined;
if (lcName === network || lcChainNetwork === network) {
chain = chains[key];
break;
} else if (key.toLowerCase() === network) {
chain = chains[key];
break;
}
}
if (!chain) {
throw new Error(
`[setNetwork] Provided chain was not found.\nFor list of available chains, check: https://github.com/wagmi-dev/references/tree/main/packages/chains#chains`,
);
}
if (
chain.network === 'localhost' ||
chain.network === 'foundry' ||
chain.network === 'hardhat'
) {
// todo: ip+port rpcUrls
const provider = new ethers.JsonRpcProvider(
chain.rpcUrls.default.http[0],
);
await provider.getNetwork().then(result => {
chain.id = Number(result.chainId);
chain.forkedFrom = result.name;
});
}
return chain;
},
// get currently active network
getCurrentNetwork() {
log('[getCurrentNetwork] Current network data', currentNetwork);
return currentNetwork;
},
// add new network to presets and list of metamask networks
async addNetwork(newNetwork) {
if (!newNetwork.network) {
newNetwork.network = newNetwork.name.toLowerCase().replace(' ', '-');
}
log(`[addNetwork] Adding new network: ${newNetwork}`);
chains[newNetwork.network] = newNetwork;
addedNetworks.push(newNetwork);
},
// check if network is already added to metamask
async checkNetworkAdded(network) {
log('[checkNetworkAdded] Checking if network is already added', network);
if (addedNetworks.includes(network)) {
log(`[checkNetworkAdded] Network is present`);
return true;
} else {
log(`[checkNetworkAdded] Network doesn't exist`);
return false;
}
},
getSynpressPath() {
if (process.env.SYNPRESS_LOCAL_TEST) {
return '.';
} else {
return path.dirname(require.resolve(packageJson.name));
}
},
async createDirIfNotExist(path) {
try {
log(`Checking if directory exists on path: ${path}`);
await fs.access(path);
return true;
} catch (e) {
if (e.code === 'ENOENT') {
log(`Creating directory as it doesn't exist..`);
await fs.mkdir(path);
return true;
}
throw new Error(
`[createDirIfNotExist] Unhandled error from fs.access() with following error:\n${e}`,
);
}
},
async checkDirOrFileExist(path) {
try {
log(`Checking if directory exists on path: ${path}`);
await fs.access(path);
return true;
} catch (e) {
if (e.code === 'ENOENT') {
log(`Directory or file doesn't exist`);
return false;
}
throw new Error(
`[checkDirOrFileExist] Unhandled error from fs.access() with following error:\n${e}`,
);
}
},
async getMetamaskReleases(version) {
log(`Trying to find metamask version ${version} in GitHub releases..`);
let filename;
let downloadUrl;
let tagName;
let response;
try {
if (version === 'latest' || !version) {
if (process.env.GH_USERNAME && process.env.GH_PAT) {
response = await axios.get(
'https://api.github.com/repos/metamask/metamask-extension/releases',
{
auth: {
username: process.env.GH_USERNAME,
password: process.env.GH_PAT,
},
},
);
} else {
response = await axios.get(
'https://api.github.com/repos/metamask/metamask-extension/releases',
);
}
filename = response.data[0].assets[0].name;
downloadUrl = response.data[0].assets[0].browser_download_url;
tagName = response.data[0].tag_name;
log(
`Metamask version found! Filename: ${filename}; Download url: ${downloadUrl}; Tag name: ${tagName}`,
);
} else if (version) {
filename = `metamask-chrome-${version}.zip`;
downloadUrl = `https://github.com/MetaMask/metamask-extension/releases/download/v${version}/metamask-chrome-${version}.zip`;
tagName = `metamask-chrome-${version}`;
log(
`Metamask version found! Filename: ${filename}; Download url: ${downloadUrl}; Tag name: ${tagName}`,
);
}
return {
filename,
downloadUrl,
tagName,
};
} catch (e) {
if (e.response && e.response.status === 403) {
throw new Error(
`[getMetamaskReleases] Unable to fetch metamask releases from GitHub because you've been rate limited! Please set GH_USERNAME and GH_PAT environment variables to avoid this issue or retry again.`,
);
}
throw new Error(
`[getMetamaskReleases] Unable to fetch metamask releases from GitHub with following error:\n${e}`,
);
}
},
getPhantomReleases: async () => {
const PHANTOM_URL = 'https://crx-backup.phantom.dev/latest.crx';
return {
filename: 'phantom-chrome-latest',
downloadUrl: PHANTOM_URL,
tagName: 'phantom-chrome-latest',
};
},
download: async (provider, url, destination) => {
try {
log(
`Trying to download and extract file from: ${url} to following path: ${destination}`,
);
if (provider === 'phantom') {
await download(url, destination, {
headers: {
Accept: 'application/octet-stream',
},
});
await unzipCrx(`${destination}/latest.crx`, destination);
return;
}
if (process.env.GH_USERNAME && process.env.GH_PAT) {
await download(url, destination, {
extract: true,
auth: `${process.env.GH_USERNAME}:${process.env.GH_PAT}`,
headers: {
Accept: 'application/octet-stream',
},
});
} else {
await download(url, destination, {
extract: true,
});
}
} catch (e) {
throw new Error(
`[download] Unable to download provider release from: ${url} to: ${destination} with following error:\n${e}`,
);
}
},
prepareProvider: async (provider, version) => {
const release =
provider === 'phantom'
? await module.exports.getPhantomReleases(version)
: await module.exports.getMetamaskReleases(version);
let downloadsDirectory;
if (os.platform() === 'win32') {
downloadsDirectory = appRoot.resolve('/node_modules');
} else {
downloadsDirectory = path.resolve(__dirname, 'downloads');
}
await module.exports.createDirIfNotExist(downloadsDirectory);
const providerDirectory = path.join(downloadsDirectory, release.tagName);
const providerkDirectoryExists = await module.exports.checkDirOrFileExist(
providerDirectory,
);
const providerManifestFilePath = path.join(
downloadsDirectory,
release.tagName,
'manifest.json',
);
const providerManifestFileExists = await module.exports.checkDirOrFileExist(
providerManifestFilePath,
);
if (!providerkDirectoryExists && !providerManifestFileExists) {
await module.exports.download(
provider,
release.downloadUrl,
providerDirectory,
);
} else {
log('provider is already downloaded');
}
return providerDirectory;
},
};