StateQL

This binary provides a graphql server query endpoint. The schema is generated from the filecoin schema defined in /types/gen in this repo.

Heavy lifting of the graphql tree generation in schema.go is performed through go-ipld-prime code generation.

(the code generation is triggered through go generate ./... at the root of this repo.)

Example Queries

Check that things are working (Get latest available tipset height)

query Query {
  Height(at: -1) {
    Height
  }
}

Get the Init Actor's mapping of key->ID addresses

query Query {
  Height(at: -1) {
    Height
    ParentStateRoot {
      Version
      Actors{
        At(key: "f01") {
        	Head {
            ... on InitV0State {
              NextID
              AddressMap{
                All {
                  Key
                  Value
                }
              }
            }
          }
        }
      }
    }
  }
}

Pull a parameter out of messages of a specific type

fragment pci on MinerV0SectorPreCommitInfo {
  Expiration
  SectorNumber
}

query Query {
  Height(at: -1) {
    Height
    Messages {
      BlsMessages {
        AllOf(method: 6) {
          InterpretedParams(actorType: "storageMinerActorV2") {
            ...pci
          }
        }
      }
    }
  }
}

Note: the actorType string is defined as the value in the table of mapped types

A more realistic message extraction query would be:

query query {
  Heights(from: 261540, to: 261545) {
    Height
    Messages {
      BlsMessages {
        AllOf(method: 4) {
          InterpretedParams(actorType: "storageMarketActorV2") {
            ... on MessageParamsMarketPublishDeals {
              Deals {
                All {
                  Proposal {
                    Client
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The AllOf filtering limits parsing to help with errors a bit. The table of which number a method corresponds to can be found in the top level of this repo.

A parameterized query for a specific Miner's Owner

query Query($addr: RawAddress!) {
  Height(at: -1) {
    ParentStateRoot{
      Actors{
        At(key: $addr) {
          Head {
            ... on MinerV2State {
              Info {
                Owner
              }
            }
          }
        }
      }
    }
  }
}

with Query variable:
{
  "addr": "f02770"
}

Or again, using the AllOf helper to get all Miner's

query Query {
  Heights(from: 224222, to: 224224) {
    Height
    ParentStateRoot {
      Actors {
        AllOf(type: "storageMinerActorV2") {
          Key
          Value {
            Head {
              ... on MinerV2State {
                Info {
                  Owner
                }
              }
            }
          }
        }
      }
    }
  }
}

Or using AllOf to get all multisig signers:

query Query {
  Height(at: -1) {
    ParentStateRoot {
      Actors {
        AllOf(type: "multisigActor") {
          Key
          Value {
            Head {
              ...on MultisigV0State {
                Signers {
                  All
                }
              }
            }
          }
        }
      }
    }
  }
}