Skip to content

Commit 5e18b13

Browse files
authored
refactor: rename fill event amplitude (#205)
Closes ACX-600
1 parent faa999c commit 5e18b13

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

src/modules/ampli/index.ts

+15-14
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* To update run 'ampli pull scraper'
88
*
99
* Required dependencies: @amplitude/analytics-node@^0.5.0
10-
* Tracking Plan Version: 32
10+
* Tracking Plan Version: 40
1111
* Build: 1.0.0
1212
* Runtime: node.js:typescript-ampli-v2
1313
*
@@ -25,22 +25,23 @@ export type EventOptions = amplitude.Types.EventOptions;
2525
export type Result = amplitude.Types.Result;
2626
export type NodeOptions = amplitude.Types.NodeOptions;
2727

28-
export type Environment = "production" | "development";
28+
export type Environment = "production" | "development" | "testing";
2929

3030
export const ApiKey: Record<Environment, string> = {
3131
production: "",
3232
development: "",
33+
testing: "",
3334
};
3435

3536
/**
3637
* Default Amplitude configuration options. Contains tracking plan information.
3738
*/
3839
export const DefaultConfiguration: NodeOptions = {
3940
plan: {
40-
version: "32",
41+
version: "40",
4142
branch: "main",
4243
source: "scraper",
43-
versionId: "e6298d8b-58e2-45e6-a09d-0f244c0489ab",
44+
versionId: "cbc4a092-7d03-473a-bbba-f4fc79ef25b2",
4445
},
4546
...{
4647
ingestionMetadata: {
@@ -117,7 +118,7 @@ export interface IdentifyProperties {
117118
walletType?: string;
118119
}
119120

120-
export interface FillTransactionCompletedProperties {
121+
export interface TransferFillConfirmedProperties {
121122
/**
122123
* Capital fee percent, in decimals
123124
*/
@@ -187,7 +188,7 @@ export interface FillTransactionCompletedProperties {
187188
/**
188189
* Address of referee, null if no referral used
189190
*/
190-
referralProgramAddress: string;
191+
referralProgramAddress?: string;
191192
/**
192193
* Relay fee percent, in decimals
193194
*/
@@ -280,10 +281,10 @@ export class Identify implements BaseEvent {
280281
}
281282
}
282283

283-
export class FillTransactionCompleted implements BaseEvent {
284-
event_type = "FillTransactionCompleted";
284+
export class TransferFillConfirmed implements BaseEvent {
285+
event_type = "TransferFillConfirmed";
285286

286-
constructor(public event_properties: FillTransactionCompletedProperties) {
287+
constructor(public event_properties: TransferFillConfirmedProperties) {
287288
this.event_properties = event_properties;
288289
}
289290
}
@@ -405,22 +406,22 @@ export class Ampli {
405406
}
406407

407408
/**
408-
* FillTransactionCompleted
409+
* TransferFillConfirmed
409410
*
410-
* [View in Tracking Plan](https://data.amplitude.com/risklabs/Risk%20Labs/events/main/latest/FillTransactionCompleted)
411+
* [View in Tracking Plan](https://data.amplitude.com/risklabs/Risk%20Labs/events/main/latest/TransferFillConfirmed)
411412
*
412413
* Owner: Dong-Ha Kim
413414
*
414415
* @param userId The user's ID.
415416
* @param properties The event's properties (e.g. capitalFeePct)
416417
* @param options Amplitude event options.
417418
*/
418-
fillTransactionCompleted(
419+
transferFillConfirmed(
419420
userId: string | undefined,
420-
properties: FillTransactionCompletedProperties,
421+
properties: TransferFillConfirmedProperties,
421422
options?: EventOptions,
422423
) {
423-
return this.track(userId, new FillTransactionCompleted(properties), options);
424+
return this.track(userId, new TransferFillConfirmed(properties), options);
424425
}
425426
}
426427

src/modules/scraper/adapter/amplitude/track-service.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { HttpService } from "@nestjs/axios";
22
import { Injectable } from "@nestjs/common";
33

4-
import { EventOptions, FillTransactionCompletedProperties, ampli } from "../../../ampli";
4+
import { EventOptions, TransferFillConfirmedProperties, ampli } from "../../../ampli";
55
import { AppConfig } from "../../../configuration/configuration.service";
66

77
@Injectable()
@@ -22,9 +22,9 @@ export class TrackService {
2222

2323
public async trackDepositFilledEvent(
2424
userId: string,
25-
eventProperties: FillTransactionCompletedProperties,
25+
eventProperties: TransferFillConfirmedProperties,
2626
eventOptions?: EventOptions,
2727
) {
28-
return ampli.fillTransactionCompleted(userId, eventProperties, eventOptions);
28+
return ampli.transferFillConfirmed(userId, eventProperties, eventOptions);
2929
}
3030
}

0 commit comments

Comments
 (0)