Class ContainerizedLocalRustCompiler

Runs the build script in a container.

Hierarchy (view full)

LocalRustCompiler
- ContainerizedLocalRustCompiler

Index

Constructors

constructor

new ContainerizedLocalRustCompiler(options?): ContainerizedLocalRustCompiler
Parameters
- Optional options: Partial<ContainerizedLocalRustCompiler>
Returns ContainerizedLocalRustCompiler
Overrides LocalRustCompiler.constructor
- Defined in compile/compile.ts:376

Properties

`Optional` buildGid

buildGid?: number = ...

Owner gid that is set on build artifacts.

buildImage

buildImage: Image

Tag of the docker image for the build container.

buildImageManifest

buildImageManifest: string = ...

Path to the dockerfile for the build container if missing.

buildImageTag

buildImageTag: string = ...

Docker image to use for dockerized builds.

`Optional` buildUid

buildUid?: number = ...

Owner uid that is set on build artifacts.

caching

caching: boolean = !this.config.getFlag('FADROMA_REBUILD', ()=>false)

Whether to enable caching and reuse contracts from artifacts directory.

config

config: Config

engine

engine: Connection

Used to launch build container.

engineSocket

engineSocket: string = ...

Path to Docker API endpoint.

`Readonly` id

id: string = 'local'

Unique identifier of this compiler implementation.

log

log: Core.Console

noFetch

noFetch: boolean = ...

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

outputDir

outputDir: Directory = ...

Name of directory where build artifacts are collected.

outputGid

outputGid: string = ...

Owner gid that is set on build artifacts.

outputUid

outputUid: string = ...

Owner uid that is set on build artifacts.

quiet

quiet: boolean = ...

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

revision

revision: string = Program.HEAD

Default Git reference from which to build sources.

`Optional` script

script?: string = ...

The build script.

toolchain

toolchain: string = ...

Version of Rust toolchain to use.

verbose

verbose: boolean = ...

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

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in compile/compile.ts:402

Methods

build

build(contract): Promise<CompiledCode>
Compile a single contract.
Parameters
- contract: string | Partial<RustSourceCode>
Returns Promise<CompiledCode>
Inherited from LocalRustCompiler.build
- Defined in compile/compile.ts:150

`Protected` buildBatch

buildBatch(__namedParameters, __namedParameters?): Promise<Record<number, CompiledCode>>
Parameters
- __namedParameters: CompileBatch
- __namedParameters: {
  buildScript?: string | Path;
  outputDir?: string;
  } = {}
  - Optional buildScript?: string | Path
  - Optional outputDir?: string
Returns Promise<Record<number, CompiledCode>>
Overrides LocalRustCompiler.buildBatch
- Defined in compile/compile.ts:406

buildMany

buildMany(contracts): Promise<CompiledCode[]>
This implementation groups the passed source by workspace and ref, in order to launch one build container per workspace/ref combination and have it build all the crates from that combination in sequence, reusing the container's internal intermediate build cache.
Parameters
- contracts: (string | Partial<RustSourceCode>)[]
Returns Promise<CompiledCode[]>
Inherited from LocalRustCompiler.buildMany
- Defined in compile/compile.ts:158

`Protected` collectBatches

collectBatches(contracts): CompileBatches
Parameters
- contracts: Partial<RustSourceCode>[]
Returns CompileBatches
Inherited from LocalRustCompiler.collectBatches
- Defined in compile/compile.ts:182

`Protected` getLogStream

getLogStream(revision, cb): LineTransformStream
Parameters
- revision: string
- cb: ((data) => void)
  - - (data): void
    - Parameters
      data: string
      Returns void
Returns LineTransformStream
- Defined in compile/compile.ts:511

`Protected` logStart

logStart(sourcePath, sourceRef, tasks): void
Parameters
- sourcePath: string
- sourceRef: string
- tasks: Set<CompileTask>
Returns void
Inherited from LocalRustCompiler.logStart
- Defined in compile/compile.ts:286

`Protected` populateBatchResults

populateBatchResults(__namedParameters): Promise<Record<number, CompiledCode>>
Parameters
- __namedParameters: {
      outputDir: string;
      sourceRef: string;
      tasks: Set<CompileTask>;
  }
  - outputDir: string
  - sourceRef: string
  - tasks: Set<CompileTask>
Returns Promise<Record<number, CompiledCode>>
Inherited from LocalRustCompiler.populateBatchResults
- Defined in compile/compile.ts:248

`Protected` resolveSource

resolveSource(source): Partial<RustSourceCode>
Parameters
- source: string | Partial<RustSourceCode>
Returns Partial<RustSourceCode>
a fully populated RustSourceCode from the original.
Inherited from LocalRustCompiler.resolveSource
- Defined in compile/compile.ts:139

`Protected` tryGetCached

tryGetCached(outputDir, __namedParameters): CompiledCode
Check if codePath exists in local artifacts cache directory. If it does, don't rebuild it but return it from there.
Parameters
- outputDir: string
- __namedParameters: Partial<RustSourceCode>
Returns CompiledCode
Inherited from LocalRustCompiler.tryGetCached
- Defined in compile/compile.ts:230

Class ContainerizedLocalRustCompiler

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: Partial<ContainerizedLocalRustCompiler>

Returns ContainerizedLocalRustCompiler

Properties

Optional buildGid

buildImage

buildImageManifest

buildImageTag

Optional buildUid

caching

config

engine

engineSocket

Readonly id

log

noFetch

outputDir

outputGid

outputUid

quiet

revision

Optional script

toolchain

verbose

Accessors

[toStringTag]

Returns string

Methods

build

Parameters

contract: string | Partial<RustSourceCode>

Returns Promise<CompiledCode>

Protected buildBatch

Parameters

__namedParameters: CompileBatch

__namedParameters: { buildScript?: string | Path; outputDir?: string; } = {}

Optional buildScript?: string | Path

Optional outputDir?: string

Returns Promise<Record<number, CompiledCode>>

buildMany

Parameters

contracts: (string | Partial<RustSourceCode>)[]

Returns Promise<CompiledCode[]>

Protected collectBatches

Parameters

contracts: Partial<RustSourceCode>[]

Returns CompileBatches

Protected getLogStream

Parameters

revision: string

cb: ((data) => void)

Parameters

data: string

Returns void

Returns LineTransformStream

Protected logStart

Parameters

sourcePath: string

sourceRef: string

tasks: Set<CompileTask>

Returns void

Protected populateBatchResults

Parameters

__namedParameters: { outputDir: string; sourceRef: string; tasks: Set<CompileTask>; }

outputDir: string

sourceRef: string

tasks: Set<CompileTask>

Returns Promise<Record<number, CompiledCode>>

Protected resolveSource

Parameters

source: string | Partial<RustSourceCode>

`Optional` options: Partial<ContainerizedLocalRustCompiler>

`Optional` buildGid

`Optional` buildUid

`Readonly` id

`Optional` script

`Protected` buildBatch

__namedParameters: {
buildScript?: string | Path;
outputDir?: string;
} = {}

`Optional` buildScript?: string | Path

`Optional` outputDir?: string

`Protected` collectBatches

`Protected` getLogStream

`Protected` logStart

`Protected` populateBatchResults

__namedParameters: {
outputDir: string;
sourceRef: string;
tasks: Set<CompileTask>;
}

`Protected` resolveSource

`Protected` tryGetCached