Skip to content

Commit

Permalink
PK-2485: test github workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
xxbbxb committed May 23, 2024
1 parent 104c162 commit 5ed647a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
fetch-depth: 0
-
name: Set up Go
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: '>=1.22.0'
-
name: Run GoReleaser
uses: goreleaser/goreleaser-action@v5
Expand Down
11 changes: 6 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ JSON-RPC/substrate aware reverse proxy in Go.
Conisist of two parts:

`proxy` - simple reverse proxy supports websocket/http

`consumer` (optional) - monitors extrinsics (seen by proxy) inclusion to blockchain, provide observability and retry mechanism to resist node failures after transaction was accepted by RPC node but before it was included into block


##### Proxy
#### Proxy configuration

* `SUB_LISTEN (default ":9944,:9933")` - Comma-separated list of local addresses to listen
* `SUB_HOSTS (default "http+ws://127.0.0.1:9944/")` - Comma-separated list of upstream urls, each upstream schemes supported: ws, http, http+ws, https, wss, https+wss
Expand All @@ -28,7 +29,7 @@ Conisist of two parts:
* `SUB_IGNORE_HEALTHCHECKS` - Removes upstream healthchecking logic considering that it's always alive
* `SUB_DENY_METHODS (default "author_rotateKeys")` - Comma-separated list of methods that proxy must not forward to upstream

##### How Proxy choose upstream
#### How Proxy choose upstream

Only one load-balancing strategy supported: **random**

Expand All @@ -41,7 +42,7 @@ Only one load-balancing strategy supported: **random**
5. if there is no server that can handle websocket request then proxy will wait 10 seconds and then retry to pick upstream and finally proxy will giveup and forward request to **random** server if no apropriate was found.


##### Consumer
#### Consumer configuration

Tracks extrinsic inclusion and optionally tries to resubmit them, configuration:

Expand All @@ -52,13 +53,13 @@ Worth mentioning:
* `SUB_TRY_RESUBMIT` - resubmit extrinsic if it not appeared on-chain so far


##### Similar projects
#### Similar projects

* [dshackle](https://github.com/emeraldpay/dshackle)
* [subway](https://github.com/acalanetwork/subway)


##### Features
#### Features

Decode storage with any http client
```curl -s -d '{"id":1, "jsonrpc":"extensions/get-storage/1.0","method":"system.events"}' -v http://127.0.0.1:9944 | jq
Expand Down

0 comments on commit 5ed647a

Please sign in to comment.