ethers.js/lib.commonjs/providers/community.d.ts

29 lines
935 B
TypeScript
Raw Permalink Normal View History

2023-03-03 18:25:07 -07:00
/**
* There are many awesome community services that provide Ethereum
* nodes both for developers just starting out and for large-scale
* communities.
*
* @_section: api/providers/thirdparty: Community Providers [thirdparty]
*/
/**
* Providers which offer community credentials should extend this
* to notify any interested consumers whether community credentials
* are in-use.
*/
export interface CommunityResourcable {
/**
* Returns true of the instance is connected using the community
* credentials.
*/
isCommunityResource(): boolean;
}
/**
* Displays a warning in tht console when the community resource is
* being used too heavily by the app, recommending the developer
* acquire their own credentials instead of using the community
* credentials.
*
* The notification will only occur once per service.
*/
export declare function showThrottleMessage(service: string): void;