WebDelve - Purpose Drive Software

---

This project is built to work with Activeledger
Activeledger on GitHub
Activeledger Website

---

Contract Compiler

This software allows you to write Activeledger Smart Contracts in multiple files and compile them into one for uploading to a network.

Rather than writing a complex contract which utilises multiple classes in a single file, you can break those classes out into separate files. This software will look for local imports in the entry file provided by the user and merge external imports and the classes in each local imported file into one output.

The external imports are handled such that

import { Activity } from "@activeledger/activeledgercontracts";

from one file, and

import { Standard } from "@activeledger/activeledgercontracts";

from another, become

import { Activity, Standard } from "@activeledger/activeledgercontracts";

in the output.

If multiple files have

import { Activity, Standard } from "@activeledger/activeledgercontracts";

that import line will only be included once in the output.

Sometimes you might need to ignore lines (commonly local imports), you can do so by adding the following to the preceeding line:

// $$ Ignore

Ignore is case insensitive, but the general structure of the comment should be followed. Also make sure you don't have an empty line inbetween the comment and the line you want to ignore, as the empty line will be ignored instead.

// Fine

// $$ Ignore
import SomeClass from "./SomeClassFile.ts";

// Fine

// $$ ignore
import SomeClass from "./SomeClassFile.ts";

// Fine

// $$ ignORE
import SomeClass from "./SomeClassFile.ts";


// Fine - extra text is ignored, as long as "// $$ ignore" is found as one 
// unbroken string

// $$ ignORE I'm ignoring this because some reason
import SomeClass from "./SomeClassFile.ts";

// Wrong - characters between // and $$

// Some reason $$ Ignore
import SomeClass from "./SomeClassFile.ts";

// Wrong - Gap between ignore comment and line to ignore

// $$ Ignore

import SomeClass from "./SomeClassFile.ts";

// Wrong - Missing a $

// $ Ignore
import SomeClass from "./SomeClassFile.ts";

Quick start

Building

With Go installed run

make build

to build the software. This will create a build in ./bin.

Move the build and the config file local to the folder containing your Smart Contract.

Running

Two CLI flags are available to be used.

# Provide an entry file
./comp -p <smartcontractfolder>/<entryfile>.ts

# Provide an output file path
./comp -o <output>.ts

# Provide both
./comp -p <smartcontractfolder>/<entryfile>.ts -o <output>.ts

Example:

./comp -p smartcontract/main.ts -o compiled.ts

This will look for a file called main.ts in the local directory smartcontract, and output to the local file compiled.ts.

Note: compiled.ts will be created if it doesn't exist, and overwritten if it does

Imports

Currently the software will look for local imports like the following

import { Second } from "./second";

Where Second is a class exported from a file named second.ts in the same directory as the provided entry file.

The software will include the entirety of the content in second.ts not just the imported class. It separates out the imports for processing, including all of them at the top of the output file. The rest of the body of second.ts will be included below, along with any other imported files and the entry file.

This means that any interfaces, etc, that you have written in second.ts will also be included.