Skip to content

Commit

Permalink
Fixed grammar in comments, improved a function name, changed purchase…
Browse files Browse the repository at this point in the history 
… reason in tests (#51)

* Added CircleCI config

* Use node 8.11.3

* "positives integer" -> "positive integers"

* Rename isSignedRequestHasError -> validateSignedRequest

The latter is a clearer representation of what the function does.

* Changed purchase reason in test cases

* Updated IPFS hash/Request hash/signature to reflect new data
  • Loading branch information
@mikery @romaric-juniet
mikery authored and romaric-juniet committed Jul 17, 2018
1 parent ebd0776 commit d2c541a
Show file tree
Hide file tree
Showing 25 changed files with 114 additions and 83 deletions.
31 changes: 31 additions & 0 deletions .circleci/config.yml
View file
@@ -0,0 +1,31 @@
version: 2
jobs:
build:
docker:
- image: circleci/node:8.11.3-stretch
- image: ipfs/go-ipfs:v0.4.16
- image: trufflesuite/ganache-cli:v6.1.6
command: [
"-l", "90000000",
"-m", "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat"]
environment:
NODE_ENV: test
steps:
- checkout
- restore_cache:
key: v1-node-modules-cache-{{ checksum "package.json" }}-{{ checksum "packages/requestNetwork.js/package.json" }}
- run:
name: Install depedencies
command: |
npm install .
cd packages/requestNetwork.js/ && npm install . && cd -
- save_cache:
key: v1-node-modules-cache-{{ checksum "package.json" }}-{{ checksum "packages/requestNetwork.js/package.json" }}
paths:
- "node_modules"
- "packages/requestNetwork.js/node_modules"
- run:
name: Deploy test contracts and run Request unit tests
command: |
./node_modules/lerna/bin/lerna.js run --scope @requestnetwork/request-network.js testdeploy
./node_modules/lerna/bin/lerna.js run --scope @requestnetwork/request-network.js test --stream
6 changes: 3 additions & 3 deletions packages/requestNetwork.js/README.md
View file
Expand Up @@ -242,7 +242,7 @@ Example:
### Check a signed request

```js
public isSignedRequestHasError(_signedRequest: any, _payer: string): string;
public validateSignedRequest(_signedRequest: any, _payer: string): string;
```

Check if a signed request is valid
Expand Down Expand Up @@ -510,7 +510,7 @@ Example:
### Check a signed request

```js
public isSignedRequestHasError(_signedRequest: any, _payer: string): string;
public validateSignedRequest(_signedRequest: any, _payer: string): string;
```

Check if a signed request is valid
Expand Down Expand Up @@ -777,7 +777,7 @@ Example:
### Check a signed request

```js
public isSignedRequestHasError(_signedRequest: any, _payer: string): string;
public validateSignedRequest(_signedRequest: any, _payer: string): string;
```

Check if a signed request is valid
Expand Down
2 changes: 1 addition & 1 deletion packages/requestNetwork.js/src/api/signed-request.ts
View file
Expand Up @@ -69,7 +69,7 @@ export default class SignedRequest {
this.signedRequestData.currencyContract,
);

return currencyUtils.serviceForCurrency(currency).isSignedRequestHasError(this.signedRequestData, payer.idAddress);
return currencyUtils.serviceForCurrency(currency).validateSignedRequest(this.signedRequestData, payer.idAddress);
}

/**
Expand Down
16 changes: 8 additions & 8 deletions packages/requestNetwork.js/src/servicesContracts/requestBitcoinNodesValidation-service.ts
View file
Expand Up @@ -144,7 +144,7 @@ export default class RequestBitcoinNodesValidationService {
}

if (_expectedAmounts.some((amount: any) => amount.isNeg())) {
return promiEvent.reject(Error('_expectedAmounts must be positives integer'));
return promiEvent.reject(Error('_expectedAmounts must be positive integers'));
}

if (!this.web3Single.isAddressNoChecksum(_payer)) {
Expand Down Expand Up @@ -251,7 +251,7 @@ export default class RequestBitcoinNodesValidationService {
}

if (_expectedAmounts.some((amount: any) => amount.isNeg())) {
return promiEvent.reject(Error('_expectedAmounts must be positives integer'));
return promiEvent.reject(Error('_expectedAmounts must be positive integers'));
}
if ( !this.web3Single.areSameAddressesNoChecksum(account, _payeesIdAddress[0]) ) {
return promiEvent.reject(Error('account broadcaster must be the main payee'));
Expand Down Expand Up @@ -319,7 +319,7 @@ export default class RequestBitcoinNodesValidationService {
this.web3Single.getDefaultAccountCallback(async (err, defaultAccount) => {
if (!_options.from && err) return promiEvent.reject(err);
const account = _options.from || defaultAccount;
const error = this.isSignedRequestHasError(_signedRequest, account);
const error = this.validateSignedRequest(_signedRequest, account);
if (error !== '') return promiEvent.reject(Error(error));

if (_additionals && _signedRequest.payeesIdAddress.length < _additionals.length) {
Expand All @@ -332,7 +332,7 @@ export default class RequestBitcoinNodesValidationService {
return promiEvent.reject(Error('payeesRefundAddress must be valid bitcoin addresses'));
}
if (additionalsParsed.some((amount: any) => amount.isNeg())) {
return promiEvent.reject(Error('_additionals must be positives integer'));
return promiEvent.reject(Error('_additionals must be positive integers'));
}
if (this.web3Single.areSameAddressesNoChecksum(account, _signedRequest.payeesIdAddress[0]) ) {
return promiEvent.reject(Error('_from must be different than the main payee'));
Expand Down Expand Up @@ -558,7 +558,7 @@ export default class RequestBitcoinNodesValidationService {
return promiEvent.reject(Error('_subtracts cannot be bigger than _payeesIdAddress'));
}
if (subtractsParsed.some((amount: any) => amount.isNeg())) {
return promiEvent.reject(Error('subtracts must be positives integer'));
return promiEvent.reject(Error('subtracts must be positive integers'));
}
if ( request.state === Types.State.Canceled ) {
return promiEvent.reject(Error('request must be accepted or created'));
Expand Down Expand Up @@ -657,7 +657,7 @@ export default class RequestBitcoinNodesValidationService {
return promiEvent.reject(Error('_additionals cannot be bigger than _payeesIdAddress'));
}
if (additionalsParsed.some((amount: any) => amount.isNeg())) {
return promiEvent.reject(Error('additionals must be positives integer'));
return promiEvent.reject(Error('additionals must be positive integers'));
}
if ( request.state === Types.State.Canceled ) {
return promiEvent.reject(Error('request must be accepted or created'));
Expand Down Expand Up @@ -870,7 +870,7 @@ export default class RequestBitcoinNodesValidationService {
* @param _payer Payer of the request
* @return return a string with the error, or ''
*/
public isSignedRequestHasError(_signedRequest: any, _payer: string): string {
public validateSignedRequest(_signedRequest: any, _payer: string): string {
_signedRequest.expectedAmounts = _signedRequest.expectedAmounts.map((amount: any) => new BN(amount));

const hashComputed = this.hashRequest(
Expand All @@ -891,7 +891,7 @@ export default class RequestBitcoinNodesValidationService {
return '_payeesIdAddress, payeesPaymentAddress and _expectedAmounts must have the same size';
}
if (_signedRequest.expectedAmounts.some((amount: any) => amount.isNeg())) {
return '_expectedAmounts must be positives integer';
return '_expectedAmounts must be positive integers';
}
if (!this.web3Single.areSameAddressesNoChecksum(this.addressRequestBitcoinNodesValidationLast, _signedRequest.currencyContract)) {
return 'currencyContract must be the last currencyContract of requestBitcoinNodesValidation';
Expand Down
28 changes: 14 additions & 14 deletions packages/requestNetwork.js/src/servicesContracts/requestERC20-service.ts
View file
Expand Up @@ -133,7 +133,7 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('account broadcaster must be the main payee'));
}
if (_expectedAmounts.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_expectedAmounts must be positives integer'));
return promiEvent.reject(Error('_expectedAmounts must be positive integers'));
}
if (!this.web3Single.isAddressNoChecksum(_payer)) {
return promiEvent.reject(Error('_payer must be a valid eth address'));
Expand Down Expand Up @@ -263,13 +263,13 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_payeesIdAddress must be valid eth addresses'));
}
if (_expectedAmounts.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_expectedAmounts must be positives integer'));
return promiEvent.reject(Error('_expectedAmounts must be positive integers'));
}
if (amountsToPayParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_amountsToPay must be positives integer'));
return promiEvent.reject(Error('_amountsToPay must be positive integers'));
}
if (additionalsParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_additionals must be positives integer'));
return promiEvent.reject(Error('_additionals must be positive integers'));
}
if (_extension) {
return promiEvent.reject(Error('extensions are disabled for now'));
Expand Down Expand Up @@ -403,7 +403,7 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_expirationDate must be greater than now'));
}
if (_expectedAmounts.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_expectedAmounts must be positives integer'));
return promiEvent.reject(Error('_expectedAmounts must be positive integers'));
}
if ( !this.web3Single.areSameAddressesNoChecksum(account, _payeesIdAddress[0]) ) {
return promiEvent.reject(Error('account broadcaster must be the main payee'));
Expand Down Expand Up @@ -500,7 +500,7 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('token not supported'));
}

await this.isSignedRequestHasError(_signedRequest, account);
await this.validateSignedRequest(_signedRequest, account);

if (_amountsToPay && _signedRequest.payeesIdAddress.length < _amountsToPay.length) {
return promiEvent.reject(Error('_amountsToPay cannot be bigger than _payeesIdAddress'));
Expand All @@ -509,10 +509,10 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_additionals cannot be bigger than _payeesIdAddress'));
}
if (amountsToPayParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_amountsToPay must be positives integer'));
return promiEvent.reject(Error('_amountsToPay must be positive integers'));
}
if (additionalsParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_additionals must be positives integer'));
return promiEvent.reject(Error('_additionals must be positive integers'));
}
if (this.web3Single.areSameAddressesNoChecksum(account, _signedRequest.payeesIdAddress[0]) ) {
return promiEvent.reject(Error('_from must be different than the main payee'));
Expand Down Expand Up @@ -758,7 +758,7 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_additionals cannot be bigger than _payeesIdAddress'));
}
if (additionalsParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('additionals must be positives integer'));
return promiEvent.reject(Error('additionals must be positive integers'));
}
if ( request.state === Types.State.Canceled ) {
return promiEvent.reject(Error('request must be accepted or created'));
Expand Down Expand Up @@ -848,7 +848,7 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_subtracts cannot be bigger than _payeesIdAddress'));
}
if (subtractsParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('subtracts must be positives integer'));
return promiEvent.reject(Error('subtracts must be positive integers'));
}
if ( request.state === Types.State.Canceled ) {
return promiEvent.reject(Error('request must be accepted or created'));
Expand Down Expand Up @@ -958,10 +958,10 @@ export default class RequestERC20Service {
return promiEvent.reject(Error('_additionals cannot be bigger than _payeesIdAddress'));
}
if (amountsToPayParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_amountsToPay must be positives integer'));
return promiEvent.reject(Error('_amountsToPay must be positive integers'));
}
if (additionalsParsed.filter((amount) => amount.isNeg()).length !== 0) {
return promiEvent.reject(Error('_additionals must be positives integer'));
return promiEvent.reject(Error('_additionals must be positive integers'));
}
if ( request.state === Types.State.Canceled ) {
return promiEvent.reject(Error('request cannot be canceled'));
Expand Down Expand Up @@ -1360,7 +1360,7 @@ export default class RequestERC20Service {
* @param _payer Payer of the request
* @return return a string with the error, or ''
*/
public isSignedRequestHasError(_signedRequest: any, _payer: string): Promise<string> {
public validateSignedRequest(_signedRequest: any, _payer: string): Promise<string> {
return new Promise(async (resolve, reject) => {
_signedRequest.expectedAmounts = _signedRequest.expectedAmounts.map((amount: any) => new BN(amount));

Expand Down Expand Up @@ -1388,7 +1388,7 @@ export default class RequestERC20Service {
}

if (_signedRequest.expectedAmounts.filter((amount: any) => amount.isNeg()).length !== 0) {
return reject(Error('_expectedAmounts must be positives integer'));
return reject(Error('_expectedAmounts must be positive integers'));
}

const contract = this.web3Single.getContractInstance(_signedRequest.currencyContract);
Expand Down

0 comments on commit d2c541a

Please sign in to comment.