cli

package

v0.15.0 Latest Latest Go to latest Published: Mar 10, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/onflow/flow-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cli defines constants, configurations, and utilities that are used across the Flow CLI.

Index ¶

Constants
Variables
func ConfigExists() bool
func EnvFromNetwork(network flow.ChainID) templates.Environment
func ExecuteScript(host string, script []byte, arguments ...cadence.Value)
func Exit(code int, msg string)
func Exitf(code int, msg string, args ...interface{})
func GcloudApplicationSignin(project string)
func GetAccount(host string, address flow.Address) *flow.Account
func GetAddressNetwork(address flow.Address) (flow.ChainID, error)
func GetBlockByHeight(host string, height uint64) *flow.Block
func GetBlockByID(host string, blockID flow.Identifier) *flow.Block
func GetBlockEvents(host string, startHeight, endHeight uint64, eventType string, printEmpty bool)
func GetCollectionByID(host string, collectionID flow.Identifier) *flow.Collection
func GetLatestBlock(host string) *flow.Block
func GetTransactionResult(host string, id string, sealed bool, showTransactionCode bool)
func KeyContextFromKMSResourceID(resourceID string) (map[string]string, error)
func MustDecodePrivateKeyHex(sigAlgo crypto.SignatureAlgorithm, prKeyHex string) crypto.PrivateKey
func MustDecodePublicKeyHex(sigAlgo crypto.SignatureAlgorithm, pubKeyHex string) crypto.PublicKey
func MustSaveConfig(conf *Config)
func ParseArguments(input string) ([]cadence.Value, error)
func PrintIndent(numberOfIndents int)
func RandomSeed(n int) []byte
func SaveConfig(conf *Config) error
func SendTransaction(host string, signerAccount *Account, tx *flow.Transaction, withResults bool)
type Account
- func (acct *Account) LoadSigner() error
- func (acct *Account) MarshalJSON() ([]byte, error)
- func (acct *Account) UnmarshalJSON(data []byte) (err error)
type CadenceArgument
- func (v CadenceArgument) MarshalJSON() ([]byte, error)
- func (v *CadenceArgument) UnmarshalJSON(b []byte) (err error)
type Config
- func LoadConfig() *Config
- func NewConfig() *Config
- func (c *Config) HostWithOverride(overrideIfNotEmpty string) string
- func (c *Config) LoadSigners() error
- func (c *Config) ServiceAccount() *Account
- func (c *Config) SetServiceAccountKey(privateKey crypto.PrivateKey, hashAlgo crypto.HashAlgorithm)
type KeyType

Constants ¶

View Source

const (
	EnvPrefix          = "FLOW"
	DefaultSigAlgo     = crypto.ECDSA_P256
	DefaultHashAlgo    = crypto.SHA3_256
	DefaultHost        = "127.0.0.1:3569"
	MaxGRPCMessageSize = 1024 * 1024 * 16
	Indent             = "  "
)

Variables ¶

View Source

var ConfigPath = []string{"flow.json"}

Functions ¶

func ConfigExists ¶

func ConfigExists() bool

func EnvFromNetwork ¶ added in v0.15.0

func EnvFromNetwork(network flow.ChainID) templates.Environment

func ExecuteScript ¶

func ExecuteScript(host string, script []byte, arguments ...cadence.Value)

func Exit ¶

func Exit(code int, msg string)

func Exitf ¶

func Exitf(code int, msg string, args ...interface{})

func GcloudApplicationSignin ¶ added in v0.12.0

func GcloudApplicationSignin(project string)

GcloudApplicationSignin signs in as an application user using gcloud command line tool currently assumes gcloud is already installed on the machine will by default pop a browser window to sign in

func GetAccount ¶

func GetAccount(host string, address flow.Address) *flow.Account

func GetAddressNetwork ¶ added in v0.15.0

func GetAddressNetwork(address flow.Address) (flow.ChainID, error)

func GetBlockByHeight ¶

func GetBlockByHeight(host string, height uint64) *flow.Block

func GetBlockByID ¶

func GetBlockByID(host string, blockID flow.Identifier) *flow.Block

func GetBlockEvents ¶

func GetBlockEvents(host string, startHeight, endHeight uint64, eventType string, printEmpty bool)

func GetCollectionByID ¶

func GetCollectionByID(host string, collectionID flow.Identifier) *flow.Collection

func GetLatestBlock ¶

func GetLatestBlock(host string) *flow.Block

func GetTransactionResult ¶

func GetTransactionResult(host string, id string, sealed bool, showTransactionCode bool)

func KeyContextFromKMSResourceID ¶ added in v0.12.0

func KeyContextFromKMSResourceID(resourceID string) (map[string]string, error)

func MustDecodePrivateKeyHex ¶

func MustDecodePrivateKeyHex(sigAlgo crypto.SignatureAlgorithm, prKeyHex string) crypto.PrivateKey

func MustDecodePublicKeyHex ¶

func MustDecodePublicKeyHex(sigAlgo crypto.SignatureAlgorithm, pubKeyHex string) crypto.PublicKey

func MustSaveConfig ¶

func MustSaveConfig(conf *Config)

func ParseArguments ¶ added in v0.15.0

func ParseArguments(input string) ([]cadence.Value, error)

func PrintIndent ¶ added in v0.15.0

func PrintIndent(numberOfIndents int)

func RandomSeed ¶

func RandomSeed(n int) []byte

func SaveConfig ¶

func SaveConfig(conf *Config) error

func SendTransaction ¶

func SendTransaction(host string, signerAccount *Account, tx *flow.Transaction, withResults bool)

Types ¶

type Account ¶

type Account struct {
	KeyType    KeyType
	KeyIndex   int
	KeyContext map[string]string
	Address    flow.Address
	PrivateKey crypto.PrivateKey
	SigAlgo    crypto.SignatureAlgorithm
	HashAlgo   crypto.HashAlgorithm
	Signer     crypto.Signer
}

func (*Account) LoadSigner ¶ added in v0.12.0

func (acct *Account) LoadSigner() error

func (*Account) MarshalJSON ¶

func (acct *Account) MarshalJSON() ([]byte, error)

func (*Account) UnmarshalJSON ¶

func (acct *Account) UnmarshalJSON(data []byte) (err error)

type CadenceArgument ¶ added in v0.15.0

type CadenceArgument struct {
	Value cadence.Value
}

func (CadenceArgument) MarshalJSON ¶ added in v0.15.0

func (v CadenceArgument) MarshalJSON() ([]byte, error)

func (*CadenceArgument) UnmarshalJSON ¶ added in v0.15.0

func (v *CadenceArgument) UnmarshalJSON(b []byte) (err error)

type Config ¶

type Config struct {
	Host     string              `json:"host"`
	Accounts map[string]*Account `json:"accounts"`
}

func LoadConfig ¶

func LoadConfig() *Config

func NewConfig ¶

func NewConfig() *Config

func (*Config) HostWithOverride ¶

func (c *Config) HostWithOverride(overrideIfNotEmpty string) string

func (*Config) LoadSigners ¶ added in v0.12.0

func (c *Config) LoadSigners() error

func (*Config) ServiceAccount ¶

func (c *Config) ServiceAccount() *Account

func (*Config) SetServiceAccountKey ¶

func (c *Config) SetServiceAccountKey(privateKey crypto.PrivateKey, hashAlgo crypto.HashAlgorithm)

type KeyType ¶ added in v0.12.0

type KeyType string

const (
	KeyTypeHex   KeyType = "hex"   // Hex private key with in memory signer
	KeyTypeKMS   KeyType = "kms"   // Google KMS signer
	KeyTypeShell KeyType = "shell" // Exec out to a shell script

)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
accounts
add-contract
create
get
remove-contract
staking-info
update-contract
blocks
get
cadence
languageserver
vscode
collections
get
emulator
events
get
initialize
keys
generate
save
save/hex
save/kms
project
cli
cli/config
cli/config/json
cli/keys
cli/txsender
commands/deploy_contracts
commands/initialize
commands/start_emulator
contracts
scripts
execute
transactions
send
status
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL