fix(naming): couple of naming improvements #27

m30m · 2024-03-08T16:39:22Z

No description provided.

anihamde · 2024-03-08T16:43:48Z

auction-server/config.sample.yaml

@@ -1,7 +1,7 @@
 chains:
  development:
    geth_rpc_addr: http://localhost:8545
-    per_contract: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853
+    relay_contract: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853


rename to express_relay_contract

or rename all instances of express relay contract to relay contract. basically just maintain consistency

anihamde · 2024-03-08T16:47:08Z

auction-server/src/config.rs

-    #[arg(env = "PER_PRIVATE_KEY")]
-    pub per_private_key: String,
+    /// A 20-byte (40 char) hex encoded Ethereum private key which is the express relay operator.
+    #[arg(long = "relay-private-key")]


maybe relay-operator-private-key? would be clearer

anihamde · 2024-03-09T22:10:20Z

README.md

@@ -1,4 +1,4 @@
-# PER
+# Express Relay

 ## [Off-chain server](auction-server/README.md)


let's rename the whole per_multicall folder (and the mentions thereof in this README) to contracts or solidity? that folder is just on-chain contract code and it would be good to make this naming reflect that

This folder is gonna be open-sourced and moved to the other monorepo in a few months. I'd rather keep this as is and then move it with a better naming and cleaner to the main repo.

anihamde · 2024-03-09T22:11:46Z

auction-server/README.md

-1. Edit `config.yaml` to point to the desired blockchains and PER contracts. You can use `config.sample.yaml` as a template.
-2. Generate a secret key to be used for the PER operator. The PER contract should be deployed with this address as the operator.
+1. Edit `config.yaml` to point to the desired blockchains and Express Relay contracts. You can use `config.sample.yaml` as a template.
+2. Generate a secret key to be used for the Express Relay operator. The Express Relay contract should be deployed with this address as the operator.


Let's use the term "relayer" everywhere as opposed to "operator". I know we've been somewhat inconsistent about this in the code and docs, but would be good to standardize.

anihamde · 2024-03-09T22:13:07Z

auction-server/config.sample.yaml

@@ -1,7 +1,7 @@
 chains:
  development:
    geth_rpc_addr: http://localhost:8545
-    per_contract: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853
+    relay_contract: 0xa513E6E4b8f2a923D98304ec87F64353C4D5C853
    adapter_contract: 0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e


Let's use "adapter" or "opportunity adapter" instead of "liquidation adapter" everywhere. will send you more thoughts in slack

anihamde · 2024-03-09T23:33:15Z

per_multicall/src/ExpressRelay.sol

        address[] calldata contracts,
        bytes[] calldata data,
-        uint256[] calldata bids
+        uint256[] calldata bidAmounts


this is good, we should make this clarification btwn bids and bidAmounts everywhere it pops up. otherwise very confusing

anihamde · 2024-03-09T23:34:12Z

per_multicall/src/LiquidationAdapter.sol

@@ -58,51 +58,51 @@ contract LiquidationAdapter is SigVerify {
    function callLiquidation(


callTarget

anihamde · 2024-03-09T23:34:23Z

per_multicall/src/LiquidationAdapter.sol

@@ -58,51 +58,51 @@ contract LiquidationAdapter is SigVerify {
    function callLiquidation(
        LiquidationCallParams memory params


TargetCallParams

anihamde · 2024-03-09T23:38:38Z

per_multicall/test/PERIntegration.t.sol

@@ -656,7 +662,7 @@ contract PERIntegrationTest is
    }

    function testLiquidateSingle() public {
-        // test PER path liquidation (via multicall, per operator calls) with searcher contract
+        // test ExpressRelay path liquidation (via multicall, express relay operator calls) with searcher contract


via entrypoint contract

anihamde · 2024-03-09T23:40:11Z

per_multicall/test/helpers/Signatures.sol

@@ -25,8 +25,8 @@ contract Signatures is Test, SigVerify {
    }

    function createLiquidationSignature(


createAdapterSignature?

anihamde · 2024-03-12T18:02:59Z

README.md

@@ -32,9 +32,9 @@ To run a happy path test of the on-chain contracts plus the off-chain services,
   f. Retrieve the number saved under "searcherAOwnerSk", convert to a hex string, and save as SEARCHER_SK. You can perform this conversion in Python by calling hex on the number.


can we rename the perOperator above --> perRelayer?

I'm creating another PR changing this e2e test and the docs along with it. Will be fixed there.

anihamde · 2024-03-12T18:11:46Z

auction-server/src/api/liquidation.rs

@@ -112,7 +112,7 @@ pub async fn post_opportunity(
        bidders: Default::default(),
    };

-    verify_opportunity(params.clone(), chain_store, store.per_operator.address())
+    verify_opportunity(params.clone(), chain_store, store.relayer.address())
        .await


i think this file and all instances of "liquidation" can be renamed to something along the lines of "opportunity". i think the only part of "liquidation" that should remain is the endpoint path

anihamde · 2024-03-12T18:15:29Z

auction-server/src/auction.rs

@@ -90,20 +91,21 @@ impl TryFrom<EthereumConfig> for Provider<Http> {
 }

 pub fn get_simulation_call(
-    per_operator: Address,
+    relayer: Address,
    provider: Provider<Http>,
    chain_config: EthereumConfig,
    permission: Bytes,


are we standardizing this as permission_key?

anihamde · 2024-03-12T18:20:34Z

auction-server/src/auction.rs

        provider,
        chain_config,
        permission,
-        contracts,
+        target_contracts,
        calldata,


the naming here is bit confusing since calldata is both singular and plural... is target_calldata any clearer that this corresponds to the target_contracts?

anihamde · 2024-03-12T18:21:26Z

auction-server/src/auction.rs

@@ -186,7 +186,7 @@ pub async fn submit_bids(
    permission: Bytes,
    contracts: Vec<Address>,


shouldn't this be target_contracts?

anihamde · 2024-03-12T18:36:23Z

per_multicall/src/Errors.sol

-// Signature: 0xd3c8346c
-error LiquidationCallFailed(string reason);
+// Signature: 0xf00364b1
+error ExecutionFailed(string reason);


ExternalExecutionFailed? just for verbosity to clarify the execution failed at the target contract

anihamde · 2024-03-12T18:39:07Z

per_multicall/src/ExpressRelay.sol

-        bytes calldata permission,
-        address[] calldata contracts,
+        bytes calldata permissionKey,
+        address[] calldata targetContracts,
        bytes[] calldata data,


similar to above, targetData?

anihamde · 2024-03-12T18:40:31Z

per_multicall/src/OnChainAuction.sol

@@ -18,7 +18,7 @@ struct Bid {
 contract AuctionManager {


is this file worth maintaining? probably can get rid of this

can add admin role and responsibilities to ExpressRelay.sol

anihamde · 2024-03-12T18:44:59Z

per_multicall/src/Structs.sol

+    TokenAmount[] sellTokens;
+    TokenAmount[] buyTokens;
+    address executor;
+    address target;


smallest of nits: targetContract? a bit clearer

anihamde · 2024-03-12T18:48:35Z

per_multicall/script/Vault.s.sol

@@ -98,8 +102,10 @@ contract VaultScript is Script {
        vm.startBroadcast(skDeployer);
        if (pyth == address(0)) pyth = deployMockPyth();
        if (weth == address(0)) weth = deployWeth();
-        (address per, address liquidationAdapter) = deployPER(weth);
-        address vault = deployVault(per, pyth);
+        (address expressRelay, address liquidationAdapter) = deployExpressRelay(


rename liquidationAdapter--fine if you want to do this with the changes to the tests later

anihamde · 2024-03-12T18:58:11Z

auction-server/src/state.rs

    /// Token amount
    #[schema(example = "1000", value_type=String)]
    #[serde(with = "crate::serde::u256")]
-    pub amount:   U256,
+    pub amount: U256,
 }

 /// Opportunity parameters needed for on-chain execution
 /// If a searcher signs the opportunity and have approved enough tokens to liquidation adapter,


remove reference to liquidation

anihamde · 2024-03-12T18:58:42Z

auction-server/src/state.rs

 }

 /// Opportunity parameters needed for on-chain execution
 /// If a searcher signs the opportunity and have approved enough tokens to liquidation adapter,
 /// by calling this contract with the given calldata and structures, they will receive the tokens specified
-/// in the receipt_tokens field, and will send the tokens specified in the repay_tokens field.
+/// in the buy_tokens field, and will send the tokens specified in the sell_tokens field.
 #[derive(Serialize, Deserialize, ToSchema, Clone, PartialEq)]
 pub struct OpportunityParamsV1 {
    /// The permission key required for succesful execution of the liquidation.


liquidation

It also includes an error name change from ExecutionFailed to TargetCallFailed

anihamde · 2024-03-13T00:30:22Z

auction-server/src/state.rs

    #[schema(example = "sepolia", value_type=String)]
    pub chain_id:       ChainId,
-    /// The contract address to call for execution of the liquidation.
+    /// The contract address to call for execution of the opportunity.
    #[schema(example = "0xcA11bde05977b3631167028862bE2a173976CA11", value_type=String)]
    pub contract:       ethers::abi::Address,


what do you think about making this target_contract?

and calldata --> target_calldata? just for the sake of verbosity

anihamde · 2024-03-13T01:07:12Z

per_multicall/README.md


-Tests can be found in `test/`. These tests include checks that the protocol functions work, as well as checks around permissioning, bid conditions, and appropriate failing of components of the multicall bundle (without failing the whole bundle).
+Tests can be found in `test/`. These tests include checks that the protocol functions work, as well as checks around permissioning, bid conditions, and appropriate failing of components of the express relay bid bundle (without failing the whole bundle).


express relay bundle

fix(naming): couple of naming improvements

79a33fc

anihamde reviewed Mar 9, 2024

View reviewed changes

m30m added 11 commits March 11, 2024 16:21

address part1

9978359

address part2

d82f59e

contracts -> targetContracts

da42c5f

bid->bid_amount

e352bac

address part3

ac9d153

address part4

909f5fd

Merge branch 'main' into renames

ac3bab9

address part 5

eac07a8

address part 6

b721b16

address part 7

8fbdaca

update error signature

4638a9d

anihamde reviewed Mar 12, 2024

View reviewed changes

m30m added 5 commits March 12, 2024 22:45

Eradicate liquidation from auction server

0e40eb2

It also includes an error name change from ExecutionFailed to TargetCallFailed

calldata/data to targetCalldata

9f80499

small fixes

c53b4b0

add target prefix for contract and calldata in executionParams

ab5c475

Remove onchain auction

b1b6944

anihamde approved these changes Mar 13, 2024

View reviewed changes

m30m added 2 commits March 13, 2024 10:52

Address comments

854f384

bump version

28a8a9e

m30m merged commit ef211c7 into main Mar 13, 2024
1 check passed

m30m deleted the renames branch March 13, 2024 10:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(naming): couple of naming improvements #27

fix(naming): couple of naming improvements #27

m30m commented Mar 8, 2024

anihamde Mar 8, 2024

anihamde Mar 8, 2024

anihamde Mar 8, 2024

anihamde Mar 9, 2024

m30m Mar 11, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 9, 2024

anihamde Mar 12, 2024

m30m Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 12, 2024

anihamde Mar 13, 2024

anihamde Mar 13, 2024

anihamde Mar 13, 2024

		@@ -58,51 +58,51 @@ contract LiquidationAdapter is SigVerify {
		function callLiquidation(

		@@ -58,51 +58,51 @@ contract LiquidationAdapter is SigVerify {
		function callLiquidation(
		LiquidationCallParams memory params

		@@ -25,8 +25,8 @@ contract Signatures is Test, SigVerify {
		}

		function createLiquidationSignature(

		@@ -32,9 +32,9 @@ To run a happy path test of the on-chain contracts plus the off-chain services,
		f. Retrieve the number saved under "searcherAOwnerSk", convert to a hex string, and save as SEARCHER_SK. You can perform this conversion in Python by calling hex on the number.

		@@ -186,7 +186,7 @@ pub async fn submit_bids(
		permission: Bytes,
		contracts: Vec<Address>,


		Tests can be found in `test/`. These tests include checks that the protocol functions work, as well as checks around permissioning, bid conditions, and appropriate failing of components of the multicall bundle (without failing the whole bundle).
		Tests can be found in `test/`. These tests include checks that the protocol functions work, as well as checks around permissioning, bid conditions, and appropriate failing of components of the express relay bid bundle (without failing the whole bundle).

fix(naming): couple of naming improvements #27

fix(naming): couple of naming improvements #27

Conversation

m30m commented Mar 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment