super

Documentation

Index

• Constants
• Variables
• type Contract
  • func (c Contract) GetAccount() string
  • func (c Contract) GetData() map[string]interface{}
  • func (c Contract) GetName() string
  • func (c Contract) GetTemplate() string
• type Generator
  • func NewGenerator(directory string, state *flowkit.State, logger output.Logger, ...) *Generator
  • func (g *Generator) Create(typeNames TemplateMap) error
• type ScriptTemplate
  • func (o ScriptTemplate) GetAccount() string
  • func (o ScriptTemplate) GetData() map[string]interface{}
  • func (o ScriptTemplate) GetName() string
  • func (o ScriptTemplate) GetTemplate() string
• type TemplateItem
• type TemplateMap
• type TransactionTemplate
  • func (o TransactionTemplate) GetAccount() string
  • func (o TransactionTemplate) GetData() map[string]interface{}
  • func (o TransactionTemplate) GetName() string
  • func (o TransactionTemplate) GetTemplate() string

Constants

const (
	DefaultCadenceDirectory = "cadence"
	ContractType            = "contract"
	TransactionType         = "transaction"
	ScriptType              = "script"
)

Variables

var DevCommand = &command.Command{
	Cmd: &cobra.Command{
		Use:     "dev",
		Short:   "Build your Flow project",
		Args:    cobra.ExactArgs(0),
		Example: "flow dev",
		GroupID: "super",
	},
	Flags: &devFlags,
	RunS:  dev,
}

var FlixCmd = &cobra.Command{
	Use:              "flix",
	Short:            "execute, generate, package",
	TraverseChildren: true,
	GroupID:          "tools",
}

var GenerateCommand = &cobra.Command{
	Use:     "generate",
	Short:   "Generate template files for common Cadence code",
	GroupID: "super",
	Aliases: []string{"g"},
}

var GenerateContractCommand = &command.Command{
	Cmd: &cobra.Command{
		Use:     "contract <name>",
		Short:   "Generate Cadence smart contract template",
		Example: "flow generate contract HelloWorld",
		Args:    cobra.ExactArgs(1),
	},
	Flags: &generateFlags,
	RunS:  generateContract,
}

var GenerateScriptCommand = &command.Command{
	Cmd: &cobra.Command{
		Use:     "script <name>",
		Short:   "Generate a Cadence script template",
		Example: "flow generate script SomeScript",
		Args:    cobra.ExactArgs(1),
	},
	Flags: &generateFlags,
	RunS:  generateScript,
}

var GenerateTransactionCommand = &command.Command{
	Cmd: &cobra.Command{
		Use:     "transaction <name>",
		Short:   "Generate a Cadence transaction template",
		Example: "flow generate transaction SomeTransaction",
		Args:    cobra.ExactArgs(1),
	},
	Flags: &generateFlags,
	RunS:  generateTransaction,
}

var SetupCommand = &command.Command{
	Cmd: &cobra.Command{
		Use:     "init <project name>",
		Short:   "Start a new Flow project",
		Example: "flow setup my-project",
		Args:    cobra.MaximumNArgs(1),
		GroupID: "super",
	},
	Flags: &setupFlags,
	Run:   create,
}

TODO: Add --config-only flag

Types

type Contract

type Contract struct {
	Name     string
	Template string
	Account  string
	Data     map[string]interface{}
}

Contract contains properties for contracts

func (Contract) GetAccount

func (c Contract) GetAccount() string

GetAccount returns the account of the contract

func (Contract) GetData

func (c Contract) GetData() map[string]interface{}

GetData returns the data of the contract

func (Contract) GetName

func (c Contract) GetName() string

GetName returns the name of the contract

func (Contract) GetTemplate

func (c Contract) GetTemplate() string

GetTemplate returns the template of the contract

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator

func NewGenerator(directory string, state *flowkit.State, logger output.Logger, disableLogs, saveState bool) *Generator

func (*Generator) Create

func (g *Generator) Create(typeNames TemplateMap) error

type ScriptTemplate

type ScriptTemplate struct {
	Name     string
	Template string
	Data     map[string]interface{}
}

ScriptTemplate contains only a name property for scripts and transactions

func (ScriptTemplate) GetAccount

func (o ScriptTemplate) GetAccount() string

GetAccount returns an empty string for scripts and transactions

func (ScriptTemplate) GetData

func (o ScriptTemplate) GetData() map[string]interface{}

GetData returns the data of the script or transaction

func (ScriptTemplate) GetName

func (o ScriptTemplate) GetName() string

GetName returns the name of the script or transaction

func (ScriptTemplate) GetTemplate

func (o ScriptTemplate) GetTemplate() string

GetTemplate returns an empty string for scripts and transactions

type TemplateItem

type TemplateItem interface {
	GetName() string
	GetTemplate() string
	GetAccount() string
	GetData() map[string]interface{}
}

TemplateItem is an interface for different template types

type TemplateMap

type TemplateMap map[string][]TemplateItem

TemplateMap holds all templates with flexibility

type TransactionTemplate

type TransactionTemplate struct {
	Name     string
	Template string
	Data     map[string]interface{}
}

TransactionTemplate contains only a name property for scripts and transactions

func (TransactionTemplate) GetAccount

func (o TransactionTemplate) GetAccount() string

GetAccount returns an empty string for scripts and transactions

func (TransactionTemplate) GetData

func (o TransactionTemplate) GetData() map[string]interface{}

GetData returns the data of the script or transaction

func (TransactionTemplate) GetName

func (o TransactionTemplate) GetName() string

GetName returns the name of the script or transaction

func (TransactionTemplate) GetTemplate

func (o TransactionTemplate) GetTemplate() string

GetTemplate returns an empty string for scripts and transactions