Merge pull request #7 from oasysgames/fix/Dockerfile

enable to set allow_list before docker_container start

Dockerfile

@@ -1,27 +1,9 @@
-###################
-## BUILD
-###################
-FROM node:18-alpine As build
+FROM node:18-alpine
+RUN mkdir -p /usr/src/app && chown -R node:node /usr/src/app
 WORKDIR /usr/src/app
 
-# COPY --chown=node:node package*.json ./
-# COPY --chown=node:node . .
-
-# USER node
-
-COPY package*.json ./
+COPY --chown=node:node . .
 RUN npm install
-COPY . .
-RUN npm run build
-
-###################
-## PRODUCTION
-###################
-FROM node:18-alpine As production
-
-COPY --chown=node:node --from=build /usr/src/app/node_modules ./node_modules
-COPY --chown=node:node --from=build /usr/src/app/dist ./dist
-
 USER node
 
-CMD [ "node", "dist/main.js" ]
+CMD ["npm", "run", "start"]

README.md

@@ -54,11 +54,21 @@ $ npm run test:cov
 ```
 
 ### Deploy
+#### 1. Set PORT
 ```bash
-# create image
-docker build . --tag verse-layer-proxy
+export PORT=[YOUR_PROXY_PORT]
+```
+
+#### 2. Set allow list config
+You have to download your allow list config to `$PWD/src/config`.
+
+#### 3. Start container
+```bash
+# chose image version and pull image
+docker pull ghcr.io/oasysgames/verse-proxy:v1.0.0
+
 # create container
-docker run --name verse-layer-proxy -d -p 3000:3000 verse-layer-proxy
+docker run --name verse-proxy -d -p $PORT:$PORT -v $PWD/src/config:/usr/src/app/src/config verse-proxy
 ```
 
 ## Control items

src/config/transactionAllowList.ts

@@ -1,4 +1,17 @@
-import { TransactionAllow } from 'src/shared/entities';
+export interface ComparisonOperation {
+  eq?: string; // txValue == condition is allowed
+  nq?: string; // txValue != condition is allowed
+  gt?: string; // txValue > condition is allowed
+  gte?: string; // txValue >= condition is allowed
+  lt?: string; // txValue < condition is allowed
+  lte?: string; // txValue <= condition is allowed
+}
+
+export interface TransactionAllow {
+  fromList: Array<string>;
+  toList: Array<string>;
+  value?: ComparisonOperation;
+}
 
 export const getTxAllowList = (): Array<TransactionAllow> => {
   return [

src/services/transaction.service.ts

@@ -1,15 +1,17 @@
 import { Injectable } from '@nestjs/common';
 import { ethers, BigNumber, Transaction } from 'ethers';
 import {
-  TransactionAllow,
   EthEstimateGasParams,
   JsonrpcRequestBody,
   JsonrpcId,
   JsonrpcVersion,
   JsonrpcError,
 } from 'src/shared/entities';
 import { AllowCheckService } from 'src/shared/services/src';
-import { getTxAllowList } from 'src/config/transactionAllowList';
+import {
+  TransactionAllow,
+  getTxAllowList,
+} from 'src/config/transactionAllowList';
 import { VerseService } from './verse.service';
 
 @Injectable()

src/shared/entities/index.ts

@@ -1,4 +1,3 @@
-export * from './TransactionAllow';
 export * from './TransactionParam';
 export * from './Jsonrpc';
 export * from './Verse';

src/shared/services/src/__tests__/allowCheck.service.spec.ts

@@ -1,5 +1,8 @@
 import { BigNumber } from 'ethers';
-import { ComparisonOperation, TransactionAllow } from 'src/shared/entities';
+import {
+  TransactionAllow,
+  ComparisonOperation,
+} from 'src/config/transactionAllowList';
 import { AllowCheckService } from '../allowCheck.service';
 import * as transactionAllowList from 'src/config/transactionAllowList';
 

src/shared/services/src/allowCheck.service.ts

@@ -1,5 +1,8 @@
 import { Injectable } from '@nestjs/common';
-import { TransactionAllow, ComparisonOperation } from 'src/shared/entities';
+import {
+  TransactionAllow,
+  ComparisonOperation,
+} from 'src/config/transactionAllowList';
 import { BigNumber } from 'ethers';
 import { getDeployAllowList } from 'src/config/transactionAllowList';