Sign upLogin

AugurProject/augur-core

View on GitHub
Star
source/libraries/ContractDeployer.ts

Summary

Maintainability
D
2 days
Test Coverage

File ContractDeployer.ts has 331 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import BN = require('bn.js');
import { hash } from 'crypto-promise';
import { exists, readFile, writeFile } from "async-file";
import { exec } from 'child_process';
import { encodeParams } from 'ethjs-abi';
Severity: Minor
Found in source/libraries/ContractDeployer.ts - About 3 hrs to fix

    ContractDeployer has 31 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class ContractDeployer {
    private readonly accountManager: AccountManager;
    private readonly configuration: DeployerConfiguration;
    private readonly connector: Connector;
    private readonly contracts: Contracts;
    Severity: Minor
    Found in source/libraries/ContractDeployer.ts - About 3 hrs to fix

      Function upload has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
      Open

          private async upload(contract: Contract): Promise<void> {
        const contractsToDelegate: {[key:string]: boolean} = {"Orders": true, "TradingEscapeHatch": true, "Cash": true};
        const contractName = contract.contractName
        if (contractName === 'Controller') return;
        if (contractName === 'Delegator') return;
      Severity: Minor
      Found in source/libraries/ContractDeployer.ts - About 2 hrs to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function whitelistTradingContracts has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          private async whitelistTradingContracts(): Promise<void> {
        console.log('Whitelisting contracts...');
        const promises: Array<Promise<any>> = [];
        for (let contract of this.contracts) {
            if (!contract.relativeFilePath.startsWith("trading/")) continue;
      Severity: Minor
      Found in source/libraries/ContractDeployer.ts - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function generateAddressMapping has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          private async generateAddressMapping(): Promise<string> {
        type ContractAddressMapping = { [name: string]: string };
        type NetworkAddressMapping = { [networkId: string]: ContractAddressMapping };

        const mapping: ContractAddressMapping = {};
      Severity: Minor
      Found in source/libraries/ContractDeployer.ts - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function deploy has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public async deploy(): Promise<void> {
        const blockNumber = await this.getBlockNumber();
        this.controller = await this.uploadController();
        await this.uploadAugur();
        await this.uploadAllContracts();
      Severity: Minor
      Found in source/libraries/ContractDeployer.ts - About 1 hr to fix

        Function deploy has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            public async deploy(): Promise<void> {
        const blockNumber = await this.getBlockNumber();
        this.controller = await this.uploadController();
        await this.uploadAugur();
        await this.uploadAllContracts();
        Severity: Minor
        Found in source/libraries/ContractDeployer.ts - About 35 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Avoid too many return statements within this function.
        Open

                if (contract.relativeFilePath.startsWith('legacy_reputation/')) return;
        Severity: Major
        Found in source/libraries/ContractDeployer.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  if (contractName === 'Augur') return;
          Severity: Major
          Found in source/libraries/ContractDeployer.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    if (contractName !== 'Map' && contract.relativeFilePath.startsWith('libraries/')) return;
            Severity: Major
            Found in source/libraries/ContractDeployer.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      if (this.configuration.isProduction && contractName === 'LegacyReputationToken') return;
              Severity: Major
              Found in source/libraries/ContractDeployer.ts - About 30 mins to fix

                Similar blocks of code found in 2 locations. Consider refactoring.
                Open

                        if (await exists(this.configuration.uploadBlockNumbersOutputPath)) {
            let existingBlockNumberData: string = await readFile(this.configuration.uploadBlockNumbersOutputPath, 'utf8');
            blockNumberMapping = JSON.parse(existingBlockNumberData);
        }
                Severity: Major
                Found in source/libraries/ContractDeployer.ts and 1 other location - About 1 hr to fix
                source/libraries/ContractDeployer.ts on lines 352..355

                Duplicated Code

                Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                Tuning

                This issue has a mass of 62.

                We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                Refactorings

                Further Reading

                Similar blocks of code found in 2 locations. Consider refactoring.
                Open

                        if (await exists(this.configuration.contractAddressesOutputPath)) {
            let existingAddressFileData: string = await readFile(this.configuration.contractAddressesOutputPath, 'utf8');
            addressMapping = JSON.parse(existingAddressFileData);
        }
                Severity: Major
                Found in source/libraries/ContractDeployer.ts and 1 other location - About 1 hr to fix
                source/libraries/ContractDeployer.ts on lines 370..373

                Duplicated Code

                Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                Tuning

                This issue has a mass of 62.

                We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                Refactorings

                Further Reading

                There are no issues that match your filters.

                Category
                Status