Subscribe checkpoints

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Subscribes to checkpoint updates.

gRPC method: sui.rpc.v2.SubscriptionService.SubscribeCheckpoints (server-streaming).

This is a gRPC method (HTTP/2, Protocol Buffers), not a REST endpoint. The request and response bodies below are shown in the proto3 JSON form that tools such as grpcurl and Postman accept and print. Pass your NOWNodes API key as the api-key gRPC metadata header. Proto files: sui/rpc/v2/subscription_service.proto.

This method is server-streaming: the server keeps the call open and sends a sequence of response messages; each message has the response schema below.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/subscription_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.SubscriptionService.SubscribeCheckpoints

Body

application/json

Request message for SubscriptionService.SubscribeCheckpoints.

readMaskobject

Optional. Mask for specifying which parts of the Checkpoint should be returned (e.g. summary, contents, signatures). cursor is always populated and is not subject to the mask. Read mask: list of field paths to return, in snake_case (e.g. "object_id", "version", "digest"). Nested fields use dots (e.g. "effects.status").

Show child attributes

pathsArray<string>required

Field paths to return.

filterTransactionFilter

Optional. DNF filter over indexed transaction dimensions. A checkpoint matches if any transaction it contains satisfies the filter. If absent, every checkpoint is streamed.

Response

200OK

Stream of response messages.

default

gRPC error. The status code (e.g. UNAUTHENTICATED, INVALID_ARGUMENT, NOT_FOUND) is returned in the grpc-status trailer, details in grpc-message.

Subscribe checkpoints

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints' \
  -H 'Content-Type: application/json' \
  -d '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "affectedAddress": {
                "address": "string"
              },
              "affectedObject": {
                "objectId": "string"
              },
              "moveCall": {
                "function": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    }
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "affectedAddress": {
                  "address": "string"
                },
                "affectedObject": {
                  "objectId": "string"
                },
                "moveCall": {
                  "function": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      }
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "affectedAddress": {
                "address": "string"
              },
              "affectedObject": {
                "objectId": "string"
              },
              "moveCall": {
                "function": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    }
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "filter": {
    "terms": [
      {
        "literals": [
          {
            "negated": True,
            "sender": {
              "address": "string"
            },
            "affectedAddress": {
              "address": "string"
            },
            "affectedObject": {
              "objectId": "string"
            },
            "moveCall": {
              "function": "string"
            },
            "emitModule": {
              "module": "string"
            },
            "eventType": {
              "eventType": "string"
            },
            "eventStreamHead": {
              "streamId": "string"
            }
          }
        ]
      }
    ]
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints', json=payload)
data = response.json()

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "affectedAddress": {
                  "address": "string"
                },
                "affectedObject": {
                  "objectId": "string"
                },
                "moveCall": {
                  "function": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      }
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "affectedAddress": {
                "address": "string"
              },
              "affectedObject": {
                "objectId": "string"
              },
              "moveCall": {
                "function": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    }
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "affectedAddress": {
                  "address": "string"
                },
                "affectedObject": {
                  "objectId": "string"
                },
                "moveCall": {
                  "function": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "filter": {
    "terms": [
      {
        "literals": [
          {
            "negated": True,
            "sender": {
              "address": "string"
            },
            "affectedAddress": {
              "address": "string"
            },
            "affectedObject": {
              "objectId": "string"
            },
            "moveCall": {
              "function": "string"
            },
            "emitModule": {
              "module": "string"
            },
            "eventType": {
              "eventType": "string"
            },
            "eventStreamHead": {
              "streamId": "string"
            }
          }
        ]
      }
    ]
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.SubscriptionService/SubscribeCheckpoints')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "affectedAddress": {
                "address": "string"
              },
              "affectedObject": {
                "objectId": "string"
              },
              "moveCall": {
                "function": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    }
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{}

{
  "readMask": {
    "paths": [
      "cursor",
      "checkpoint.sequence_number",
      "checkpoint.digest"
    ]
  }
}