oceanprotocol/ocean.js

View on GitHub
src/config/ConfigHelper.ts

Summary

Maintainability
F
4 days
Test Coverage
D
66%

File ConfigHelper.ts has 319 lines of code (exceeds 250 allowed). Consider refactoring.
Open

// eslint-disable-next-line import/no-named-default
import { default as DefaultContractsAddresses } from '@oceanprotocol/contracts/addresses/address.json'
import fs from 'fs'
import { Config } from '.'
import { LoggerInstance } from '../utils'
Severity: Minor
Found in src/config/ConfigHelper.ts - About 3 hrs to fix

    Function getAddressesFromEnv has 87 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      public getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config> {
        // use the defaults first
        let configAddresses: Partial<Config>
        // load from custom addresses structure
        if (customAddresses && customAddresses[network]) {
    Severity: Major
    Found in src/config/ConfigHelper.ts - About 3 hrs to fix

      Function getConfig has 37 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        public getConfig(network: string | number, infuraProjectId?: string): Config {
          const filterBy = typeof network === 'string' ? 'network' : 'chainId'
      
          let config = configHelperNetworks.find((c) => c[filterBy] === network)
      
      
      Severity: Minor
      Found in src/config/ConfigHelper.ts - About 1 hr to fix

        Function getConfig has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

          public getConfig(network: string | number, infuraProjectId?: string): Config {
            const filterBy = typeof network === 'string' ? 'network' : 'chainId'
        
            let config = configHelperNetworks.find((c) => c[filterBy] === network)
        
        
        Severity: Minor
        Found in src/config/ConfigHelper.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 getAddressesFromEnv has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

          public getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config> {
            // use the defaults first
            let configAddresses: Partial<Config>
            // load from custom addresses structure
            if (customAddresses && customAddresses[network]) {
        Severity: Minor
        Found in src/config/ConfigHelper.ts - About 25 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

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

              if (DefaultContractsAddresses[network]) {
                const {
                  FixedPrice,
                  Dispenser,
                  OPFCommunityFeeCollector,
        Severity: Major
        Found in src/config/ConfigHelper.ts and 1 other location - About 1 day to fix
        src/config/ConfigHelper.ts on lines 207..292

        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 252.

        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 (customAddresses && customAddresses[network]) {
              const {
                FixedPrice,
                Dispenser,
                ERC721Factory,
        Severity: Major
        Found in src/config/ConfigHelper.ts and 1 other location - About 1 day to fix
        src/config/ConfigHelper.ts on lines 250..291

        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 252.

        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