Merge pull request #60 from coinbase/patrick/timestamp-start-index

Add timestamp_start_index
coinbase · Oct 19, 2020 · 5d91fdf · 5d91fdf
2 parents 8d01572 + 6667d05
commit 5d91fdf
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/api.json b/api.json
@@ -1,7 +1,7 @@
 {
  "openapi":"3.0.2",
  "info": {
-   "version":"1.4.5",
+   "version":"1.4.6",
    "title":"Rosetta",
    "description":"Build Once. Integrate Your Blockchain Everywhere.",
    "license": {
@@ -1154,6 +1154,12 @@
            "type":"boolean",
            "description":"Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true."
           },
+         "timestamp_start_index": {
+           "type":"integer",
+           "format":"int64",
+           "minimum": 0,
+           "description":"If populated, `timestamp_start_index` indicates the first block index where block timestamps are considered valid (i.e. all blocks less than `timestamp_start_index` could have invalid timestamps). This is useful when the genesis block (or blocks) of a network have timestamp 0. If not populated, block timestamps are assumed to be valid for all available blocks."
+          },
          "call_methods": {
            "type":"array",
            "description":"All methods that are supported by the /call endpoint. Communicating which parameters should be provided to /call is the responsibility of the implementer (this is en lieu of defining an entire type system and requiring the implementer to define that in Allow).",

diff --git a/api.yaml b/api.yaml
@@ -14,7 +14,7 @@
 
 openapi: 3.0.2
 info:
-  version: 1.4.5
+  version: 1.4.6
   title: Rosetta
   description: |
     Build Once. Integrate Your Blockchain Everywhere.

diff --git a/models/Allow.yaml b/models/Allow.yaml
@@ -57,6 +57,19 @@ properties:
     description: |
       Any Rosetta implementation that supports querying the balance
       of an account at any height in the past should set this to true.
+  timestamp_start_index:
+    type: integer
+    format: int64
+    minimum: 0
+    description: |
+      If populated, `timestamp_start_index` indicates the first block index
+      where block timestamps are considered valid (i.e. all blocks
+      less than `timestamp_start_index` could have invalid timestamps).
+      This is useful when the genesis block (or blocks) of a network
+      have timestamp 0.
+
+      If not populated, block timestamps are assumed to be valid for
+      all available blocks.
   call_methods:
     type: array
     description: |