Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions public/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -1335,6 +1335,40 @@
}
}
},
"/api/v3/{network}/dapps-staking/get-period-range/{period}": {
"get": {
"tags": [
"Dapps Staking"
],
"description": "Retreives the start and end block numbers for the given dApp staking period.",
"parameters": [
{
"name": "network",
"in": "path",
"required": true,
"type": "string",
"description": "The network name. Supported networks: astar",
"enum": [
"astar",
"shiden",
"shibuya"
]
},
{
"name": "period",
"in": "path",
"required": true,
"type": "string",
"description": "dApp staking period."
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/{network}/node/tx-perblock/total": {
"get": {
"tags": [
Expand Down
30 changes: 30 additions & 0 deletions src/controllers/DappsStakingV3Controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -498,5 +498,35 @@ export class DappsStakingV3Controller extends ControllerBase implements IControl
}
},
);

app.route('/api/v3/:network/dapps-staking/get-period-range/:period').get(
async (req: Request, res: Response) => {
/*
#swagger.description = 'Retreives the start and end block numbers for the given dApp staking period.'
#swagger.tags = ['Dapps Staking']
#swagger.parameters['network'] = {
in: 'path',
description: 'The network name. Supported networks: astar',
required: true,
enum: ['astar', 'shiden', 'shibuya']
}
#swagger.parameters['period'] = {
in: 'path',
description: 'dApp staking period.',
required: true,
}
*/
try {
res.json(
await this._dappsStakingEvents.getPeriodBlockRange(
req.params.network as NetworkType,
Number(req.params.period),
),
);
} catch (err) {
this.handleError(res, err as Error);
}
},
);
}
}
31 changes: 31 additions & 0 deletions src/services/DappsStakingEvents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export interface IDappsStakingEvents {
getAggregatedPeriodData(network: NetworkType, period: number): Promise<PeriodDataResponse[]>;
getAggregatedStakerData(network: NetworkType, stakerAddress: string): Promise<StakerPeriodDataResponse[]>;
getTotalAggregatedStakerData(network: NetworkType, stakerAddress: string): Promise<StakerPeriodTotalResponse>;
getPeriodBlockRange(network: NetworkType, period: number): Promise<{ start: number; end?: number }>;
}

export type RewardEventType = 'Reward' | 'BonusReward' | 'DAppReward';
Expand Down Expand Up @@ -616,4 +617,34 @@ export class DappsStakingEvents extends DappStakingV3IndexerBase implements IDap

return total;
}

public async getPeriodBlockRange(network: NetworkType, period: number): Promise<{ start: number; end?: number }> {
this.GuardNetwork(network);
if (period <= 0) {
throw new Error('Period must be greater than 0');
}

try {
const result = await axios.post(this.getApiUrl(network), {
query: `query {
subperiods(orderBy: timestamp_ASC, where: {type_eq: Voting}) {
blockNumber
}
}`,
});

const subperiods = result.data.data.subperiods;
if (period > subperiods.length) {
throw new Error(`Season ${period} not found`);
}

return {
start: subperiods[period - 1].blockNumber,
end: subperiods[period]?.blockNumber - 1,
};
} catch (e) {
console.error(e);
throw new Error('Unable to fetch season block range from a node.');
}
}
}