Add comment about Provider type

2018-04-11 18:43:58 +09:00 · 2018-04-11 18:43:58 +09:00 · 41bd0e30d6
commit 41bd0e30d6
parent 40f4dd91e9
1 changed files with 4 additions and 0 deletions
--- a/packages/types/src/index.ts
+++ b/packages/types/src/index.ts
@ -2,6 +2,10 @@ import { BigNumber } from 'bignumber.js';

 export type JSONRPCErrorCallback = (err: Error | null, result?: JSONRPCResponsePayload) => void;

+/**
+ * Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library
+ * Read more about Providers in the 0x wiki.
+ */
 export interface Provider {
    sendAsync(payload: JSONRPCRequestPayload, callback: JSONRPCErrorCallback): void;
 }