Skip to content

Commit 2ec85e5

Browse files
committed
update readme
1 parent c07d192 commit 2ec85e5

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.MD

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

22
# How to run
3+
At repo root folder, run the following command to start the server
34

45
```
5-
docker compose up --build -d
6+
docker compose -f Docker-Compose.yml up --build
67
```
78
and the server will run on port 8080
89

@@ -96,6 +97,8 @@ and the server will run on port 8080
9697
- Must obtain transactionID before any write operation
9798
- Each transactionID can only be used once
9899
- Ensures idempotency and prevents duplicate transactions
100+
- We can also put transaction validation logic here, and return hash as transactionID
101+
- And when transactionID is used, we can use it to validate the transaction in middleware
99102
4. Deposit
100103
- PUT /api/v1/users/{userID}/wallet/deposit
101104
- Deposits funds into user's wallet
@@ -146,10 +149,10 @@ and the server will run on port 8080
146149
- Use pagination for efficient large data retrieval
147150
- User can query with time
148151
- Query parameters:
149-
- createdBefore: RFC3339 timestamp
150-
- IDBefore: Transaction ID for pagination
151-
- limit: Max number of records (default 100)
152-
- Returns transactions sorted by creation time
152+
- createdBefore (optional, RFC3339 timestamp string): RFC3339 timestamp, like `2024-12-16T03:59:02.608558Z`
153+
- IDBefore (optional, int): Transaction ID for pagination
154+
- limit (optional, int): Max number of records (default 100)
155+
- Returns transactions sorted by creation time descending
153156

154157
## Postman Collection
155158
[Postman Collection](./Cryptocom.postman_collection.json)

0 commit comments

Comments
 (0)