templates

Documentation

Index

• func AccountKeyToCadenceCryptoKey(key *flow.AccountKey) (cadence.Value, error)
• func AddAccountContract(address flow.Address, contract Contract) *flow.Transaction
• func AddAccountKey(address flow.Address, accountKey *flow.AccountKey) (*flow.Transaction, error)
• func CreateAccount(accountKeys []*flow.AccountKey, contracts []Contract, payer flow.Address) (*flow.Transaction, error)
• func CreateAccountAndFund(accountKeys []*flow.AccountKey, contracts []Contract, payer flow.Address, ...) (*flow.Transaction, error)
• func RemoveAccountContract(address flow.Address, contractName string) *flow.Transaction
• func RemoveAccountKey(address flow.Address, keyIndex int) *flow.Transaction
• func UpdateAccountContract(address flow.Address, contract Contract) *flow.Transaction
• type Contract
  • func (c Contract) SourceBytes() []byte
  • func (c Contract) SourceHex() string

Functions

func AccountKeyToCadenceCryptoKey

func AccountKeyToCadenceCryptoKey(key *flow.AccountKey) (cadence.Value, error)

AccountKeyToCadenceCryptoKey converts a `flow.AccountKey` key to the Cadence struct `Crypto.KeyListEntry`, so that it can more easily be used as a parameter in scripts and transactions.

example: ```go

key := AccountKeyToCadenceCryptoKey(accountKey)

return flow.NewTransaction().
	SetScript([]byte(templates.AddAccountKey)).
	AddRawArgument(jsoncdc.MustEncode(key))

```

func AddAccountContract

func AddAccountContract(address flow.Address, contract Contract) *flow.Transaction

AddAccountContract generates a transaction that deploys a contract to an account.

func AddAccountKey

func AddAccountKey(address flow.Address, accountKey *flow.AccountKey) (*flow.Transaction, error)

AddAccountKey generates a transaction that adds a public key to an account.

func CreateAccount

func CreateAccount(accountKeys []*flow.AccountKey, contracts []Contract, payer flow.Address) (*flow.Transaction, error)

CreateAccount generates a transactions that creates a new account.

This template accepts a list of public keys and a contracts argument, both of which are optional.

The contracts argument is a dictionary of *contract name*: *contract code (in bytes)*. All of the contracts will be deployed to the account.

The final argument is the address of the account that will pay the account creation fee. This account is added as a transaction authorizer and therefore must sign the resulting transaction.

func CreateAccountAndFund

func CreateAccountAndFund(
	accountKeys []*flow.AccountKey,
	contracts []Contract,
	payer flow.Address,
	amount string,
	network flow.ChainID,
) (*flow.Transaction, error)

func RemoveAccountContract

func RemoveAccountContract(address flow.Address, contractName string) *flow.Transaction

RemoveAccountContract generates a transaction that removes a contract with the given name

func RemoveAccountKey

func RemoveAccountKey(address flow.Address, keyIndex int) *flow.Transaction

RemoveAccountKey generates a transaction that removes a key from an account.

func UpdateAccountContract

func UpdateAccountContract(address flow.Address, contract Contract) *flow.Transaction

UpdateAccountContract generates a transaction that updates a contract deployed at an account.

Types

type Contract

type Contract struct {
	Name   string
	Source string
}

Contract is a Cadence contract deployed to a Flow account.

Name is the identifier for the contract within the account.

Source is the the Cadence code of the contract.

func (Contract) SourceBytes

func (c Contract) SourceBytes() []byte

SourceBytes returns the UTF-8 encoded source code (Source) of the contract.

func (Contract) SourceHex

func (c Contract) SourceHex() string

SourceHex returns the UTF-8 encoded source code (Source) of the contract as a hex string.