From fe63a81f6a15a521c643b74f4442cdbf037202cf Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 16 Jun 2017 16:30:35 +0200 Subject: Add and improve comments --- src/contract_wrappers/token_registry_wrapper.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/contract_wrappers/token_registry_wrapper.ts') 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 { const tokenRegistryContract = await this._getTokenRegistryContractAsync(); -- cgit v1.2.3