Operator: every checkpoint, the recorded settlement comparisons, and anchoring's incidents (F-017).

GET

/v1/ops/anchors

const url = 'https://example.com/v1/ops/anchors';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/ops/anchors \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

The answer, from one consistent view (REQ-QR-2).

application/json

Anchoring as the operator reads it.

object

checkpoints

required

Every checkpoint.

Array<object>

A checkpoint on the wire.

object

commitment

required

The commitment, hex.

string

coordinate

Any of:

object
null

A settlement-layer record cited by its coordinate.

object

digest

required

The entry’s digest, hex.

string

instance

required

The instance.

integer format: uint32

seq

required

The position in its inbox.

integer format: uint64

created_at

required

When it was created.

integer format: uint64

entry_sequence

required

The sequence of the last entry it covers.

integer format: uint64

kernel_root

required

The kernel root, hex.

string

number

required

Its number: the settlement layer’s anchor number.

integer format: uint64

status

required

pending, submitted or final.

string

comparisons

required

Every recorded comparison.

Array<object>

A settlement comparison at an inbox cut (F-017, REQ-PR-5).

object

anchors

required

The final checkpoints it is the recorded comparison of.

Array<integer>

required

When the core compared.

integer format: uint64

cut

required

The cut: the inbox length at the finalized block compared.

integer format: uint64

differs

required

Whether any asset differs.

boolean

height

required

The block’s height.

integer format: uint64

rows

required

Every asset either side holds.

Array<object>

One asset of a settlement comparison (F-017).

object

asset

required

The asset.

string

book

required

What the book records as held on the settlement layer: minor units, a signed decimal-integer string.

string

difference

required

The layer’s less the book’s.

string

layer

required

What the layer holds, minor units.

string

incidents

required

Every incident.

Array<object>

An anchoring incident on the wire.

object

detail

required

What it concerns.

string

kind

required

commitment_mismatch, unknown_anchor or position_difference.

string

latest_comparison

Any of:

object
null

A settlement comparison at an inbox cut (F-017, REQ-PR-5).

object

anchors

required

The final checkpoints it is the recorded comparison of.

Array<integer>

required

When the core compared.

integer format: uint64

cut

required

The cut: the inbox length at the finalized block compared.

integer format: uint64

differs

required

Whether any asset differs.

boolean

height

required

The block’s height.

integer format: uint64

rows

required

Every asset either side holds.

Array<object>

One asset of a settlement comparison (F-017).

object

asset

required

The asset.

string

book

required

What the book records as held on the settlement layer: minor units, a signed decimal-integer string.

string

difference

required

The layer’s less the book’s.

string

layer

required

What the layer holds, minor units.

string

Example^generated

{
  "checkpoints": [
    {
      "commitment": "example",
      "coordinate": {
        "digest": "example",
        "instance": 1,
        "seq": 1
      },
      "created_at": 1,
      "entry_sequence": 1,
      "kernel_root": "example",
      "number": 1,
      "status": "example"
    }
  ],
  "comparisons": [
    {
      "anchors": [
        1
      ],
      "at": 1,
      "cut": 1,
      "differs": true,
      "height": 1,
      "rows": [
        {
          "asset": "example",
          "book": "example",
          "difference": "example",
          "layer": "example"
        }
      ]
    }
  ],
  "incidents": [
    {
      "detail": "example",
      "kind": "example"
    }
  ],
  "latest_comparison": {
    "anchors": [
      1
    ],
    "at": 1,
    "cut": 1,
    "differs": true,
    "height": 1,
    "rows": [
      {
        "asset": "example",
        "book": "example",
        "difference": "example",
        "layer": "example"
      }
    ]
  }
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).

Operator: every checkpoint, the recorded settlement comparisons, and anchoring's incidents (F-017).

Authorizations

Responses

200

Examplegenerated

4XX

Example

5XX

Example

Headers

Example^generated