network

func AdvanceEpoch ¶

func AdvanceEpoch(ctx context.Context, client rpc.Client, epochIncrement int) error

AdvanceEpoch triggers the sealing of an epoch advancing it by the given number. The function blocks until the final epoch has been reached.

func ApplyNetworkRules ¶

func ApplyNetworkRules(ctx context.Context, backend ContractBackend, rules genesis.NetworkRulesPatch) error

ApplyNetworkRules updates the network rules on the network.

func DelegateToValidator ¶

func DelegateToValidator(
	ctx context.Context,
	client rpc.Client,
	validatorId int,
	stake uint64,
	delegator *ecdsa.PrivateKey,
) error

DelegateToValidator delegates the given stake (in S) from the delegator account to the validator identified by validatorId. The delegator account must already hold enough funds to cover stake + gas.

func FundAccount ¶

func FundAccount(
	ctx context.Context,
	client rpc.Client,
	source *ecdsa.PrivateKey,
	dest common.Address,
	amount uint64,
) error

FundAccount transfers `amount` S from the source account to the destination address using a plain value-transfer transaction.

func GetActiveValidatorIDs ¶

func GetActiveValidatorIDs(client rpc.Client) ([]int, error)

GetActiveValidatorIDs returns the ids of the validators taking part in consensus in the epoch currently being built. SFC validator sets are per-epoch: a validator registered mid-epoch is absent from this set until that epoch is sealed.

func GetCurrentEpoch ¶

func GetCurrentEpoch(client rpc.Client) (hexutil.Uint64, error)

func GetDelegatorStake ¶

func GetDelegatorStake(
	client rpc.Client,
	delegator common.Address,
	validatorId int,
) (uint64, error)

GetDelegatorStake returns the current on-chain stake (in S) held by the given delegator on the given validator.

func RegisterValidatorNode ¶

func RegisterValidatorNode(ctx context.Context, backend ContractBackend, stake uint64) (int, error)

RegisterValidatorNode registers a validator in the SFC contract. If stake is 0, the default stake of 5,000,000 S is used.

func Retry ¶

func Retry(
	ctx context.Context,
	numAttempts int,
	delay time.Duration,
	do func(context.Context) error,
) error

Retry executes the input function until it produces no error. It however executes only the configured number of times with the configured delay between attempts. If the execution is not successful since, the execution returns the last error. The context can be used to abort the retry loop early.

func RetryReturn ¶

func RetryReturn[Out any](
	ctx context.Context,
	numAttempts int,
	delay time.Duration,
	do func(context.Context) (Out, error),
) (Out, error)

RetryReturn executes the input function until it produces no error. It however executes only the configured number of times with the configured delay between attempts. If the execution is not successful since, the execution returns the last error. When execution is successful, the execution result is returned from this method. The context can be used to abort the retry loop early. If the function returns a PermanentError, the retry loop stops immediately.

func UndelegateFromValidator ¶

func UndelegateFromValidator(
	ctx context.Context,
	client rpc.Client,
	validatorId int,
	stake uint64,
	delegator *ecdsa.PrivateKey,
) error

UndelegateFromValidator undelegates the given stake (in S) from the validator, signing the transaction with the delegator's private key. When stake is 0, the current on-chain stake for the delegator on the given validator is queried and fully undelegated.

func UnregisterValidatorNode ¶

func UnregisterValidatorNode(ctx context.Context, client rpc.Client, validatorId int, stake uint64) error

UnregisterValidatorNode undelegates a validator's self-stake from the SFC contract. If stake is 0, the currently staked amount is queried on-chain via GetSelfStake and used as the undelegate amount.

func WaitForEpochChange ¶

func WaitForEpochChange(ctx context.Context, client rpc.Client) error

WaitForEpochChange waits until the current epoch changes. It polls the network until a new epoch is observed or a timeout of 60 seconds is reached.