types

package
v1.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

View Source 
const BlockchainConnector = "blockchain_connector"
View Source 
const BlockchainNodeProvider = "blockchain_node_provider"
View Source 
const BlockchainProvider = "blockchain_provider"
View Source 
const Consensus = "consensus"
View Source 
const DatabaseSelection = "database_selection"
View Source 
const IPFSMode = "ipfs_mode"
View Source 
const PrivateTransactionManager = "private_transaction_manager"
View Source 
const ReleaseChannelSelection = "release_channel"
View Source 
const TokenProvider = "token_provider"

Variables

View Source 
var (
	IPFSModePrivate = fftypes.FFEnumValue(IPFSMode, "private")
	IPFSModePublic  = fftypes.FFEnumValue(IPFSMode, "public")
)
View Source 
var (
	BlockchainProviderEthereum = fftypes.FFEnumValue(BlockchainProvider, "ethereum")
	BlockchainProviderTezos    = fftypes.FFEnumValue(BlockchainProvider, "tezos")
	BlockchainProviderFabric   = fftypes.FFEnumValue(BlockchainProvider, "fabric")
	BlockchainProviderCorda    = fftypes.FFEnumValue(BlockchainProvider, "corda")
)
View Source 
var (
	BlockchainConnectorEthconnect   = fftypes.FFEnumValue(BlockchainConnector, "ethconnect")
	BlockchainConnectorEvmconnect   = fftypes.FFEnumValue(BlockchainConnector, "evmconnect")
	BlockchainConnectorTezosconnect = fftypes.FFEnumValue(BlockchainConnector, "tezosconnect")
	BlockchainConnectorFabconnect   = fftypes.FFEnumValue(BlockchainConnector, "fabric")
)
View Source 
var (
	BlockchainNodeProviderGeth      = fftypes.FFEnumValue(BlockchainNodeProvider, "geth")
	BlockchainNodeProviderQuorum    = fftypes.FFEnumValue(BlockchainNodeProvider, "quorum")
	BlockchainNodeProviderBesu      = fftypes.FFEnumValue(BlockchainNodeProvider, "besu")
	BlockchainNodeProviderRemoteRPC = fftypes.FFEnumValue(BlockchainNodeProvider, "remote-rpc")
)
View Source 
var (
	ConsensusClique = fftypes.FFEnumValue(Consensus, "clique")
	ConsensusRaft   = fftypes.FFEnumValue(Consensus, "raft")
	ConsensusIbft   = fftypes.FFEnumValue(Consensus, "ibft")
	ConsensusQbft   = fftypes.FFEnumValue(Consensus, "qbft")
)
View Source 
var (
	PrivateTransactionManagerNone    = fftypes.FFEnumValue(PrivateTransactionManager, "none")
	PrivateTransactionManagerTessera = fftypes.FFEnumValue(PrivateTransactionManager, "tessera")
)
View Source 
var (
	DatabaseSelectionSQLite   = fftypes.FFEnumValue(DatabaseSelection, "sqlite3")
	DatabaseSelectionPostgres = fftypes.FFEnumValue(DatabaseSelection, "postgres")
)
View Source 
var (
	TokenProviderNone        = fftypes.FFEnumValue(TokenProvider, "none")
	TokenProviderERC1155     = fftypes.FFEnumValue(TokenProvider, "erc1155")
	TokenProviderERC20ERC721 = fftypes.FFEnumValue(TokenProvider, "erc20_erc721")
)
View Source 
var (
	ReleaseChannelStable = fftypes.FFEnumValue(ReleaseChannelSelection, "stable")
	ReleaseChannelHead   = fftypes.FFEnumValue(ReleaseChannelSelection, "head")
	ReleaseChannelAlpha  = fftypes.FFEnumValue(ReleaseChannelSelection, "alpha")
	ReleaseChannelBeta   = fftypes.FFEnumValue(ReleaseChannelSelection, "beta")
	ReleaseChannelRC     = fftypes.FFEnumValue(ReleaseChannelSelection, "rc")
)

Functions

func FFEnumArray added in v1.1.0 

func FFEnumArray(ctx context.Context, a []string) ([]fftypes.FFEnum, error)

func FFEnumArrayToStrings added in v1.1.0 

func FFEnumArrayToStrings(input []fftypes.FFEnum) []string

Types

type AdminServerConfig added in v1.1.0 

type AdminServerConfig struct {
	HTTPServerConfig `yaml:",inline"`
	Enabled          bool `yaml:"enabled,omitempty"`
	PreInit          bool `yaml:"preinit,omitempty"`
}

type BasicAuth added in v1.1.0 

type BasicAuth struct {
	Username string `yaml:"username,omitempty"`
	Password string `yaml:"password,omitempty"`
}

type BlockchainConfig added in v1.1.0 

type BlockchainConfig struct {
	Name     string          `yaml:"name,omitempty"`
	Type     string          `yaml:"type,omitempty"`
	Ethereum *EthereumConfig `yaml:"ethereum,omitempty"`
	Tezos    *TezosConfig    `yaml:"tezos,omitempty"`
	Fabric   *FabricConfig   `yaml:"fabric,omitempty"`
}

type CommonDBConfig added in v1.1.0 

type CommonDBConfig struct {
	URL        string            `yaml:"url,omitempty"`
	Migrations *MigrationsConfig `yaml:"migrations,omitempty"`
}

type ContractConfig added in v1.1.0 

type ContractConfig struct {
	Location   interface{} `yaml:"location"`
	FirstEvent string      `yaml:"firstEvent,omitempty"`
	Options    interface{} `yaml:"options"`
}

type ContractDeploymentResult added in v1.0.0 

type ContractDeploymentResult struct {
	Message          string
	DeployedContract *DeployedContract
}

type DBEventsConfig added in v1.1.0 

type DBEventsConfig struct {
	BufferSize int `yaml:"bufferSize,omitempty"`
}

type DataExchangeConfig added in v1.1.0 

type DataExchangeConfig struct {
	Name string              `yaml:"name,omitempty"`
	Type string              `yaml:"type,omitempty"`
	FFDX *HTTPEndpointConfig `yaml:"ffdx,omitempty"`
}

type DatabaseConfig added in v1.1.0 

type DatabaseConfig struct {
	Name       string          `yaml:"name,omitempty"`
	Type       string          `yaml:"type,omitempty"`
	PostgreSQL *CommonDBConfig `yaml:"postgres,omitempty"`
	SQLite3    *CommonDBConfig `yaml:"sqlite3,omitempty"`
}

type DeployedContract added in v0.0.47 

type DeployedContract struct {
	Name     string      `json:"name"`
	Location interface{} `json:"location"`
}

type EthconnectConfig added in v1.1.0 

type EthconnectConfig struct {
	URL   string     `yaml:"url,omitempty"`
	Topic string     `yaml:"topic,omitempty"`
	Auth  *BasicAuth `yaml:"auth,omitempty"`
}

type EthereumConfig added in v1.1.0 

type EthereumConfig struct {
	Ethconnect *EthconnectConfig `yaml:"ethconnect,omitempty"`
}

type EventConfig added in v1.1.0 

type EventConfig struct {
	DBEvents *DBEventsConfig `yaml:"dbevents,omitempty"`
}

type FFTokensConfig added in v1.1.0 

type FFTokensConfig struct {
	URL string `yaml:"url,omitempty"`
}

type FabconnectConfig added in v1.1.0 

type FabconnectConfig struct {
	URL       string `yaml:"url,omitempty"`
	Channel   string `yaml:"channel,omitempty"`
	Chaincode string `yaml:"chaincode,omitempty"`
	Topic     string `yaml:"topic,omitempty"`
	Signer    string `yaml:"signer,omitempty"`
}

type FabricConfig added in v1.1.0 

type FabricConfig struct {
	Fabconnect *FabconnectConfig `yaml:"fabconnect,omitempty"`
}

type FireflyConfig added in v1.1.0 

type FireflyConfig struct {
	Log        *LogConfig           `yaml:"log,omitempty"`
	Debug      *HTTPServerConfig    `yaml:"debug,omitempty"`
	HTTP       *HTTPServerConfig    `yaml:"http,omitempty"`
	Admin      *AdminServerConfig   `yaml:"admin,omitempty"` // V1.0 admin API
	SPI        *SPIServerConfig     `yaml:"spi,omitempty"`   // V1.1 and later SPI
	Metrics    *MetricsServerConfig `yaml:"metrics,omitempty"`
	UI         *UIConfig            `yaml:"ui,omitempty"`
	Event      *EventConfig         `yaml:"event,omitempty"`
	Plugins    *Plugins             `yaml:"plugins"`
	Namespaces *NamespacesConfig    `yaml:"namespaces"`
}

type FireflyIPFSConfig added in v1.1.0 

type FireflyIPFSConfig struct {
	API     *HTTPEndpointConfig `yaml:"api,omitempty"`
	Gateway *HTTPEndpointConfig `yaml:"gateway,omitempty"`
}

type GitHubRelease added in v0.0.34 

type GitHubRelease struct {
	TagName string `json:"tag_name,omitempty"`
}

type HTTPEndpointConfig added in v1.3.0 

type HTTPEndpointConfig struct {
	URL  string    `yaml:"url,omitempty"`
	Auth BasicAuth `yaml:"auth,omitempty"`
}

type HTTPServerConfig added in v1.3.0 

type HTTPServerConfig struct {
	Port      int    `yaml:"port,omitempty"`
	Address   string `yaml:"address,omitempty"`
	PublicURL string `yaml:"publicURL,omitempty"`
}

type HexAddress added in v1.1.0 

type HexAddress string

func (HexAddress) MarshalYAML added in v1.1.0 

func (h HexAddress) MarshalYAML() (interface{}, error)

Explicitly quote hex addresses so that they are interpreted as string (not int)

type InitOptions added in v0.0.47 

type InitOptions struct {
	StackName                 string
	MemberCount               int
	FireFlyBasePort           int
	ServicesBasePort          int
	PtmBasePort               int
	DatabaseProvider          string
	ExternalProcesses         int
	OrgNames                  []string
	NodeNames                 []string
	BlockchainConnector       string
	BlockchainProvider        string
	BlockchainNodeProvider    string
	PrivateTransactionManager string
	Consensus                 string
	TokenProviders            []string
	FireFlyVersion            string
	ManifestPath              string
	PrometheusEnabled         bool
	PrometheusPort            int
	SandboxEnabled            bool
	ExtraCoreConfigPath       string
	ExtraConnectorConfigPath  string
	BlockPeriod               int
	ContractAddress           string
	RemoteNodeURL             string
	ChainID                   int64
	DisableTokenFactories     bool
	RequestTimeout            int
	ReleaseChannel            string
	MultipartyEnabled         bool
	IPFSMode                  string
	CCPYAMLPaths              []string
	MSPPaths                  []string
	ChannelName               string
	ChaincodeName             string
	CustomPinSupport          bool
	RemoteNodeDeploy          bool
	EnvironmentVars           map[string]string
}

type LogConfig added in v1.1.0 

type LogConfig struct {
	Level string `yaml:"level,omitempty"`
}

type ManifestEntry added in v0.0.34 

type ManifestEntry struct {
	Image string `json:"image,omitempty"`
	Local bool   `json:"local,omitempty"`
	Tag   string `json:"tag,omitempty"`
	SHA   string `json:"sha,omitempty"`
}

func (*ManifestEntry) GetDockerImageString added in v0.0.34 

func (m *ManifestEntry) GetDockerImageString() string

type MetricsServerConfig added in v1.1.0 

type MetricsServerConfig struct {
	HTTPServerConfig `yaml:",inline"`
	Enabled          bool   `yaml:"enabled,omitempty"`
	Path             string `yaml:"path,omitempty"`
}

type MigrationsConfig added in v1.1.0 

type MigrationsConfig struct {
	Auto      bool   `yaml:"auto,omitempty"`
	Directory string `yaml:"directory,omitempty"`
}

type MultipartyConfig added in v1.1.0 

type MultipartyConfig struct {
	Enabled  bool              `yaml:"enabled"`
	Org      *OrgConfig        `yaml:"org"`
	Node     *NodeConfig       `yaml:"node"`
	Contract []*ContractConfig `yaml:"contract"`
}

type MultipartyOrgConfig added in v1.1.0 

type MultipartyOrgConfig struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description,omitempty"`
	Key         string `yaml:"key"`
}

type Namespace added in v1.1.0 

type Namespace struct {
	Name        string            `yaml:"name"`
	Description string            `yaml:"description,omitempty"`
	Plugins     []string          `yaml:"plugins"`
	Multiparty  *MultipartyConfig `yaml:"multiparty,omitempty"`
	DefaultKey  interface{}       `yaml:"defaultKey"`
}

type NamespacesConfig added in v1.1.0 

type NamespacesConfig struct {
	Default    string       `json:"default"`
	Predefined []*Namespace `json:"predefined"`
}

type NodeConfig added in v1.1.0 

type NodeConfig struct {
	Name string `yaml:"name,omitempty"`
}

type OrgConfig added in v1.1.0 

type OrgConfig struct {
	Name string `yaml:"name,omitempty"`
	Key  string `yaml:"key,omitempty"`
}

type Organization added in v1.1.0 

type Organization struct {
	ID                          string       `json:"id,omitempty"`
	Index                       *int         `json:"index,omitempty"`
	Account                     interface{}  `json:"account,omitempty"`
	ExposedFireflyPort          int          `json:"exposedFireflyPort,omitempty"`
	ExposedFireflyAdminSPIPort  int          `json:"exposedFireflyAdminPort,omitempty"` // stack.json still contains the word "Admin" (rather than SPI) for migration
	ExposedFireflyMetricsPort   int          `json:"exposedFireflyMetricsPort,omitempty"`
	ExposedConnectorPort        int          `json:"exposedConnectorPort,omitempty"`
	ExposedConnectorMetricsPort int          `json:"exposedConnectorMetricsPort,omitempty"`
	ExposedDatabasePort         int          `json:"exposedPostgresPort,omitempty"`
	ExposedDataexchangePort     int          `json:"exposedDataexchangePort,omitempty"`
	ExposedIPFSApiPort          int          `json:"exposedIPFSApiPort,omitempty"`
	ExposedIPFSGWPort           int          `json:"exposedIPFSGWPort,omitempty"`
	ExposedUIPort               int          `json:"exposedUiPort,omitempty"`
	ExposedSandboxPort          int          `json:"exposedSandboxPort,omitempty"`
	ExposedTokensPorts          []int        `json:"exposedTokensPorts,omitempty"`
	ExposePtmTpPort             int          `json:"exposePtmTpPort,omitempty"`
	External                    bool         `json:"external,omitempty"`
	OrgName                     string       `json:"orgName,omitempty"`
	NodeName                    string       `json:"nodeName,omitempty"`
	Namespaces                  []*Namespace `json:"namespaces"`
}

type Plugins added in v1.1.0 

type Plugins struct {
	Database      []*DatabaseConfig      `yaml:"database,omitempty"`
	Blockchain    []*BlockchainConfig    `yaml:"blockchain,omitempty"`
	SharedStorage []*SharedStorageConfig `yaml:"sharedstorage,omitempty"`
	DataExchange  []*DataExchangeConfig  `yaml:"dataexchange,omitempty"`
	Tokens        []*TokensConfig        `yaml:"tokens,omitempty"`
}

type PullOptions added in v0.0.47 

type PullOptions struct {
	Retries int
}

type SPIServerConfig added in v1.1.0 

type SPIServerConfig struct {
	HTTPServerConfig `yaml:",inline"`
	Enabled          bool `yaml:"enabled,omitempty"`
}

type SharedStorageConfig added in v1.1.0 

type SharedStorageConfig struct {
	Name string             `yaml:"name,omitempty"`
	Type string             `yaml:"type,omitempty"`
	IPFS *FireflyIPFSConfig `yaml:"ipfs,omitempty"`
}

type Stack 

type Stack struct {
	Name                      string                 `json:"name,omitempty"`
	Members                   []*Organization        `json:"members,omitempty"`
	SwarmKey                  string                 `json:"swarmKey,omitempty"`
	ExposedBlockchainPort     int                    `json:"exposedBlockchainPort,omitempty"`
	ExposedPtmPort            int                    `json:"exposedPtmPort,omitempty"`
	Database                  fftypes.FFEnum         `json:"database"`
	BlockchainProvider        fftypes.FFEnum         `json:"blockchainProvider"`
	BlockchainConnector       fftypes.FFEnum         `json:"blockchainConnector"`
	BlockchainNodeProvider    fftypes.FFEnum         `json:"blockchainNodeProvider"`
	PrivateTransactionManager fftypes.FFEnum         `json:"privateTransactionManager"`
	Consensus                 fftypes.FFEnum         `json:"consensus"`
	TokenProviders            []fftypes.FFEnum       `json:"tokenProviders"`
	VersionManifest           *VersionManifest       `json:"versionManifest,omitempty"`
	PrometheusEnabled         bool                   `json:"prometheusEnabled,omitempty"`
	SandboxEnabled            bool                   `json:"sandboxEnabled,omitempty"`
	MultipartyEnabled         bool                   `json:"multiparty"`
	ExposedPrometheusPort     int                    `json:"exposedPrometheusPort,omitempty"`
	ContractAddress           string                 `json:"contractAddress,omitempty"`
	ChainIDPtr                *int64                 `json:"chainID,omitempty"`
	RemoteNodeURL             string                 `json:"remoteNodeURL,omitempty"`
	DisableTokenFactories     bool                   `json:"disableTokenFactories,omitempty"`
	RequestTimeout            int                    `json:"requestTimeout,omitempty"`
	IPFSMode                  fftypes.FFEnum         `json:"ipfsMode"`
	RemoteFabricNetwork       bool                   `json:"remoteFabricNetwork,omitempty"`
	ChannelName               string                 `json:"channelName,omitempty"`
	ChaincodeName             string                 `json:"chaincodeName,omitempty"`
	CustomPinSupport          bool                   `json:"customPinSupport,omitempty"`
	RemoteNodeDeploy          bool                   `json:"remoteNodeDeploy,omitempty"`
	EnvironmentVars           map[string]interface{} `json:"environmentVars"`
	InitDir                   string                 `json:"-"`
	RuntimeDir                string                 `json:"-"`
	StackDir                  string                 `json:"-"`
	State                     *StackState            `json:"-"`
}

func (*Stack) ChainID added in v1.0.2 

func (s *Stack) ChainID() int64

func (*Stack) ConcatenateWithProvidedEnvironmentVars added in v1.3.1 

func (s *Stack) ConcatenateWithProvidedEnvironmentVars(input map[string]interface{}) map[string]interface{}

func (*Stack) HasRunBefore added in v1.1.0 

func (s *Stack) HasRunBefore() (bool, error)

func (*Stack) IsOldFileStructure added in v1.1.0 

func (s *Stack) IsOldFileStructure() (bool, error)

type StackState added in v0.0.47 

type StackState struct {
	DeployedContracts []*DeployedContract `json:"deployedContracts"`
	Accounts          []interface{}       `json:"accounts"`
}

type StartOptions added in v0.0.47 

type StartOptions struct {
	NoRollback bool
}

type TezosConfig added in v1.3.0 

type TezosConfig struct {
	Tezosconnect *TezosconnectConfig `yaml:"tezosconnect,omitempty"`
}

type TezosconnectConfig added in v1.3.0 

type TezosconnectConfig struct {
	URL   string     `yaml:"url,omitempty"`
	Topic string     `yaml:"topic,omitempty"`
	Auth  *BasicAuth `yaml:"auth,omitempty"`
}

type TokensConfig added in v1.1.0 

type TokensConfig struct {
	Type     string          `yaml:"type,omitempty"`
	Name     string          `yaml:"name,omitempty"`
	FFTokens *FFTokensConfig `yaml:"fftokens,omitempty"`
}

type UIConfig added in v1.1.0 

type UIConfig struct {
	Path string `yaml:"path,omitempty"`
}

type VersionManifest added in v0.0.34 

type VersionManifest struct {
	FireFly           *ManifestEntry `json:"firefly,omitempty"`
	Ethconnect        *ManifestEntry `json:"ethconnect"`
	Evmconnect        *ManifestEntry `json:"evmconnect"`
	Tezosconnect      *ManifestEntry `json:"tezosconnect"`
	Fabconnect        *ManifestEntry `json:"fabconnect"`
	DataExchange      *ManifestEntry `json:"dataexchange-https"`
	TokensERC1155     *ManifestEntry `json:"tokens-erc1155"`
	TokensERC20ERC721 *ManifestEntry `json:"tokens-erc20-erc721"`
	Signer            *ManifestEntry `json:"signer"`
}

func (*VersionManifest) Entries added in v0.0.35 

func (m *VersionManifest) Entries() []*ManifestEntry

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.