tesseract

README

Tesseract

Tesseract is a library to run SmartContract on Docker Container.

Architecture

Overview of the architecture of Tesseract can be found in the following link.

ARCHITECTURE

Lincese

Tesseract source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file.

Documentation

Index

• type CallBack
• type Container
• type ContainerConfig
• type ContainerFactory
• type ContainerID
• type ContainerImage
  • func (dc ContainerImage) GetFullName() string
• type Network
• type Request
• type Volume
  • func NewVolume(createdAt, driver, mountpoint, name string, opts map[string]string) Volume

Types

type CallBack

type CallBack func(response *pb.Response, err error)

type Container

type Container interface {
	// send request to container
	Request(req Request, callback CallBack) error

	// close container
	Close() error

	// get container ID
	GetID() string
}

type ContainerConfig

type ContainerConfig struct {
	Language string // language that icode use

	Name string // container name

	ContainerImage ContainerImage // container docker image name to pull. example : 'golang:1.9'

	HostIp string // HostIp address that manage icode.

	ContainerIp string // ContainerIp

	Port string // port num to communicate container and icode

	StartCmd []string // start command to initiate icode. it must contain icodename. ex {"go","run.sh","testicode/icode.go","-p","4401}

	Network *Network // docker network option. if you don't use, nil

	Mount []string // [Mount-src-path or volume name]:[Mount-dist-path] ex) /go/src/github.com/it-chain/learn-icode:/icode

}

type ContainerFactory

type ContainerFactory interface {
	Create(ContainerConfig) Container
}

type ContainerID

type ContainerID = string

type ContainerImage

type ContainerImage struct {
	Name string // language docker image name ( ex : go )
	Tag  string // language docker image Tag ( ex : 1.9 )
}

func (ContainerImage) GetFullName

func (dc ContainerImage) GetFullName() string

type Network

type Network struct {
	ID   string
	Name string
}

type Request

type Request struct {
	Uuid     string
	TypeName string
	FuncName string
	Args     []string
}

type Volume

type Volume struct {
	CreatedAt  string
	Driver     string
	Mountpoint string
	Name       string
	Options    map[string]string
}

referenced go-docker repository: https://github.com/docker/go-docker/blob/master/api/types/volume.go

func NewVolume

func NewVolume(createdAt, driver, mountpoint, name string, opts map[string]string) Volume