Merge pull request #235 from sCrypt-Inc/artifact

Rename ContractArtifact to Artifact

Author: gitzhou

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "scryptlib",
-  "version": "2.1.18",
+  "version": "2.1.19",
   "description": "Javascript SDK for integration of Bitcoin SV Smart Contracts written in sCrypt language.",
   "engines": {
     "node": ">=14.0.0"
@@ -75,4 +75,4 @@
     "sourcemap-codec": "^1.4.8",
     "yargs": "^17.6.2"
   }
-}
+}

package.json

@@ -2,7 +2,7 @@ import { ChildProcess, exec, execSync } from 'child_process';
 import { existsSync, mkdirSync, readFileSync, renameSync, unlinkSync, writeFileSync } from 'fs';
 import { basename, dirname, join } from 'path';
 import {
-  buildTypeResolver, ContractArtifact, CURRENT_CONTRACT_ARTIFACT_VERSION, findCompiler, hash160, md5, path2uri, resolveConstValue, TypeResolver
+  buildTypeResolver, Artifact, CURRENT_CONTRACT_ARTIFACT_VERSION, findCompiler, hash160, md5, path2uri, resolveConstValue, TypeResolver
 } from './internal';
 import rimraf = require('rimraf');
 import JSONbig = require('json-bigint');
@@ -110,9 +110,9 @@ export class CompileResult {
   sourceMapFile?: string;
   dbgFile?: string;
 
-  toArtifact(): ContractArtifact {
+  toArtifact(): Artifact {
 
-    const artifact: ContractArtifact = {
+    const artifact: Artifact = {
       version: CURRENT_CONTRACT_ARTIFACT_VERSION,
       compilerVersion: this.compilerVersion || '0.0.0',
       contract: this.contract || '',
@@ -1098,7 +1098,7 @@ function doClean(settings: CompilingSettings, outputFiles: Record<string, string
   // console.log('compile time spent: ', Date.now() - st)
 }
 
-export function loadSourceMapfromArtifact(artifact: ContractArtifact): Array<{
+export function loadSourceMapfromArtifact(artifact: Artifact): Array<{
   pos: Pos | undefined,
   opcode: string
 }> {

src/compilerWrapper.ts

@@ -41,7 +41,7 @@ export interface VerifyResult {
 export const CURRENT_CONTRACT_ARTIFACT_VERSION = 9;
 
 export const SUPPORTED_MINIMUM_VERSION = 8;
-export interface ContractArtifact {
+export interface Artifact {
   /** version of artifact file */
   version: number;
   /** version of compiler used to produce this file */
@@ -82,7 +82,7 @@ export type StepIndex = number;
 
 export class AbstractContract {
 
-  public static artifact: ContractArtifact;
+  public static artifact: Artifact;
   public static opcodes?: OpCode[];
   public static hex: string;
   public static abi: ABIEntity[];
@@ -129,27 +129,27 @@ export class AbstractContract {
   }
 
   get sourceMapFile(): string {
-    const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+    const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
     return artifact.sourceMapFile;
   }
 
   get file(): string {
-    const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+    const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
     return artifact.file;
   }
 
   get contractName(): string {
-    const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+    const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
     return artifact.contract;
   }
 
   get stateProps(): ParamEntity[] {
-    const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+    const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
     return artifact.stateProps || [];
   }
 
   get version(): number {
-    const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+    const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
     return artifact.version || 0;
   }
 
@@ -338,7 +338,7 @@ export class AbstractContract {
       }
     } else if (this.version <= 8) {
 
-      const artifact = Object.getPrototypeOf(this).constructor.artifact as ContractArtifact;
+      const artifact = Object.getPrototypeOf(this).constructor.artifact as Artifact;
 
       const sourceMap = loadSourceMapfromArtifact(artifact);
 
@@ -811,7 +811,7 @@ const invalidMethodName = ['arguments',
 
 
 
-export function buildContractClass(artifact: ContractArtifact | CompileResult): typeof AbstractContract {
+export function buildContractClass(artifact: Artifact | CompileResult): typeof AbstractContract {
 
 
   if (artifact instanceof CompileResult) {
@@ -918,7 +918,7 @@ export function buildContractClass(artifact: ContractArtifact | CompileResult):
 
 
 
-export function buildTypeResolverFromArtifact(artifact: ContractArtifact): TypeResolver {
+export function buildTypeResolverFromArtifact(artifact: Artifact): TypeResolver {
   const alias: AliasEntity[] = artifact.alias || [];
   const library: LibraryEntity[] = artifact.library || [];
   const structs: StructEntity[] = artifact.structs || [];

src/contract.ts

@@ -22,7 +22,7 @@ export {
   OpCodeType, SupportedParamType, PubKeyHash, TxContext, ContractClass, Contract, SortedItem, HashedMap, HashedSet,
   StructObject, TypeResolver, PrimitiveTypes, AsmVarValues, Flavor,
   Arguments, Argument, StructEntity, LibraryEntity, ABIEntity, ABIEntityType, ABI, ParamEntity,
-  BuildType, RelatedInformation, ContractArtifact, VerifyResult, VerifyError, AbstractContract,
+  BuildType, RelatedInformation, Artifact, VerifyResult, VerifyError, AbstractContract,
   DebugInfo, DebugModeTag, ContractEntity, TypeInfo, SymbolType, DEFAULT_FLAGS, ScryptType, DEFAULT_SIGHASH_TYPE, CallData
 } from './internal';