Skip to content
v9.1.1
Français

ArtifactReference

import type { ArtifactReference } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • formatRequired
    1
    Reference format version, always 1.
  • idRequired
    string
    Content-addressed id: SHA-256 of the format, digest, size, contract, producer and ordered parents. Reads recompute it and reject an edited reference.
  • digestRequired
    string
    SHA-256 of the stored bytes, in lowercase hexadecimal. Reads reject bytes with another digest.
  • sizeRequired
    number
    Byte length of the stored payload. Reads reject bytes of another length.
  • contractRequired
    ArtifactIdentity
    Name, version and encoding of the contract that encoded the payload. A read with another contract rejects with Artifact contract mismatch.
  • producerRequired
    ArtifactProducer
    Execution, task and attempt that published the artifact, as declared by the publisher; not authenticated.
  • parentsRequired
    readonly string[]
    Ids of the parent artifacts, in the order given at publication, without duplicates.

Signature

Section titled “Signature”
export interface ArtifactReference {
  readonly format: 1;
  readonly id: string;
  readonly digest: string;
  readonly size: number;
  readonly contract: ArtifactIdentity;
  readonly producer: ArtifactProducer;
  readonly parents: readonly string[];
}
Section titled “Related contracts”