omnirpc doc fixes #2637
+3,056
−4
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -102,6 +102,7 @@ require ( | |
| github.com/fatih/structtag v1.2.0 // indirect | ||
| github.com/felixge/httpsnoop v1.0.3 // indirect | ||
| github.com/fjl/memsize v0.0.2 // indirect | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b // indirect | ||
| github.com/fsnotify/fsnotify v1.6.0 // indirect | ||
| github.com/gabriel-vasile/mimetype v1.4.3 // indirect | ||
| github.com/gballet/go-libpcsclite v0.0.0-20191108122812-4678299bea08 // indirect | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -351,6 +351,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw | |
| github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA= | ||
| github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus= | ||
| github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k= | ||
| github.com/frankban/quicktest v1.11.3/go.mod h1:wRf/ReqHper53s+kmmSZizM8NamnL3IM0I9ntUbOk+k= | ||
| github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -114,6 +114,7 @@ require ( | |
| github.com/fatih/structtag v1.2.0 // indirect | ||
| github.com/felixge/httpsnoop v1.0.3 // indirect | ||
| github.com/fjl/memsize v0.0.2 // indirect | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b // indirect | ||
| github.com/fsnotify/fsnotify v1.6.0 // indirect | ||
| github.com/gabriel-vasile/mimetype v1.4.3 // indirect | ||
| github.com/gballet/go-libpcsclite v0.0.0-20191108122812-4678299bea08 // indirect | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -617,6 +617,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw | |
| github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA= | ||
| github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus= | ||
| github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k= | ||
| github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= | ||
| github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||||||
| # OmniRPC | ||||||||||
|
|
||||||||||
| [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc) | ||||||||||
|
There was a problem hiding this comment. Fix the URL for the Go Reference badge. - [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc)
+ [](https://pkg.go.dev/github.com/synapsecns/sanguine/services/omnirpc)Committable suggestion
Suggested change
|
||||||||||
| [](https://goreportcard.com/report/github.com/synapsecns/sanguine/services/omnirpc) | ||||||||||
|
|
||||||||||
|
|
||||||||||
|
|
@@ -73,7 +73,7 @@ This is because chains might have different states for "latest", resulting in fa | |||||||||
|
|
||||||||||
| You can also query using a customizable number of confirmations using (for 2 confirmations on eth): `http://localhost:5000/confirmations/2/rpc/1`. | ||||||||||
|
|
||||||||||
| A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint` | ||||||||||
|
There was a problem hiding this comment. Replace hard tabs with spaces in the YAML configuration example. - "jsonrpc":"2.0",
- "method":"eth_getTransactionCount",
- "params":[
- "0x230a1ac45690b9ae1176389434610b9526d2f21b",
- "0xec1d40"
- ],
- "id":1
+ "jsonrpc":"2.0",
+ "method":"eth_getTransactionCount",
+ "params":[
+ "0x230a1ac45690b9ae1176389434610b9526d2f21b",
+ "0xec1d40"
+ ],
+ "id":1Committable suggestion
Suggested change
Clarify the endpoint for the Postman collection. - A full postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json endpoint`
+ A full Postman collection can be found [here](https://github.com/synapsecns/sanguine/blob/master/services/omnirpc/swagger/collection.json) or at the `/collection.json` endpoint.Committable suggestion
Suggested change
|
||||||||||
|
|
||||||||||
| Confirmable only when latest or pending are not passed: | ||||||||||
|
|
||||||||||
|
|
@@ -122,3 +122,4 @@ You can also quickly start a server running against all public chainlist rpcs wi | |||||||||
| ## Additional functionality | ||||||||||
|
|
||||||||||
| Please see [modules/README.md](modules/README.md) for additional functionality. | ||||||||||
|
|
||||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,7 @@ require ( | |
| github.com/buger/jsonparser v1.1.1 | ||
| github.com/davecgh/go-spew v1.1.1 | ||
| github.com/ethereum/go-ethereum v1.11.6 | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b | ||
| github.com/gin-gonic/gin v1.9.1 | ||
| github.com/go-http-utils/headers v0.0.0-20181008091004-fed159eddc2a | ||
| github.com/go-resty/resty/v2 v2.11.0 | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -339,6 +339,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw | |
| github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA= | ||
| github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI= | ||
| github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus= | ||
| github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k= | ||
| github.com/frankban/quicktest v1.11.3/go.mod h1:wRf/ReqHper53s+kmmSZizM8NamnL3IM0I9ntUbOk+k= | ||
| github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ import ( | |
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/core/types" | ||
| "github.com/ethereum/go-ethereum/params" | ||
| "github.com/flowchartsman/swaggerui" | ||
| "github.com/gin-gonic/gin" | ||
| "github.com/synapsecns/sanguine/core/ginhelper" | ||
| "github.com/synapsecns/sanguine/core/metrics" | ||
|
|
@@ -17,6 +18,7 @@ import ( | |
| "github.com/synapsecns/sanguine/ethergo/parser/rpc" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/collection" | ||
| omniHTTP "github.com/synapsecns/sanguine/services/omnirpc/http" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/swagger" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "io" | ||
|
|
@@ -82,6 +84,8 @@ func (r *finalizedProxyImpl) Run(ctx context.Context) error { | |
| c.Data(http.StatusOK, gin.MIMEJSON, res) | ||
| }) | ||
|
|
||
| router.Any("/swagger/*any", gin.WrapH(http.StripPrefix("/swagger", swaggerui.Handler(swagger.OpenAPI)))) | ||
|
|
||
| r.logger.Infof(ctx, "running on port %d", r.port) | ||
| err := router.Run(fmt.Sprintf("0.0.0.0:%d", r.port)) | ||
| if err != nil { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,7 @@ import ( | |
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/core/types" | ||
| "github.com/ethereum/go-ethereum/eth/filters" | ||
| "github.com/flowchartsman/swaggerui" | ||
| "github.com/gin-gonic/gin" | ||
| "github.com/ipfs/go-log" | ||
| "github.com/synapsecns/sanguine/core/ginhelper" | ||
|
|
@@ -19,6 +20,7 @@ import ( | |
| "github.com/synapsecns/sanguine/services/omnirpc/collection" | ||
| omniHTTP "github.com/synapsecns/sanguine/services/omnirpc/http" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/proxy" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/swagger" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "golang.org/x/sync/errgroup" | ||
|
|
@@ -71,6 +73,8 @@ func (r *HarmonyProxy) Run(_ context.Context) error { | |
| } | ||
| }) | ||
|
|
||
| router.Any("/swagger/*any", gin.WrapH(http.StripPrefix("/swagger", swaggerui.Handler(swagger.OpenAPI)))) | ||
|
|
||
| router.GET("/collection.json", func(c *gin.Context) { | ||
| res, err := collection.CreateCollection() | ||
| if err != nil { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,13 +3,15 @@ package proxy | |
| import ( | ||
| "context" | ||
| "fmt" | ||
| "github.com/flowchartsman/swaggerui" | ||
| "github.com/gin-gonic/gin" | ||
| "github.com/synapsecns/sanguine/core/ginhelper" | ||
| "github.com/synapsecns/sanguine/core/metrics" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/chainmanager" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/collection" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/config" | ||
| omniHTTP "github.com/synapsecns/sanguine/services/omnirpc/http" | ||
| "github.com/synapsecns/sanguine/services/omnirpc/swagger" | ||
| "go.opentelemetry.io/otel/trace" | ||
| "net/http" | ||
| "strconv" | ||
|
|
@@ -96,6 +98,8 @@ func (r *RPCProxy) Run(ctx context.Context) { | |
| c.JSON(http.StatusOK, r.chainManager.GetChainIDs()) | ||
| }) | ||
|
|
||
| router.Any("/swagger/*any", gin.WrapH(http.StripPrefix("/swagger", swaggerui.Handler(swagger.OpenAPI)))) | ||
|
|
||
| router.GET("/collection.json", func(c *gin.Context) { | ||
| res, err := collection.CreateCollection() | ||
| if err != nil { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace hard tabs with spaces in the YAML configuration example.
Committable suggestion