Skip to main content

Artifact

@opcat-labs/scrypt-ts-opcat v1.0.4


@opcat-labs/scrypt-ts-opcat / Artifact

Interface: Artifact

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:24

An Bitcoin Contract Artifact is a collection of files generated during the compilation of a smart contract. It contains all the necessary metadata, code, and interfaces required to deploy, interact with, and verify the contract on the Bitcoin blockchain. Artifacts are generated by @opcat-labs/cli-opcat.

Properties

abi

abi: ABIEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:46

ABI of the contract: interfaces of its public functions and constructor


alias

alias: AliasEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:44

all typealias defined in the contracts, including dependent contracts


buildType

buildType: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:30

build type, can be debug or release


compilerVersion

compilerVersion: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:28

version of compiler used to produce this file


contract

contract: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:32

name of the contract


file

file: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:53

relative file uri of the main contract source code file


hex

hex: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:51

locking script of the contract in hex format, including placeholders for constructor parameters


library

library: LibraryEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:42

all library defined in the contracts, including dependent contracts


md5

md5: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:34

md5 of the contract source code


stateProps

stateProps: ParamEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:36

all stateful properties defined in the contracts


stateType?

optional stateType: string

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:38

the type of the state property used in the contracts


staticAbi?

optional staticAbi: ABIEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:49

ABI of the contract: interfaces of its static functions


structs

structs: StructEntity[]

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:40

all structures defined in the contracts, including dependent contracts


version

version: number

Defined in: packages/scrypt-ts-opcat/src/smart-contract/types/artifact.ts:26

version of artifact file