feat: add service provider address to config #93

jahabeebs · 2024-11-20T01:14:03Z

🤖 Linear

Closes GRT-229

Description

Protocol provider config schema includes accessControl.serviceProviderAddress object + property.
-serviceProviderAddress can be unspecified/undefined.
If serviceProviderAddress is unspecified, the address can be derived from the PROTOCOL_PROVIDER_PRIVATE_KEY value
ProtocolProvider stores the new address within its instance to use it later

Tests for now don't cover the actual use of this value as that will come next

linear · 2024-11-20T01:14:05Z

GRT-229 Add service provider address to config

0xyaco

Left some comments! I strongly suggest reading them all before addressing them one by one, they are all kinda linked so it might be more helpful to do so.

As a short summary:

No env var needed for this
ProtocolProvider instances should get the new address via its constructor
You'll probably have to update ProtocolProvider instantiation in the agent + scripts

0xyaco · 2024-11-20T09:26:36Z

packages/automated-dispute/src/providers/protocolProvider.ts

+            const account = privateKeyToAccount(privateKey);
+            this.serviceProviderAddress = account.address;


0xyaco · 2024-11-20T09:29:37Z

packages/automated-dispute/src/providers/protocolProvider.ts

+    accessControl?: {
+        serviceProviderAddress: Address;
+    };


The service provider address should be a ProtocolProvider constructor stand-alone argument, like the private key (but optional in this case).

The value per se is not related with the RPCs' configuration.

0xyaco · 2024-11-20T09:41:17Z

apps/agent/src/config/schemas.ts

@@ -55,6 +68,7 @@ const protocolProviderConfigSchema = z.object({
        bondEscalationModule: addressSchema,
        horizonAccountingExtension: addressSchema,
    }),
+    accessControl: accessControlSchema.optional(),


If we specify the accessControl property here (which is good, it's what we want), the user needs to include the accessControl object within the protocolProvider object in the config YAML file.

protocolProvider: rpcsConfig: ... contracts: ... accessControl: serviceProviderAddress: 0x....

Thus we don't need the env var.

Remember that as a general approach, we generally want public values to be in the config YAML file and secrets to be in env vars.

0xyaco · 2024-11-20T09:43:28Z

apps/agent/src/config/index.ts

+    accessControl: envData.SERVICE_PROVIDER_ADDRESS
+        ? { serviceProviderAddress: envData.SERVICE_PROVIDER_ADDRESS }
+        : undefined,


Given that the service provider address will already be in configData, we won't be using envData anymore. You should be able to safely remove this!

0xyaco · 2024-11-20T09:43:55Z

apps/agent/README.md

@@ -38,6 +38,7 @@ cp .env.example .env
 | `BLOCK_NUMBER_BLOCKMETA_TOKEN`  | Bearer token for the Blockmeta service (see notes below on how to obtain)                                                                                         | Yes      |
 | `EBO_AGENT_CONFIG_FILE_PATH`    | Path to the agent YAML configuration file                                                                                                                         | Yes      |
 | `DISCORD_WEBHOOK`               | Your Discord channel webhook for notifications [Learn how to create a Discord webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) | No       |
+| `SERVICE_PROVIDER_ADDRESS`      | Service provider address to use with access control modules                                                                                                       | No       |


No need for this if we are not going to use the env var

0xyaco · 2024-11-20T09:44:10Z

apps/agent/.env.example

+
+# Optional: Service Provider Address for Access Control Modules
+# If not specified, it will be derived from PROTOCOL_PROVIDER_PRIVATE_KEY
+SERVICE_PROVIDER_ADDRESS=0xYourServiceProviderAddressHere


No need for this neither if we are not going to use the env var

0xyaco · 2024-11-20T09:44:34Z

apps/agent/src/config/schemas.ts

@@ -31,9 +38,11 @@ export const envSchema = z.object({
    BLOCK_NUMBER_BLOCKMETA_TOKEN: z.string(),
    EBO_AGENT_CONFIG_FILE_PATH: z.string(),
    DISCORD_WEBHOOK: z.string().optional(),
+    SERVICE_PROVIDER_ADDRESS: serviceProviderAddressSchema,


Env var related stuff

0xyaco · 2024-11-20T09:46:47Z

apps/scripts/utilities/approveAccountingModules.ts

+    SERVICE_PROVIDER_ADDRESS: z
+        .string()
+        .refine((val) => isAddress(val), {
+            message: "SERVICE_PROVIDER_ADDRESS must be a valid blockchain address",
+        })
+        .optional(),


This env var is fine, it can stay as we are not using yaml config files for the scripts.

0xyaco · 2024-11-20T09:54:17Z

packages/automated-dispute/src/config.ts

+    accessControl: z
+        .object({
+            /**
+             * The service provider address used with access control modules.
+             * This is an optional field. If not provided, it will be derived from the PROTOCOL_PROVIDER_PRIVATE_KEY.
+             */
+            serviceProviderAddress: z
+                .string()
+                .refine((val) => isAddress(val), {
+                    message: "serviceProviderAddress must be a valid blockchain address",
+                })
+                .optional(),
+        })
+        .optional(),


Is this property being used somewhere? 🤔

0xnigir1

good to go after addressing Yaco's comments 🫡

jahabeebs · 2024-11-20T23:46:04Z

@0xyaco addressed your comments--I think this is what you mean by passing it in the constructor (as part of the yaml
config rather than as a separate variable) right?

0xyaco

Just one small change and it's good to go!

0xyaco · 2024-11-21T09:25:17Z

packages/automated-dispute/src/providers/protocolProvider.ts

-        private readonly rpcConfig: ProtocolRpcConfig,
+        private readonly config: ProtocolProviderConfig,
        contracts: ProtocolContractsAddresses,
        privateKey: Hex,


The service provider address needs to go below this line. The service provider address is not part of the RpcConfig.

privateKey: Hex, serviceProviderAddress: Address | undefined

When initializing the agent, you'll need to explicitly pass that address (that you'll have in the config).

This might be useful as an example:

new ProtocolProvider( config.protocolProvider.rpcConfig, config.protocolProvider.contracts, config.privateKey, config.protocolProvider.accessControl.serviceProviderAddress ... )

jahabeebs added 4 commits November 19, 2024 19:51

feat: add service provider address to config

1d0d9ae

chore: cleanup types and docs

e6accab

chore: cleanup docs

f764db0

chore: cleanup docs

e5db40f

jahabeebs requested review from 0xkenj1, 0xnigir1 and 0xyaco November 20, 2024 01:14

jahabeebs self-assigned this Nov 20, 2024

0xyaco reviewed Nov 20, 2024

View reviewed changes

0xnigir1 reviewed Nov 20, 2024

View reviewed changes

fix: pr comments

0d7cd9d

jahabeebs requested a review from 0xyaco November 20, 2024 23:44

0xyaco previously approved these changes Nov 21, 2024

View reviewed changes

fix: pr comments

54fbd3a

jahabeebs dismissed 0xyaco’s stale review via 54fbd3a November 21, 2024 16:56

jahabeebs requested a review from 0xyaco November 21, 2024 18:21

0xyaco approved these changes Nov 21, 2024

View reviewed changes

Merge branch 'dev' into feat/grt-229-add-service-prov-address-to-config

43bfebb

0xyaco approved these changes Nov 21, 2024

View reviewed changes

0xnigir1 approved these changes Nov 22, 2024

View reviewed changes

jahabeebs merged commit 09c4dcd into dev Nov 22, 2024
5 checks passed

jahabeebs deleted the feat/grt-229-add-service-prov-address-to-config branch November 22, 2024 14:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add service provider address to config #93

feat: add service provider address to config #93

jahabeebs commented Nov 20, 2024

linear bot commented Nov 20, 2024

0xyaco left a comment •

edited

Loading

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

0xyaco Nov 20, 2024

jahabeebs Nov 20, 2024

0xnigir1 left a comment

jahabeebs commented Nov 20, 2024

0xyaco left a comment

0xyaco Nov 21, 2024

		const account = privateKeyToAccount(privateKey);
		this.serviceProviderAddress = account.address;

feat: add service provider address to config #93

feat: add service provider address to config #93

Conversation

jahabeebs commented Nov 20, 2024

🤖 Linear

Description

linear bot commented Nov 20, 2024

0xyaco left a comment • edited Loading

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

0xnigir1 left a comment

Choose a reason for hiding this comment

jahabeebs commented Nov 20, 2024

0xyaco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xyaco left a comment •

edited

Loading