flixkit

Documentation

Index

• type ContractInfos
• type FlixService
  • func NewFlixService(config *FlixServiceConfig) FlixService
• type FlixServiceConfig
• type FlowInteractionTemplateExecution
• type NetworkAddressMap

Types

type ContractInfos

type ContractInfos = internal.ContractInfos

ContractInfos is an input into generating a template, it is a map of contract name to network information of deployed contracts of the source Cadence code.

type FlixService

type FlixService interface {
	// GetTemplate returns the raw flix template
	GetTemplate(ctx context.Context, templateName string) (string, string, error)
	// GetAndReplaceImports returns the raw flix template with cadence imports replaced
	GetTemplateAndReplaceImports(ctx context.Context, templateName string, network string) (*FlowInteractionTemplateExecution, error)
	// GenerateBinding returns the generated binding given the language
	GetTemplateAndCreateBinding(ctx context.Context, templateName string, lang string, destFile string) (string, error)
	// GenerateTemplate returns the generated raw template
	CreateTemplate(ctx context.Context, contractInfos ContractInfos, code string, preFill string, networks []config.Network) (string, error)
}

func NewFlixService

func NewFlixService(config *FlixServiceConfig) FlixService

NewFlixService returns a new FlixService given a FlixServiceConfig

type FlixServiceConfig

type FlixServiceConfig = internal.FlixServiceConfig

FlixServiceConfig is the configuration for the FlixService that provides a override for FlixServerURL and default values for FileReader and Logger.

type FlowInteractionTemplateExecution

type FlowInteractionTemplateExecution = internal.FlowInteractionTemplateExecution

FlowInteractionTemplateCadence is the interface returned from Replacing imports, it provides helper methods to assist in executing the resulting Cadence.

type NetworkAddressMap

type NetworkAddressMap = internal.NetworkAddressMap