Deprecate use of polling provider #105
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -4,82 +4,63 @@ import { | |
| LoadProviderResponse, | ||
| NETWORK_CONFIG, | ||
| NetworkName, | ||
| ProviderJson, | ||
| TXIDVersion, | ||
| createProviderFromJsonConfig, | ||
| isDefined, | ||
| } from '@railgun-community/shared-models'; | ||
| import { sendMessage } from '../../../utils'; | ||
| import { reportAndSanitizeError } from '../../../utils/error'; | ||
| import { WalletPOI } from '../../poi/wallet-poi'; | ||
| import { getEngine } from './engine'; | ||
| import { | ||
| RailgunVersionedSmartContracts, | ||
| } from '@railgun-community/engine'; | ||
| import { type Provider} from 'ethers' | ||
| import { | ||
| providerMap, | ||
| setProviderForNetwork, | ||
| } from './providers'; | ||
| import { WalletPOINodeInterface } from '../../poi/wallet-poi-node-interface'; | ||
|
|
||
| const createProviderForNetwork = async ( | ||
| networkName: NetworkName, | ||
| providerJsonConfig: FallbackProviderJsonConfig | ProviderJson, | ||
| pollingInterval?: number, | ||
| ): Promise<Provider> => { | ||
| const existingProvider = providerMap[networkName]; | ||
|
Contributor
There was a problem hiding this comment. It's throwing a lint error for me here |
||
| if (existingProvider) { | ||
| return existingProvider; | ||
| } | ||
| const provider = createProviderFromJsonConfig( | ||
| providerJsonConfig, | ||
| pollingInterval | ||
| ); | ||
| setProviderForNetwork(networkName, provider); | ||
| return provider; | ||
| }; | ||
|
|
||
| /** | ||
| * | ||
| * @param chain | ||
| * @param networkName | ||
| * @param fallbackProviderJsonConfig | ||
| * @param pollingInterval | ||
| */ | ||
| const loadProviderForNetwork = async ( | ||
| chain: Chain, | ||
| networkName: NetworkName, | ||
| providerJsonConfig: FallbackProviderJsonConfig | ProviderJson, | ||
| pollingInterval: number, | ||
|
Contributor
Author
There was a problem hiding this comment. It's already there if you are asking to ensure it has deprecated on it |
||
| ) => { | ||
| sendMessage(`Load provider for network: ${networkName}`); | ||
|
|
||
| // Create the provider from the JSON config | ||
| const provider = await createProviderForNetwork( | ||
| networkName, | ||
| providerJsonConfig, | ||
| pollingInterval, | ||
| ); | ||
|
|
||
| const network = NETWORK_CONFIG[networkName]; | ||
| const { | ||
|
|
@@ -125,8 +106,8 @@ const loadProviderForNetwork = async ( | |
| poseidonMerkleAccumulatorV3Contract, | ||
| poseidonMerkleVerifierV3Contract, | ||
| tokenVaultV3Contract, | ||
| provider, // Can be of type FallbackProvider, WebSocketProvider, or JsonRpcProvider | ||
| undefined, // pollingProvider is being deprecated | ||
|
There was a problem hiding this comment. Type error here. I do not think it's a breaking change to change the type to
Contributor
Author
There was a problem hiding this comment. Are you saying to remove the optional param and not pass undefined? Or just stating that it is okay It is part of the last commit to the relating engine PR Railgun-Community/engine@3e3f607 |
||
| deploymentBlocks, | ||
| poi?.launchBlock, | ||
| supportsV3, | ||
|
|
@@ -138,22 +119,25 @@ const loadProviderForNetwork = async ( | |
| * for new RAILGUN events (balance updates). | ||
| */ | ||
| export const loadProvider = async ( | ||
| providerJsonConfig: FallbackProviderJsonConfig | ProviderJson, | ||
| networkName: NetworkName, | ||
| /** | ||
| * @deprecated pollingInterval - Default ethers polling interval is used | ||
| */ | ||
| pollingInterval = 15000, | ||
| ): Promise<LoadProviderResponse> => { | ||
| try { | ||
| delete providerMap[networkName]; | ||
|
|
||
| const { chain, supportsV3 } = NETWORK_CONFIG[networkName]; | ||
| if ('chainId' in providerJsonConfig && providerJsonConfig.chainId !== chain.id) { | ||
| throw new Error('Invalid chain ID'); | ||
| } | ||
|
|
||
| await loadProviderForNetwork( | ||
| chain, | ||
| networkName, | ||
| providerJsonConfig, | ||
| pollingInterval, | ||
| ); | ||
| WalletPOINodeInterface.unpause(chain); | ||
|
|
@@ -197,23 +181,33 @@ export const unloadProvider = async ( | |
| networkName: NetworkName, | ||
| ): Promise<void> => { | ||
| WalletPOINodeInterface.pause(NETWORK_CONFIG[networkName].chain); | ||
| providerMap[networkName]?.destroy(); | ||
| delete providerMap[networkName]; | ||
| }; | ||
|
|
||
| export const pauseAllPollingProviders = ( | ||
| excludeNetworkName?: NetworkName, | ||
| ): void => { | ||
| Object.keys(providerMap).forEach(networkName => { | ||
| if (networkName === excludeNetworkName) { | ||
| return; | ||
| } | ||
| const provider = providerMap[networkName]; | ||
|
|
||
| // Check if provider exists | ||
| if (!isDefined(provider)) { | ||
| throw new Error(`No provider found for network: ${networkName}`); | ||
| } | ||
|
|
||
| // Ensure provider is a pausable provider | ||
| if (!('paused' in provider && 'pause' in provider)) { | ||
| throw new Error( | ||
| `Provider for network ${networkName} is not a pausable provider`, | ||
| ); | ||
| } | ||
|
|
||
| // Safe to call pause() after type check | ||
| (provider as { pause(): void }).pause(); | ||
| }); | ||
| }; | ||
|
|
||
|
|
@@ -223,11 +217,20 @@ export const resumeIsolatedPollingProviderForNetwork = ( | |
| pauseAllPollingProviders( | ||
| networkName, // excludeNetworkName | ||
|
Contributor
There was a problem hiding this comment. can we rename this to excludedNetworkName instead of just having it as a comment ? |
||
| ); | ||
| const provider = providerMap[networkName]; | ||
|
|
||
| // Check if provider exists | ||
| if (!isDefined(provider)) { | ||
| throw new Error(`No provider found for network: ${networkName}`); | ||
| } | ||
|
|
||
| // Ensure provider has resume functionality | ||
| if (!('paused' in provider && 'resume' in provider)) { | ||
|
Contributor
There was a problem hiding this comment. We could do a validateProvider function rather than having this statement twice, since the flow itself its pretty similar something like |
||
| throw new Error( | ||
| `Provider for network ${networkName} is not a pausable provider`, | ||
| ); | ||
| } | ||
|
|
||
| // Safe to call resume() after type check | ||
| (provider as { resume(): void }).resume(); | ||
| }; | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -1,42 +1,21 @@ | ||
| import { NetworkName, isDefined } from '@railgun-community/shared-models'; | ||
| import { Provider } from 'ethers'; | ||
|
|
||
| export const providerMap: MapType<Provider> = {}; | ||
|
|
||
| export const getProviderForNetwork = ( | ||
| networkName: NetworkName, | ||
| ): Provider => { | ||
| const provider = providerMap[networkName]; | ||
| if (!isDefined(provider)) { | ||
| throw new Error(`Provider not yet loaded for network ${networkName}`); | ||
| } | ||
| return provider; | ||
| }; | ||
|
|
||
| export const setProviderForNetwork = ( | ||
| networkName: NetworkName, | ||
| provider: Provider, | ||
| ): void => { | ||
| providerMap[networkName] = provider; | ||
| }; |
This file contains hidden or 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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we plan to remove this once the pr is approved right ?