Categorygithub.com/onflow/flow-core-contracts/lib/go/templates

modulepackage

1.4.0

Repository: https://github.com/onflow/flow-core-contracts.git

Documentation: pkg.go.dev

# README

Core Contracts Transaction Templates

This module contains transaction and script templates for the Flow core contracts, primarly templates for staking and delegating FLOW.

Generated manifest files

The manifest.mainnet.json and testnet.mainnet.json files declare all transaction templates in a portable format for mainnet and testnet respectively.

To update the manifest files:

Add your desired templates to cmd/manifest/manifest.go.
Run make generate in this directory.

# Packages

cmd

No description provided by the author

# Functions

GenerateAddAccountCreator

No description provided by the author

GenerateAddApprovedAndLimitsScript

No description provided by the author

GenerateAddApprovedNodesScript

No description provided by the author

GenerateAddKeyScript

No description provided by the author

GenerateAddNodeInfoScript

GenerateAddNodeInfoScript generates a script that adds the node operators node info to their account.

GenerateAdvanceViewScript

No description provided by the author

GenerateCapabilityEndEpochScript

No description provided by the author

GenerateChangeCutScript

GenerateChangeCutScript creates a script that changes the cut percentage.

GenerateChangeDelegatorMinimumsScript

No description provided by the author

GenerateChangeMinimumsScript

GenerateChangeMinimumsScript creates a script that changes the staking minimums.

GenerateChangePayoutScript

GenerateChangePayoutScript creates a script that changes the weekly payout.

GenerateChangeStorageFeeParametersScript

No description provided by the author

GenerateChangeVersionFreezePeriodScript

No description provided by the author

GenerateCheckMainRegistrationScript

No description provided by the author

GenerateCheckSharedRegistrationScript

No description provided by the author

GenerateCollectionAddDelegator

No description provided by the author

GenerateCollectionAddNode

No description provided by the author

GenerateCollectionCloseStake

No description provided by the author

GenerateCollectionCreateMachineAccountForNodeScript

No description provided by the author

GenerateCollectionCreateNewTokenHolderAccountScript

No description provided by the author

GenerateCollectionDepositTokensScript

No description provided by the author

GenerateCollectionDoesAccountHaveStakingCollection

No description provided by the author

GenerateCollectionGetAllDelegatorInfoScript

No description provided by the author

GenerateCollectionGetAllNodeInfoScript

No description provided by the author

GenerateCollectionGetDelegatorIDsScript

No description provided by the author

GenerateCollectionGetDoesStakeExistScript

No description provided by the author

GenerateCollectionGetLockedTokensUsedScript

No description provided by the author

GenerateCollectionGetMachineAccountAddressScript

No description provided by the author

GenerateCollectionGetMachineAccountsScript

No description provided by the author

GenerateCollectionGetNodeIDsScript

No description provided by the author

GenerateCollectionGetTokensScript

No description provided by the author

GenerateCollectionGetUnlockedTokensUsedScript

No description provided by the author

GenerateCollectionRegisterDelegator

No description provided by the author

GenerateCollectionRegisterMultipleDelegatorsScript

No description provided by the author

GenerateCollectionRegisterMultipleNodesScript

No description provided by the author

GenerateCollectionRegisterNode

No description provided by the author

GenerateCollectionRequestUnstaking

No description provided by the author

GenerateCollectionRestakeAllStakersTokens

No description provided by the author

GenerateCollectionSetup

No description provided by the author

GenerateCollectionStakeNewTokens

No description provided by the author

GenerateCollectionStakeRewardedTokens

No description provided by the author

GenerateCollectionStakeUnstakedTokens

No description provided by the author

GenerateCollectionTransferDelegator

No description provided by the author

GenerateCollectionTransferNode

No description provided by the author

GenerateCollectionUnstakeAll

No description provided by the author

GenerateCollectionUpdateNetworkingAddressScript

No description provided by the author

GenerateCollectionWithdrawFromMachineAccountScript

No description provided by the author

GenerateCollectionWithdrawRewardedTokens

No description provided by the author

GenerateCollectionWithdrawUnstakedTokens

No description provided by the author

GenerateCreateAccountScript

account templates.

GenerateCreateDelegationScript

No description provided by the author

GenerateCreateDKGParticipantScript

GenerateCreateDKGParticipantScript generates a script that creates a dkg node object.

GenerateCreateLockedDelegatorScript

CreateLockedDelegatorScript creates a script that creates a new node request with locked tokens.

GenerateCreateSharedAccountScript

No description provided by the author

GenerateCreateVoterScript

GenerateCreateVoterScript generates a script that creates a qc node object.

GenerateCustodyCreateAccountsScript

No description provided by the author

GenerateCustodyCreateAccountWithLeaseAccountScript

No description provided by the author

GenerateCustodyCreateOnlyLeaseAccountScript

No description provided by the author

GenerateCustodyCreateOnlySharedAccountScript

No description provided by the author

GenerateDelegateLockedRewardedTokensScript

DelegateLockedRewardedTokensScript creates a script that stakes unstaked tokens.

GenerateDelegateLockedUnstakedTokensScript

DelegateLockedUnstakedTokensScript creates a script that stakes unstaked tokens.

GenerateDelegateNewLockedTokensScript

DelegateNewLockedTokensScript creates a script that stakes new locked tokens.

GenerateDelegatorRequestUnstakeScript

No description provided by the author

GenerateDelegatorStakeNewScript

No description provided by the author

GenerateDelegatorStakeRewardedScript

No description provided by the author

GenerateDelegatorStakeUnstakedScript

No description provided by the author

GenerateDelegatorWithdrawRewardsScript

No description provided by the author

GenerateDelegatorWithdrawUnstakedScript

No description provided by the author

GenerateDeleteVersionBoundaryScript

No description provided by the author

GenerateDeployEpochScript

GenerateDeployEpochScript.

GenerateDeployLockedTokens

No description provided by the author

GenerateDeployQCDKGScript

GenerateDeployQCDKGScript.

GenerateDeployStakingCollectionScript

No description provided by the author

GenerateDepositAccountCreatorScript

No description provided by the author

GenerateDepositFeesScript

No description provided by the author

GenerateDepositLockedTokensScript

No description provided by the author

GenerateDepositTokensScript

No description provided by the author

GenerateEndEpochChangePayoutScript

GenerateEndEpochChangePayoutScript creates a script that changes the weekly payout and then ends the epoch.

GenerateEndEpochScript

No description provided by the author

GenerateEndStakingScript

GenerateEndStakingScript creates a script that ends the staking auction.

GenerateEndStakingTestScript

No description provided by the author

GenerateEpochCalculateSetRewardsScript

No description provided by the author

GenerateEpochPayRewardsScript

No description provided by the author

GenerateEpochRegisterDKGParticipantScript

No description provided by the author

GenerateEpochRegisterNodeScript

No description provided by the author

GenerateEpochRegisterQCVoterScript

No description provided by the author

GenerateEpochSetAutomaticRewardsScript

No description provided by the author

GenerateEpochSetBonusTokensScript

No description provided by the author

GenerateForceStopDKGScript

No description provided by the author

GenerateGenerateQuorumCertificateScript

No description provided by the author

GenerateGetAccountAvailableBalanceFilenameScript

No description provided by the author

GenerateGetAccountCreators

No description provided by the author

GenerateGetAccountsCapacityForTransactionStorageCheckScript

No description provided by the author

GenerateGetApprovedNodesScript

No description provided by the author

GenerateGetBadAccountsScript

No description provided by the author

GenerateGetBonusTokensScript

No description provided by the author

GenerateGetCandidateLimitsScript

No description provided by the author

GenerateGetCandidateNodesScript

No description provided by the author

GenerateGetClusterCompleteScript

No description provided by the author

GenerateGetClusterNodeWeightsScript

No description provided by the author

GenerateGetClusterScript

No description provided by the author

GenerateGetClustersScript

No description provided by the author

GenerateGetClusterVotesScript

No description provided by the author

GenerateGetClusterVoteThresholdScript

No description provided by the author

GenerateGetClusterWeightScript

No description provided by the author

GenerateGetCommittedBalanceScript

GenerateGetCommittedBalanceScript creates a script that returns the balance of the committed tokens of a node.

GenerateGetConsensusNodesScript

No description provided by the author

GenerateGetCreateClustersScript

No description provided by the author

GenerateGetCurrentEpochCounterScript

No description provided by the author

GenerateGetCurrentNodeVersionAsStringScript

No description provided by the author

GenerateGetCurrentNodeVersionScript

No description provided by the author

GenerateGetCurrentViewScript

No description provided by the author

GenerateGetCutPercentageScript

GenerateGetCutPercentageScript gets the delegator cut percentage.

GenerateGetDelegatorCommittedScript

No description provided by the author

GenerateGetDelegatorIDScript

No description provided by the author

GenerateGetDelegatorInfoFromAddressScript

No description provided by the author

GenerateGetDelegatorInfoScript

No description provided by the author

GenerateGetDelegatorNodeIDScript

No description provided by the author

GenerateGetDelegatorRequestScript

No description provided by the author

GenerateGetDelegatorRewardsScript

No description provided by the author

GenerateGetDelegatorStakedScript

No description provided by the author

GenerateGetDelegatorStakeRequirementScript

GenerateGetDelegatorStakeRequirementScript returns the stake requirement for delegators.

GenerateGetDelegatorUnstakedScript

No description provided by the author

GenerateGetDelegatorUnstakingRequestScript

No description provided by the author

GenerateGetDelegatorUnstakingScript

No description provided by the author

GenerateGetDKGCanonicalFinalSubmissionScript

No description provided by the author

GenerateGetDKGCompletedScript

No description provided by the author

GenerateGetDKGEnabledScript

No description provided by the author

GenerateGetDKGFinalSubmissionsScript

No description provided by the author

GenerateGetDKGLatestWhiteBoardMessagesScript

No description provided by the author

GenerateGetDKGNodeFinalSubmissionScript

No description provided by the author

GenerateGetDKGNodeHasFinalSubmittedScript

No description provided by the author

GenerateGetDKGNodeIsClaimedScript

No description provided by the author

GenerateGetDKGNodeIsRegisteredScript

No description provided by the author

GenerateGetDKGThresholdsScript

No description provided by the author

GenerateGetDKGWhiteBoardMessagesScript

No description provided by the author

GenerateGetEpochConfigMetadataScript

No description provided by the author

GenerateGetEpochMetadataScript

No description provided by the author

GenerateGetEpochPhaseScript

No description provided by the author

GenerateGetEpochTimingConfigScript

No description provided by the author

GenerateGetExecutionEffortWeights

No description provided by the author

GenerateGetExecutionMemoryLimit

No description provided by the author

GenerateGetExecutionMemoryWeights

No description provided by the author

GenerateGetFeeParametersScript

No description provided by the author

GenerateGetFeesBalanceScript

No description provided by the author

GenerateGetFlowBalanceScript

No description provided by the author

GenerateGetFlowTotalSupplyScript

No description provided by the author

GenerateGetInitialWeightScript

GenerateGetInitialWeightScript creates a script that returns the initial weight of a node.

GenerateGetIsAccountCreationRestricted

No description provided by the author

GenerateGetIsAccountCreator

No description provided by the author

GenerateGetLockedAccountAddressScript

No description provided by the author

GenerateGetLockedAccountBalanceScript

No description provided by the author

GenerateGetLockedDelegatorInfoScript

GenerateGetDelegatorInfoScript creates a script that returns an optional FlowIDTableStaking.DelegatorInfo object that is associated with an account that is delegating locked tokens.

GenerateGetLockedStakerInfoScript

GenerateGetStakerInfoScript creats a script that returns an optional FlowIDTableStaking.NodeInfo? object that is associated with an account that is staking locked tokens.

GenerateGetNetworkingAddressScript

GenerateGetNetworkingAddressScript creates a script that returns the networking address of a node.

GenerateGetNetworkingKeyScript

GenerateGetNetworkingKeyScript creates a script that returns the networking key of a node.

GenerateGetNextTableUpdatedSequenceScript

No description provided by the author

GenerateGetNextVersionBoundaryScript

No description provided by the author

GenerateGetNodeHasVotedScript

No description provided by the author

GenerateGetNodeIDScript

No description provided by the author

GenerateGetNodeInfoFromAddressScript

No description provided by the author

GenerateGetNodeInfoScript

No description provided by the author

GenerateGetNodeWeightScript

No description provided by the author

GenerateGetNonOperationalListScript

No description provided by the author

GenerateGetProposedEpochCounterScript

No description provided by the author

GenerateGetQCEnabledScript

No description provided by the author

GenerateGetRandomizeScript

No description provided by the author

GenerateGetRemoteNodeInfoScript

No description provided by the author

GenerateGetRewardBalanceScript

GenerateGetRewardBalanceScript creates a script that returns the balance of the rewarded tokens of a node.

GenerateGetRewardRatioScript

GenerateGetRewardRatioScript gets the reward ratio for a node type.

GenerateGetRoleCountsScript

No description provided by the author

GenerateGetRoleScript

GenerateGetRoleScript creates a script that returns the role of a node.

GenerateGetSlotLimitsScript

No description provided by the author

GenerateGetStakedBalanceScript

GenerateGetStakedBalanceScript creates a script that returns the balance of the staked tokens of a node.

GenerateGetStakeRequirementsScript

GenerateGetStakeRequirementsScript returns the stake requirement for a node type.

GenerateGetStakingKeyScript

GenerateGetStakingKeyScript creates a script that returns the staking key of a node.

GenerateGetStorageCapacityScript

No description provided by the author

GenerateGetStorageFeeConversionScript

No description provided by the author

GenerateGetStorageFeeMinimumScript

No description provided by the author

GenerateGetTargetEndTimeForEpochScript

No description provided by the author

GenerateGetTotalBalanceScript

No description provided by the author

GenerateGetTotalCommitmentBalanceScript

GenerateGetTotalCommitmentBalanceScript creates a script that returns the balance of the total committed tokens of a node plus delegators.

GenerateGetTotalCommitmentBalanceWithoutDelegatorsScript

GenerateGetTotalCommitmentBalanceWithoutDelegatorsScript creates a script that returns the balance of the total committed tokens of a node without delegators.

GenerateGetTotalTokensStakedByTypeScript

GenerateGetTotalTokensStakedByTypeScript returns the total tokens staked for a node type.

GenerateGetTotalTokensStakedScript

GenerateGetTotalTokensStakedScript returns the total tokens staked.

GenerateGetUnlockLimitScript

No description provided by the author

GenerateGetUnstakedBalanceScript

GenerateGetUnstakedBalanceScript creates a script that returns the balance of the unstaked tokens of a node.

GenerateGetUnstakingBalanceScript

GenerateGetUnstakingBalanceScript creates a script that returns the balance of the unstaking tokens of a node.

GenerateGetUnstakingRequestScript

GenerateGetUnstakingRequestScript creates a script that returns the balance of the unstaking request for a node.

GenerateGetVersionBoundariesScript

No description provided by the author

GenerateGetVersionBoundaryFreezePeriodScript

No description provided by the author

GenerateGetVoterIsRegisteredScript

No description provided by the author

GenerateGetVotingCompletedScript

No description provided by the author

GenerateGetWeeklyPayoutScript

GenerateGetWeeklyPayoutScript gets the total weekly reward payout.

GenerateHeartbeatScript

No description provided by the author

GenerateIncreaseUnlockLimitForMultipleAccountsScript

No description provided by the author

GenerateIncreaseUnlockLimitScript

No description provided by the author

GenerateLockedNodeUpdateNetworkingAddressScript

Change the networking address of a locked node.

GenerateMintFlowScript

FlowToken Templates.

GenerateMoveTokensScript

GenerateMoveTokensScript creates a script that moves tokens between buckets.

GeneratePayRewardsScript

GeneratePayRewardsScript creates a script that pays rewards.

GenerateProxyRequestUnstakingScript

No description provided by the author

GenerateProxyStakeNewTokensScript

No description provided by the author

GenerateProxyStakeUnstakedTokensScript

No description provided by the author

GenerateProxyUnstakeAllScript

No description provided by the author

GenerateProxyWithdrawRewardsScript

No description provided by the author

GenerateProxyWithdrawUnstakedScript

No description provided by the author

GeneratePublishDKGParticipantScript

No description provided by the author

GeneratePublishVoterScript

No description provided by the author

GenerateRegisterDelegatorScript

No description provided by the author

GenerateRegisterLockedNodeScript

CreateLockedNodeScript creates a script that creates a new node request with locked tokens.

GenerateRegisterManyDelegatorsScript

No description provided by the author

GenerateRegisterManyNodesScript

No description provided by the author

GenerateRegisterNodeScript

GenerateRegisterNodeScript creates a script that creates a new node struct and stores it in the Node records.

GenerateRegisterStakingProxyNodeScript

No description provided by the author

GenerateRemoveAccountCreator

No description provided by the author

GenerateRemoveApprovedNodesScript

No description provided by the author

GenerateRemoveDelegatorScript

No description provided by the author

GenerateRemoveInvalidNodesScript

No description provided by the author

GenerateRemoveNodeInfoScript

No description provided by the author

GenerateRemoveNodeScript

GenerateRemoveNodeScript creates a script that removes a node from the record.

GenerateRemoveStakingProxyScript

No description provided by the author

GenerateResetEpochScript

No description provided by the author

GenerateReturnCurrentTableScript

GenerateReturnCurrentTableScript creates a script that returns the current ID table.

GenerateReturnProposedTableScript

GenerateReturnProposedTableScript creates a script that returns the ID table for the proposed next epoch.

GenerateReturnTableScript

GenerateReturnTableScript creates a script that returns the the whole ID table nodeIDs.

GenerateRevokeKeyScript

No description provided by the author

GenerateScaleRewardsTestScript

For testing only.

GenerateSendDKGFinalSubmissionScript

GenerateSendDKGFinalSubmissionScript generates a script that sends a dkg final submission for a node.

GenerateSendDKGWhiteboardMessageScript

GenerateSendDKGWhiteboardMessageScript generates a script that sends a dkg final submission for a node.

GenerateSetApprovedNodesScript

No description provided by the author

GenerateSetCandidateLimitsScript

No description provided by the author

GenerateSetClaimedScript

GenerateSetClaimedScript creates a script that sets the new metadata claimed fields.

GenerateSetExecutionEffortWeights

No description provided by the author

GenerateSetExecutionMemoryLimit

No description provided by the author

GenerateSetExecutionMemoryWeights

No description provided by the author

GenerateSetFeeParametersScript

No description provided by the author

GenerateSetFeeSurgeFactorScript

No description provided by the author

GenerateSetIsAccountCreationRestricted

No description provided by the author

GenerateSetNodeWeightScript

No description provided by the author

GenerateSetNonOperationalScript

No description provided by the author

GenerateSetOpenAccessSlotsScript

No description provided by the author

GenerateSetSafeThresholdScript

GenerateSetSafeThresholdScript generates a script for the admin to set a new threshold percentage for DKG completion.

GenerateSetSlotLimitsScript

No description provided by the author

GenerateSetupCustodyAccountScript

No description provided by the author

GenerateSetupFTAccountFromAddressScript

FT and NFT templates.

GenerateSetupNFTAccountFromAddressScript

No description provided by the author

GenerateSetupNodeAccountScript

GenerateSetupNodeAccountScript generates a script that sets up a node operator's account to receive staking proxies.

GenerateSetVersionBoundaryScript

No description provided by the author

GenerateStakeLockedRewardedTokensScript

StakeLockedRewardedTokensScript creates a script that stakes unstaked tokens.

GenerateStakeLockedUnstakedTokensScript

StakeLockedUnstakedTokensScript creates a script that stakes unstaked tokens.

GenerateStakeNewLockedTokensScript

StakeNewLockedTokensScript creates a script that stakes new locked tokens.

GenerateStakeNewTokensScript

GenerateStakeNewTokensScript creates a script that stakes new tokens for a node operator.

GenerateStakeRewardedTokensScript

GenerateStakeRewardedTokensScript creates a script that stakes tokens for a node operator from their rewarded bucket.

GenerateStakeUnstakedTokensScript

GenerateStakeUnstakedTokensScript creates a script that stakes tokens for a node operator from their unstaked bucket.

GenerateStartDKGScript

GenerateStartDKGScript generates a script for the admin that starts DKG.

GenerateStartStakingScript

GenerateStartStakingScript creates a script that starts the staking auction.

GenerateStartVotingScript

GenerateStartVotingScript generates a script for the admin that starts voting.

GenerateStopDKGScript

GenerateStopDKGScript generates a script for the admin that stops DKG.

GenerateStopVotingScript

GenerateStopVotingScript generates a script for the admin that stops voting.

GenerateSubmitVoteScript

GenerateSubmitVoteScript generates a script that submits a qc vote for a node.

GenerateTransferAdminCapabilityScript

No description provided by the author

GenerateTransferFeesAdminScript

No description provided by the author

GenerateTransferGenericNFTWithAddressScript

No description provided by the author

GenerateTransferGenericNFTWithPathsScript

No description provided by the author

GenerateTransferGenericVaultWithAddressScript

No description provided by the author

GenerateTransferGenericVaultWithPathsScript

No description provided by the author

GenerateTransferMinterAndDeployScript

GenerateTransferMinterAndDeployScript generates a script that transfers a flow minter and deploys the id table account.

GenerateUnDelegateLockedTokensScript

UnDelegateLockedTokensScript creates a script that unstakes locked tokens.

GenerateUnstakeAllLockedTokensScript

UnstakeAllLockedTokensScript creates a script that unstakes all locked tokens.

GenerateUnstakeAllScript

GenerateUnstakeAllScript creates a script that makes an unstaking request for an existing node operator to unstake all their tokens.

GenerateUnstakeLockedTokensScript

UnstakeLockedTokensScript creates a script that unstakes locked tokens.

GenerateUnstakeTokensScript

GenerateUnstakeTokensScript creates a script that makes an unstaking request for an existing node operator.

GenerateUpdateDKGViewsScript

No description provided by the author

GenerateUpdateEpochConfigScript

No description provided by the author

GenerateUpdateEpochTimingConfigScript

No description provided by the author

GenerateUpdateEpochViewsScript

No description provided by the author

GenerateUpdateNetworkingAddressScript

GenerateUpdateNetworkingAddressScript creates a script changes the networking address for an existing node operator.

GenerateUpdateNumClustersScript

No description provided by the author

GenerateUpdateRewardPercentageScript

No description provided by the author

GenerateUpdateStakingViewsScript

No description provided by the author

GenerateUpgradeStakingScript

GenerateUpgradeStakingScript creates a script that upgrades the staking contract.

GenerateVerifyPayerBalanceForTxExecution

No description provided by the author

GenerateWithdrawDelegatorLockedRewardedTokensScript

WithdrawDelegatorLockedRewardedTokensScript creates a script that requests a withdrawal of unstaked tokens.

GenerateWithdrawDelegatorLockedRewardedTokensToLockedAccountScript

No description provided by the author

GenerateWithdrawDelegatorLockedUnstakedTokensScript

WithdrawDelegatorLockedUnstakedTokensScript creates a script that requests a withdrawal of unstaked tokens.

GenerateWithdrawLockedRewardedTokensScript

WithdrawLockedRewardedTokensScript creates a script that requests a withdrawal of unstaked tokens.

GenerateWithdrawLockedRewardedTokensToLockedAccountScript

No description provided by the author

GenerateWithdrawLockedUnstakedTokensScript

WithdrawLockedUnstakedTokensScript creates a script that requests a withdrawal of unstaked tokens.

GenerateWithdrawRewardedTokensScript

GenerateWithdrawRewardedTokensScript creates a script that withdraws rewarded tokens for an existing node operator.

GenerateWithdrawTokensScript

No description provided by the author

GenerateWithdrawUnstakedTokensScript

GenerateWithdrawUnstakedTokensScript creates a script that withdraws unstaked tokens for an existing node operator.

ReplaceAddresses

No description provided by the author

# Structs

Environment

No description provided by the author