aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-11 17:43:58 +0800
committerFabio Berger <me@fabioberger.com>2018-04-11 17:43:58 +0800
commit41bd0e30d6d0a18530e31133efe57d35e3360ebd (patch)
treeb38cb87090bafa662baf62cf9a73f0a53a1a3579
parent40f4dd91e95386c0d292c49dce335b2943039468 (diff)
downloaddexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar.gz
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar.bz2
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar.lz
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar.xz
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.tar.zst
dexon-sol-tools-41bd0e30d6d0a18530e31133efe57d35e3360ebd.zip
Add comment about Provider type
-rw-r--r--packages/types/src/index.ts4
1 files changed, 4 insertions, 0 deletions
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;
}