Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix some typos in comments #89

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/js_sdk/erc20Trade/orderERC20.md
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ const [{depth}, {ammPoolSnapshot}] = await Promise.all([
]);
```

### Step 5. check MinAmt see log and calc mini receive and ouput value & maxfeeBips & priceImpact
### Step 5. check MinAmt see log and calc mini receive and output value & maxfeeBips & priceImpact

```ts
const { calcTradeParams, maxFeeBips, minimumReceived } = calculateSwap(
Expand Down
2 changes: 1 addition & 1 deletion src/api/request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export class Request {
return true
}
return false
// return true // always true, handle exception in each bussiness logic
// return true // always true, handle exception in each business logic
},

insecure: true,
Expand Down
2 changes: 1 addition & 1 deletion src/api/sign/poseidon/permutation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ export class permunation {

// poseidon
/*
Main instansiation of the Poseidon permutation
Main instantiation of the Poseidon permutation

The state is `t` elements wide, there are `F` full-rounds
followed by `P` partial rounds, then `F` full rounds again.
Expand Down
2 changes: 1 addition & 1 deletion src/defs/account_defs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { PublicKey } from './loopring_enums'
* AccountInfo
* @property accountId number Account ID
* @property owner string Ethereum address
* @property frozen boolean The frozen state of the account, true stands for frozen, if the account is frozen, the user cant submit order.
* @property frozen boolean The frozen state of the account, true stands for frozen, if the account is frozen, the user can't submit order.
* @property publicKey PublicKey The user's public key
* @property tags? string Comma separated list of tags such as VIP levels, etc
* @property nonce number field.DexAccountV3.nonce
Expand Down
2 changes: 1 addition & 1 deletion src/defs/loopring_defs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1484,7 +1484,7 @@ export enum STOP_SIDE {

export interface SubmitOrderRequestV3 {
/**
* The adderss of the exchange which has to process this order
* The address of the exchange which has to process this order
* @type {string}
* @memberof SubmitOrderRequestV3
*/
Expand Down
4 changes: 2 additions & 2 deletions src/tests/demo/erc20Trade/orderERC20.md
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ const [{depth}, {ammPoolSnapshot}] = await Promise.all([
]);
```

### Step 5. Check MinAmt see log and calc mini receive and ouput value & maxfeeBips & priceImpact & swap output
### Step 5. Check MinAmt see log and calc mini receive and output value & maxfeeBips & priceImpact & swap output

```ts
const { calcTradeParams, maxFeeBips, minimumReceived } = calculateSwap(
Expand Down Expand Up @@ -719,7 +719,7 @@ const [{depth}, {ammPoolSnapshot}] = await Promise.all([
]);
```

### Step 5. check MinAmt see log and calc mini receive and ouput value & maxfeeBips & priceImpact
### Step 5. check MinAmt see log and calc mini receive and output value & maxfeeBips & priceImpact

```ts
const { calcTradeParams, maxFeeBips, minimumReceived } = calculateSwap(
Expand Down
2 changes: 1 addition & 1 deletion src/tests/demo/erc20Trade/orderERC20.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ describe("orderERC20", function () {
}),
]);

// Step 5. check MinAmt see log and calc mini receive and ouput value & maxfeeBips & priceImpact
// Step 5. check MinAmt see log and calc mini receive and output value & maxfeeBips & priceImpact
// @ts-ignore
const { calcTradeParams, maxFeeBips, minimumReceived } = calculateSwap(
sell,
Expand Down