dash-platform-sdk 1.3.0-dev.7 → 1.3.0-dev.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dash-platform-sdk",
-  "version": "1.3.0-dev.7",
+  "version": "1.3.0-dev.9",
   "main": "index.js",
   "description": "Lightweight SDK for accessing Dash Platform blockchain",
   "ts-standard": {

package/src/identities/createStateTransition.d.ts

@@ -1,3 +1,3 @@
 import { StateTransitionWASM } from 'pshenmic-dpp';
 import { IdentityTransitionParams } from '../types.js';
-export default function createStateTransition(type: 'create' | 'update' | 'topUp', params: IdentityTransitionParams): StateTransitionWASM;
+export default function createStateTransition(type: 'create' | 'update' | 'topUp' | 'creditTransfer' | 'withdrawal', params: IdentityTransitionParams): StateTransitionWASM;

package/src/identities/createStateTransition.js

@@ -1,4 +1,4 @@
-import { IdentityCreateTransitionWASM, IdentityTopUpTransitionWASM, IdentityUpdateTransitionWASM } from 'pshenmic-dpp';
+import { IdentityCreateTransitionWASM, IdentityTopUpTransitionWASM, IdentityUpdateTransitionWASM, IdentityCreditTransferWASM, IdentityCreditWithdrawalTransitionWASM } from 'pshenmic-dpp';
 const identityTransitionsMap = {
     create: {
         class: IdentityCreateTransitionWASM,
@@ -14,6 +14,16 @@ const identityTransitionsMap = {
         class: IdentityUpdateTransitionWASM,
         arguments: ['identityId', 'revision', 'identityNonce', 'addPublicKeys', 'disablePublicKeyIds'],
         optionalArguments: ['userFeeIncrease']
+    },
+    creditTransfer: {
+        class: IdentityCreditTransferWASM,
+        arguments: ['identityId', 'amount', 'recipientId', 'identityNonce'],
+        optionalArguments: ['userFeeIncrease']
+    },
+    withdrawal: {
+        class: IdentityCreditWithdrawalTransitionWASM,
+        arguments: ['identityId', 'amount', 'coreFeePerByte', 'pooling', 'identityNonce', 'outputScript'],
+        optionalArguments: ['userFeeIncrease']
     }
 };
 export default function createStateTransition(type, params) {

package/src/identities/index.d.ts

@@ -68,8 +68,10 @@ export declare class IdentitiesController {
      * all necessary AssetLockProof data to make the transaction.
      * Both InstantSend and ChainLock AssetLock proofs supported
      *
-     * @param type {string} type of transition, must be a one of ('create' | 'update' | 'topUp')
+     * Please refer to Identity.spec.js or README for example commands
+     *
+     * @param type {string} type of transition, must be a one of ('create' | 'update' | 'topUp' | 'creditTransfer' | 'withdrawal')
      * @param params {IdentityTransitionParams} params
      */
-    createStateTransition(type: 'create' | 'update' | 'topUp', params: IdentityTransitionParams): StateTransitionWASM;
+    createStateTransition(type: 'create' | 'update' | 'topUp' | 'creditTransfer' | 'withdrawal', params: IdentityTransitionParams): StateTransitionWASM;
 }

package/src/identities/index.js

@@ -4,10 +4,11 @@ import getIdentityNonce from './getIdentityNonce.js';
 import getIdentityBalance from './getIdentityBalance.js';
 import getIdentityByPublicKeyHash from './getIdentityByPublicKeyHash.js';
 import getIdentityByIdentifier from './getIdentityByIdentifier.js';
-import { AssetLockProofWASM, ContractBoundsWASM, IdentifierWASM, IdentityPublicKeyInCreationWASM, OutPointWASM } from 'pshenmic-dpp';
+import { AssetLockProofWASM, ContractBoundsWASM, CoreScriptWASM, IdentifierWASM, IdentityPublicKeyInCreationWASM, OutPointWASM, PoolingWASM } from 'pshenmic-dpp';
 import createStateTransition from './createStateTransition.js';
 import getIdentityByNonUniquePublicKeyHash from './getIdentityByNonUniquePublicKeyHash.js';
 import hexToBytes from '../utils/hexToBytes.js';
+import { base58 } from '@scure/base';
 /**
  * Collection of methods to query identities and its related data
  *
@@ -97,7 +98,9 @@ export class IdentitiesController {
      * all necessary AssetLockProof data to make the transaction.
      * Both InstantSend and ChainLock AssetLock proofs supported
      *
-     * @param type {string} type of transition, must be a one of ('create' | 'update' | 'topUp')
+     * Please refer to Identity.spec.js or README for example commands
+     *
+     * @param type {string} type of transition, must be a one of ('create' | 'update' | 'topUp' | 'creditTransfer' | 'withdrawal')
      * @param params {IdentityTransitionParams} params
      */
     createStateTransition(type, params) {
@@ -136,6 +139,15 @@ export class IdentitiesController {
             params.publicKeys = params.publicKeys
                 .map(({ id, purpose, securityLevel, keyType, readOnly, data, signature, contractBounds }) => new IdentityPublicKeyInCreationWASM(id, purpose, securityLevel, keyType, readOnly, data, signature, (contractBounds != null) ? new ContractBoundsWASM(contractBounds.dataContractId, contractBounds.documentType) : undefined));
         }
+        if (params.recipientId != null) {
+            params.recipientId = new IdentifierWASM(params.recipientId);
+        }
+        if (type === 'withdrawal') {
+            // @ts-expect-error
+            params.pooling = params.pooling != null ? PoolingWASM[params.pooling] : PoolingWASM.Standard;
+            params.coreFeePerByte = params.coreFeePerByte ?? 1;
+            params.outputScript = params.outputScript ?? (params.withdrawalAddress != null ? CoreScriptWASM.newP2PKH(base58.decode(params.withdrawalAddress).slice(1, 21)) : undefined);
+        }
         return createStateTransition(type, params);
     }
 }

package/src/types.d.ts

@@ -1,5 +1,5 @@
-import { DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
-export { IdentifierWASM, IdentityWASM, DocumentWASM, DataContractWASM, StateTransitionWASM, IdentityPublicKeyWASM } from 'pshenmic-dpp';
+import { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
+export { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
 export type IdentifierLike = IdentifierWASM | string | Uint8Array;
 export type Network = 'mainnet' | 'testnet';
 export { DashPlatformSDK } from './DashPlatformSDK.js';
@@ -186,7 +186,13 @@ export interface IdentityTransitionParams {
     disablePublicKeyIds?: number[];
     revision?: bigint;
     identityNonce?: bigint;
+    amount?: bigint;
     identityId?: IdentifierLike;
+    recipientId?: IdentifierLike;
+    withdrawalAddress?: string;
+    outputScript?: CoreScriptWASM;
+    pooling?: 'Standard' | 'Never' | 'IfAvailable';
+    coreFeePerByte?: number;
     userFeeIncrease?: number;
 }
 export interface TokenTotalSupply {

package/src/types.js

@@ -1,4 +1,4 @@
-export { IdentifierWASM, IdentityWASM, DocumentWASM, DataContractWASM, StateTransitionWASM, IdentityPublicKeyWASM } from 'pshenmic-dpp';
+export { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierWASM, KeyType, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
 export { DashPlatformSDK } from './DashPlatformSDK.js';
 export var ContestedStateResultType;
 (function (ContestedStateResultType) {

package/src/utils/createMasternodeIdentityId.d.ts

@@ -0,0 +1,2 @@
+import { IdentifierWASM } from 'pshenmic-dpp';
+export declare function createMasternodeIdentityId(proTxHash: string): IdentifierWASM;

package/src/utils/createMasternodeIdentityId.js

@@ -0,0 +1,4 @@
+import { IdentifierWASM } from 'pshenmic-dpp';
+export function createMasternodeIdentityId(proTxHash) {
+    return IdentifierWASM.fromHex(proTxHash);
+}

package/src/utils/index.d.ts

@@ -1,3 +1,4 @@
+import { IdentifierWASM } from 'pshenmic-dpp';
 /**
  * Collection of conversion functions
  *
@@ -44,4 +45,21 @@ export declare class UtilsController {
      * @return {string}
      */
     convertToHomographSafeChars(str: string): string;
+    /**
+     * Creates a voting identity identifier from proTxHash and voting address
+     *
+     * @param proTxHash {string} Pro TX Hash in hex format
+     * @param publicKeyHash {string} Voting address's public key hash (20 bytes), in hex
+     *
+     * @return {Promise<string>}
+     */
+    createVoterIdentifier(proTxHash: string, publicKeyHash: string): Promise<IdentifierWASM>;
+    /**
+     * Creates a masternode identity identifier from proTxHash
+     *
+     * @param proTxHash {string} Pro TX Hash in hex format
+     *
+     * @return {string}
+     * */
+    createMasternodeIdentifier(proTxHash: string): IdentifierWASM;
 }

package/src/utils/index.js

@@ -2,6 +2,8 @@ import convertToHomographSafeChars from './convertToHomographSafeChars.js';
 import { base58 } from '@scure/base';
 import hexToBytes from './hexToBytes.js';
 import bytesToHex from './bytesToHex.js';
+import { createVoterIdentityId } from './createVoterIdentityId.js';
+import { createMasternodeIdentityId } from './createMasternodeIdentityId.js';
 /**
  * Collection of conversion functions
  *
@@ -58,4 +60,25 @@ export class UtilsController {
     convertToHomographSafeChars(str) {
         return convertToHomographSafeChars(str);
     }
+    /**
+     * Creates a voting identity identifier from proTxHash and voting address
+     *
+     * @param proTxHash {string} Pro TX Hash in hex format
+     * @param publicKeyHash {string} Voting address's public key hash (20 bytes), in hex
+     *
+     * @return {Promise<string>}
+     */
+    async createVoterIdentifier(proTxHash, publicKeyHash) {
+        return await createVoterIdentityId(proTxHash, publicKeyHash);
+    }
+    /**
+     * Creates a masternode identity identifier from proTxHash
+     *
+     * @param proTxHash {string} Pro TX Hash in hex format
+     *
+     * @return {string}
+     * */
+    createMasternodeIdentifier(proTxHash) {
+        return createMasternodeIdentityId(proTxHash);
+    }
 }

package/src/voting/index.d.ts

@@ -26,9 +26,9 @@ export declare class VotingController {
        */
     createVote(dataContractId: IdentifierLike, documentTypeName: string, indexName: string, indexValues: string[], choice: ResourceVoteChoice): VoteWASM;
     /**
-       * Creates a {StateTransitionWASM} from masternoe protxhash and voter identity
+       * Creates a {StateTransitionWASM} from masternode Pro Tx Hash and voter identity
        *
-       * @param voteWASM {VoteWASM} vote instance from .createMsternodeVote() method
+       * @param voteWASM {VoteWASM} vote instance from .createMasternodeVote() method
        * @param proTxHash {string} pro tx hash of the masternode as hex
        * @param voterIdentity {IdentifierWASM} voter identity identifier
        * @param identityNonce {BigInt} identity nonce

package/src/voting/index.js

@@ -41,9 +41,9 @@ export class VotingController {
         return createVote(new IdentifierWASM(dataContractId), documentTypeName, indexName, indexValues, resourceVoteChoice);
     }
     /**
-       * Creates a {StateTransitionWASM} from masternoe protxhash and voter identity
+       * Creates a {StateTransitionWASM} from masternode Pro Tx Hash and voter identity
        *
-       * @param voteWASM {VoteWASM} vote instance from .createMsternodeVote() method
+       * @param voteWASM {VoteWASM} vote instance from .createMasternodeVote() method
        * @param proTxHash {string} pro tx hash of the masternode as hex
        * @param voterIdentity {IdentifierWASM} voter identity identifier
        * @param identityNonce {BigInt} identity nonce

package/test/unit/Identity.spec.js

@@ -1,5 +1,6 @@
-import { IdentityPublicKeyWASM, IdentityWASM, KeyType, PrivateKeyWASM, Purpose, SecurityLevel } from 'pshenmic-dpp';
+import { CoreScriptWASM, IdentityPublicKeyWASM, IdentityWASM, KeyType, PrivateKeyWASM, Purpose, SecurityLevel, StateTransitionWASM } from 'pshenmic-dpp';
 import { DashPlatformSDK } from '../../src/types.js';
+import { base58 } from '@scure/base';
 let sdk;
 describe('Identity', () => {
     beforeAll(() => {
@@ -228,5 +229,38 @@ describe('Identity', () => {
             });
             identityUpdateTransition.signByPrivateKey(masterPrivateKey, masterKeyId, KeyType.ECDSA_SECP256K1);
         });
+        test('should able be create credit transfer transition', async () => {
+            const identityId = 'QMfCRPcjXoTnZa9sA9JR2KWgGxZXMRJ4akgS3Uia1Qv';
+            const recipientId = 'HT3pUBM1Uv2mKgdPEN1gxa7A4PdsvNY89aJbdSKQb5wR';
+            const amount = 100000n;
+            const identityNonce = await sdk.identities.getIdentityNonce(identityId);
+            const stateTransition = sdk.identities.createStateTransition('creditTransfer', { identityId, identityNonce, recipientId, amount });
+            expect(stateTransition).toEqual(expect.any(StateTransitionWASM));
+        });
+        test('should be able create credit withdrawal', async () => {
+            const identityId = 'QMfCRPcjXoTnZa9sA9JR2KWgGxZXMRJ4akgS3Uia1Qv';
+            const amount = 100000n;
+            const identityNonce = await sdk.identities.getIdentityNonce(identityId);
+            const withdrawalAddress = 'yjHVQ3dj37UJwXFmvMTKR9ZVfoJSc3opTD';
+            const stateTransition = sdk.identities.createStateTransition('withdrawal', { identityId, identityNonce, amount, withdrawalAddress });
+            expect(stateTransition).toEqual(expect.any(StateTransitionWASM));
+        });
+        test('should be able create credit withdrawal with custom CoreScript', async () => {
+            const identityId = 'QMfCRPcjXoTnZa9sA9JR2KWgGxZXMRJ4akgS3Uia1Qv';
+            const amount = 100000n;
+            const identityNonce = await sdk.identities.getIdentityNonce(identityId);
+            const withdrawalAddress = 'yjHVQ3dj37UJwXFmvMTKR9ZVfoJSc3opTD';
+            const outputScript = CoreScriptWASM.newP2PKH(base58.decode(withdrawalAddress).slice(1, 21));
+            const stateTransition = sdk.identities.createStateTransition('withdrawal', { identityId, identityNonce, amount, outputScript });
+            expect(stateTransition).toEqual(expect.any(StateTransitionWASM));
+        });
+        test('should be able create credit withdrawal with no withdrawal address', async () => {
+            const identityId = 'QMfCRPcjXoTnZa9sA9JR2KWgGxZXMRJ4akgS3Uia1Qv';
+            const recipientId = 'HT3pUBM1Uv2mKgdPEN1gxa7A4PdsvNY89aJbdSKQb5wR';
+            const amount = 100000n;
+            const identityNonce = await sdk.identities.getIdentityNonce(identityId);
+            const stateTransition = sdk.identities.createStateTransition('creditTransfer', { identityId, recipientId, amount, identityNonce });
+            expect(stateTransition).toEqual(expect.any(StateTransitionWASM));
+        });
     });
 });