From 41bd0e30d6d0a18530e31133efe57d35e3360ebd Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 11 Apr 2018 18:43:58 +0900 Subject: Add comment about Provider type --- packages/types/src/index.ts | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'packages') diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index 2e7e629b5..044aae3c8 100644 --- 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; } -- cgit v1.2.3