Now use the public gasolina repo

LayerZero-Labs · Feb 15, 2024 · 9058f78 · 9058f78
1 parent d072818
commit 9058f78
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 56 deletions.
diff --git a/README.md b/README.md
@@ -1,74 +1,87 @@
 # gasolina-aws
 
 ## Description
+
 This repository provides Infrastructure-As-Code (IAC) for installing Gasolina on AWS via CDK.
-- Bootstraps CDK
-- Creates a VPC
-- Uploads providers to S3
-- Setup a CloudWatch log group
-- Deploys the Gasolina API app on ECS
-- Sets up load balancer on Fargate in the VPC private subnet
-- Sets up API Gateway to route to the Gasolina API (we don't expose the load balancer directly, API Gateway offers TLS without the need for a certificate)
+
+-   Bootstraps CDK
+-   Creates a VPC
+-   Uploads providers to S3
+-   Setup a CloudWatch log group
+-   Deploys the Gasolina API app on ECS
+-   Sets up load balancer on Fargate in the VPC private subnet
+-   Sets up API Gateway to route to the Gasolina API (we don't expose the load balancer directly, API Gateway offers TLS without the need for a certificate)
 
 ## Step-by-step instructions on setting up the infrastructure and deploying the Gasolina application
 
-### 1. Provide the LayerZero team with your AWS account number
-The Gasolina image is currently hosted in a private ECR repository. In order to pull from it with this example repo. Provide the LayerZero team with your AWS account in and we will add it to our repository permissions.
+### 1. Setup aws valid credentials
+
+-   Authenticate with AWS CLI with a valid method: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html
 
-### 2. Setup aws valid credentials
-- Authenticate with AWS CLI with a valid method: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html
+### 2. Decide whether you want to use your own mnemonics or HSM-backed AWS KMS keys
 
-### 3. Decide whether you want to use your own mnemonics or HSM-backed AWS KMS keys
-- If you want to use your own mnemonics you can configure a mnemonic per signer in the Gasolina API. Go to Secret Manager in AWS store and create a new secret for mnemonics and path.
-  - You want to store the secret as key-value pair. For a single secret:
-  - For the mnemonic use the key: LAYERZERO_WALLET_MNEMONIC
-  - For the PATH use the key: LAYERZERO_WALLET_PATH
-- If you want to use AWS KMS (backed by HSM), you can set this in your config and all key creation and registration into the application is done for you.
+-   If you want to use your own mnemonics you can configure a mnemonic per signer in the Gasolina API. Go to Secret Manager in AWS store and create a new secret for mnemonics and path.
+    -   You want to store the secret as key-value pair. For a single secret:
+    -   For the mnemonic use the key: LAYERZERO_WALLET_MNEMONIC
+    -   For the PATH use the key: LAYERZERO_WALLET_PATH
+-   If you want to use AWS KMS (backed by HSM), you can set this in your config and all key creation and registration into the application is done for you.
 
-- In the root directory of the project, run `yarn` to install all dependencies.
+-   In the root directory of the project, run `yarn` to install all dependencies.
 
 ![img.png](assets/secret-manager-setup.png)
-- Bootstrap CDK if this is your first time using CDK in the AWS account. In `cdk/gasolina/` run:
+
+-   Bootstrap CDK if this is your first time using CDK in the AWS account. In `cdk/gasolina/` run:
+
 ```bash
-cdk bootstrap 
+cdk bootstrap
 ```
 
-### 4. Configuration of infra and application
-- In `cdk/gasolina/config/index.ts` in the CONFIG object:
-  - Configure the AWS account number for the key of the object.
-  - `projectName`: Your unique project name (this is used for your s3 bucket which needs to be globally unique on AWS)
-  - `environment`: The environment your API will be pointing to on layerzero (mainnet/testnet)
-  - `availableChainNames`: The chains your Gasolina app supports in comma seperated format e.g. `ethereum,bsc,avalanche`
-  - `signerType`: Either `MNEMONIC` if you are using mnemonics stored in secret manager or `KMS` if you want CDK to set up asymmetric keys backed by HSM for you and register these keys into the Gasolina app.
-    - If `MNEMONIC`, the number of signers registered will be based on your wallet definitions in `walletConfig/<environment>.json`
-    - If `KMS`, you can optionally set `kmsNumOfSigners` in CONFIG. This value will create and register multiple keys into the same api
-- In `cdk/gasolina/config/providers/<environment>/providers.json` 
-  - Configure all the RPC providers that you listed for the `availableChainNames` in the previous step.
-- In `cdk/gasolina/config/walletConfig/<environment>.json`
-  - Under `definitions`, add a Wallet Definition per Signer in Gasolina API that you registered in Secret Manager in the pre-requisites step.
-    - Configure the `address` of the signer
-    - Configure the `secretName` of that signer. This is used by the application to fetch the mnemonics when it needs to sign the payload
-
-### 5. CDK Deploy
+### 3. Configuration of infra and application
+
+-   In `cdk/gasolina/config/index.ts` in the CONFIG object:
+    -   Configure the AWS account number for the key of the object.
+    -   `projectName`: Your unique project name (this is used for your s3 bucket which needs to be globally unique on AWS)
+    -   `environment`: The environment your API will be pointing to on layerzero (mainnet/testnet)
+    -   `availableChainNames`: The chains your Gasolina app supports in comma seperated format e.g. `ethereum,bsc,avalanche`
+    -   `signerType`: Either `MNEMONIC` if you are using mnemonics stored in secret manager or `KMS` if you want CDK to set up asymmetric keys backed by HSM for you and register these keys into the Gasolina app.
+        -   If `MNEMONIC`, the number of signers registered will be based on your wallet definitions in `walletConfig/<environment>.json`
+        -   If `KMS`, you can optionally set `kmsNumOfSigners` in CONFIG. This value will create and register multiple keys into the same api
+-   In `cdk/gasolina/config/providers/<environment>/providers.json`
+    -   Configure all the RPC providers that you listed for the `availableChainNames` in the previous step.
+-   In `cdk/gasolina/config/walletConfig/<environment>.json`
+    -   Under `definitions`, add a Wallet Definition per Signer in Gasolina API that you registered in Secret Manager in the pre-requisites step.
+        -   Configure the `address` of the signer
+        -   Configure the `secretName` of that signer. This is used by the application to fetch the mnemonics when it needs to sign the payload
+
+### 4. CDK Deploy
+
 Setup infrastructure and deploy the Gasolina application.
 In `cdk/gasolina/` run:
+
 ```bash
 cdk deploy
 ```
+
 After the deployment is done, in the stdout you will see `Oracle.ApiGatewayUrl = <URL>`. Send this URL over to LayerZeroLabs.
 
-### 6. Testing
+### 5. Testing
+
 Make an HTTP GET request to the ApiGatewayUrl at the following endpoint:
+
 ```
 curl https://<ApiGatewayUrl>/signer-info?chainName=ethereum
 ```
+
 If successful, you should see the signers registered on Gasolina API.
 
 To test the API against a sample message, in the root directory run:
+
 ```bash
 ts-node scripts/testDeployment -u <ApiGatewayUrl> -e <environment>
 ```
-- A successful response will look like:
+
+-   A successful response will look like:
+
 ```bash
 --- [200] Successful request ---
 Response: {
@@ -85,8 +98,11 @@ Response: {
 }
 
 ```
+
 ## Troubleshooting
+
 ### 1. CDK Deploy failed and cannot redeploy because resource already exists
-- Some resources have deletion projection policies. You will need to delete these resources before you can redeploy:
-  - the CloudWatch log group: `GasolinaMetricLogGroup`
-  - the S3 bucket: `providerconfigs-<projectName>-<environment>-gasolina`
+
+-   Some resources have deletion projection policies. You will need to delete these resources before you can redeploy:
+    -   the CloudWatch log group: `GasolinaMetricLogGroup`
+    -   the S3 bucket: `providerconfigs-<projectName>-<environment>-gasolina`
diff --git a/cdk/gasolina/config/index.ts b/cdk/gasolina/config/index.ts
@@ -2,7 +2,7 @@ export const CONFIG: {
     [account: string]: {
         projectName: string
         environment: string
-        ecrRepositoryArn: string
+        gasolinaRepo: string
         appVersion: string
         availableChainNames: string
         signerType: string
@@ -11,8 +11,7 @@ export const CONFIG: {
 } = {
     // EDIT: aws account number
     '<aws-account-number>': {
-        ecrRepositoryArn:
-            'arn:aws:ecr:us-east-1:438003944538:repository/gasolina',
+        gasolinaRepo: 'public.ecr.aws/t7p6p5n2/gasolina',
         appVersion: 'latest', // EDIT: version and tag of the gasolina image
         projectName: '<project_name>', // EDIT: project_name e.g. foobar-gasolina
         environment: '<environment>', // EDIT: environment e.g. mainnet/testnet

diff --git a/cdk/gasolina/lib/gasolinaApi.ts b/cdk/gasolina/lib/gasolinaApi.ts
@@ -37,7 +37,7 @@ interface CreateGasolinaServiceProps {
         }
     }
     signerType: string
-    ecrRepositoryArn: string
+    gasolinaRepo: string
     appVersion: string
     availableChainNames: string
     kmsNumOfSigners?: number
@@ -91,12 +91,6 @@ export const createGasolinaService = (props: CreateGasolinaServiceProps) => {
         },
     )
 
-    const repository = ecr.Repository.fromRepositoryArn(
-        props.stack,
-        `EcrRepository-${serviceName}`,
-        props.ecrRepositoryArn,
-    )
-
     if (!['MNEMONIC', 'KMS'].includes(props.signerType)) {
         throw new Error('Invalid signer type - Use either MNEMONIC or KMS')
     }
@@ -121,9 +115,8 @@ export const createGasolinaService = (props: CreateGasolinaServiceProps) => {
         layerzeroPrefix: LAYERZERO_PREFIX,
         vpc: props.vpc,
         cluster: props.cluster,
-        dockerImage: ecs.ContainerImage.fromEcrRepository(
-            repository,
-            props.appVersion,
+        dockerImage: ecs.ContainerImage.fromRegistry(
+            `${props.gasolinaRepo}:${props.appVersion}`,
         ),
         serviceName,
         workerRole: workerRole,

diff --git a/cdk/gasolina/lib/gasolinaCdkStack.ts b/cdk/gasolina/lib/gasolinaCdkStack.ts
@@ -36,7 +36,7 @@ export class GasolinaCdkStack extends LZCdkStack {
             verifyAndDeliverConfig: {
                 contractAddresses: {},
             },
-            ecrRepositoryArn: config.ecrRepositoryArn,
+            gasolinaRepo: config.gasolinaRepo,
             appVersion: config.appVersion,
             availableChainNames: config.availableChainNames,
             signerType: config.signerType,