Skip to content

Deprecate use of polling provider #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jacobmakarsky wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Deprecate use of polling provider #105

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d43f658
deprecate use of polling provider
jacobmakarsky Jan 21, 2025
4ff6e52
deprecation comment updates
jacobmakarsky Jan 23, 2025
7c05beb
allow fallbackProvider, jsonRpcProvider or websocketprovider types fo…
jacobmakarsky Jan 25, 2025
0ac5673
engine patch until matching PR is merged
jacobmakarsky Jan 25, 2025
ac818ed
add patch-package to package.json postinstall script
jacobmakarsky Jan 25, 2025
c5ff86f
add patch-package package
jacobmakarsky Jan 25, 2025
c23d095
only check chainId param for fallbackProviderJsonConfig as providerJs…
jacobmakarsky Jan 25, 2025
9907a34
fix test in ensuring provider is setup properly against shared-models…
jacobmakarsky Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 17 additions & 37 deletions src/services/railgun/core/load-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,12 @@ import { reportAndSanitizeError } from '../../../utils/error';
import { WalletPOI } from '../../poi/wallet-poi';
import { getEngine } from './engine';
import {
PollingJsonRpcProvider,
RailgunVersionedSmartContracts,
createPollingJsonRpcProviderForListeners,
} from '@railgun-community/engine';
import { FallbackProvider } from 'ethers'
import {
fallbackProviderMap,
pollingProviderMap,
setFallbackProviderForNetwork,
setPollingProviderForNetwork,
} from './providers';
import { WalletPOINodeInterface } from '../../poi/wallet-poi-node-interface';

Expand All @@ -41,32 +37,20 @@ const createFallbackProviderForNetwork = async (
return fallbackProvider;
};

const createPollingProviderForNetwork = async (
networkName: NetworkName,
fallbackProvider: FallbackProvider,
pollingInterval: number,
): Promise<PollingJsonRpcProvider> => {
const existingProvider = pollingProviderMap[networkName];
if (existingProvider) {
return existingProvider;
}
const network = NETWORK_CONFIG[networkName];
if (!isDefined(network)) {
throw new Error('No network found');
}
const pollingProvider = await createPollingJsonRpcProviderForListeners(
fallbackProvider,
network.chain.id,
pollingInterval,
);
setPollingProviderForNetwork(networkName, pollingProvider);
return pollingProvider;
};

/**
*
* @param chain
* @param networkName
* @param fallbackProviderJsonConfig
* @param pollingInterval - DEPRECATED
Comment thread
jacobmakarsky marked this conversation as resolved.
Outdated
Comment thread
jacobmakarsky marked this conversation as resolved.
Outdated
*/
const loadProviderForNetwork = async (
chain: Chain,
networkName: NetworkName,
fallbackProviderJsonConfig: FallbackProviderJsonConfig,
/**
* @deprecated pollingInterval - DEPRECATED
Comment thread
jacobmakarsky marked this conversation as resolved.
Outdated
Comment thread
jacobmakarsky marked this conversation as resolved.
Outdated
*/
pollingInterval: number,

@emilbayes emilbayes Jan 22, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add deprecated to this too?

@jacobmakarsky jacobmakarsky Jan 23, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's already there if you are asking to ensure it has deprecated on it

) => {
sendMessage(`Load provider for network: ${networkName}`);
Expand All @@ -75,11 +59,6 @@ const loadProviderForNetwork = async (
networkName,
fallbackProviderJsonConfig,
);
const pollingProvider = await createPollingProviderForNetwork(
networkName,
fallbackProvider,
pollingInterval
);

const network = NETWORK_CONFIG[networkName];
const {
Expand Down Expand Up @@ -126,7 +105,7 @@ const loadProviderForNetwork = async (
poseidonMerkleVerifierV3Contract,
tokenVaultV3Contract,
fallbackProvider,
pollingProvider,
undefined, // pollingProvider is being deprecated

@emilbayes emilbayes Jan 22, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type error here. I do not think it's a breaking change to change the type to ? on the functions that take the now deprecated polling provider such that you no longer have to pass them

@jacobmakarsky jacobmakarsky Jan 23, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,
Expand All @@ -140,6 +119,9 @@ const loadProviderForNetwork = async (
export const loadProvider = async (
fallbackProviderJsonConfig: FallbackProviderJsonConfig,
networkName: NetworkName,
/**
* @deprecated pollingInterval - DEPRECATED
Comment thread
jacobmakarsky marked this conversation as resolved.
Outdated
*/
pollingInterval = 15000,
): Promise<LoadProviderResponse> => {
try {
Expand Down Expand Up @@ -198,19 +180,17 @@ export const unloadProvider = async (
): Promise<void> => {
WalletPOINodeInterface.pause(NETWORK_CONFIG[networkName].chain);
await fallbackProviderMap[networkName]?.destroy();
pollingProviderMap[networkName]?.destroy();
delete fallbackProviderMap[networkName];
delete pollingProviderMap[networkName];
};

export const pauseAllPollingProviders = (
excludeNetworkName?: NetworkName,
): void => {
Object.keys(pollingProviderMap).forEach(networkName => {
Object.keys(fallbackProviderMap).forEach(networkName => {
if (networkName === excludeNetworkName) {
return;
}
const pollingProvider = pollingProviderMap[networkName];
const pollingProvider = fallbackProviderMap[networkName];
if (isDefined(pollingProvider) && !pollingProvider.paused) {
pollingProvider.pause();
}
Expand All @@ -223,7 +203,7 @@ export const resumeIsolatedPollingProviderForNetwork = (
pauseAllPollingProviders(
networkName, // excludeNetworkName

@bhflm bhflm Jan 29, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we rename this to excludedNetworkName instead of just having it as a comment ?

);
const pollingProviderForNetwork = pollingProviderMap[networkName];
const pollingProviderForNetwork = fallbackProviderMap[networkName];
if (
isDefined(pollingProviderForNetwork) &&
pollingProviderForNetwork.paused
Expand Down
21 changes: 0 additions & 21 deletions src/services/railgun/core/providers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import { NetworkName, isDefined } from '@railgun-community/shared-models';
import { PollingJsonRpcProvider } from '@railgun-community/engine';
import { FallbackProvider } from 'ethers';

export const fallbackProviderMap: MapType<FallbackProvider> = {};
export const pollingProviderMap: MapType<PollingJsonRpcProvider> = {};

export const getFallbackProviderForNetwork = (
networkName: NetworkName,
Expand All @@ -15,28 +13,9 @@ export const getFallbackProviderForNetwork = (
return provider;
};

export const getPollingProviderForNetwork = (
networkName: NetworkName,
): PollingJsonRpcProvider => {
const provider = pollingProviderMap[networkName];
if (!isDefined(provider)) {
throw new Error(
`Polling provider not yet loaded for network ${networkName}`,
);
}
return provider;
};

export const setFallbackProviderForNetwork = (
networkName: NetworkName,
provider: FallbackProvider,
): void => {
fallbackProviderMap[networkName] = provider;
};

export const setPollingProviderForNetwork = (
networkName: NetworkName,
provider: PollingJsonRpcProvider,
): void => {
pollingProviderMap[networkName] = provider;
};