synapsecns/sanguine

View on GitHub
services/rfq/relayer/inventory/circle.go

Summary

Maintainability
D
2 days
Test Coverage

Method rebalanceManagerCircleCCTP.Execute has 58 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func (c *rebalanceManagerCircleCCTP) Execute(parentCtx context.Context, rebalance *RebalanceData) (err error) {
    ctx, span := c.handler.Tracer().Start(parentCtx, "rebalance.Execute", trace.WithAttributes(
        attribute.Int("rebalance_origin", rebalance.OriginMetadata.ChainID),
        attribute.Int("rebalance_dest", rebalance.DestMetadata.ChainID),
        attribute.String("rebalance_amount", rebalance.Amount.String()),
Severity: Minor
Found in services/rfq/relayer/inventory/circle.go - About 1 hr to fix

    Method rebalanceManagerCircleCCTP.Execute has 8 return statements (exceeds 4 allowed).
    Open

    func (c *rebalanceManagerCircleCCTP) Execute(parentCtx context.Context, rebalance *RebalanceData) (err error) {
        ctx, span := c.handler.Tracer().Start(parentCtx, "rebalance.Execute", trace.WithAttributes(
            attribute.Int("rebalance_origin", rebalance.OriginMetadata.ChainID),
            attribute.Int("rebalance_dest", rebalance.DestMetadata.ChainID),
            attribute.String("rebalance_amount", rebalance.Amount.String()),
    Severity: Major
    Found in services/rfq/relayer/inventory/circle.go - About 50 mins to fix

      Method rebalanceManagerCircleCCTP.initListeners has 7 return statements (exceeds 4 allowed).
      Open

      func (c *rebalanceManagerCircleCCTP) initListeners(parentCtx context.Context) (err error) {
          ctx, span := c.handler.Tracer().Start(parentCtx, "initListeners")
          defer func(err error) {
              metrics.EndSpanWithErr(span, err)
          }(err)
      Severity: Major
      Found in services/rfq/relayer/inventory/circle.go - About 45 mins to fix

        Function newRebalanceManagerCircleCCTP has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        func newRebalanceManagerCircleCCTP(cfg relconfig.Config, handler metrics.Handler, chainClient submitter.ClientFetcher, txSubmitter submitter.TransactionSubmitter, relayerAddress common.Address, db reldb.Service) *rebalanceManagerCircleCCTP {
        Severity: Minor
        Found in services/rfq/relayer/inventory/circle.go - About 45 mins to fix

          Method rebalanceManagerCircleCCTP.handleDepositForBurn has 7 return statements (exceeds 4 allowed).
          Open

          func (c *rebalanceManagerCircleCCTP) handleDepositForBurn(ctx context.Context, log types.Log, chainID int, ethClient client.EVM) (err error) {
              ctx, span := c.handler.Tracer().Start(ctx, "rebalance.handleDepositForBurn", trace.WithAttributes(
                  attribute.Int(metrics.ChainID, chainID),
              ))
              defer func(err error) {
          Severity: Major
          Found in services/rfq/relayer/inventory/circle.go - About 45 mins to fix

            Method rebalanceManagerCircleCCTP.Start has 7 return statements (exceeds 4 allowed).
            Open

            func (c *rebalanceManagerCircleCCTP) Start(ctx context.Context) (err error) {
                err = c.initContracts(ctx)
                if err != nil {
                    return fmt.Errorf("could not initialize contracts: %w", err)
                }
            Severity: Major
            Found in services/rfq/relayer/inventory/circle.go - About 45 mins to fix

              Method rebalanceManagerCircleCCTP.listenMessageReceived has 6 return statements (exceeds 4 allowed).
              Open

              func (c *rebalanceManagerCircleCCTP) listenMessageReceived(parentCtx context.Context, chainID int, ethClient client.EVM) (err error) {
                  listener, ok := c.transmitterListeners[chainID]
                  if !ok {
                      return fmt.Errorf("could not find listener for chain %d", chainID)
                  }
              Severity: Major
              Found in services/rfq/relayer/inventory/circle.go - About 40 mins to fix

                Method rebalanceManagerCircleCCTP.listenDepositForBurn has 6 return statements (exceeds 4 allowed).
                Open

                func (c *rebalanceManagerCircleCCTP) listenDepositForBurn(parentCtx context.Context, chainID int, ethClient client.EVM) (err error) {
                    listener, ok := c.messengerListeners[chainID]
                    if !ok {
                        return fmt.Errorf("could not find listener for chain %d", chainID)
                    }
                Severity: Major
                Found in services/rfq/relayer/inventory/circle.go - About 40 mins to fix

                  Method rebalanceManagerCircleCCTP.initContracts has 6 return statements (exceeds 4 allowed).
                  Open

                  func (c *rebalanceManagerCircleCCTP) initContracts(parentCtx context.Context) (err error) {
                      ctx, span := c.handler.Tracer().Start(parentCtx, "initContracts")
                      defer func(err error) {
                          metrics.EndSpanWithErr(span, err)
                      }(err)
                  Severity: Major
                  Found in services/rfq/relayer/inventory/circle.go - About 40 mins to fix

                    Method rebalanceManagerCircleCCTP.handleMessageReceived has 5 return statements (exceeds 4 allowed).
                    Open

                    func (c *rebalanceManagerCircleCCTP) handleMessageReceived(ctx context.Context, log types.Log, chainID int, ethClient client.EVM) (err error) {
                        ctx, span := c.handler.Tracer().Start(ctx, "rebalance.handleMessageReceived")
                        defer func(err error) {
                            metrics.EndSpanWithErr(span, err)
                        }(err)
                    Severity: Major
                    Found in services/rfq/relayer/inventory/circle.go - About 35 mins to fix

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

                      func (c *rebalanceManagerCircleCCTP) listenMessageReceived(parentCtx context.Context, chainID int, ethClient client.EVM) (err error) {
                          listener, ok := c.transmitterListeners[chainID]
                          if !ok {
                              return fmt.Errorf("could not find listener for chain %d", chainID)
                          }
                      Severity: Major
                      Found in services/rfq/relayer/inventory/circle.go and 1 other location - About 4 hrs to fix
                      services/rfq/relayer/inventory/circle.go on lines 260..289

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

                      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

                      func (c *rebalanceManagerCircleCCTP) listenDepositForBurn(parentCtx context.Context, chainID int, ethClient client.EVM) (err error) {
                          listener, ok := c.messengerListeners[chainID]
                          if !ok {
                              return fmt.Errorf("could not find listener for chain %d", chainID)
                          }
                      Severity: Major
                      Found in services/rfq/relayer/inventory/circle.go and 1 other location - About 4 hrs to fix
                      services/rfq/relayer/inventory/circle.go on lines 292..321

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

                      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