Class BuildLocalAbstract

Can perform builds. Will only perform a build if a contract is not built yet or FADROMA_REBUILD=1 is set.

Hierarchy

Constructors

constructor

Properties

buildGid? buildUid? caching id log noFetch outputDir quiet revision script? toolchain verbose workspace? variants

Methods

build buildMany hashPath populatePrebuilt prebuild resolveSource

Constructors

constructor

  • Parameters

    • options: Partial<{
          builder: string;
          caching: boolean;
          dockerImage: "ghcr.io/hackbg/fadroma:master";
          dockerSocket: "/var/run/docker.sock";
          dockerfile: string;
          noFetch: false;
          outputDir: string;
          outputGid: undefined | string;
          outputUid: undefined | string;
          podman: false;
          preferredRemote: undefined | string;
          quiet: false;
          raw: false;
          script: string;
          sshAuthSocket: undefined | string;
          toolchain: "";
          verbose: false;
          workspace: string;
      }>

    Returns BuildLocal

Properties

Optional buildGid

buildGid?: number = ...

Owner gid that is set on build artifacts.

Optional buildUid

buildUid?: number = ...

Owner uid that is set on build artifacts.

caching

caching: boolean = true

Whether to enable build caching. When set to false, this builder will rebuild even when binary and checksum are both present in wasm/ directory

Readonly id

id: string = 'local'

Unique identifier of this builder implementation.

log

log: BuildConsole = ...

Logger.

noFetch

noFetch: boolean = false

Whether to skip any git fetch calls in the build script.

outputDir

outputDir: OpaqueDirectory

Name of directory where build artifacts are collected.

quiet

quiet: boolean = false

Whether the build log should be printed only on error, or always

revision

revision: string = HEAD

Default Git reference from which to build sources.

Optional script

script?: string

The build script.

toolchain

toolchain: null | string = null

Version of Rust toolchain to use.

verbose

verbose: boolean = false

Whether the build process should print more detail to the console.

Optional workspace

workspace?: string

The project workspace.

Static variants

variants: Record<string, BuilderClass<Builder>> = {}

Global registry of builder variants. Populated downstream.

Methods

Abstract build

  • Up to the implementation. @hackbg/fadroma implements dockerized and non-dockerized variants on top of the build.impl.mjs script.

    Parameters

    Returns Promise<Built>

Abstract buildMany

Protected hashPath

  • Parameters

    • location: string | Path

    Returns string

    the SHA256 hash of the file at the specified location

Protected populatePrebuilt

Protected prebuild

  • Check if artifact exists in local artifacts cache directory. If it does, don't rebuild it but return it from there.

    Parameters

    • outputDir: string
    • Optional crate: string
    • revision: string = HEAD

    Returns null | Built

Protected resolveSource

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc