@taqueria/protocol 0.0.0-pr-156-6d26c0f4

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,7 @@
+# README
+
+Provides a shared collection of TypeScript types used in Taqueria.
+
+This package is consumed by `taqueria` itself, as well as `taqueria-sdk`.
+
+This package can be consumed as an NPM package, and too included as a Deno module.

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@taqueria/protocol",
+  "version": "0.0.0-pr-156-6d26c0f4",
+  "description": "A TypeScript package which contains types that are to be shared between @taqueria/node-sdk and @taqueria/taqueria.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "echo \"just passing through for CI, no need to build\" && exit 0",
+    "prod-config": "echo \"just passing through for CI, no need to update SDK dependency\" && exit 0"
+  },
+  "keywords": [
+    "taqueria",
+    "tezos",
+    "build",
+    "test",
+    "deploy",
+    "ecad",
+    "ecadlabs",
+    "protocol"
+  ],
+  "author": "ECAD Labs",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/ecadlabs/taqueria/issues"
+  },
+  "homepage": "https://github.com/ecadlabs/taqueria#readme",
+  "devDependencies": {
+    "typescript": "^4.5.4"
+  }
+}

package/taqueria-protocol-types.ts

@@ -0,0 +1,579 @@
+// TODO - using .ts is necessary for Deno. Explore how to make this
+// consumable by Deno or the TypeScript compiler without any warnings
+// or errors emited
+// @ts-ignore
+import {SanitizedAbsPath, SHA256} from '../taqueria-utils/taqueria-utils-types.ts'
+
+/**
+ * String-like types
+ */
+
+export abstract class StringLike {
+    readonly value: string
+    protected constructor(value: string){
+        this.value = value
+    }
+    static create (value: string) {
+        return this.constructor.call(this, value)
+    }
+    public toString() {
+        return this.value
+    }
+}
+
+const stringMax30Type: unique symbol = Symbol()
+export class StringMax30 extends StringLike {
+    [stringMax30Type]: void
+    static create(value: string, truncate=false) : StringMax30 | undefined {
+        return (value.length <= 30)
+            ? new StringMax30(value)
+            : (truncate
+                ? new StringMax30(value.substr(0, 30))
+                : undefined
+            )
+    }
+}
+
+const stringNoSpaces: unique symbol = Symbol()
+export class StringNoSpaces extends StringLike {
+    [stringNoSpaces]: void
+    static create(value: string) : StringNoSpaces {
+        return new StringNoSpaces(value.replace(/\s+/g, '_'))
+    }
+}
+
+const identiferType: unique symbol = Symbol()
+export class Identifier extends StringLike {
+    [identiferType]: void
+    static create(value: string): Identifier | undefined {
+        const result = StringNoSpaces.create(value).value.match(/^[A-Za-z0-9]+[A-Za-z0-9-_]*$/)
+        return result ? new Identifier(result[0]) : undefined
+    }
+}
+
+const humanReadableIdentifierType: unique symbol = Symbol()
+export class HumanReadableIdentifier extends StringLike {
+    [humanReadableIdentifierType]: void
+    static create(value: string): HumanReadableIdentifier | undefined {
+        const input = StringMax30.create(StringNoSpaces.create(value).value)
+        if (input) {
+            const result = input.value.match(/^[A-Za-z]+[A-Za-z0-9-_]*$/)
+            return result ? new HumanReadableIdentifier(result[0]) : undefined
+        }
+        return undefined
+    }
+}
+
+const verbType: unique symbol = Symbol()
+export class Verb extends StringLike {
+    [verbType]: void
+    static create(value: string): Verb | undefined {
+        const result = value.match(/^[A-Za-z\-\ ]+/)
+        // TODO - should we do more validation whether its a verb?
+        return result ? new Verb(result[0]) : undefined
+    }
+}
+
+const commandType: unique symbol = Symbol()
+export class Command extends StringLike {
+    [commandType]: void
+    static create(value: string) : Command | undefined {
+        if (value.match(/^([A-Za-z-_ ]+ ?)((\[.+\] ?)|(\<.+\>) ?)*$/)) {
+            return new Command(value)
+        }
+        return undefined   
+    }
+}
+
+const singleChar: unique symbol = Symbol()
+export class SingleChar extends StringLike {
+    [singleChar]: void
+    static create(value: string): SingleChar | undefined {
+        return value && value.toString().match(/^[A-Za-z]/)
+            ? new SingleChar(value[0])
+            : undefined
+    }
+}
+
+const urlType: unique symbol = Symbol()
+export class Url {
+    [urlType]: void
+    readonly url: URL
+    private constructor(value: URL) {
+        this.url = value
+    }
+    static create(value: string): Url | undefined {
+        try {
+            const url = new URL(value)
+            return new Url(url)
+        }
+        catch (_) {
+            return undefined
+        }
+    }
+} 
+
+export type Alias = Verb | SingleChar
+
+/**
+ * Types used in the Taqueria Config
+ */
+
+export interface InstalledPlugin {
+    readonly name: string
+    readonly type: 'npm' | 'binary' | "deno"
+}
+
+export interface Config {
+    readonly language?: 'en' | 'fr'
+    readonly plugins: InstalledPlugin[]
+    readonly contractsDir: string
+    readonly testsDir: string
+    readonly artifactsDir: string
+
+    readonly environment: Record<'default'|string, string|EnvironmentConfig>
+
+    readonly sandbox: Record<string, SandboxConfig>
+
+    readonly network: Record<string, NetworkConfig>
+}
+
+export interface ConfigArgs extends Config {
+    projectDir: SanitizedAbsPath,
+    configFile: SanitizedAbsPath,
+    
+    hash: SHA256
+}
+
+/**
+ * Protocol Models
+ */
+
+export interface UnvalidatedPositionalArg {
+    readonly placeholder: string
+    readonly type?: OptionType
+    readonly defaultValue?: string | number | boolean
+    readonly description: string
+}
+
+
+export interface UnvalidatedOption {
+    readonly shortFlag?: string
+    readonly flag: string
+    readonly description: string
+    readonly defaultValue?: string | number | boolean
+    readonly choices?: string[]
+    readonly required?: boolean
+    readonly boolean?: boolean
+}
+
+export interface UnvalidatedHook {
+    // TODO
+}
+
+export interface UnvalidatedScaffold {
+    // TODO
+}
+
+export interface UnvalidatedNetwork {
+    readonly name: string
+    readonly label: string
+    readonly rpcUrl: string
+    readonly protocol: string
+    readonly attributes?: Attributes
+}
+
+export interface UnvalidatedSandbox extends UnvalidatedNetwork {
+    readonly plugin?: string
+    readonly accounts?: Record<string, AccountDetails>
+}
+
+const hookType: unique symbol = Symbol()
+export class Hook {
+    [hookType] : void
+    static create(unvalidatedHook: UnvalidatedHook): Hook | undefined {
+        return undefined
+    }
+}
+
+const scaffoldType: unique symbol = Symbol()
+export class Scaffold {
+    [scaffoldType] : void
+    static create(unvalidatedScaffold: UnvalidatedScaffold): Scaffold | undefined {
+        return undefined
+    }
+}
+
+export type TaskHandler = "proxy" | string | string[]
+
+
+export interface UnvalidatedTask {
+    readonly task: string
+    readonly command: string
+    readonly description: string
+    readonly aliases?: string[]
+    readonly options?: (UnvalidatedOption|Option|undefined)[],
+    readonly positionals?: (UnvalidatedPositionalArg|undefined|PositionalArg)[]
+    readonly handler: "proxy" | string | string[]
+    readonly hidden?: boolean
+    readonly example?: string
+}
+
+export interface UnvalidatedPluginInfo {
+    readonly schema: string
+    readonly name: string
+    readonly alias?: string
+    readonly version: string
+    readonly tasks?: (UnvalidatedTask|undefined)[]
+    readonly scaffolds?: (UnvalidatedScaffold|undefined)[]
+    readonly hooks?: (UnvalidatedHook|undefined)[]
+    readonly networks?: (UnvalidatedNetwork|undefined)[]
+    readonly sandboxes?: (UnvalidatedSandbox|undefined)[]
+}
+
+export class PluginInfo {
+    readonly schema: string
+    readonly name: string
+    readonly alias?: string
+    readonly version: string
+    readonly tasks: Task[]
+    readonly scaffolds: Scaffold[]
+    readonly hooks: Hook[]
+    readonly networks: Network[]
+    readonly sandboxes: Sandbox[]
+    constructor(schema: string, name: string, version: string, tasks: Task[], scaffolds: Scaffold[], hooks: Hook[], networks: Network[], sandboxes: Sandbox[], alias?: string) {
+        this.schema = schema
+        this.alias = alias
+        this.name = name
+        this.version = version
+        this.tasks = tasks
+        this.scaffolds = scaffolds
+        this.hooks = hooks
+        this.networks = networks
+        this.sandboxes = sandboxes
+    }
+
+    static convert<A, B>(factory: (item: A) => B|undefined) {
+        return (obj: UnvalidatedPluginInfo, prop: keyof UnvalidatedPluginInfo) : B[] => obj[prop] ? (obj[prop] as (A|undefined)[]).reduce(
+            (retval: B[], unvalidatedItem: A|undefined) => {
+                if (unvalidatedItem) {
+                    try {
+                        const item = factory(unvalidatedItem)
+                        return item ? [...retval, item]: retval
+                    }
+                    catch (_) {
+                        return retval
+                    }
+                }
+                return retval
+            },
+            []
+        ) : []
+    }
+
+    static create(obj: UnvalidatedPluginInfo) : PluginInfo | undefined {
+        if (obj.version && obj.schema) {
+            try {
+                const createTask = Task.create.bind(Task)
+                //TODO: Finish doing the above for each factory/constructor
+
+                const temp: Record<string, string> = obj.alias
+                    ? {alias: obj.alias}
+                    : {}
+
+                const pluginInfo : PluginInfo = {
+                    ...temp,
+                    name: obj.name,
+                    schema: obj.schema,
+                    version: obj.version,
+                    tasks: this.convert<UnvalidatedTask, Task>(createTask) (obj, "tasks"),
+                    hooks: this.convert(Hook.create) (obj, "hooks"),
+                    scaffolds: this.convert(Scaffold.create) (obj, "scaffolds"),
+                    networks: this.convert(Network.create) (obj, "networks"),
+                    sandboxes: this.convert(Sandbox.create) (obj, "sandboxes")
+                }
+                return pluginInfo
+            }
+            catch (_) {
+                return undefined
+            }
+        }
+        return undefined
+    }
+}
+
+export type OptionType = 'string' | 'number' | 'boolean'
+
+const positionalArgType: unique symbol = Symbol()
+export class PositionalArg {
+    [positionalArgType]: void
+    readonly placeholder: HumanReadableIdentifier
+    readonly description: string
+    readonly defaultValue?: string | number | boolean
+    readonly type?: OptionType
+
+    protected constructor(placeholder: HumanReadableIdentifier, description: string, type?: OptionType, defaultValue?: string | number | boolean) {
+        this.placeholder = placeholder
+        this.defaultValue = defaultValue
+        this.description = description
+        this.type = type
+    }
+
+    static create(arg: UnvalidatedPositionalArg) {
+        const placeholder = HumanReadableIdentifier.create(arg.placeholder)
+        return placeholder
+            ? new PositionalArg(placeholder, arg.description, arg.type, arg.defaultValue)
+            : undefined
+    }
+}
+
+const optionType: unique symbol = Symbol()
+export class Option {
+    [optionType]: void
+    readonly shortFlag?: SingleChar
+    readonly flag: Verb
+    readonly description: string
+    readonly defaultValue?: string | number | boolean
+    readonly choices?: string[]
+    readonly required?: boolean
+    readonly boolean?: boolean
+    private constructor(shortFlag: SingleChar | undefined, flag: Verb, description: string, choices: string[], required: boolean, boolean: boolean, defaultValue?: string | number | boolean) {
+        this.shortFlag = shortFlag
+        this.flag = flag
+        this.description = description
+        this.defaultValue = defaultValue
+        this.required = required
+        this.choices = choices
+        this.boolean = boolean
+    }
+    static create(option: UnvalidatedOption): Option | undefined {
+        const flag = Verb.create(option.flag)
+
+        if (!option.shortFlag && flag)
+            return new Option(undefined, flag, option.description, option.choices || [], option.required || false, option.boolean ? true : false, option.defaultValue)
+
+        if (option.shortFlag && flag) {
+            const shortFlag = SingleChar.create(option.shortFlag)
+            return shortFlag
+                ? new Option(shortFlag, flag, option.description, option.choices || [], option.required || false, option.boolean ? true : false, option.defaultValue)
+                : undefined
+        }
+
+        return undefined
+    }
+}
+
+ const taskType: unique symbol = Symbol()
+ export class Task {
+     [taskType]: void
+     readonly task: Verb
+     readonly command: Command
+     readonly aliases: Alias[]
+     readonly description: string
+     readonly example?: string
+     readonly options?: Option[]
+     readonly handler: TaskHandler
+     readonly hidden: boolean
+     readonly positionals: PositionalArg[]
+     protected constructor(name: Verb, command: Command, description: string, handler: TaskHandler, options: Option[]=[], positionals: PositionalArg[]=[], aliases: Alias[]=[], hidden=false, example?: string) {
+         this.task = name
+         this.command = command
+         this.description = description
+         this.options = options
+         this.aliases = aliases
+         this.handler = handler
+         this.hidden = hidden
+         this.example = example
+         this.positionals = positionals
+     }
+     static createAlias(value: string): Alias | undefined {
+        return Verb.create(value) || SingleChar.create(value)
+    }
+
+     static create (task: UnvalidatedTask): Task | undefined {
+        const name = Verb.create(task.task)
+        const command = Command.create(task.command)
+        const aliases = task.aliases
+            ? task.aliases.reduce(
+                (retval: Alias[], unvalidatedAlias) => {
+                    const alias  = this.createAlias(unvalidatedAlias)
+                    return alias ? [...retval, alias] : retval
+                },
+                []
+            )
+            : []
+
+        const options = !task.options ? [] : task.options.reduce(
+            (retval: Option[], option) => {
+                if (option instanceof Option) {
+                    return [...retval, option]
+                }
+                else if (option === undefined) {
+                    return retval
+                }
+                else {
+                    const validOption = Option.create(option as UnvalidatedOption)
+                    return validOption ? [...retval, validOption] : retval
+                }
+            },
+            []
+        )
+
+        const positionals = !task.positionals ? [] : task.positionals.reduce(
+            (retval: PositionalArg[], item) => {
+                if (item instanceof PositionalArg) {
+                    return [...retval, item]
+                }
+                else if (item === undefined) {
+                    return retval
+                }
+
+                const positional = PositionalArg.create(item as UnvalidatedPositionalArg)
+                return positional
+                    ? [...retval, positional]:
+                    retval
+            },
+            []
+        )
+
+        return name && command
+            ? new Task(name, command, task.description, task.handler, options, positionals, aliases, task.hidden ? true : false, task.example)
+            : undefined
+        }
+}
+
+export interface AccountKeys {
+    alias: string
+    encryptedKey: string
+    publicKey: string
+    secretKey: string
+}
+
+export interface AccountDetails {
+    readonly initialBalance?: string,
+    keys?: AccountKeys
+}
+
+export interface SandboxConfig {
+    readonly label?: string,
+    readonly plugin?: string,
+    readonly rpcUrl?: string
+    readonly protocol?: string
+    readonly attributes?: Attributes
+    readonly accounts: Record<string|'default', AccountDetails|string>
+}
+
+export interface NetworkConfig {
+    readonly label?: string,
+    readonly rpcUrl?: string 
+    readonly protocol?: string
+    readonly faucet: {
+        readonly pkh: string
+        readonly mnemonic: string[]   
+        readonly email: string
+        readonly password: string
+        readonly amount: string
+        readonly activation_code: string
+    }
+}
+
+export interface EnvironmentConfig {
+    readonly networks?: string[]
+    readonly sandboxes: string[]
+    readonly storage: Record<string, unknown>
+}
+
+export interface RuntimeDependency {
+    readonly name: string,
+    readonly path: string,
+    readonly version: string,
+    readonly kind: "required" | "optional"
+}
+
+export interface Attributes {
+    [key: string]: string|number|boolean
+}
+
+const economicalPrototypeHashType: unique symbol = Symbol()
+export class EconomicalProtocolHash extends StringLike {
+    [economicalPrototypeHashType]: void
+    static create(value: string): EconomicalProtocolHash | undefined {
+        return value.length === 51 && value[0] === 'P' && /[A-Za-z0-9]+/.test(value)
+            ? new EconomicalProtocolHash(value)
+            : undefined
+    }
+}
+
+const economicProtocalType: unique symbol = Symbol()
+export class EconomicalProtocol {
+    readonly hash: EconomicalProtocolHash
+    readonly label: HumanReadableIdentifier | undefined
+    constructor(hash: EconomicalProtocolHash, label: (HumanReadableIdentifier|undefined)=undefined) {
+        this.hash = hash
+        this.label = label
+    }
+    static create(hash: string, label: (string|undefined)=undefined) {
+        const validHash = EconomicalProtocolHash.create(hash)
+        const validLabel = label ? HumanReadableIdentifier.create(label) : undefined
+        return validHash
+            ? new EconomicalProtocol(validHash, validLabel)
+            : undefined
+    }
+}
+
+const networkType: unique symbol = Symbol()
+export class Network {
+    [networkType]: void
+    readonly name: HumanReadableIdentifier
+    readonly label: StringMax30
+    readonly rpcUrl: Url
+    readonly protocol: EconomicalProtocol
+    readonly attributes: Attributes
+    public constructor (name: HumanReadableIdentifier, label: StringMax30, rpcUrl: Url, protocol: EconomicalProtocol, attributes: Attributes) {
+        this.name = name
+        this.label = label
+        this.rpcUrl = rpcUrl
+        this.protocol = protocol
+        this.attributes = attributes
+    }
+
+    static create(network : UnvalidatedNetwork) {
+        const validName = HumanReadableIdentifier.create(network.name)
+        const validLabel = StringMax30.create(network.label)
+        const validUrl = Url.create(network.rpcUrl)
+        const validProto = EconomicalProtocol.create(network.protocol)
+
+        return validName && validLabel && validUrl && validProto
+            ? new Network(validName, validLabel, validUrl, validProto, network.attributes ? network.attributes : {})
+            : undefined
+    }
+}
+
+const sandboxType: unique symbol = Symbol()
+export class Sandbox extends Network {
+    readonly accounts: Record<string, AccountDetails>
+    [sandboxType]: void
+    readonly plugin?: string
+
+    protected constructor(name: HumanReadableIdentifier, label: StringMax30, rpcUrl: Url, protocol: EconomicalProtocol, attributes: Attributes, plugin?: string, accounts?: Record<string, AccountDetails>) {
+        super(name, label, rpcUrl, protocol, attributes)
+        this.plugin = plugin
+        this.accounts = accounts ? accounts: {}
+    }
+
+    static create(sandbox: UnvalidatedSandbox) {
+        const network = super.create(sandbox)
+        return network
+            ? new Sandbox(network.name, network.label, network.rpcUrl, network.protocol, network.attributes, sandbox.plugin, sandbox.accounts)
+            : undefined
+    }
+}
+
+export interface Environment {
+    readonly name: string
+    readonly networks?: Network[]
+    readonly sandboxes?: Sandbox[]
+    readonly storage: Record<string, unknown>
+}
+
+export type Action = "checkRuntimeDependencies" | "installRuntimeDependencies" | "proxy" | "pluginInfo" | string