Merge pull request #2079 from opentensor/evm-associate-key-rate-limit

Evm associate key rate limit

Author: sam0x17

evm-tests/test/evm-uid.precompile.lookup.test.ts

@@ -14,77 +14,76 @@ import { keccak256 } from 'ethers';
 import { addNewSubnetwork, forceSetBalanceToSs58Address, startCall } from "../src/subtensor";
 
 describe("Test the UID Lookup precompile", () => {
-    const hotkey = getRandomSubstrateKeypair();
-    const coldkey = getRandomSubstrateKeypair();
-    const evmWallet = generateRandomEthersWallet();
-    let publicClient: PublicClient;
+  const hotkey = getRandomSubstrateKeypair();
+  const coldkey = getRandomSubstrateKeypair();
+  const evmWallet = generateRandomEthersWallet();
+  let publicClient: PublicClient;
 
-    let api: TypedApi<typeof devnet>
+  let api: TypedApi<typeof devnet>
 
-    let alice: PolkadotSigner;
+  let alice: PolkadotSigner;
 
-    let uid: number;
-    let blockNumber: number;
-    let netuid: number;
-    let blockNumberAssociated: bigint;
+  let uid: number;
+  let blockNumber: number;
+  let netuid: number;
+  let blockNumberAssociated: bigint;
 
-    before(async () => {
-        publicClient = await getPublicClient(ETH_LOCAL_URL)
-        api = await getDevnetApi()
-        alice = await getAliceSigner();
+  before(async () => {
+    publicClient = await getPublicClient(ETH_LOCAL_URL)
+    api = await getDevnetApi()
+    alice = await getAliceSigner();
 
-        await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(alice.publicKey))
-        await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(hotkey.publicKey))
-        await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(coldkey.publicKey))
+    await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(alice.publicKey))
+    await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(hotkey.publicKey))
+    await forceSetBalanceToSs58Address(api, convertPublicKeyToSs58(coldkey.publicKey))
 
-        netuid = await addNewSubnetwork(api, hotkey, coldkey)
-        await startCall(api, netuid, coldkey)
+    netuid = await addNewSubnetwork(api, hotkey, coldkey)
+    await startCall(api, netuid, coldkey)
 
-        const maybeUid = await api.query.SubtensorModule.Uids.getValue(netuid, convertPublicKeyToSs58(hotkey.publicKey))
+    const maybeUid = await api.query.SubtensorModule.Uids.getValue(netuid, convertPublicKeyToSs58(hotkey.publicKey))
 
-        if (maybeUid === undefined) {
-            throw new Error("UID should be defined")
-        }
-        uid = maybeUid
+    if (maybeUid === undefined) {
+      throw new Error("UID should be defined")
+    }
+    uid = maybeUid
 
-        // Associate EVM key
-        blockNumber = await api.query.System.Number.getValue();
-        const blockNumberBytes = u64.enc(BigInt(blockNumber));
-        const blockNumberHash = hexToU8a(keccak256(blockNumberBytes));
-        const concatenatedArray = new Uint8Array([...hotkey.publicKey, ...blockNumberHash]);
-        const signature = await evmWallet.signMessage(concatenatedArray);
-        const associateEvmKeyTx = api.tx.SubtensorModule.associate_evm_key({
-            netuid: netuid,
-            hotkey: convertPublicKeyToSs58(hotkey.publicKey),
-            evm_key: convertToFixedSizeBinary(evmWallet.address, 20),
-            block_number: BigInt(blockNumber),
-            signature: convertToFixedSizeBinary(signature, 65)
-        });
-        const signer = getSignerFromKeypair(coldkey);
-        await waitForTransactionCompletion(api, associateEvmKeyTx, signer)
-            .then(() => { })
-            .catch((error) => { console.log(`transaction error ${error}`) });
+    // Associate EVM key
+    blockNumber = await api.query.System.Number.getValue();
+    const blockNumberBytes = u64.enc(BigInt(blockNumber));
+    const blockNumberHash = hexToU8a(keccak256(blockNumberBytes));
+    const concatenatedArray = new Uint8Array([...hotkey.publicKey, ...blockNumberHash]);
+    const signature = await evmWallet.signMessage(concatenatedArray);
+    const associateEvmKeyTx = api.tx.SubtensorModule.associate_evm_key({
+      netuid: netuid,
+      evm_key: convertToFixedSizeBinary(evmWallet.address, 20),
+      block_number: BigInt(blockNumber),
+      signature: convertToFixedSizeBinary(signature, 65)
+    });
+    const signer = getSignerFromKeypair(hotkey);
+    await waitForTransactionCompletion(api, associateEvmKeyTx, signer)
+      .then(() => { })
+      .catch((error) => { console.log(`transaction error ${error}`) });
 
-        const storedEvmKey = await api.query.SubtensorModule.AssociatedEvmAddress.getValue(netuid, uid)
-        assert.notEqual(storedEvmKey, undefined, "storedEvmKey should be defined")
-        if (storedEvmKey !== undefined) {
-            assert.equal(storedEvmKey[0].asHex(), convertToFixedSizeBinary(evmWallet.address, 20).asHex())
-            blockNumberAssociated = storedEvmKey[1]
-        }
-    })
-
-    it("UID lookup via precompile contract works correctly", async () => {
-        // Get UID for the EVM address
-        const uidArray = await publicClient.readContract({
-            abi: IUIDLookupABI,
-            address: toViemAddress(IUID_LOOKUP_ADDRESS),
-            functionName: "uidLookup",
-            args: [netuid, evmWallet.address, 1024]
-        })
+    const storedEvmKey = await api.query.SubtensorModule.AssociatedEvmAddress.getValue(netuid, uid)
+    assert.notEqual(storedEvmKey, undefined, "storedEvmKey should be defined")
+    if (storedEvmKey !== undefined) {
+      assert.equal(storedEvmKey[0].asHex(), convertToFixedSizeBinary(evmWallet.address, 20).asHex())
+      blockNumberAssociated = storedEvmKey[1]
+    }
+  })
 
-        assert.notEqual(uidArray, undefined, "UID should be defined")
-        assert.ok(Array.isArray(uidArray), `UID should be an array, got ${typeof uidArray}`)
-        assert.ok(uidArray.length > 0, "UID array should not be empty")
-        assert.deepStrictEqual(uidArray[0], { uid: uid, block_associated: blockNumberAssociated })
+  it("UID lookup via precompile contract works correctly", async () => {
+    // Get UID for the EVM address
+    const uidArray = await publicClient.readContract({
+      abi: IUIDLookupABI,
+      address: toViemAddress(IUID_LOOKUP_ADDRESS),
+      functionName: "uidLookup",
+      args: [netuid, evmWallet.address, 1024]
     })
+
+    assert.notEqual(uidArray, undefined, "UID should be defined")
+    assert.ok(Array.isArray(uidArray), `UID should be an array, got ${typeof uidArray}`)
+    assert.ok(uidArray.length > 0, "UID array should not be empty")
+    assert.deepStrictEqual(uidArray[0], { uid: uid, block_associated: blockNumberAssociated })
+  })
 });

pallets/admin-utils/src/tests/mock.rs

@@ -152,6 +152,7 @@ parameter_types! {
     pub const HotkeySwapOnSubnetInterval: u64 = 7 * 24 * 60 * 60 / 12; // 7 days
     pub const LeaseDividendsDistributionInterval: u32 = 100; // 100 blocks
     pub const MaxImmuneUidsPercentage: Percent = Percent::from_percent(80);
+    pub const EvmKeyAssociateRateLimit: u64 = 0;
 }
 
 impl pallet_subtensor::Config for Test {
@@ -231,6 +232,7 @@ impl pallet_subtensor::Config for Test {
     type GetCommitments = ();
     type MaxImmuneUidsPercentage = MaxImmuneUidsPercentage;
     type CommitmentsInterface = CommitmentsI;
+    type EvmKeyAssociateRateLimit = EvmKeyAssociateRateLimit;
 }
 
 parameter_types! {

pallets/subtensor/src/lib.rs

@@ -2002,6 +2002,8 @@ pub enum CustomTransactionError {
     CommitNotFound,
     CommitBlockNotInRevealRange,
     InputLengthsUnequal,
+    UidNotFound,
+    EvmKeyAssociateRateLimitExceeded,
 }
 
 impl From<CustomTransactionError> for u8 {
@@ -2027,6 +2029,8 @@ impl From<CustomTransactionError> for u8 {
             CustomTransactionError::CommitNotFound => 16,
             CustomTransactionError::CommitBlockNotInRevealRange => 17,
             CustomTransactionError::InputLengthsUnequal => 18,
+            CustomTransactionError::UidNotFound => 19,
+            CustomTransactionError::EvmKeyAssociateRateLimitExceeded => 20,
         }
     }
 }

pallets/subtensor/src/macros/config.rs

@@ -66,6 +66,9 @@ mod config {
         ///  Interface to clean commitments on network dissolution.
         type CommitmentsInterface: CommitmentsInterface;
 
+        /// Rate limit for associating an EVM key.
+        type EvmKeyAssociateRateLimit: Get<u64>;
+
         /// =================================
         /// ==== Initial Value Constants ====
         /// =================================

pallets/subtensor/src/macros/dispatches.rs

@@ -2037,17 +2037,15 @@ mod dispatches {
         /// ```
         ///
         /// # Arguments
-        /// * `origin` - The origin of the transaction, which must be signed by the coldkey that owns the `hotkey`.
+        /// * `origin` - The origin of the transaction, which must be signed by the `hotkey`.
         /// * `netuid` - The netuid that the `hotkey` belongs to.
-        /// * `hotkey` - The hotkey associated with the `origin`.
         /// * `evm_key` - The EVM key to associate with the `hotkey`.
         /// * `block_number` - The block number used in the `signature`.
         /// * `signature` - A signed message by the `evm_key` containing the `hotkey` and the hashed `block_number`.
         ///
         /// # Errors
         /// Returns an error if:
         /// * The transaction is not signed.
-        /// * The hotkey is not owned by the origin coldkey.
         /// * The hotkey does not belong to the subnet identified by the netuid.
         /// * The EVM key cannot be recovered from the signature.
         /// * The EVM key recovered from the signature does not match the given EVM key.
@@ -2058,17 +2056,16 @@ mod dispatches {
         #[pallet::weight((
             Weight::from_parts(3_000_000, 0).saturating_add(T::DbWeight::get().reads_writes(2, 1)),
             DispatchClass::Normal,
-            Pays::Yes
+            Pays::No
         ))]
         pub fn associate_evm_key(
             origin: T::RuntimeOrigin,
             netuid: NetUid,
-            hotkey: T::AccountId,
             evm_key: H160,
             block_number: u64,
             signature: Signature,
         ) -> DispatchResult {
-            Self::do_associate_evm_key(origin, netuid, hotkey, evm_key, block_number, signature)
+            Self::do_associate_evm_key(origin, netuid, evm_key, block_number, signature)
         }
 
         /// Recycles alpha from a cold/hot key pair, reducing AlphaOut on a subnet

pallets/subtensor/src/macros/errors.rs

@@ -254,5 +254,7 @@ mod errors {
         SubnetLimitReached,
         /// Insufficient funds to meet the subnet lock cost
         CannotAffordLockCost,
+        /// exceeded the rate limit for associating an EVM key.
+        EvmKeyAssociateRateLimitExceeded,
     }
 }