Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: enable listing API methods for Boost #1442

Merged
merged 3 commits into from
May 10, 2023
Merged

feat: enable listing API methods for Boost #1442

merged 3 commits into from
May 10, 2023

Conversation

LexLuthr
Copy link
Collaborator

@LexLuthr LexLuthr commented May 9, 2023

Fixes #1416

Sample output:

# curl -s  http://boost:1288/rpc/v0 -H "Authorization: Bearer $(cat /var/lib/boost/token)" -X POST -H "Content-Type: application/json" --data '{"method":"Filecoin.Discover","params":[],"id":1,"jsonrpc":"2.0"}' | jq . | head -20
{
  "jsonrpc": "2.0",
  "result": {
    "info": {
      "title": "Boost RPC API",
      "version": "1.7.3-rc1"
    },
    "methods": [
      {
        "deprecated": false,
        "description": "```go\nfunc (s *BoostStruct) ActorSectorSize(p0 context.Context, p1 address.Address) (abi.SectorSize, error) {\n\tif s.Internal.ActorSectorSize == nil {\n\t\treturn *new(abi.SectorSize), ErrNotSupported\n\t}\n\treturn s.Internal.ActorSectorSize(p0, p1)\n}\n```",
        "externalDocs": {
          "description": "Github remote link",
          "url": "https://github.com/filecoin-project/boost/blob/master/api/proxy_gen.go#L271"
        },
        "name": "Filecoin.ActorSectorSize",
        "paramStructure": "by-position",
        "params": [
          {
            "deprecated": false,
# curl -s  http://boost:1288/rpc/v0 -H "Authorization: Bearer $(cat /var/lib/boost/token)" -X POST -H "Content-Type: application/json" --data '{"method":"rpc.discover","params":[],"id":1,"jsonrpc":"2.0"}' | jq . | head -20
{
  "jsonrpc": "2.0",
  "result": {
    "info": {
      "title": "Boost RPC API",
      "version": "1.7.3-rc1"
    },
    "methods": [
      {
        "deprecated": false,
        "description": "```go\nfunc (s *BoostStruct) ActorSectorSize(p0 context.Context, p1 address.Address) (abi.SectorSize, error) {\n\tif s.Internal.ActorSectorSize == nil {\n\t\treturn *new(abi.SectorSize), ErrNotSupported\n\t}\n\treturn s.Internal.ActorSectorSize(p0, p1)\n}\n```",
        "externalDocs": {
          "description": "Github remote link",
          "url": "https://github.com/filecoin-project/boost/blob/master/api/proxy_gen.go#L271"
        },
        "name": "Filecoin.ActorSectorSize",
        "paramStructure": "by-position",
        "params": [
          {
            "deprecated": false,

@LexLuthr LexLuthr changed the title feat: enable rpc.discover API feat: enable listing API methods for Boost May 9, 2023
@LexLuthr LexLuthr marked this pull request as ready for review May 9, 2023 17:39
@LexLuthr LexLuthr requested a review from dirkmc May 9, 2023 17:56
@LexLuthr LexLuthr merged commit 803878f into main May 10, 2023
@LexLuthr LexLuthr deleted the feat/api-list branch May 10, 2023 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable rpc.discover for Boost API
2 participants