feat: introduce getRecentPerformanceSamples rpc (#12442)

* feat: introduce getRecentPerformanceSamples rpc

* test: indroduce tests and clean up style

* test: skip live tests

* feat: run tests live
This commit is contained in:
Josh
2020-10-08 20:26:58 -07:00
committed by GitHub
parent 6972e63f51
commit e0eb374d9c
4 changed files with 131 additions and 0 deletions

View File

@ -505,8 +505,25 @@ type ConfirmedBlock = {
}>,
};
/**
* A performance sample
*
* @typedef {Object} PerfSample
* @property {number} slot Slot number of sample
* @property {number} numTransactions Number of transactions in a sample window
* @property {number} numSlots Number of slots in a sample window
* @property {number} samplePeriodSecs Sample window in seconds
*/
type PerfSample = {
slot: number,
numTransactions: number,
numSlots: number,
samplePeriodSecs: number,
};
function createRpcRequest(url: string, useHttps: boolean): RpcRequest {
const agentManager = new AgentManager(useHttps);
const server = jayson(async (request, callback) => {
const agent = agentManager.requestStart();
const options = {
@ -1182,6 +1199,20 @@ const GetRecentBlockhashAndContextRpcResult = jsonRpcResultAndContext(
}),
);
/*
* Expected JSON RPC response for "getRecentPerformanceSamples" message
*/
const GetRecentPerformanceSamplesRpcResult = jsonRpcResult(
struct.array([
struct.pick({
slot: 'number',
numTransactions: 'number',
numSlots: 'number',
samplePeriodSecs: 'number',
}),
]),
);
/**
* Expected JSON RPC response for the "getFeeCalculatorForBlockhash" message
*/
@ -2325,6 +2356,30 @@ export class Connection {
return res.result;
}
/**
* Fetch recent performance samples
* @return {Promise<Array<PerfSample>>}
*/
async getRecentPerformanceSamples(
limit: ?number,
): Promise<Array<PerfSample>> {
const args = this._buildArgs(limit ? [limit] : []);
const unsafeRes = await this._rpcRequest(
'getRecentPerformanceSamples',
args,
);
const res = GetRecentPerformanceSamplesRpcResult(unsafeRes);
if (res.error) {
throw new Error(
'failed to get recent performance samples: ' + res.error.message,
);
}
assert(typeof res.result !== 'undefined');
return res.result;
}
/**
* Fetch the fee calculator for a recent blockhash from the cluster, return with context
*/