Skip to content

Commit 2a71277

Browse files
committed
Update README file
1 parent 1511294 commit 2a71277

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11

2+
23
# Custom Alerts for Wallet Activities
34

45

@@ -62,6 +63,45 @@ Create a `config.yaml` file in the root directory with the following content:
6263

6364
```sh
6465
client, err := ethclient.Dial("wss://mainnet.infura.io/ws/v3/YOUR_INFURA_PROJECT_ID")
65-
2. **Run the application**:
66+
2. **Configure user preferences**
67+
68+
userPreference := &models.UserPreference{
69+
UserID: "user@example.com",
70+
WalletAddress: "0x...",
71+
MinEtherValue: "1000000000000000000", // 1 ETH
72+
TrackNFTs: true,
73+
EmailNotification: true
74+
})
75+
76+
3. **Run the application**:
77+
```sh
78+
go run main.go
79+
## Testing
80+
81+
1. **Run all tests**:
82+
83+
```sh
84+
go test ./... -v
85+
2. **Run specific tests**:
86+
6687
```sh
67-
go run main.go
88+
go test -v ./services/... // Test notification services
89+
go test -v ./repository/... // Test repositories
90+
## Key Components
91+
92+
**NFT Detection**:
93+
94+
Pre-configured list of popular NFT contract addresses
95+
Extensible for adding new collections
96+
Transaction Processing:
97+
98+
**Real-time block monitoring**:
99+
100+
Transaction filtering and categorization
101+
Event creation and storage
102+
103+
**Notification System**:
104+
105+
Email notifications via SendGrid
106+
User preference-based filtering
107+
Customizable notification templates

0 commit comments

Comments
 (0)