Skip to content
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

Reduce verbosity of smartprovider logging #3084

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Reduce verbosity of smartprovider logging #3084

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f1eab0
Reduce verbosity of smartprovider logging
jmrossy Dec 19, 2023
decdf0c
Replace url with provider index
jmrossy Dec 19, 2023
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
15 changes: 9 additions & 6 deletions typescript/sdk/src/providers/SmartProvider/HyperlaneEtherscanProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export class HyperlaneEtherscanProvider
constructor(
public readonly explorerConfig: BlockExplorer,
network: providers.Networkish,
public readonly options?: { debug?: boolean },
) {
super(network, explorerConfig.apiKey);
if (!explorerConfig.apiKey) {
Expand Down Expand Up @@ -80,9 +81,10 @@ export class HyperlaneEtherscanProvider
const hostname = this.getHostname();
let waitTime = this.getQueryWaitTime();
while (waitTime > 0) {
this.logger(
`HyperlaneEtherscanProvider waiting ${waitTime}ms to avoid rate limit`,
);
if (this.options?.debug)
this.logger(
`HyperlaneEtherscanProvider waiting ${waitTime}ms to avoid rate limit`,
);
await sleep(waitTime);
waitTime = this.getQueryWaitTime();
}
Expand All @@ -92,9 +94,10 @@ export class HyperlaneEtherscanProvider
}

async perform(method: string, params: any, reqId?: number): Promise<any> {
this.logger(
`HyperlaneEtherscanProvider performing method ${method} for reqId ${reqId}`,
);
if (this.options?.debug)
this.logger(
`HyperlaneEtherscanProvider performing method ${method} for reqId ${reqId}`,
);
if (!this.supportedMethods.includes(method as ProviderMethod))
throw new Error(`Unsupported method ${method}`);

Expand Down
8 changes: 5 additions & 3 deletions typescript/sdk/src/providers/SmartProvider/HyperlaneJsonRpcProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ export class HyperlaneJsonRpcProvider
constructor(
public readonly rpcConfig: RpcConfigWithConnectionInfo,
network: providers.Networkish,
public readonly options?: { debug?: boolean },
) {
super(rpcConfig.connection ?? rpcConfig.http, network);
}

async perform(method: string, params: any, reqId?: number): Promise<any> {
this.logger(
`HyperlaneJsonRpcProvider performing method ${method} for reqId ${reqId}`,
);
if (this.options?.debug)
this.logger(
`HyperlaneJsonRpcProvider performing method ${method} for reqId ${reqId}`,
);
if (method === ProviderMethod.GetLogs) {
return this.performGetLogs(params);
}
Expand Down
16 changes: 9 additions & 7 deletions typescript/sdk/src/providers/SmartProvider/SmartProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,16 +289,18 @@ export class HyperlaneSmartProvider
reqId: number,
): Promise<ProviderPerformResult> {
try {
this.logger(
`Provider using ${providerUrl} performing method ${method} for reqId ${reqId}`,
);
if (this.options?.debug)
this.logger(
`Provider using ${providerUrl} performing method ${method} for reqId ${reqId}`,
);
const result = await provider.perform(method, params, reqId);
return { status: ProviderStatus.Success, value: result };
} catch (error) {
this.logger(
`Error performing ${method} on provider ${providerUrl} for reqId ${reqId}`,
error,
);
if (this.options?.debug)
this.logger(
`Error performing ${method} on provider ${providerUrl} for reqId ${reqId}`,
jmrossy marked this conversation as resolved.
Show resolved Hide resolved
error,
);
return { status: ProviderStatus.Error, error };
}
}
Expand Down
1 change: 1 addition & 0 deletions typescript/sdk/src/providers/SmartProvider/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,5 @@ export interface ProviderRetryOptions {
export interface SmartProviderOptions extends ProviderRetryOptions {
// The time to wait before attempting the next provider
fallbackStaggerMs?: number;
debug?: boolean;
}
Loading