dash-platform-sdk 1.4.0-dev.4 → 1.4.0-dev.5

package/src/dataContracts/index.d.ts

@@ -1,6 +1,6 @@
-import { DataContractConfig, IdentifierLike } from '../../types.js';
-import { DataContractTokens, DataContractWASM, PlatformVersionWASM, StateTransitionWASM } from 'pshenmic-dpp';
+import { DataContractTokens, DataContractWASM, IdentifierLike, PlatformVersionWASM, StateTransitionWASM } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
+import { DataContractConfig } from '../../types.js';
 /**
  * Collection of methods necessary to work with Data Contracts in the network,
  * such as data contract creation or retrieval

package/src/documents/create.d.ts

@@ -1,3 +1,2 @@
-import { DocumentWASM } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { DocumentWASM, IdentifierLike } from 'pshenmic-dpp';
 export default function createDocument(dataContractId: IdentifierLike, documentType: string, data: object, owner: IdentifierLike, revision?: bigint, documentId?: IdentifierLike): DocumentWASM;

package/src/documents/index.d.ts

@@ -1,5 +1,5 @@
-import { DocumentTransitionParams, IdentifierLike } from '../../types.js';
-import { DocumentWASM, IdentifierWASM, StateTransitionWASM, WhereClause } from 'pshenmic-dpp';
+import { DocumentTransitionParams } from '../../types.js';
+import { DocumentWASM, IdentifierLike, IdentifierWASM, StateTransitionWASM, WhereClause } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 /**
  * Collection of methods to work with documents like creation, querying or preparing a transition action

package/src/documents/query.d.ts

@@ -1,4 +1,3 @@
-import { DocumentWASM, IdentifierWASM, WhereClause } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { DocumentWASM, IdentifierLike, IdentifierWASM, WhereClause } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function query(grpcPool: GRPCConnectionPool, dataContractId: IdentifierLike, documentTypeName: string, where?: WhereClause[], orderBy?: string[][], limit?: number | undefined, startAt?: IdentifierWASM, startAfter?: IdentifierWASM): Promise<DocumentWASM[]>;

package/src/identities/getIdentityBalance.d.ts

@@ -1,3 +1,3 @@
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function getIdentityBalance(grpcPool: GRPCConnectionPool, identifier: IdentifierLike): Promise<bigint>;

package/src/identities/getIdentityByIdentifier.d.ts

@@ -1,4 +1,3 @@
-import { IdentityWASM } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike, IdentityWASM } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function getIdentityByIdentifier(grpcPool: GRPCConnectionPool, identifier: IdentifierLike): Promise<IdentityWASM>;

package/src/identities/getIdentityContractNonce.d.ts

@@ -1,3 +1,3 @@
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function getIdentityContractNonce(grpcPool: GRPCConnectionPool, identity: IdentifierLike, dataContract: IdentifierLike): Promise<bigint>;

package/src/identities/getIdentityNonce.d.ts

@@ -1,3 +1,3 @@
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function getIdentityNonce(grpcPool: GRPCConnectionPool, identifier: IdentifierLike): Promise<bigint>;

package/src/identities/getIdentityPublicKeys.d.ts

@@ -1,4 +1,3 @@
-import { IdentityPublicKeyWASM } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike, IdentityPublicKeyWASM } from 'pshenmic-dpp';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
 export default function getIdentityPublicKeys(grpcPool: GRPCConnectionPool, identifier: IdentifierLike, keyIds?: number[]): Promise<IdentityPublicKeyWASM[]>;

package/src/identities/index.d.ts

@@ -1,6 +1,6 @@
-import { IdentifierLike, IdentityTransitionParams } from '../../types.js';
+import { IdentityTransitionParams } from '../../types.js';
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentityPublicKeyWASM, IdentityWASM, StateTransitionWASM } from 'pshenmic-dpp';
+import { IdentifierLike, IdentityPublicKeyWASM, IdentityWASM, StateTransitionWASM } from 'pshenmic-dpp';
 /**
  * Collection of methods to query identities and its related data
  *

package/src/names/index.d.ts

@@ -1,6 +1,5 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { DocumentWASM, PrivateKeyWASM } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { DocumentWASM, IdentifierLike, PrivateKeyWASM } from 'pshenmic-dpp';
 /**
  * Functions related to DPNS names (usernames)
  *

package/src/node/index.d.ts

@@ -1,5 +1,5 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { Network, NodeStatus } from '../../types.js';
+import { NodeStatus } from '../../types.js';
 import { EpochInfo } from './epochs.js';
 /**
  * Node controller for requesting information about DAPI node
@@ -9,8 +9,7 @@ import { EpochInfo } from './epochs.js';
 export declare class NodeController {
     /** @ignore **/
     grpcPool: GRPCConnectionPool;
-    network: Network;
-    constructor(grpcPool: GRPCConnectionPool, network: Network);
+    constructor(grpcPool: GRPCConnectionPool);
     /**
      * Retrieves an info about node
      * Includes information about genesis, chain, software versions

package/src/node/index.js

@@ -9,10 +9,8 @@ import getTotalCredits from './totalCredits.js';
 export class NodeController {
     /** @ignore **/
     grpcPool;
-    network;
-    constructor(grpcPool, network) {
+    constructor(grpcPool) {
         this.grpcPool = grpcPool;
-        this.network = network;
     }
     /**
      * Retrieves an info about node
@@ -29,7 +27,7 @@ export class NodeController {
      * @return {Promise<bigint>}
      */
     async totalCredits() {
-        return await getTotalCredits(this.grpcPool, this.network);
+        return await getTotalCredits(this.grpcPool);
     }
     /**
      * Retrieves an info about epochs

package/src/node/totalCredits.d.ts

@@ -1,3 +1,2 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { Network } from '../../types.js';
-export default function totalCredits(grpcPool: GRPCConnectionPool, network: Network): Promise<bigint>;
+export default function totalCredits(grpcPool: GRPCConnectionPool): Promise<bigint>;

package/src/node/totalCredits.js

@@ -4,7 +4,7 @@ import { verifyTotalCreditsProof } from 'pshenmic-dpp';
 import { getQuorumPublicKey } from '../utils/getQuorumPublicKey.js';
 import bytesToHex from '../utils/bytesToHex.js';
 import verifyTenderdashProof from '../utils/verifyTenderdashProof.js';
-export default async function totalCredits(grpcPool, network) {
+export default async function totalCredits(grpcPool) {
     const getTotalCreditsInPlatformRequest = GetTotalCreditsInPlatformRequest.create({
         version: {
             oneofKind: 'v0',
@@ -24,7 +24,7 @@ export default async function totalCredits(grpcPool, network) {
     if (metadata == null) {
         throw new Error('Metadata not found');
     }
-    const activationHeight = network === 'testnet' ? TESTNET_ACTIVATION_HEIGHT : MAINNET_ACTIVATION_HEIGHT;
+    const activationHeight = grpcPool.network === 'testnet' ? TESTNET_ACTIVATION_HEIGHT : MAINNET_ACTIVATION_HEIGHT;
     const { rootHash, totalCredits } = verifyTotalCreditsProof(proof.grovedbProof, HALVING_INTERVAL, activationHeight, Number(metadata.height), LATEST_PLATFORM_VERSION);
     const quorumPublicKey = await getQuorumPublicKey(grpcPool.network, proof.quorumType, bytesToHex(proof.quorumHash));
     const verify = await verifyTenderdashProof(proof, metadata, rootHash, quorumPublicKey);

package/src/platformAddresses/getAddressInfo.d.ts

@@ -0,0 +1,4 @@
+import GRPCConnectionPool from '../grpcConnectionPool.js';
+import { PlatformAddressLike } from 'pshenmic-dpp';
+import { PlatformAddressInfo } from '../../types.js';
+export declare function getAddressInfo(grpcPool: GRPCConnectionPool, platformAddress: PlatformAddressLike): Promise<PlatformAddressInfo>;

package/src/platformAddresses/getAddressInfo.js

@@ -0,0 +1,45 @@
+import { PlatformAddressWASM, verifyPlatformAddressInfo } from 'pshenmic-dpp';
+import { GetAddressInfoRequest } from '../../proto/generated/platform.js';
+import { LATEST_PLATFORM_VERSION } from '../constants.js';
+import { getQuorumPublicKey } from '../utils/getQuorumPublicKey.js';
+import bytesToHex from '../utils/bytesToHex.js';
+import verifyTenderdashProof from '../utils/verifyTenderdashProof.js';
+export async function getAddressInfo(grpcPool, platformAddress) {
+    const platformAddressWASM = new PlatformAddressWASM(platformAddress);
+    const getAddressInfoRequest = GetAddressInfoRequest.create({
+        version: {
+            oneofKind: 'v0',
+            v0: {
+                address: platformAddressWASM.bytes(),
+                prove: true
+            }
+        }
+    });
+    const { response } = await grpcPool.getClient().getAddressInfo(getAddressInfoRequest);
+    const { version } = response;
+    if (version.oneofKind !== 'v0') {
+        throw new Error('Unexpected oneOf type returned from DAPI (must be v0)');
+    }
+    const { v0 } = version;
+    if (v0.result.oneofKind !== 'proof') {
+        throw new Error('Unexpected oneOf type returned from DAPI (must be proof)');
+    }
+    const { result: { proof }, metadata } = v0;
+    if (metadata == null) {
+        throw new Error('Metadata not found');
+    }
+    const { rootHash, address, nonce, balance } = await verifyPlatformAddressInfo(proof.grovedbProof, platformAddressWASM, true, LATEST_PLATFORM_VERSION);
+    if (address == null || nonce == null || balance == null) {
+        throw new Error(`Failed to fetch info for address ${platformAddressWASM.toBech32m(grpcPool.network)}`);
+    }
+    const quorumPublicKey = await getQuorumPublicKey(grpcPool.network, proof.quorumType, bytesToHex(proof.quorumHash));
+    const verify = await verifyTenderdashProof(proof, metadata, rootHash, quorumPublicKey);
+    if (!verify) {
+        throw new Error('Failed to verify query');
+    }
+    return {
+        address,
+        nonce,
+        balance
+    };
+}

package/src/platformAddresses/index.d.ts

@@ -0,0 +1,15 @@
+import GRPCConnectionPool from '../grpcConnectionPool.js';
+import { PlatformAddressLike } from 'pshenmic-dpp';
+import { PlatformAddressInfo } from '../../types.js';
+export declare class PlatformAddressesController {
+    /** @ignore **/
+    grpcPool: GRPCConnectionPool;
+    constructor(grpcPool: GRPCConnectionPool);
+    /**
+     * Makes a query for platform address info, returns an object with address, balance and nonce
+     *
+     * @param address {PlatformAddressLike}
+     * @return {Promise<PlatformAddressInfo>}
+     */
+    getAddressInfo(address: PlatformAddressLike): Promise<PlatformAddressInfo>;
+}

package/src/platformAddresses/index.js

@@ -0,0 +1,17 @@
+import { getAddressInfo } from './getAddressInfo.js';
+export class PlatformAddressesController {
+    /** @ignore **/
+    grpcPool;
+    constructor(grpcPool) {
+        this.grpcPool = grpcPool;
+    }
+    /**
+     * Makes a query for platform address info, returns an object with address, balance and nonce
+     *
+     * @param address {PlatformAddressLike}
+     * @return {Promise<PlatformAddressInfo>}
+     */
+    async getAddressInfo(address) {
+        return await getAddressInfo(this.grpcPool, address);
+    }
+}

package/src/tokens/getIdentitiesTokenBalances.d.ts

@@ -1,6 +1,5 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike } from '../../types.js';
-import { IdentifierWASM } from 'pshenmic-dpp';
+import { IdentifierLike, IdentifierWASM } from 'pshenmic-dpp';
 export interface IdentitiesTokenBalances {
     identityId: IdentifierWASM;
     balance?: bigint | undefined;

package/src/tokens/getIdentityTokensBalances.d.ts

@@ -1,6 +1,5 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike } from '../../types.js';
-import { IdentifierWASM } from 'pshenmic-dpp';
+import { IdentifierLike, IdentifierWASM } from 'pshenmic-dpp';
 export interface IdentityTokenBalances {
     tokenId: IdentifierWASM;
     balance?: bigint | undefined;

package/src/tokens/getTokenContractInfo.d.ts

@@ -1,6 +1,5 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike } from '../../types.js';
-import { IdentifierWASM } from 'pshenmic-dpp';
+import { IdentifierLike, IdentifierWASM } from 'pshenmic-dpp';
 export interface TokenContractInfo {
     dataContractId: IdentifierWASM;
     tokenContractPosition: number;

package/src/tokens/getTokenDirectPurchasePrices.d.ts

@@ -1,3 +1,4 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike, TokenDirectPurchasePrices } from '../../types.js';
+import { TokenDirectPurchasePrices } from '../../types.js';
+import { IdentifierLike } from 'pshenmic-dpp';
 export default function getTokenDirectPurchasePrices(grpcPool: GRPCConnectionPool, tokenIdentifiers: IdentifierLike[]): Promise<TokenDirectPurchasePrices[]>;

package/src/tokens/getTokenTotalSupply.d.ts

@@ -1,3 +1,4 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike, TokenTotalSupply } from '../../types.js';
+import { TokenTotalSupply } from '../../types.js';
+import { IdentifierLike } from 'pshenmic-dpp';
 export default function getTokenTotalSupply(grpcPool: GRPCConnectionPool, tokenIdentifier: IdentifierLike): Promise<TokenTotalSupply>;

package/src/tokens/index.d.ts

@@ -1,9 +1,9 @@
 import GRPCConnectionPool from '../grpcConnectionPool.js';
-import { IdentifierLike, TokenDirectPurchasePrices, TokenTotalSupply, TokenTransitionParams, TokenTransitionType } from '../../types.js';
+import { TokenDirectPurchasePrices, TokenTotalSupply, TokenTransitionParams, TokenTransitionType } from '../../types.js';
 import { IdentitiesTokenBalances } from './getIdentitiesTokenBalances.js';
 import { IdentityTokenBalances } from './getIdentityTokensBalances.js';
 import { TokenContractInfo } from './getTokenContractInfo.js';
-import { StateTransitionWASM, TokenBaseTransitionWASM } from 'pshenmic-dpp';
+import { IdentifierLike, StateTransitionWASM, TokenBaseTransitionWASM } from 'pshenmic-dpp';
 /**
  * Tokens controller for requesting information about tokens and tokens holders
  *

package/src/utils/index.d.ts

@@ -1,5 +1,4 @@
-import { IdentifierWASM } from 'pshenmic-dpp';
-import { IdentifierLike } from '../../types.js';
+import { IdentifierLike, IdentifierWASM } from 'pshenmic-dpp';
 /**
  * Collection of conversion functions
  *

package/src/voting/index.d.ts

@@ -1,5 +1,5 @@
-import { IdentifierLike, ResourceVoteChoice } from '../../types.js';
-import { IdentifierWASM, StateTransitionWASM, VoteWASM } from 'pshenmic-dpp';
+import { IdentifierLike, IdentifierWASM, StateTransitionWASM, VoteWASM } from 'pshenmic-dpp';
+import { ResourceVoteChoice } from '../../types.js';
 /**
  * Voting controller for performing masternode votes
  *

package/test/unit/PlatformAddress.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/test/unit/PlatformAddress.spec.js

@@ -0,0 +1,13 @@
+import { DashPlatformSDK } from '../../src/DashPlatformSDK.js';
+let sdk;
+describe('PlatformAddress', () => {
+    beforeAll(() => {
+        sdk = new DashPlatformSDK({ network: 'testnet' });
+    });
+    test('getAddressInfo', async () => {
+        const info = await sdk.platformAddresses.getAddressInfo('tdashevo1qpgz9hk6tkn5zj3653s8qkjmk9439qkf0gl4yxxw');
+        expect(info.balance).toBeDefined();
+        expect(info.nonce).toBeDefined();
+        expect(info.address).toBeDefined();
+    });
+});

package/types.d.ts

@@ -1,6 +1,5 @@
-import { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
-export { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM, StateTransitionWASM, BatchTransitionWASM, IdentityPublicKeyWASM, PrivateKeyWASM, DataContractUpdateTransitionWASM, IdentityWASM, IdentityUpdateTransitionWASM, IdentityCreditTransferWASM, MasternodeVoteTransitionWASM } from 'pshenmic-dpp';
-export type IdentifierLike = IdentifierWASM | string | Uint8Array;
+import { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierLike, IdentifierWASM, KeyType, PlatformAddressWASM, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
+export { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM, StateTransitionWASM, BatchTransitionWASM, IdentityPublicKeyWASM, PrivateKeyWASM, DataContractUpdateTransitionWASM, IdentityWASM, IdentityUpdateTransitionWASM, IdentityCreditTransferWASM, MasternodeVoteTransitionWASM, IdentifierLike, PlatformAddressLike } from 'pshenmic-dpp';
 export type Network = 'mainnet' | 'testnet';
 export { DashPlatformSDK } from './src/DashPlatformSDK.js';
 export type MasternodeList = Record<string, MasternodeInfo>;
@@ -206,3 +205,8 @@ export interface TokenDirectPurchasePrices {
     pricingSchedule?: TokenPricingScheduleWASM | undefined;
 }
 export type ResourceVoteChoice = IdentifierLike | 'lock' | 'abstain';
+export interface PlatformAddressInfo {
+    address: PlatformAddressWASM;
+    nonce: number;
+    balance: bigint;
+}