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.

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

feat: add AlchemyProvider class #205

Merged
merged 9 commits into from
Apr 22, 2023
Merged
Changes from 3 commits
Commits
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
37 changes: 37 additions & 0 deletions src/providers/AlchemyProvider.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { BaseProvider } from './BaseProvider';

export class AlchemyProvider extends BaseProvider {
Copy link
Owner

Choose a reason for hiding this comment

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

I think we can do this entire thing in just 5 lines by extending JsonRpcProvider instead.

Copy link
Owner

Choose a reason for hiding this comment

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

Yea this was overengineering @jtfirek. This does the same:

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Noted @dawsbot! that's much more simplified

/**
* @ignore
*/
selectRpcUrl(): string {
return this._rpcUrls[0];
}

/**
* @ignore
*/
post(body: Record<string, unknown>): Promise<any> {
return this._post(body);
}

/**
* @param apiKey The Alchemy API key
* @param network The Ethereum network to connect to
*/
constructor(apiKey: string, network = 'mainnet') {
const alchemyUrl = `https://eth-${network}.alchemyapi.io/v2/${apiKey}`;
super([alchemyUrl]);
}
}

/**
* Helper function to avoid "new"
*
* @param apiKey the Alchemy API key
* @param network the Ethereum network to connect to
* @returns an initiated {@link AlchemyProvider}
*/
export function alchemyProvider(apiKey: string, network?: string) {
return new AlchemyProvider(apiKey, network);
}