Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 7.84 KB

README.md

File metadata and controls

122 lines (89 loc) · 7.84 KB

Script Usage

Example environment variable values are found in example.env. The scripts assume your EOA is a keystore accessible via the --account flag, see cast wallet for more info.

Core URC Admin functions

Deploying Registry.sol

forge script script/Deploy.s.sol:DeployScript --sig "deploy()" --rpc-url $RPC_URL --account $FOUNDRY_WALLET --broadcast

Generating dummy registrations

-THIS SCRIPT IS NOT MEANT FOR PRODUCTION- it is useful for testing the URC functions.

Running this script will generate N SignedRegistration messages signed by deterministic BLS private keys. The SignedRegistrations will be saved to script/output/{$SIGNED_REGISTRATIONS_FILE} following the template file SignedRegistrations.json.

forge script script/Register.s.sol:RegisterScript --sig "nDummyRegistrations(uint256,address,string)" $N $OWNER $SIGNED_REGISTRATIONS_FILE

Registering to the URC

Running this script will call register() using the supplied SignedRegistrations located in script/output/{$SIGNED_REGISTRATIONS_FILE} following the template file SignedRegistrations.json. $COLLATERAL wei will be transferred from the caller's account to the URC.

forge script script/Register.s.sol:RegisterScript --sig "register(address,uint256,string)" $REGISTRY_ADDRESS $COLLATERAL $SIGNED_REGISTRATIONS_FILE --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Unregistering from the URC

Running this script will call unregister() using the $REGISTRATION_ROOT. It's required that the caller is the registered owner address.

forge script script/Register.s.sol:RegisterScript --sig "unregister(address,bytes32)" $REGISTRY_ADDRESS $REGISTRATION_ROOT --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Opting into a Slasher

Running this script will call optInToSlasher() for the specified $REGISTRATION_ROOT. The caller must be the registered operator's owner address.

forge script script/OptInAndOut.s.sol:OptInAndOutScript --sig "optInToSlasher(address,bytes32,address,address)" $REGISTRY_ADDRESS $REGISTRATION_ROOT $SLASHER $COMMITTER --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Opting out of a Slasher

Running this script will call optOutOfSlasher() for the specified $REGISTRATION_ROOT. The caller must be the registered operator's owner address.

forge script script/OptInAndOut.s.sol:OptInAndOutScript --sig "optOutOfSlasher(address,bytes32,address)" $REGISTRY_ADDRESS $REGISTRATION_ROOT $SLASHER --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Adding operator collateral

Running this script will call addCollateral() for the specified $REGISTRATION_ROOT. The caller must be the registered operator's owner address. $COLLATERAL wei will be transferred from the caller's account to the URC.

forge script script/Collateral.s.sol:CollateralScript --sig "addCollateral(address,bytes32,uint256)" $REGISTRY_ADDRESS $REGISTRATION_ROOT $COLLATERAL --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Claiming operator collateral

Running this script will call claimCollateral() for the specified $REGISTRATION_ROOT. The caller must be the registered operator's owner address. The unregistration delay must have passed since calling unregister().

forge script script/Collateral.s.sol:CollateralScript --sig "claimCollateral(address,bytes32)" $REGISTRY_ADDRESS $REGISTRATION_ROOT --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Claiming slashed collateral

Running this script will call claimSlashedCollateral() for the specified $REGISTRATION_ROOT. The caller must be the registered operator's owner address. The slash window must have passed since the operator was slashed.

forge script script/Collateral.s.sol:CollateralScript --sig "claimSlashedCollateral(address,bytes32)" $REGISTRY_ADDRESS $REGISTRATION_ROOT --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

URC Slashing functions

Registering a bad registration (for testing)

-THIS SCRIPT IS NOT MEANT FOR PRODUCTION- it is useful for testing the slashRegistration function.

Running this script will generate and register an intentionally invalid BLS registration. The registration will be saved to script/output/{$SIGNED_REGISTRATIONS_FILE} following the template file SignedRegistrations.json.

forge script script/Slashing.s.sol:SlashingScript --sig "registerBadRegistration(address,address,string)" $REGISTRY_ADDRESS $OWNER $SIGNED_REGISTRATIONS_FILE --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Slashing a registration

Running this script will call slashRegistration() for the RegistrationProof located in script/output/{$REGISTRATION_PROOF_FILE} following the template file RegistrationProof.json.

forge script script/Slashing.s.sol:SlashingScript --sig "slashRegistration(address,string)" $REGISTRY_ADDRESS $REGISTRATION_PROOF_FILE --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

Generating equivocating delegations (for testing)

-THIS SCRIPT IS NOT MEANT FOR PRODUCTION- it is useful for testing the slashEquivocation function.

Running this script will generate two SignedDelegation messages with the same proposer and slot but different delegates. The delegations will be saved to script/output/{$DELEGATION_ONE_FILE} and script/output/{$DELEGATION_TWO_FILE} following the template file Delegation.json.

forge script script/Slashing.s.sol:SlashingScript --sig "generateEquivocatingDelegations(address,address,uint256,string,string)" $OWNER $COMMITTER $SLOT $DELEGATION_ONE_FILE $DELEGATION_TWO_FILE

Slashing for equivocation

Running this script will call slashEquivocation() using:

  • The RegistrationProof located in script/output/{$REGISTRATION_PROOF_FILE}
  • Two equivocating delegations located in script/output/{$DELEGATION_ONE_FILE} and script/output/{$DELEGATION_TWO_FILE}
forge script script/Slashing.s.sol:SlashingScript --sig "slashEquivocation(address,string,string,string)" $REGISTRY_ADDRESS $REGISTRATION_PROOF_FILE $DELEGATION_ONE_FILE $DELEGATION_TWO_FILE --account $FOUNDRY_WALLET --rpc-url $RPC_URL --broadcast

URC Utility functions

getOperatorData

Given a $REGISTRATION_ROOT, the script will write the OperatorData to script/output/{$OPERATOR_DATA_FILE} following the template file OperatorData.json.

forge script script/Getters.s.sol:GettersScript --sig "getOperatorData(address,bytes32,string)" $REGISTRY_ADDRESS $REGISTRATION_ROOT $OPERATOR_DATA_FILE --rpc-url $RPC_URL

getRegistrationProof

Given a compressed 48-byte-hex-encoded BLS $PUBKEY and a SignedRegistrations file located in script/output/{$SIGNED_REGISTRATIONS_FILE}, the script will write the RegistrationProof for the specified pubkey to script/output/{$REGISTRATION_PROOF_FILE} following the template file RegistrationProof.json.

forge script script/Getters.s.sol:GettersScript --sig "getRegistrationProof(address,bytes,string,string)" $REGISTRY_ADDRESS $PUBKEY $SIGNED_REGISTRATIONS_FILE $REGISTRATION_PROOF_FILE --account $FOUNDRY_WALLET --rpc-url $RPC_URL

getSlasherCommitment

Given a $REGISTRATION_ROOT and $SLASHER_ADDRESS, the script will write the SlasherCommitment data to script/output/{$SLASHER_COMMITMENT_FILE} following the template file SlasherCommitment.json.

forge script script/Getters.s.sol:GettersScript --sig "getSlasherCommitment(address,bytes32,address,string)" $REGISTRY_ADDRESS $REGISTRATION_ROOT $SLASHER $SLASHER_COMMITMENT_FILE --rpc-url $RPC_URL