add a rebalancer in LR token pool (#151)

* add a rebalancer in LR token pool

* update ops

* fix

* fix build

* fix test

* update

* update

Author: FelixFan1992

bindings/generated/ccip/ccip_token_pools/lock_release_token_pool/lock_release_token_pool.go

@@ -20,18 +20,21 @@ public struct LockReleaseTokenPoolState<phantom T> has key {
     id: UID,
     token_pool_state: TokenPoolState,
     reserve: Coin<T>,
-    /// the rebalancer is the address that can manage liquidity of the token pool
-    rebalancer: address,
+    rebalancer_cap_id: ID,
     ownable_state: OwnableState,
 }
 
+public struct RebalancerCap has key, store {
+    id: UID,
+}
+
 const CLOCK_ADDRESS: address = @0x6;
 
 const EInvalidArguments: u64 = 1;
 const ETokenPoolBalanceTooLow: u64 = 2;
-const EUnauthorized: u64 = 3;
-const EInvalidOwnerCap: u64 = 4;
-const EInvalidFunction: u64 = 5;
+const EInvalidOwnerCap: u64 = 3;
+const EInvalidFunction: u64 = 4;
+const EInvalidRebalancerCap: u64 = 5;
 const EPoolStillRegistered: u64 = 6;
 
 // ================================================================
@@ -76,7 +79,11 @@ fun initialize_internal<T>(
     let coin_metadata_address: address = object::id_to_address(&object::id(coin_metadata));
     let (ownable_state, owner_cap) = ownable::new(ctx);
 
-    let mut lock_release_token_pool = LockReleaseTokenPoolState<T> {
+    let rebalancer_cap = RebalancerCap {
+        id: object::new(ctx),
+    };
+
+    let lock_release_token_pool = LockReleaseTokenPoolState<T> {
         id: object::new(ctx),
         token_pool_state: token_pool::initialize(
             coin_metadata_address,
@@ -85,14 +92,14 @@ fun initialize_internal<T>(
             ctx,
         ),
         reserve: coin::zero<T>(ctx),
-        rebalancer: @0x0,
+        rebalancer_cap_id: object::id(&rebalancer_cap),
         ownable_state,
     };
-    set_rebalancer_internal(&mut lock_release_token_pool, rebalancer);
     let token_pool_state_address = object::uid_to_address(&lock_release_token_pool.id);
 
     transfer::share_object(lock_release_token_pool);
     transfer::public_transfer(owner_cap, ctx.sender());
+    transfer::public_transfer(rebalancer_cap, rebalancer);
 
     token_pool_state_address
 }
@@ -445,58 +452,53 @@ public fun set_chain_rate_limiter_config<T>(
 
 public fun provide_liquidity<T>(
     state: &mut LockReleaseTokenPoolState<T>,
+    rebalancer_cap: &RebalancerCap,
     c: Coin<T>,
-    ctx: &mut TxContext,
+    _: &mut TxContext,
 ) {
-    assert!(ctx.sender() == state.rebalancer, EUnauthorized);
+    assert!(object::id(rebalancer_cap) == state.rebalancer_cap_id, EInvalidRebalancerCap);
     let amount = c.value();
 
     coin::join(&mut state.reserve, c);
 
     token_pool::emit_liquidity_added(
         &state.token_pool_state,
-        state.rebalancer,
+        object::id_to_address(&state.rebalancer_cap_id),
         amount,
     );
 }
 
 public fun withdraw_liquidity<T>(
     state: &mut LockReleaseTokenPoolState<T>,
+    rebalancer_cap: &RebalancerCap,
     amount: u64,
     ctx: &mut TxContext,
 ): Coin<T> {
-    assert!(ctx.sender() == state.rebalancer, EUnauthorized);
+    assert!(object::id(rebalancer_cap) == state.rebalancer_cap_id, EInvalidRebalancerCap);
 
     assert!(state.reserve.value() >= amount, ETokenPoolBalanceTooLow);
 
-    token_pool::emit_liquidity_removed(&state.token_pool_state, state.rebalancer, amount);
+    token_pool::emit_liquidity_removed(
+        &state.token_pool_state,
+        object::id_to_address(&state.rebalancer_cap_id),
+        amount,
+    );
     coin::split(&mut state.reserve, amount, ctx)
 }
 
-public fun set_rebalancer<T>(
-    owner_cap: &OwnerCap,
-    state: &mut LockReleaseTokenPoolState<T>,
-    rebalancer: address,
-) {
-    assert!(object::id(owner_cap) == ownable::owner_cap_id(&state.ownable_state), EInvalidOwnerCap);
-    set_rebalancer_internal(state, rebalancer);
-}
-
-fun set_rebalancer_internal<T>(state: &mut LockReleaseTokenPoolState<T>, rebalancer: address) {
-    token_pool::emit_rebalancer_set(
-        &state.token_pool_state,
-        state.rebalancer,
-        rebalancer,
-    );
-    state.rebalancer = rebalancer;
+public fun get_balance<T>(state: &LockReleaseTokenPoolState<T>): u64 {
+    state.reserve.value()
 }
 
 public fun get_rebalancer<T>(state: &LockReleaseTokenPoolState<T>): address {
-    state.rebalancer
+    object::id_to_address(&state.rebalancer_cap_id)
 }
 
-public fun get_balance<T>(state: &LockReleaseTokenPoolState<T>): u64 {
-    state.reserve.value()
+#[test_only]
+public fun create_fake_rebalancer_cap(ctx: &mut TxContext): RebalancerCap {
+    RebalancerCap {
+        id: object::new(ctx),
+    }
 }
 
 // ================================================================
@@ -612,33 +614,6 @@ public fun mcms_register_upgrade_cap(
 
 public struct McmsCallback<phantom T> has drop {}
 
-public fun mcms_set_rebalancer<T>(
-    state: &mut LockReleaseTokenPoolState<T>,
-    registry: &mut Registry,
-    params: ExecutingCallbackParams,
-) {
-    let (owner_cap, function, data) = mcms_registry::get_callback_params_with_caps<
-        McmsCallback<T>,
-        OwnerCap,
-    >(
-        registry,
-        McmsCallback<T> {},
-        params,
-    );
-    assert!(function == string::utf8(b"set_rebalancer"), EInvalidFunction);
-
-    let mut stream = bcs_stream::new(data);
-    bcs_stream::validate_obj_addrs(
-        vector[object::id_address(owner_cap), object::id_address(state)],
-        &mut stream,
-    );
-
-    let rebalancer = bcs_stream::deserialize_address(&mut stream);
-    bcs_stream::assert_is_consumed(&stream);
-
-    set_rebalancer(owner_cap, state, rebalancer);
-}
-
 public fun mcms_set_allowlist_enabled<T>(
     state: &mut LockReleaseTokenPoolState<T>,
     registry: &mut Registry,
@@ -1082,7 +1057,7 @@ public fun destroy_token_pool<T>(
         id: state_id,
         token_pool_state,
         reserve,
-        rebalancer: _,
+        rebalancer_cap_id: _,
         ownable_state,
     } = state;
     token_pool::destroy_token_pool(token_pool_state);

contracts/ccip/ccip_token_pools/lock_release_token_pool/sources/lock_release_token_pool.move

@@ -256,10 +256,7 @@ public fun test_accept_ownership_already_accepted() {
 public fun test_ownable_functions_with_owner_cap_validation() {
     let (mut env, owner_cap) = setup();
 
-    // Test that owner cap validation works in other functions
-    // These should succeed because we have the correct owner cap
-    lock_release_token_pool::set_rebalancer(&owner_cap, &mut env.state, @0x999);
-    assert!(lock_release_token_pool::get_rebalancer(&env.state) == @0x999);
+    assert!(lock_release_token_pool::get_rebalancer(&env.state) != @0x0);
 
     lock_release_token_pool::set_allowlist_enabled(&mut env.state, &owner_cap, true);
     assert!(lock_release_token_pool::get_allowlist_enabled(&env.state) == true);