Fix typos
This commit is contained in:
parent
170e5589f9
commit
05daab5dea
@ -83,7 +83,7 @@ export class ZeroEx {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Generates a pseudo-random 256-bit salt.
|
* Generates a pseudo-random 256-bit salt.
|
||||||
* The salt can be included in an 0x order, ensuring that the order generates a unique orderHash
|
* The salt can be included in a 0x order, ensuring that the order generates a unique orderHash
|
||||||
* and will not collide with other outstanding orders that are identical in all other parameters.
|
* and will not collide with other outstanding orders that are identical in all other parameters.
|
||||||
* @return A pseudo-random 256-bit number that can be used as a salt.
|
* @return A pseudo-random 256-bit number that can be used as a salt.
|
||||||
*/
|
*/
|
||||||
|
@ -64,7 +64,7 @@ export class EtherTokenWrapper extends ContractWrapper {
|
|||||||
* equivalent number of wrapped ETH tokens.
|
* equivalent number of wrapped ETH tokens.
|
||||||
* @param etherTokenAddress EtherToken address you wish to withdraw from.
|
* @param etherTokenAddress EtherToken address you wish to withdraw from.
|
||||||
* @param amountInWei Amount of ETH in Wei the caller wishes to withdraw.
|
* @param amountInWei Amount of ETH in Wei the caller wishes to withdraw.
|
||||||
* @param withdrawer The hex encoded user Ethereum address that would like to make the withdrawl.
|
* @param withdrawer The hex encoded user Ethereum address that would like to make the withdrawal.
|
||||||
* @param txOpts Transaction parameters.
|
* @param txOpts Transaction parameters.
|
||||||
* @return Transaction hash.
|
* @return Transaction hash.
|
||||||
*/
|
*/
|
||||||
@ -96,7 +96,7 @@ export class EtherTokenWrapper extends ContractWrapper {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Gets historical logs without creating a subscription
|
* Gets historical logs without creating a subscription
|
||||||
* @param etherTokenAddress An address of the ether token that emmited the logs.
|
* @param etherTokenAddress An address of the ether token that emitted the logs.
|
||||||
* @param eventName The ether token contract event you would like to subscribe to.
|
* @param eventName The ether token contract event you would like to subscribe to.
|
||||||
* @param blockRange Block range to get logs from.
|
* @param blockRange Block range to get logs from.
|
||||||
* @param indexFilterValues An object where the keys are indexed args returned by the event and
|
* @param indexFilterValues An object where the keys are indexed args returned by the event and
|
||||||
|
@ -860,7 +860,7 @@ export class ExchangeWrapper extends ContractWrapper {
|
|||||||
return isRoundingError;
|
return isRoundingError;
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Checks if logs contain LogError, which is emmited by Exchange contract on transaction failure.
|
* Checks if logs contain LogError, which is emitted by Exchange contract on transaction failure.
|
||||||
* @param logs Transaction logs as returned by `zeroEx.awaitTransactionMinedAsync`
|
* @param logs Transaction logs as returned by `zeroEx.awaitTransactionMinedAsync`
|
||||||
*/
|
*/
|
||||||
public throwLogErrorsAsErrors(logs: Array<LogWithDecodedArgs<DecodedLogArgs> | Web3.LogEntry>): void {
|
public throwLogErrorsAsErrors(logs: Array<LogWithDecodedArgs<DecodedLogArgs> | Web3.LogEntry>): void {
|
||||||
|
@ -385,7 +385,7 @@ export class TokenWrapper extends ContractWrapper {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Gets historical logs without creating a subscription
|
* Gets historical logs without creating a subscription
|
||||||
* @param tokenAddress An address of the token that emmited the logs.
|
* @param tokenAddress An address of the token that emitted the logs.
|
||||||
* @param eventName The token contract event you would like to subscribe to.
|
* @param eventName The token contract event you would like to subscribe to.
|
||||||
* @param blockRange Block range to get logs from.
|
* @param blockRange Block range to get logs from.
|
||||||
* @param indexFilterValues An object where the keys are indexed args returned by the event and
|
* @param indexFilterValues An object where the keys are indexed args returned by the event and
|
||||||
|
@ -59,7 +59,7 @@ const DEFAULT_CLEANUP_JOB_INTERVAL_MS = 1000 * 60 * 60; // 1h
|
|||||||
/**
|
/**
|
||||||
* This class includes all the functionality related to watching a set of orders
|
* This class includes all the functionality related to watching a set of orders
|
||||||
* for potential changes in order validity/fillability. The orderWatcher notifies
|
* for potential changes in order validity/fillability. The orderWatcher notifies
|
||||||
* the subscriber of these changes so that a final decison can be made on whether
|
* the subscriber of these changes so that a final decision can be made on whether
|
||||||
* the order should be deemed invalid.
|
* the order should be deemed invalid.
|
||||||
*/
|
*/
|
||||||
export class OrderStateWatcher {
|
export class OrderStateWatcher {
|
||||||
|
@ -137,7 +137,7 @@ describe('EtherTokenWrapper', () => {
|
|||||||
gasCost = expectedETHBalance.minus(postETHBalance);
|
gasCost = expectedETHBalance.minus(postETHBalance);
|
||||||
expect(gasCost).to.be.bignumber.lte(MAX_REASONABLE_GAS_COST_IN_WEI);
|
expect(gasCost).to.be.bignumber.lte(MAX_REASONABLE_GAS_COST_IN_WEI);
|
||||||
});
|
});
|
||||||
it('should throw if user has insufficient WETH balance for withdrawl', async () => {
|
it('should throw if user has insufficient WETH balance for withdrawal', async () => {
|
||||||
const preWETHBalance = await zeroEx.token.getBalanceAsync(wethContractAddress, addressWithETH);
|
const preWETHBalance = await zeroEx.token.getBalanceAsync(wethContractAddress, addressWithETH);
|
||||||
expect(preWETHBalance).to.be.bignumber.equal(0);
|
expect(preWETHBalance).to.be.bignumber.equal(0);
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
The following example shows you how to validate an 0x order using the `@0xproject/json-schemas` package.
|
The following example shows you how to validate a 0x order using the `@0xproject/json-schemas` package.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
|
import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas';
|
||||||
|
Loading…
x
Reference in New Issue
Block a user