synapsecns/sanguine

View on GitHub
services/cctp-relayer/relayer/relayer.go

Summary

Maintainability
C
1 day
Test Coverage

Function NewCCTPRelayer has 73 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func NewCCTPRelayer(ctx context.Context, cfg config.Config, store db2.CCTPRelayerDB, omniRPCClient omniClient.RPCClient, handler metrics.Handler, attestationAPI attestation.CCTPAPI, rawOpts ...OptionsArgsOption) (*CCTPRelayer, error) {
    opts := makeOptions(rawOpts)

    omniClient := omniClient.NewOmnirpcClient(cfg.BaseOmnirpcURL, handler, omniClient.WithCaptureReqRes())

Severity: Minor
Found in services/cctp-relayer/relayer/relayer.go - About 1 hr to fix

    Function NewCCTPRelayer has 10 return statements (exceeds 4 allowed).
    Open

    func NewCCTPRelayer(ctx context.Context, cfg config.Config, store db2.CCTPRelayerDB, omniRPCClient omniClient.RPCClient, handler metrics.Handler, attestationAPI attestation.CCTPAPI, rawOpts ...OptionsArgsOption) (*CCTPRelayer, error) {
        opts := makeOptions(rawOpts)
    
        omniClient := omniClient.NewOmnirpcClient(cfg.BaseOmnirpcURL, handler, omniClient.WithCaptureReqRes())
    
    
    Severity: Major
    Found in services/cctp-relayer/relayer/relayer.go - About 1 hr to fix

      Method CCTPRelayer.Run has 10 return statements (exceeds 4 allowed).
      Open

      func (c *CCTPRelayer) Run(parentCtx context.Context) error {
          g, ctx := errgroup.WithContext(parentCtx)
      
          // listen for contract events
          for cid, listeners := range c.chainListeners {
      Severity: Major
      Found in services/cctp-relayer/relayer/relayer.go - About 1 hr to fix

        Function NewCCTPRelayer has 7 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        func NewCCTPRelayer(ctx context.Context, cfg config.Config, store db2.CCTPRelayerDB, omniRPCClient omniClient.RPCClient, handler metrics.Handler, attestationAPI attestation.CCTPAPI, rawOpts ...OptionsArgsOption) (*CCTPRelayer, error) {
        Severity: Major
        Found in services/cctp-relayer/relayer/relayer.go - About 50 mins to fix

          Function NewCCTPRelayer has a Cognitive Complexity of 23 (exceeds 20 allowed). Consider refactoring.
          Open

          func NewCCTPRelayer(ctx context.Context, cfg config.Config, store db2.CCTPRelayerDB, omniRPCClient omniClient.RPCClient, handler metrics.Handler, attestationAPI attestation.CCTPAPI, rawOpts ...OptionsArgsOption) (*CCTPRelayer, error) {
              opts := makeOptions(rawOpts)
          
              omniClient := omniClient.NewOmnirpcClient(cfg.BaseOmnirpcURL, handler, omniClient.WithCaptureReqRes())
          
          
          Severity: Minor
          Found in services/cctp-relayer/relayer/relayer.go - About 45 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

          Method CCTPRelayer.processQueue has 6 return statements (exceeds 4 allowed).
          Open

          func (c *CCTPRelayer) processQueue(parentCtx context.Context) (err error) {
              // TODO: this might be too short of a deadline depending on the number of pendingTxes in the queue
              deadlineCtx, cancel := context.WithTimeout(parentCtx, time.Second*90)
              defer cancel()
          
          
          Severity: Major
          Found in services/cctp-relayer/relayer/relayer.go - About 40 mins to fix

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

                ctx, span := c.handler.Tracer().Start(parentCtx, "processMessage", trace.WithAttributes(
                    attribute.String(MessageHash, msg.MessageHash),
                    attribute.Int(metrics.Origin, int(msg.OriginChainID)),
                    attribute.Int(metrics.Destination, int(msg.DestChainID)),
                    attribute.String(metrics.TxHash, msg.OriginTxHash),
            Severity: Minor
            Found in services/cctp-relayer/relayer/relayer.go and 2 other locations - About 40 mins to fix
            services/cctp-relayer/relayer/relayer.go on lines 378..383
            services/cctp-relayer/relayer/synapse.go on lines 227..232

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

            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 3 locations. Consider refactoring.
            Open

                ctx, span := c.handler.Tracer().Start(parentCtx, "fetchAttestation", trace.WithAttributes(
                    attribute.String(MessageHash, msg.MessageHash),
                    attribute.Int(metrics.Origin, int(msg.OriginChainID)),
                    attribute.Int(metrics.Destination, int(msg.DestChainID)),
                    attribute.String(metrics.TxHash, msg.OriginTxHash),
            Severity: Minor
            Found in services/cctp-relayer/relayer/relayer.go and 2 other locations - About 40 mins to fix
            services/cctp-relayer/relayer/relayer.go on lines 254..259
            services/cctp-relayer/relayer/synapse.go on lines 227..232

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

            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

                g.Go(func() error {
                    if !c.txSubmitter.Started() {
                        err := c.txSubmitter.Start(ctx)
                        if err != nil && !errors.Is(err, submitter.ErrSubmitterAlreadyStarted) {
                            return fmt.Errorf("could not start tx submitter: %w", err)
            Severity: Minor
            Found in services/cctp-relayer/relayer/relayer.go and 1 other location - About 35 mins to fix
            services/rfq/guard/service/guard.go on lines 135..144

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

            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