aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/src/types.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/0x.js/src/types.ts')
-rw-r--r--packages/0x.js/src/types.ts7
1 files changed, 5 insertions, 2 deletions
diff --git a/packages/0x.js/src/types.ts b/packages/0x.js/src/types.ts
index a8da05205..af4f054f0 100644
--- a/packages/0x.js/src/types.ts
+++ b/packages/0x.js/src/types.ts
@@ -355,9 +355,11 @@ export interface IndexedFilterValues {
[index: string]: ContractEventArg;
}
+// Earliest is omitted by design. It is simply an alias for the `0` constant and
+// is thus not very helpful. Moreover, this type is used in places that only accept
+// `latest` or `pending`.
export enum BlockParamLiteral {
Latest = 'latest',
- Earliest = 'earliest',
Pending = 'pending',
}
@@ -385,7 +387,8 @@ export type AsyncMethod = (...args: any[]) => Promise<any>;
/**
* We re-export the `Web3.Provider` type specified in the Web3 Typescript typings
* since it is the type of the `provider` argument to the `ZeroEx` constructor.
- * It is however a `Web3` library type, not a native `0x.js` type.
+ * It is however a `Web3` library type, not a native `0x.js` type. To learn more
+ * about providers, visit https://0xproject.com/wiki#Web3-Provider-Explained
*/
export type Web3Provider = Web3.Provider;