migrations

Documentation

Index

• func CreateAccountBasedMigration(log zerolog.Logger, nWorker int, migrations []AccountBasedMigration) func(payloads []*ledger.Payload) ([]*ledger.Payload, error)
• func MigrateByAccount(log zerolog.Logger, nWorker int, allPayloads []*ledger.Payload, ...) ([]*ledger.Payload, error)
• func MigrateGroupConcurrently(log zerolog.Logger, migrations []AccountBasedMigration, ...) ([]*ledger.Payload, error)
• func NoOpMigration(p []ledger.Payload) ([]ledger.Payload, error)
• func PruneMigration(payload []ledger.Payload) ([]ledger.Payload, error)
• type AccountBasedMigration
• type AccountUsageMigrator
  • func (m *AccountUsageMigrator) Close() error
  • func (m *AccountUsageMigrator) InitMigration(log zerolog.Logger, _ []*ledger.Payload, _ int) error
  • func (m *AccountUsageMigrator) MigrateAccount(_ context.Context, address common.Address, payloads []*ledger.Payload) ([]*ledger.Payload, error)
• type AccountsAtreeLedger
  • func NewAccountsAtreeLedger(accounts environment.Accounts) *AccountsAtreeLedger
  • func (a *AccountsAtreeLedger) AllocateStorageIndex(owner []byte) (atree.StorageIndex, error)
  • func (a *AccountsAtreeLedger) GetValue(owner, key []byte) ([]byte, error)
  • func (a *AccountsAtreeLedger) SetValue(owner, key, value []byte) error
  • func (a *AccountsAtreeLedger) ValueExists(owner, key []byte) (exists bool, err error)
• type ChangeContractCodeMigration
  • func (d *ChangeContractCodeMigration) Close() error
  • func (d *ChangeContractCodeMigration) InitMigration(log zerolog.Logger, _ []*ledger.Payload, _ int) error
  • func (d *ChangeContractCodeMigration) MigrateAccount(_ context.Context, address common.Address, payloads []*ledger.Payload) ([]*ledger.Payload, error)
  • func (d *ChangeContractCodeMigration) RegisterContractChange(address common.Address, contractName string, newContractCode string) (previousNewContractCode string)
• type DeduplicateContractNamesMigration
  • func (d *DeduplicateContractNamesMigration) Close() error
  • func (d *DeduplicateContractNamesMigration) InitMigration(log zerolog.Logger, _ []*ledger.Payload, _ int) error
  • func (d *DeduplicateContractNamesMigration) MigrateAccount(ctx context.Context, address common.Address, payloads []*ledger.Payload) ([]*ledger.Payload, error)
• type SystemContractChange
  • func NewSystemContractChange(systemContract systemcontracts.SystemContract, newContractCode []byte) SystemContractChange
  • func SystemContractChanges(chainID flow.ChainID) []SystemContractChange

Functions

func CreateAccountBasedMigration

func CreateAccountBasedMigration(
	log zerolog.Logger,
	nWorker int,
	migrations []AccountBasedMigration,
) func(payloads []*ledger.Payload) ([]*ledger.Payload, error)

CreateAccountBasedMigration creates a migration function that migrates the payloads account by account using the given migrations accounts are processed concurrently using the given number of workers but each account is processed sequentially by the given migrations in order. The migrations InitMigration function is called once before the migration starts And the Close function is called once after the migration finishes if the migration is a finisher.

func MigrateByAccount

func MigrateByAccount(
	log zerolog.Logger,
	nWorker int,
	allPayloads []*ledger.Payload,
	migrations []AccountBasedMigration,
) (
	[]*ledger.Payload,
	error,
)

MigrateByAccount takes migrations and all the Payloads, and returns the migrated Payloads.

func MigrateGroupConcurrently

func MigrateGroupConcurrently(
	log zerolog.Logger,
	migrations []AccountBasedMigration,
	accountGroups *util.PayloadAccountGrouping,
	nWorker int,
) ([]*ledger.Payload, error)

MigrateGroupConcurrently migrate the Payloads in the given account groups. It uses nWorker to process the Payloads concurrently. The Payloads in each account are processed sequentially by the given migrations in order.

func NoOpMigration

func NoOpMigration(p []ledger.Payload) ([]ledger.Payload, error)

func PruneMigration

func PruneMigration(payload []ledger.Payload) ([]ledger.Payload, error)

PruneMigration removes all the payloads with empty value this prunes the trie for values that has been deleted

Types

type AccountBasedMigration

type AccountBasedMigration interface {
	InitMigration(
		log zerolog.Logger,
		allPayloads []*ledger.Payload,
		nWorkers int,
	) error
	MigrateAccount(
		ctx context.Context,
		address common.Address,
		payloads []*ledger.Payload,
	) ([]*ledger.Payload, error)
	io.Closer
}

AccountBasedMigration is an interface for migrations that migrate account by account concurrently getting all the payloads for each account at a time.

type AccountUsageMigrator

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

AccountUsageMigrator iterates through each payload, and calculate the storage usage and update the accounts status with the updated storage usage

func (*AccountUsageMigrator) Close

func (m *AccountUsageMigrator) Close() error

func (*AccountUsageMigrator) InitMigration

func (m *AccountUsageMigrator) InitMigration(
	log zerolog.Logger,
	_ []*ledger.Payload,
	_ int,
) error

func (*AccountUsageMigrator) MigrateAccount

func (m *AccountUsageMigrator) MigrateAccount(
	_ context.Context,
	address common.Address,
	payloads []*ledger.Payload,
) ([]*ledger.Payload, error)

type AccountsAtreeLedger

type AccountsAtreeLedger struct {
	Accounts environment.Accounts
}

func NewAccountsAtreeLedger

func NewAccountsAtreeLedger(accounts environment.Accounts) *AccountsAtreeLedger

func (*AccountsAtreeLedger) AllocateStorageIndex

func (a *AccountsAtreeLedger) AllocateStorageIndex(owner []byte) (atree.StorageIndex, error)

AllocateStorageIndex allocates new storage index under the owner accounts to store a new register

func (*AccountsAtreeLedger) GetValue

func (a *AccountsAtreeLedger) GetValue(owner, key []byte) ([]byte, error)

func (*AccountsAtreeLedger) SetValue

func (a *AccountsAtreeLedger) SetValue(owner, key, value []byte) error

func (*AccountsAtreeLedger) ValueExists

func (a *AccountsAtreeLedger) ValueExists(owner, key []byte) (exists bool, err error)

type ChangeContractCodeMigration

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

func (*ChangeContractCodeMigration) Close

func (d *ChangeContractCodeMigration) Close() error

func (*ChangeContractCodeMigration) InitMigration

func (d *ChangeContractCodeMigration) InitMigration(
	log zerolog.Logger,
	_ []*ledger.Payload,
	_ int,
) error

func (*ChangeContractCodeMigration) MigrateAccount

func (d *ChangeContractCodeMigration) MigrateAccount(
	_ context.Context,
	address common.Address,
	payloads []*ledger.Payload,
) ([]*ledger.Payload, error)

func (*ChangeContractCodeMigration) RegisterContractChange

func (d *ChangeContractCodeMigration) RegisterContractChange(
	address common.Address,
	contractName string,
	newContractCode string,
) (
	previousNewContractCode string,
)

type DeduplicateContractNamesMigration

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

DeduplicateContractNamesMigration checks if the contract names have been duplicated and removes the duplicate ones.

This migration de-syncs storage used, so it should be run before the StorageUsedMigration.

func (*DeduplicateContractNamesMigration) Close

func (d *DeduplicateContractNamesMigration) Close() error

func (*DeduplicateContractNamesMigration) InitMigration

func (d *DeduplicateContractNamesMigration) InitMigration(
	log zerolog.Logger,
	_ []*ledger.Payload,
	_ int,
) error

func (*DeduplicateContractNamesMigration) MigrateAccount

func (d *DeduplicateContractNamesMigration) MigrateAccount(
	ctx context.Context,
	address common.Address,
	payloads []*ledger.Payload,
) ([]*ledger.Payload, error)

type SystemContractChange

type SystemContractChange struct {
	Address         common.Address
	ContractName    string
	NewContractCode string
}

func NewSystemContractChange

func NewSystemContractChange(
	systemContract systemcontracts.SystemContract,
	newContractCode []byte,
) SystemContractChange

func SystemContractChanges

func SystemContractChanges(chainID flow.ChainID) []SystemContractChange