-
Notifications
You must be signed in to change notification settings - Fork 409
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1107 from ethereum/staging
Quick Release
- Loading branch information
Showing
18 changed files
with
421 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| import { | ||
| FetchRequest, | ||
| JsonRpcProvider, | ||
| Network, | ||
| TransactionResponse, | ||
| getAddress, | ||
| } from 'ethers'; | ||
| import { Chain, SourcifyChainExtension } from './types'; | ||
| import { logInfo, logWarn } from './logger'; | ||
|
|
||
| const RPC_TIMEOUT = process.env.RPC_TIMEOUT | ||
| ? parseInt(process.env.RPC_TIMEOUT) | ||
| : 5000; | ||
|
|
||
| // It is impossible to get the url from the Provider for logging purposes | ||
| interface JsonRpcProviderWithUrl extends JsonRpcProvider { | ||
| url?: string; | ||
| } | ||
|
|
||
| // Need to define the rpc property explicitly as when a sourcifyChain is created with {...chain, sourcifyChainExtension}, Typescript throws with "Type '(string | FetchRequest)[]' is not assignable to type 'string[]'." For some reason the Chain.rpc is not getting overwritten by SourcifyChainExtension.rpc | ||
| export type SourcifyChainInstance = Omit<Chain, 'rpc'> & | ||
| Omit<SourcifyChainExtension, 'rpc'> & { rpc: Array<string | FetchRequest> }; | ||
|
|
||
| export default class SourcifyChain { | ||
| name: string; | ||
| title?: string | undefined; | ||
| chainId: number; | ||
| rpc: Array<string | FetchRequest>; | ||
| supported: boolean; | ||
| monitored: boolean; | ||
| contractFetchAddress?: string | undefined; | ||
| graphQLFetchAddress?: string | undefined; | ||
| txRegex?: string[] | undefined; | ||
| providers: JsonRpcProviderWithUrl[]; | ||
|
|
||
| constructor(sourcifyChainObj: SourcifyChainInstance) { | ||
| this.name = sourcifyChainObj.name; | ||
| this.title = sourcifyChainObj.title; | ||
| this.chainId = sourcifyChainObj.chainId; | ||
| this.rpc = sourcifyChainObj.rpc; | ||
| this.supported = sourcifyChainObj.supported; | ||
| this.monitored = sourcifyChainObj.monitored; | ||
| this.contractFetchAddress = sourcifyChainObj.contractFetchAddress; | ||
| this.graphQLFetchAddress = sourcifyChainObj.graphQLFetchAddress; | ||
| this.txRegex = sourcifyChainObj.txRegex; | ||
| this.providers = []; | ||
|
|
||
| if (!this.supported) return; // Don't create providers if chain is not supported | ||
|
|
||
| if (!this?.rpc.length) | ||
| throw new Error( | ||
| 'No RPC provider was given for this chain with id ' + | ||
| this.chainId + | ||
| ' and name ' + | ||
| this.name | ||
| ); | ||
|
|
||
| for (const rpc of this.rpc) { | ||
| let provider: JsonRpcProviderWithUrl | undefined; | ||
| const ethersNetwork = new Network(this.name, this.chainId); | ||
| if (typeof rpc === 'string') { | ||
| if (rpc.startsWith('http')) { | ||
| // Use staticNetwork to avoid sending unnecessary eth_chainId requests | ||
| provider = new JsonRpcProvider(rpc, ethersNetwork, { | ||
| staticNetwork: ethersNetwork, | ||
| }); | ||
| provider.url = rpc; | ||
| } else { | ||
| // Do not use WebSockets because of not being able to catch errors on websocket initialization. Most networks don't support WebSockets anyway. See https://github.com/ethers-io/ethers.js/discussions/2896 | ||
| // provider = new WebSocketProvider(rpc); | ||
| logInfo(`Won't create a WebSocketProvider for ${rpc}`); | ||
| } | ||
| } else { | ||
| provider = new JsonRpcProvider(rpc, ethersNetwork, { | ||
| staticNetwork: ethersNetwork, | ||
| }); | ||
| provider.url = rpc.url; | ||
| } | ||
| if (provider) { | ||
| this.providers.push(provider); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| rejectInMs = (ms: number, host?: string) => | ||
| new Promise<never>((_resolve, reject) => { | ||
| setTimeout(() => reject(`RPC ${host} took too long to respond`), ms); | ||
| }); | ||
|
|
||
| getTx = async (creatorTxHash: string) => { | ||
| // Try sequentially all providers | ||
| for (const provider of this.providers) { | ||
| try { | ||
| // Race the RPC call with a timeout | ||
| const tx = await Promise.race([ | ||
| provider.getTransaction(creatorTxHash), | ||
| this.rejectInMs(RPC_TIMEOUT, provider.url), | ||
| ]); | ||
| if (tx instanceof TransactionResponse) { | ||
| logInfo( | ||
| `Transaction ${creatorTxHash} fetched via ${provider.url} from chain ${this.chainId}` | ||
| ); | ||
| return tx; | ||
| } else { | ||
| throw new Error( | ||
| `Transaction ${creatorTxHash} not found on RPC ${provider.url} and chain ${this.chainId}` | ||
| ); | ||
| } | ||
| } catch (err) { | ||
| if (err instanceof Error) { | ||
| logWarn( | ||
| `Can't fetch the transaction ${creatorTxHash} from RPC ${provider.url} and chain ${this.chainId}\n ${err}` | ||
| ); | ||
| continue; | ||
| } else { | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
| throw new Error( | ||
| 'None of the RPCs responded fetching tx ' + | ||
| creatorTxHash + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * Fetches the contract's deployed bytecode from SourcifyChain's rpc's. | ||
| * Tries to fetch sequentially if the first RPC is a local eth node. Fetches in parallel otherwise. | ||
| * | ||
| * @param {SourcifyChain} sourcifyChain - chain object with rpc's | ||
| * @param {string} address - contract address | ||
| */ | ||
| getBytecode = async (address: string): Promise<string> => { | ||
| address = getAddress(address); | ||
|
|
||
| // Request sequentially. Custom node is always before ALCHEMY so we don't waste resources if succeeds. | ||
| for (const provider of this.providers) { | ||
| try { | ||
| // Race the RPC call with a timeout | ||
| const bytecode = await Promise.race([ | ||
| provider.getCode(address), | ||
| this.rejectInMs(RPC_TIMEOUT, provider.url), | ||
| ]); | ||
| logInfo( | ||
| 'Bytecode fetched from ' + | ||
| provider.url + | ||
| ' for ' + | ||
| address + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| return bytecode; | ||
| } catch (err) { | ||
| if (err instanceof Error) { | ||
| logWarn( | ||
| `Can't fetch bytecode from RPC ${provider.url} and chain ${this.chainId}` | ||
| ); | ||
| continue; | ||
| } else { | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
| throw new Error( | ||
| 'None of the RPCs responded fetching bytecode for ' + | ||
| address + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| }; | ||
|
|
||
| getBlock = async (blockNumber: number, preFetchTxs = true) => { | ||
| // Request sequentially. Custom node is always before ALCHEMY so we don't waste resources if succeeds. | ||
| for (const provider of this.providers) { | ||
| try { | ||
| // Race the RPC call with a timeout | ||
| const block = await Promise.race([ | ||
| provider.getBlock(blockNumber, preFetchTxs), | ||
| this.rejectInMs(RPC_TIMEOUT, provider.url), | ||
| ]); | ||
| logInfo( | ||
| 'Block fetched from ' + | ||
| provider.url + | ||
| ' for ' + | ||
| blockNumber + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| return block; | ||
| } catch (err) { | ||
| if (err instanceof Error) { | ||
| logWarn( | ||
| `Can't fetch block ${blockNumber} from RPC ${provider.url} and chain ${this.chainId}` | ||
| ); | ||
| continue; | ||
| } else { | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
| throw new Error( | ||
| 'None of the RPCs responded fetching block ' + | ||
| blockNumber + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| }; | ||
|
|
||
| getBlockNumber = async () => { | ||
| // Request sequentially. Custom node is always before ALCHEMY so we don't waste resources if succeeds. | ||
| for (const provider of this.providers) { | ||
| try { | ||
| // Race the RPC call with a timeout | ||
| const block = await Promise.race([ | ||
| provider.getBlockNumber(), | ||
| this.rejectInMs(RPC_TIMEOUT, provider.url), | ||
| ]); | ||
| logInfo( | ||
| 'Block number fetched from ' + | ||
| provider.url + | ||
| ' on chain ' + | ||
| this.chainId | ||
| ); | ||
| return block; | ||
| } catch (err) { | ||
| if (err instanceof Error) { | ||
| logWarn( | ||
| `Can't fetch the current block number from RPC ${provider.url} and chain ${this.chainId}` | ||
| ); | ||
| continue; | ||
| } else { | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
| throw new Error( | ||
| 'None of the RPCs responded fetching the blocknumber on chain ' + | ||
| this.chainId | ||
| ); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.