provider-alchemy.d.ts 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. /**
  2. * [[link-alchemy]] provides a third-party service for connecting to
  3. * various blockchains over JSON-RPC.
  4. *
  5. * **Supported Networks**
  6. *
  7. * - Ethereum Mainnet (``mainnet``)
  8. * - Goerli Testnet (``goerli``)
  9. * - Sepolia Testnet (``sepolia``)
  10. * - Arbitrum (``arbitrum``)
  11. * - Arbitrum Goerli Testnet (``arbitrum-goerli``)
  12. * - Arbitrum Sepolia Testnet (``arbitrum-sepolia``)
  13. * - Base (``base``)
  14. * - Base Goerlia Testnet (``base-goerli``)
  15. * - Base Sepolia Testnet (``base-sepolia``)
  16. * - Optimism (``optimism``)
  17. * - Optimism Goerli Testnet (``optimism-goerli``)
  18. * - Optimism Sepolia Testnet (``optimism-sepolia``)
  19. * - Polygon (``matic``)
  20. * - Polygon Amoy Testnet (``matic-amoy``)
  21. * - Polygon Mumbai Testnet (``matic-mumbai``)
  22. *
  23. * @_subsection: api/providers/thirdparty:Alchemy [providers-alchemy]
  24. */
  25. import { FetchRequest } from "../utils/index.js";
  26. import { Network } from "./network.js";
  27. import { JsonRpcProvider } from "./provider-jsonrpc.js";
  28. import type { AbstractProvider, PerformActionRequest } from "./abstract-provider.js";
  29. import type { CommunityResourcable } from "./community.js";
  30. import type { Networkish } from "./network.js";
  31. /**
  32. * The **AlchemyProvider** connects to the [[link-alchemy]]
  33. * JSON-RPC end-points.
  34. *
  35. * By default, a highly-throttled API key is used, which is
  36. * appropriate for quick prototypes and simple scripts. To
  37. * gain access to an increased rate-limit, it is highly
  38. * recommended to [sign up here](link-alchemy-signup).
  39. *
  40. * @_docloc: api/providers/thirdparty
  41. */
  42. export declare class AlchemyProvider extends JsonRpcProvider implements CommunityResourcable {
  43. readonly apiKey: string;
  44. constructor(_network?: Networkish, apiKey?: null | string);
  45. _getProvider(chainId: number): AbstractProvider;
  46. _perform(req: PerformActionRequest): Promise<any>;
  47. isCommunityResource(): boolean;
  48. static getRequest(network: Network, apiKey?: string): FetchRequest;
  49. }
  50. //# sourceMappingURL=provider-alchemy.d.ts.map