aboutsummaryrefslogtreecommitdiffstats
path: root/src/contract_wrappers/token_registry_wrapper.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-06-16 22:30:35 +0800
committerFabio Berger <me@fabioberger.com>2017-06-16 22:30:35 +0800
commitfe63a81f6a15a521c643b74f4442cdbf037202cf (patch)
treea596b494ceb6ed1a84ab054e5983a3b44fcc95cd /src/contract_wrappers/token_registry_wrapper.ts
parent225ec506454ac9b912ee50fb6a138c201da1519b (diff)
downloaddexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar.gz
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar.bz2
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar.lz
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar.xz
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.tar.zst
dexon-sol-tools-fe63a81f6a15a521c643b74f4442cdbf037202cf.zip
Add and improve comments
Diffstat (limited to 'src/contract_wrappers/token_registry_wrapper.ts')
-rw-r--r--src/contract_wrappers/token_registry_wrapper.ts5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/contract_wrappers/token_registry_wrapper.ts b/src/contract_wrappers/token_registry_wrapper.ts
index ab0218777..3e87e4852 100644
--- a/src/contract_wrappers/token_registry_wrapper.ts
+++ b/src/contract_wrappers/token_registry_wrapper.ts
@@ -5,6 +5,9 @@ import {assert} from '../utils/assert';
import {ContractWrapper} from './contract_wrapper';
import * as TokenRegistryArtifacts from '../artifacts/TokenRegistry.json';
+/**
+ * This class includes all the functionality related to interacting with the 0x Token Registry smart contract.
+ */
export class TokenRegistryWrapper extends ContractWrapper {
private _tokenRegistryContractIfExists?: TokenRegistryContract;
constructor(web3Wrapper: Web3Wrapper) {
@@ -15,7 +18,7 @@ export class TokenRegistryWrapper extends ContractWrapper {
}
/**
* Retrieves all the tokens currently listed in the Token Registry smart contract
- * @return An array of JS objects that conform to the Token interface.
+ * @return An array of objects that conform to the Token interface.
*/
public async getTokensAsync(): Promise<Token[]> {
const tokenRegistryContract = await this._getTokenRegistryContractAsync();