dash-platform-sdk 1.4.0 → 1.5.0-dev.2

package/types.d.ts

@@ -1,4 +1,4 @@
-import { CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierLike, IdentifierWASM, KeyType, PlatformAddressWASM, Purpose, SecurityLevel, TokenEmergencyActionWASM, TokenPricingScheduleWASM } from 'pshenmic-dpp';
+import { AddressFundsFeeStrategyStepWASM, AssetLockProofWASM, CoreScriptWASM, DocumentWASM, GasFeesPaidByWASM, IdentifierLike, IdentifierWASM, InputAddressWASM, KeyType, OrchardAddressWASM, PlatformAddressLike, PlatformAddressWASM, PlatformVersionWASM, PoolingLike, PrivateKeyWASM, Purpose, SecurityLevel, SpendableNoteWASM, 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';
@@ -20,6 +20,80 @@ export interface DocumentTransitionParams {
         gasFeesPaidBy: GasFeesPaidByWASM;
     };
 }
+export interface ShieldedTransitionBaseParams {
+    /** version of the platform (defaults to the latest supported version) */
+    platformVersion?: PlatformVersionWASM;
+}
+/** Spend inputs shared by `shieldedWithdrawal`, `unshield`, `shieldedTransfer` and `identityCreateFromShieldedPool`. */
+export interface ShieldedSpendParams extends ShieldedTransitionBaseParams {
+    spends: SpendableNoteWASM[];
+    changeAddress: OrchardAddressWASM;
+    seed: Uint8Array;
+    coinType: number;
+    account: number;
+    anchor: Uint8Array;
+    /** optional UTF-8 memo string (defaults to an empty memo) */
+    memo?: string;
+}
+/** Transparent platform addresses -> pool (deposit). */
+export interface ShieldParams extends ShieldedTransitionBaseParams {
+    recipient: OrchardAddressWASM;
+    shieldAmount: bigint;
+    inputs: InputAddressWASM[];
+    privateKeys: PrivateKeyWASM[];
+    feeStrategy: AddressFundsFeeStrategyStepWASM[];
+    userFeeIncrease: number;
+    /** optional UTF-8 memo string (defaults to an empty memo) */
+    memo?: string;
+    senderOvk?: Uint8Array;
+}
+/** Asset lock -> pool (deposit). */
+export interface ShieldFromAssetLockParams extends ShieldedTransitionBaseParams {
+    recipient: OrchardAddressWASM;
+    shieldAmount: bigint;
+    assetLockProof: AssetLockProofWASM;
+    privateKey: PrivateKeyWASM;
+    /** optional UTF-8 memo string (defaults to an empty memo) */
+    memo?: string;
+    dummyOutputs: number;
+    senderOvk?: Uint8Array;
+    surplusOutput?: PlatformAddressLike;
+}
+/** Pool -> core L1 (spend). */
+export interface ShieldedWithdrawalParams extends ShieldedSpendParams {
+    withdrawalAmount: bigint;
+    outputScript: CoreScriptWASM;
+    coreFeePerByte: number;
+    pooling: PoolingLike;
+}
+/** Pool -> platform identity balance (spend). */
+export interface UnshieldParams extends ShieldedSpendParams {
+    outputAddress: PlatformAddressLike;
+    unshieldAmount: bigint;
+}
+/** Pool -> pool (spend). */
+export interface ShieldedTransferParams extends ShieldedSpendParams {
+    recipient: OrchardAddressWASM;
+    transferAmount: bigint;
+}
+/** Pool -> new identity (spend). */
+export interface IdentityCreateFromShieldedPoolParams extends ShieldedSpendParams {
+    publicKeys: IdentityPublicKeyInCreation[];
+    privateKeys: PrivateKeyWASM[];
+    denomination: bigint;
+    sendToAddressOnCreationFailure: PlatformAddressLike;
+}
+/** Maps each shielded transition type to the params it requires. */
+export interface ShieldedTransitionParamsMap {
+    shield: ShieldParams;
+    shieldFromAssetLock: ShieldFromAssetLockParams;
+    shieldedWithdrawal: ShieldedWithdrawalParams;
+    unshield: UnshieldParams;
+    shieldedTransfer: ShieldedTransferParams;
+    identityCreateFromShieldedPool: IdentityCreateFromShieldedPoolParams;
+}
+export type ShieldedTransitionType = keyof ShieldedTransitionParamsMap;
+export type ShieldedTransitionParams = ShieldedTransitionParamsMap[ShieldedTransitionType];
 export interface MasternodeInfo {
     proTxHash: string;
     address: string;
@@ -210,3 +284,13 @@ export interface PlatformAddressInfo {
     nonce: number;
     balance: bigint;
 }
+export interface ShieldedEncryptedNote {
+    nullifier: Uint8Array;
+    cmx: Uint8Array;
+    encryptedNote: Uint8Array;
+    cvNet: Uint8Array;
+}
+export interface ShieldedNullifierStatus {
+    nullifier: Uint8Array;
+    isSpent: boolean;
+}