From e8fc49e3cc3613eca2053423957a2f3abda64c67 Mon Sep 17 00:00:00 2001 From: Paul DeLucia <69597248+pauldelucia@users.noreply.github.com> Date: Wed, 14 Aug 2024 17:47:15 +0700 Subject: [PATCH] refactor: rename getTotalCreditsOnPlatform (#2056) --- .../GetTotalCreditsInPlatformResponse.js | 46 +++++++++++++++++++ .../GetTotalCreditsOnPlatformResponse.js | 46 ------------------- .../getTotalCreditsOnPlatformFactory.js | 38 +++++++-------- packages/rs-drive-proof-verifier/src/proof.rs | 4 +- packages/rs-drive-proof-verifier/src/types.rs | 2 +- packages/rs-sdk/src/mock/requests.rs | 4 +- packages/rs-sdk/src/platform/fetch.rs | 2 +- .../types/total_credits_in_platform.rs | 4 +- 8 files changed, 73 insertions(+), 73 deletions(-) create mode 100644 packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsInPlatformResponse.js delete mode 100644 packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsOnPlatformResponse.js diff --git a/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsInPlatformResponse.js b/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsInPlatformResponse.js new file mode 100644 index 0000000000..bf197cf373 --- /dev/null +++ b/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsInPlatformResponse.js @@ -0,0 +1,46 @@ +const AbstractResponse = require('../response/AbstractResponse'); +const InvalidResponseError = require('../response/errors/InvalidResponseError'); + +class GetTotalCreditsInPlatformResponse extends AbstractResponse { + /** + * @param {number} totalCreditsInPlatform + * @param {Metadata} metadata + * @param {Proof} [proof] + */ + constructor(totalCreditsInPlatform, metadata, proof = undefined) { + super(metadata, proof); + + this.totalCreditsInPlatform = totalCreditsInPlatform; + } + + /** + * @returns {number} + */ + getTotalCreditsInPlatform() { + return this.totalCreditsInPlatform; + } + + /** + * @param proto + * @returns {GetTotalCreditsInPlatformResponse} + */ + static createFromProto(proto) { + // eslint-disable-next-line + const totalCreditsInPlatform = proto.getV0().getTotalCreditsInPlatform(); + const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto( + proto, + ); + + if ((typeof totalCreditsInPlatform === 'undefined' || totalCreditsInPlatform === null) && !proof) { + throw new InvalidResponseError('Total Credits on Platform data is not defined'); + } + + return new GetTotalCreditsInPlatformResponse( + totalCreditsInPlatform, + metadata, + proof, + ); + } +} + +module.exports = GetTotalCreditsInPlatformResponse; diff --git a/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsOnPlatformResponse.js b/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsOnPlatformResponse.js deleted file mode 100644 index 5f4a8f71c3..0000000000 --- a/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/GetTotalCreditsOnPlatformResponse.js +++ /dev/null @@ -1,46 +0,0 @@ -const AbstractResponse = require('../response/AbstractResponse'); -const InvalidResponseError = require('../response/errors/InvalidResponseError'); - -class GetTotalCreditsOnPlatformResponse extends AbstractResponse { - /** - * @param {number} totalCreditsOnPlatform - * @param {Metadata} metadata - * @param {Proof} [proof] - */ - constructor(totalCreditsOnPlatform, metadata, proof = undefined) { - super(metadata, proof); - - this.totalCreditsOnPlatform = totalCreditsOnPlatform; - } - - /** - * @returns {number} - */ - getTotalCreditsOnPlatform() { - return this.totalCreditsOnPlatform; - } - - /** - * @param proto - * @returns {GetTotalCreditsOnPlatformResponse} - */ - static createFromProto(proto) { - // eslint-disable-next-line - const totalCreditsOnPlatform = proto.getV0().getTotalCreditsOnPlatform(); - const { metadata, proof } = AbstractResponse.createMetadataAndProofFromProto( - proto, - ); - - if ((typeof totalCreditsOnPlatform === 'undefined' || totalCreditsOnPlatform === null) && !proof) { - throw new InvalidResponseError('Total Credits on Platform data is not defined'); - } - - return new GetTotalCreditsOnPlatformResponse( - totalCreditsOnPlatform, - metadata, - proof, - ); - } -} - -module.exports = GetTotalCreditsOnPlatformResponse; diff --git a/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/getTotalCreditsOnPlatformFactory.js b/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/getTotalCreditsOnPlatformFactory.js index fdd7a00f84..1bbbd3f022 100644 --- a/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/getTotalCreditsOnPlatformFactory.js +++ b/packages/js-dapi-client/lib/methods/platform/getTotalCreditsOnPlatform/getTotalCreditsOnPlatformFactory.js @@ -1,34 +1,34 @@ const { v0: { PlatformPromiseClient, - GetTotalCreditsOnPlatformRequest, + GetTotalCreditsInPlatformRequest, }, } = require('@dashevo/dapi-grpc'); -const GetTotalCreditsOnPlatformResponse = require('./GetTotalCreditsOnPlatformResponse'); +const GetTotalCreditsInPlatformResponse = require('./GetTotalCreditsInPlatformResponse'); const InvalidResponseError = require('../response/errors/InvalidResponseError'); /** * @param {GrpcTransport} grpcTransport - * @returns {getTotalCreditsOnPlatform} + * @returns {getTotalCreditsInPlatform} */ -function getTotalCreditsOnPlatformFactory(grpcTransport) { +function getTotalCreditsInPlatformFactory(grpcTransport) { /** * Fetch the version upgrade votes status - * @typedef {getTotalCreditsOnPlatform} + * @typedef {getTotalCreditsInPlatform} * @param {DAPIClientOptions & {prove: boolean}} [options] - * @returns {Promise} + * @returns {Promise} */ - async function getTotalCreditsOnPlatform(options = {}) { + async function getTotalCreditsInPlatform(options = {}) { const { - GetTotalCreditsOnPlatformRequestV0, - } = GetTotalCreditsOnPlatformRequest; + GetTotalCreditsInPlatformRequestV0, + } = GetTotalCreditsInPlatformRequest; // eslint-disable-next-line max-len - const getTotalCreditsOnPlatformRequest = new GetTotalCreditsOnPlatformRequest(); + const getTotalCreditsInPlatformRequest = new GetTotalCreditsInPlatformRequest(); - getTotalCreditsOnPlatformRequest.setV0( - new GetTotalCreditsOnPlatformRequestV0() + getTotalCreditsInPlatformRequest.setV0( + new GetTotalCreditsInPlatformRequestV0() .setProve(!!options.prove), ); @@ -38,15 +38,15 @@ function getTotalCreditsOnPlatformFactory(grpcTransport) { for (let i = 0; i < 3; i += 1) { try { // eslint-disable-next-line no-await-in-loop - const getTotalCreditsOnPlatformResponse = await grpcTransport.request( + const getTotalCreditsInPlatformResponse = await grpcTransport.request( PlatformPromiseClient, - 'getTotalCreditsOnPlatform', - getTotalCreditsOnPlatformRequest, + 'getTotalCreditsInPlatform', + getTotalCreditsInPlatformRequest, options, ); - return GetTotalCreditsOnPlatformResponse - .createFromProto(getTotalCreditsOnPlatformResponse); + return GetTotalCreditsInPlatformResponse + .createFromProto(getTotalCreditsInPlatformResponse); } catch (e) { if (e instanceof InvalidResponseError) { lastError = e; @@ -61,7 +61,7 @@ function getTotalCreditsOnPlatformFactory(grpcTransport) { throw lastError; } - return getTotalCreditsOnPlatform; + return getTotalCreditsInPlatform; } -module.exports = getTotalCreditsOnPlatformFactory; +module.exports = getTotalCreditsInPlatformFactory; diff --git a/packages/rs-drive-proof-verifier/src/proof.rs b/packages/rs-drive-proof-verifier/src/proof.rs index 141b2769c2..de46f75a1e 100644 --- a/packages/rs-drive-proof-verifier/src/proof.rs +++ b/packages/rs-drive-proof-verifier/src/proof.rs @@ -1646,7 +1646,7 @@ impl FromProof for Vote { } } -impl FromProof for TotalCreditsOnPlatform { +impl FromProof for TotalCreditsInPlatform { type Request = platform::GetTotalCreditsInPlatformRequest; type Response = platform::GetTotalCreditsInPlatformResponse; @@ -1685,7 +1685,7 @@ impl FromProof for TotalCreditsOnPla verify_tenderdash_proof(proof, mtd, &root_hash, provider)?; Ok(( - Some(TotalCreditsOnPlatform(credits)), + Some(TotalCreditsInPlatform(credits)), mtd.clone(), proof.clone(), )) diff --git a/packages/rs-drive-proof-verifier/src/types.rs b/packages/rs-drive-proof-verifier/src/types.rs index bd3288b8bc..f417d12979 100644 --- a/packages/rs-drive-proof-verifier/src/types.rs +++ b/packages/rs-drive-proof-verifier/src/types.rs @@ -174,7 +174,7 @@ pub struct KeysInPath { derive(Encode, Decode, PlatformSerialize, PlatformDeserialize), platform_serialize(unversioned) )] -pub struct TotalCreditsOnPlatform(pub Credits); +pub struct TotalCreditsInPlatform(pub Credits); /// A query with no parameters #[derive(Debug, Clone, Copy)] diff --git a/packages/rs-sdk/src/mock/requests.rs b/packages/rs-sdk/src/mock/requests.rs index db66c71ea3..6cb4dde30d 100644 --- a/packages/rs-sdk/src/mock/requests.rs +++ b/packages/rs-sdk/src/mock/requests.rs @@ -16,7 +16,7 @@ use dpp::{ }; use drive_proof_verifier::types::{ Contenders, ContestedResources, ElementFetchRequestItem, IdentityBalanceAndRevision, - MasternodeProtocolVote, PrefundedSpecializedBalance, TotalCreditsOnPlatform, + MasternodeProtocolVote, PrefundedSpecializedBalance, TotalCreditsInPlatform, VotePollsGroupedByTimestamp, Voters, }; use std::collections::BTreeMap; @@ -227,5 +227,5 @@ impl_mock_response!(Contenders); impl_mock_response!(Voters); impl_mock_response!(VotePollsGroupedByTimestamp); impl_mock_response!(PrefundedSpecializedBalance); -impl_mock_response!(TotalCreditsOnPlatform); +impl_mock_response!(TotalCreditsInPlatform); impl_mock_response!(ElementFetchRequestItem); diff --git a/packages/rs-sdk/src/platform/fetch.rs b/packages/rs-sdk/src/platform/fetch.rs index eee0a5a16d..109140bdb7 100644 --- a/packages/rs-sdk/src/platform/fetch.rs +++ b/packages/rs-sdk/src/platform/fetch.rs @@ -251,7 +251,7 @@ impl Fetch for drive_proof_verifier::types::IdentityBalance { type Request = platform_proto::GetIdentityBalanceRequest; } -impl Fetch for drive_proof_verifier::types::TotalCreditsOnPlatform { +impl Fetch for drive_proof_verifier::types::TotalCreditsInPlatform { type Request = platform_proto::GetTotalCreditsInPlatformRequest; } diff --git a/packages/rs-sdk/src/platform/types/total_credits_in_platform.rs b/packages/rs-sdk/src/platform/types/total_credits_in_platform.rs index 14459901ee..ebfd787967 100644 --- a/packages/rs-sdk/src/platform/types/total_credits_in_platform.rs +++ b/packages/rs-sdk/src/platform/types/total_credits_in_platform.rs @@ -3,10 +3,10 @@ use crate::platform::fetch_current_no_parameters::FetchCurrent; use crate::{platform::Fetch, Error, Sdk}; use async_trait::async_trait; use dapi_grpc::platform::v0::{Proof, ResponseMetadata}; -use drive_proof_verifier::types::{NoParamQuery, TotalCreditsOnPlatform}; +use drive_proof_verifier::types::{NoParamQuery, TotalCreditsInPlatform}; #[async_trait] -impl FetchCurrent for TotalCreditsOnPlatform { +impl FetchCurrent for TotalCreditsInPlatform { async fn fetch_current(sdk: &Sdk) -> Result { let (total_credits_on_platform, _) = Self::fetch_current_with_metadata(sdk).await?; Ok(total_credits_on_platform)