Client states

ClientStates queries all the IBC light clients of a chain.

GET//rest.origin.uptick.network/ibc/core/client/v1/client_states

Query parameters

Response

200default

A successful response.

Body

*/*

client_statesarray of object

list of stored ClientStates of the chain.

paginationpagination response

PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest. message SomeResponse { repeated Bar results = 1; PageResponse page = 2; }

Request

JavaScriptCurlPython

const response = await fetch('//rest.origin.uptick.network/ibc/core/client/v1/client_states', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "client_states": [
    {
      "client_id": "text",
      "client_state": {
        "type_url": "text",
        "value": "Ynl0ZXM="
      }
    }
  ],
  "pagination": {
    "next_key": "Ynl0ZXM=",
    "total": "text"
  }
}

ClientState queries an IBC light client.

GET//rest.origin.uptick.network/ibc/core/client/v1/client_states/{client_id}

Path parameters

client_id*string

client state unique identifier

Response

200default

A successful response.

Body

*/*

client_stateclient state associated with the request identifier

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; }

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

proofmerkle proof of existence

proof_heightheight at which the proof was retrieved

Normally the RevisionHeight is incremented at each height while keeping RevisionNumber the same. However some consensus algorithms may choose to reset the height in certain conditions e.g. hard forks, state-machine breaking changes In these cases, the RevisionNumber is incremented so that height continues to be monitonically increasing even as the RevisionHeight gets reset

Request

JavaScriptCurlPython

const response = await fetch('//rest.origin.uptick.network/ibc/core/client/v1/client_states/{client_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "client_state": {
    "type_url": "text",
    "value": "Ynl0ZXM="
  },
  "proof": "Ynl0ZXM=",
  "proof_height": {
    "revision_number": "text",
    "revision_height": "text"
  }
}