PolySign ABC Memorials API

openapi: 3.2.0
info:
  description: This document lists all AtomicNet ABC Proxy Service APIs for development use.
  license:
    name: PolySign License
    url: https://polysign.io/licenses/LICENSE-1.0
  title: AtomicNet ABC Proxy Service ABC Memorials API
  version: 5fddf272a23655e1582a8a157a8d0ac8e0d517e2
security:
- OAuth2:
  - participant
tags:
- name: ABC Memorials
paths:
  /v1/abc_memorials/:
    put:
      summary: Memorialize a digest using abc account for the given AtomicNet id.
      tags:
      - ABC Memorials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ABCMemorialRequest'
      responses:
        '200':
          description: Empty
  /v1/abc_memorials/{digest}:
    get:
      summary: Verify if the digest is memorialized to ABC.
      tags:
      - ABC Memorials
      parameters:
      - name: digest
        in: path
        description: The digest to be checked
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The ABC memorialization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ABCVerifyMemorialResponse'
components:
  schemas:
    ABCVerifyMemorialResponse:
      type: object
      properties:
        block_height:
          type: integer
          description: The block height of the memorialized digest.
        status:
          type: string
          description: The status of memorial.
      required:
      - block_height
      - status
      description: Dataclass for ABC check memorial response schema.
    ABCMemorialRequest:
      type: object
      properties:
        signature:
          description: Signature for the associated digest.
          allOf:
          - $ref: '#/components/schemas/AbcSignature'
        digest:
          type: string
          description: The data digest to be memorialized.
        payload:
          type:
          - string
          - 'null'
          default: null
          description: The (sideband) data payload.
        txn_fee:
          type:
          - integer
          - 'null'
          default: null
          description: The memorial transaction fee.
        memorial_type:
          type:
          - string
          - 'null'
          default: null
          description: The memorial type.
        atomicnet_id:
          type: string
          format: uuid
          description: Identifier of the AtomicNet Participant.
      required:
      - atomicnet_id
      - digest
      - signature
      description: Dataclass for ABC memorial request schema.
    AbcSignature:
      type: object
      properties:
        schema_version:
          type:
          - integer
          - 'null'
          default: 1
          description: Version for the message schema.
        digest_type:
          type: string
          description: The ABC digest type.
        signature:
          type: string
          description: Signature of the digest.
        digest:
          type: string
          description: The digest to be signed.
        abc_account_id:
          type: string
          description: Identifier of the ABC account.
      required:
      - abc_account_id
      - digest
      - digest_type
      - signature
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 with the client credentials grant flow.
      flows:
        clientCredentials:
          tokenUrl: /v1/auth/token
          scopes:
            participant: Grants access to participant.