Circuit Breaker

It allows nodes to protect themselves from being flooded with HTLCs.

  • Crypto Currency
  • Security
It allows nodes to protect themselves from being flooded with HTLCs. With circuitbreaker a maximum to the number of in-flight HTLCs can be set on a per-peer basis. Known and trusted peers for example can be assigned a higher maximum, while a new channel from a previously unseen node may be limited to only a few pending HTLCs. Furthermore it is possible to apply rate limits to the number of forwarded HTLCs. This offers protection against DoS/spam attacks that rely on large numbers of fast-resolving HTLCs. Rate limiting is implemented with a Token bucket. Via the UI the minimum interval between HTLCs can be specified. Large numbers of HTLCs are also required for probing channel balances. Reducing the information leakage through probing could be another reason to put in place a rate limit for untrusted peers. Operating modes There are multiple modes in which circuitbreaker can operate. A

Platform availability

Available on 1 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

18/100 Low

Maintained
0last commit 1003 days ago
Popular
00 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
701 GB minimum RAM

Availability: platform listings confirmed today, links checked 16 days ago

GitHub stars
0
Open issues
0
Last commit
2024-02-22
License
MIT
Activity
stale

Checked 5 days ago - source: GitHub (stfndamjanovic/php-circuit-breaker)

Resources & Compatibility

Minimum requirements: 1 GB RAM, 80 MB disk.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Add the core library before starting In your project's Gradle settings file (the file Gradle uses to build the app), add the circuit-foundation dependency line from the docs. Without it, the compiler can't find Circuit classes and the project won't build. source
  • Add code generation if your app uses it If you are using Circuit's code generation, add the KSP (a build plugin that generates code while compiling) and the two circuit-codegen dependency lines. Without them, Circuit can't create the extra code it needs, so the build may fail. source
  • Wire up navigation so screens can move Wrap your Circuit content in CircuitCompositionLocals, create a back stack (the list of screens the user can return to) and navigator, and pass them to NavigableCircuitContent. Without this, your app won't have working screen-to-screen navigation or back behavior. source

Fetched 39 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How should I install the PHP circuit breaker for a self-hosted app?

Install it through Composer with the package name stfn/php-circuit-breaker.

Which storage option is recommended for most PHP applications?

The default InMemoryStorage is described as not suitable for most PHP applications. RedisStorage is described as more useful, and a custom storage implementation is also possible.

How can I stop calls to a service temporarily?

Use forceOpenCircuit on the CircuitBreaker instance to put it into Force Open. Calls in that state throw a CircuitOpenException.

Which failure and recovery settings can be customized?

You can customize failure_threshold, recovery_time, and sample_duration.

Answers sourced from github.com

Community

Collected 48 days ago - public community threads