Doichain

Current state of the Doichain network as seen by the node behind this server: block height, sync state, time of the last block, fork check, node version, peers, mempool size and whether public anchoring is available.

{
  "type": "object",
  "properties": {},
  "title": "get_chain_statusArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_chain_statusDictOutput"
}

Compute the SHA-256 digest of a short text (UTF-8) on the server, for example to anchor a statement or a message with anchor_proof. The text is sent to the server but not stored or logged. For files and for confidential texts compute the hash locally instead (sha256sum file, or Get-FileHash -Algorithm SHA256).

{
  "type": "object",
  "properties": {
    "text": {
      "description": "Text to hash, encoded as UTF-8 exactly as given (whitespace and line breaks count), at most 40,000 characters",
      "maxLength": 40000,
      "title": "Text",
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "title": "hash_textArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "hash_textDictOutput"
}

Check whether a SHA-256 hash is anchored on the Doichain (name poe/<sha256>) and since when. Returns status (confirmed, pending, expired, unknown) and at the top level block height, block time, transaction and links of the first anchoring, which is the proof time. If the name was updated later or registered again after it expired (possibly by someone else), that registration is reported separately in latest_registration with its own holder and record, which are not part of the original proof. A confirmed or expired proof shows that a document with exactly this hash existed no later than the block time, not who submitted it.

{
  "type": "object",
  "properties": {
    "sha256": {
      "description": "SHA-256 digest of the document, 64 hexadecimal characters (a sha256: or 0x prefix is accepted)",
      "maxLength": 100,
      "title": "Sha256",
      "type": "string"
    }
  },
  "required": [
    "sha256"
  ],
  "title": "check_proofArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "check_proofDictOutput"
}

Anchor a SHA-256 hash on the Doichain as a tamper-evident timestamp (proof of existence, name poe/<sha256>). Free for users, limited per IP address and day (see get_anchoring_quota). Confirms with the next block, usually within 10 minutes, then check_proof returns block height and time. If the hash is already anchored or pending, the existing proof is returned instead of creating a second one. If an earlier proof of the hash has expired, it stays valid and is returned with expired true. Nothing is registered unless reanchor_expired is true. Only the hash and the optional note and file name become public, never the document itself. The operator of this server pays for the name and holds it. The proof shows that a document with this hash existed no later than the block time, not who submitted it.

{
  "type": "object",
  "properties": {
    "sha256": {
      "description": "SHA-256 digest of the document, 64 hexadecimal characters, computed from the actual file. Never guess it and never send the document",
      "maxLength": 100,
      "title": "Sha256",
      "type": "string"
    },
    "note": {
      "anyOf": [
        {
          "maxLength": 160,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional public note (max 160 characters), stored on the blockchain forever. No personal data, no secrets",
      "title": "Note"
    },
    "filename": {
      "anyOf": [
        {
          "maxLength": 80,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional public file name (max 80 characters), stored forever. Only set it when the user explicitly wants the name public",
      "title": "Filename"
    },
    "reanchor_expired": {
      "default": false,
      "description": "Only set to true when an earlier proof of this hash has expired and the user explicitly wants an additional, later registration. The original anchoring stays the proof time. The new registration adds a later timestamp and replaces the public note and holder of the name. Default false",
      "title": "Reanchor Expired",
      "type": "boolean"
    }
  },
  "required": [
    "sha256"
  ],
  "title": "anchor_proofArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "anchor_proofDictOutput"
}

How many proofs can still be anchored today (UTC day) within the free public quota for the caller's IP address. Hosted chat apps connect from their own servers, so their users share one quota. Callers that send their own API key in the X-API-Key header have no quota.

{
  "type": "object",
  "properties": {},
  "title": "get_anchoring_quotaArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_anchoring_quotaDictOutput"
}

Read the current value, owner address and expiry of a Doichain name. Unregistered names come back with exists false and status not_registered (the name is free). Expired names have status expired and the real expiry date.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Full name including namespace, for example poe/<sha256>, d/example or id/alice",
      "maxLength": 255,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "lookup_nameArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "lookup_nameDictOutput"
}

All registrations and updates of a name, newest first: block height, transaction, owner address and the value at that time. Shows who held a name when, and every value it ever had.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Full name including namespace",
      "maxLength": 255,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    },
    "limit": {
      "default": 20,
      "description": "Maximum number of entries, newest first",
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "name"
  ],
  "title": "get_name_historyArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_name_historyDictOutput"
}

Check up to 25 names at once: status (active, expiring_soon, expired, not_registered), blocks left, an estimated expiry date for active names (from the measured block interval) and the real expiry date for expired names. Names expire 36,000 blocks after their last update and are renewed by updating them from the owning wallet.

{
  "type": "object",
  "properties": {
    "names": {
      "description": "Up to 25 full names, for example ['d/example', 'poe/<sha256>']",
      "items": {
        "type": "string"
      },
      "maxItems": 25,
      "minItems": 1,
      "title": "Names",
      "type": "array"
    },
    "warn_days": {
      "default": 30,
      "description": "Names expiring within this many days are flagged expiring_soon",
      "maximum": 365,
      "minimum": 1,
      "title": "Warn Days",
      "type": "integer"
    }
  },
  "required": [
    "names"
  ],
  "title": "check_name_expiryArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "check_name_expiryDictOutput"
}

List names that start with a prefix, in the node's order (shorter names first, then byte order). Lists only active names unless include_expired is true. Expired names (for example old poe/ proofs) stay in the chain history and are listed with include_expired. Page through large results with next_after until exhausted is true. Names and values are chosen by arbitrary users (name_untrusted, value_untrusted).

{
  "type": "object",
  "properties": {
    "prefix": {
      "description": "Name prefix, for example poe/, d/ or id/",
      "maxLength": 255,
      "minLength": 1,
      "title": "Prefix",
      "type": "string"
    },
    "limit": {
      "default": 20,
      "description": "Maximum number of names",
      "maximum": 100,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    },
    "after": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Paging cursor: pass next_after from the previous result unchanged",
      "title": "After"
    },
    "include_expired": {
      "default": false,
      "description": "Also list expired names, for example proofs whose poe/ name has expired. Default false: active names only",
      "title": "Include Expired",
      "type": "boolean"
    }
  },
  "required": [
    "prefix"
  ],
  "title": "search_namesArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "search_namesDictOutput"
}

Header data of a block by height or hash: time, confirmations, number of transactions and the first 50 transaction IDs.

{
  "type": "object",
  "properties": {
    "block": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "description": "Block height (number) or block hash (64 hexadecimal characters)",
      "title": "Block"
    }
  },
  "required": [
    "block"
  ],
  "title": "get_blockArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_blockDictOutput"
}

A transaction with confirmations, block time, outputs (amount in DOI and address) and any name operation (name_doi, name_update, ...) it contains.

{
  "type": "object",
  "properties": {
    "txid": {
      "description": "Transaction ID, 64 hexadecimal characters",
      "maxLength": 100,
      "title": "Txid",
      "type": "string"
    }
  },
  "required": [
    "txid"
  ],
  "title": "get_transactionArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_transactionDictOutput"
}

Confirmed and unconfirmed balance of a Doichain address in DOI, optionally with its most recent transactions. Invalid addresses return an error with the reason.

{
  "type": "object",
  "properties": {
    "address": {
      "description": "Doichain address (M... or N..., 6..., or bech32 dc1q...)",
      "maxLength": 100,
      "minLength": 20,
      "title": "Address",
      "type": "string"
    },
    "include_history": {
      "default": false,
      "description": "Also return the most recent transactions",
      "title": "Include History",
      "type": "boolean"
    },
    "history_limit": {
      "default": 10,
      "description": "Number of recent transactions when include_history is true",
      "maximum": 50,
      "minimum": 1,
      "title": "History Limit",
      "type": "integer"
    }
  },
  "required": [
    "address"
  ],
  "title": "get_addressArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_addressDictOutput"
}

Check whether a message was signed with the private key of a Doichain address (signmessage format). Only legacy addresses (M... or N...) can sign messages, bech32 addresses (dc1q...) are not supported. Useful to confirm that a statement really comes from the holder of an address.

{
  "type": "object",
  "properties": {
    "address": {
      "description": "Legacy Doichain address (M... or N...) that supposedly signed the message",
      "maxLength": 100,
      "minLength": 20,
      "title": "Address",
      "type": "string"
    },
    "message": {
      "description": "The exact signed text",
      "maxLength": 10000,
      "title": "Message",
      "type": "string"
    },
    "signature": {
      "description": "Signature in Base64",
      "maxLength": 200,
      "minLength": 20,
      "title": "Signature",
      "type": "string"
    }
  },
  "required": [
    "address",
    "message",
    "signature"
  ],
  "title": "verify_messageArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "verify_messageDictOutput"
}