Skip to content

Latest commit

 

History

History
89 lines (71 loc) · 2.65 KB

AEIP-13.md

File metadata and controls

89 lines (71 loc) · 2.65 KB
Raw
AEIP Title Author Type Category Status Requires Created
13
AEWeb - Publication Status
Bastien CHAMAGNE <[email protected]>
Standard Track
AERC
Final
AEIP-08
2023-06-26

Specification

It's a fact, data on the blockchain is immutable. No-one can erase a transaction. Since we cannot remove anything, how can a user remove a AEWeb website?

This AEIP defines a new schema for AEWeb reference transactions. By adding an attribute, it allows a AEWeb website's owner to change its AEWeb website publication status. This new attribute publicationStatus tells the AEWeb internal dApp to not serve the content and return an error message instead.

This works because the first thing AEWeb does is fetch the latest reference transaction of the chain. This is how a AEWeb website is able to keep the same URL even though it might be updated multiple times.

The node needs two modifications:

  1. Add a new sub schema for AEWeb transaction
  2. The controller which serves the AEWeb content should check the status and act accordingly

New sub schema

{
  "type": "object",
  "description": "Reference tx of an unpublished website",
  "properties": {
    "aeip": {
      "type": "array",
      "items": { "type": "number" },
      "description": "Supported AEIPs"
    },
    "aewebVersion": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "AEWeb's version"
    },
    "publicationStatus": {
      "type": "string",
      "enum": ["UNPUBLISHED"]
    }
  },
  "required": ["aewebVersion", "publicationStatus"],
  "additionalProperties": false
}

This sub schema is used in a oneOf that also contains the two existing sub schemas:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {...},
    "oneOf": [
        {"$ref": "#/definitions/aewebRefTxPublished"},
        {"$ref": "#/definitions/aewebRefTxUnpublished"},
        {"$ref": "#/definitions/aewebDataTx"},
    ]
}

Example of a web_hosting transaction's content to unpublish a website

{
  "aeip": [8, 13],
  "aewebVersion": 1,
  "publicationStatus": "UNPUBLISHED"
}

Controller logic

When fetching the reference transaction for a AEWeb website, the controller will check the new publicationStatus attribute from the JSON. From there, there is 3 possibilities:

  1. publicationStatus is not set, defaults to PUBLISHED
  2. publicationStatus is set to PUBLISHED
  3. publicationStatus is set to UNPUBLISHED

Now, when the website is unpublished, instead of fetching the data, the controller will return a 410 Gone HTTP response status.

Backward compatibility

Backward compatibility is assured because we default to PUBLISHED status.