Merge pull request #949 from IntersectMBO/split-ts-into-multiple-files

Split TypeScript declaration files

Author: palas

.gitignore

@@ -77,9 +77,8 @@ cardano-tracer/cardano-tracer-test
 
 cardano-wasm/examples/*/cardano-wasm.wasm
 cardano-wasm/examples/*/cardano-wasm.js
-cardano-wasm/examples/*/cardano-api.d.ts
+cardano-wasm/examples/*/*.d.ts
 cardano-wasm/examples/*/cardano-api.js
 cardano-wasm/examples/*/cardano_node_grpc_web_pb.js
 .ghc-wasm/
 
-

cardano-wasm/app/Main.hs

@@ -24,4 +24,4 @@ parser =
 main :: IO ()
 main = do
   cmdArgs <- execParser (info (parser <**> helper) fullDesc)
-  writeTypeScriptToDir (outputDir cmdArgs) (apiInfoToTypeScriptFile apiInfo)
+  mapM_ (writeTypeScriptToDir (outputDir cmdArgs)) (apiInfoToTypeScriptFile apiInfo)

cardano-wasm/cardano-wasm.cabal

@@ -61,6 +61,7 @@ executable cardano-wasm
     cardano-crypto-class,
     cardano-ledger-api,
     cardano-strict-containers,
+    casing,
     containers,
     exceptions,
     filepath,

cardano-wasm/lib-wrapper/cardano-api.d.ts

@@ -1,161 +1,10 @@
 // cardano-api.d.ts
 
-export default initialise;
-
-/**
- * Initialises the Cardano API.
- * @returns A promise that resolves to the main `CardanoApi` object.
- */
-declare function initialise(): Promise<CardanoApi>;
+import UnsignedTx from './unsigned-tx';
 
-/**
- * Represents an unsigned transaction.
- */
-declare interface UnsignedTx {
-    /**
-     * The type of the object, used for identification (the "UnsignedTx" string).
-     */
-    objectType: string;
+import GrpcConnection from './grpc-connection';
 
-    /**
-     * Adds a simple transaction input to the transaction.
-     * @param txId The transaction ID of the input UTxO.
-     * @param txIx The index of the input within the UTxO.
-     * @returns The `UnsignedTx` object with the added input.
-     */
-    addTxInput(txId: string, txIx: number): UnsignedTx;
-
-    /**
-     * Adds a simple transaction output to the transaction.
-     * @param destAddr The destination address.
-     * @param lovelaceAmount The amount in lovelaces to output.
-     * @returns The `UnsignedTx` object with the added output.
-     */
-    addSimpleTxOut(destAddr: string, lovelaceAmount: bigint): UnsignedTx;
-
-    /**
-     * Sets the fee for the transaction.
-     * @param lovelaceAmount The fee amount in lovelaces.
-     * @returns The `UnsignedTx` object with the set fee.
-     */
-    setFee(lovelaceAmount: bigint): UnsignedTx;
-
-    /**
-     * Estimates the minimum fee for the transaction.
-     * @param protocolParams The protocol parameters.
-     * @param numKeyWitnesses The number of key witnesses.
-     * @param numByronKeyWitnesses The number of Byron key witnesses.
-     * @param totalRefScriptSize The total size of reference scripts in bytes.
-     * @returns A promise that resolves to the estimated minimum fee in lovelaces.
-     */
-    estimateMinFee(protocolParams: any, numKeyWitnesses: number, numByronKeyWitnesses: number, totalRefScriptSize: number): Promise<bigint>;
-
-    /**
-     * Signs the transaction with a payment key.
-     * @param signingKey The signing key to witness the transaction.
-     * @returns A promise that resolves to a `SignedTx` object.
-     */
-    signWithPaymentKey(signingKey: string): Promise<SignedTx>;
-}
-
-/**
- * Represents a signed transaction.
- */
-declare interface SignedTx {
-    /**
-     * The type of the object, used for identification (the "SignedTx" string).
-     */
-    objectType: string;
-
-    /**
-     * Adds an extra signature to the transaction with a payment key.
-     * @param signingKey The signing key to witness the transaction.
-     * @returns The `SignedTx` object with the additional signature.
-     */
-    alsoSignWithPaymentKey(signingKey: string): SignedTx;
-
-    /**
-     * Converts the signed transaction to its CBOR representation.
-     * @returns A promise that resolves to the CBOR representation of the transaction as a hex string.
-     */
-    txToCbor(): Promise<string>;
-}
-
-/**
- * Represents a gRPC-web client connection to a Cardano node.
- */
-declare interface GrpcConnection {
-    /**
-     * The type of the object, used for identification (the "GrpcConnection" string).
-     */
-    objectType: string;
-
-    /**
-     * Get the era from the Cardano Node using a GRPC-web client.
-     * @returns A promise that resolves to the current era number.
-     */
-    getEra(): Promise<number>;
-
-    /**
-     * Submit a signed and CBOR-encoded transaction to the Cardano node.
-     * @param txCbor The CBOR-encoded transaction as a hex string.
-     * @returns A promise that resolves to the transaction ID.
-     */
-    submitTx(txCbor: string): Promise<string>;
-
-    /**
-     * Get the protocol parameters in the cardano-ledger format from the Cardano Node using a GRPC-web client.
-     * @returns A promise that resolves to the current protocol parameters.
-     */
-    getProtocolParams(): Promise<any>;
-
-    /**
-     * Get all UTXOs from the node using a GRPC-web client.
-     * @returns A promise that resolves to the current UTXO set.
-     */
-    getAllUtxos(): Promise<{ address: string, txId: string, txIndex: number, lovelace: bigint, assets: any[], datum?: any, script?: any }[]>;
-
-    /**
-     * Get UTXOs for a given address using a GRPC-web client.
-     * @param address The address to get UTXOs for.
-     * @returns A promise that resolves to the UTXOs for the given address.
-     */
-    getUtxosForAddress(address: string): Promise<{ txId: string, txIndex: number, lovelace: bigint, assets: any[], datum?: any, script?: any }[]>;
-}
-
-/**
- * Represents a wallet.
- */
-declare interface Wallet {
-    /**
-     * The type of the object, used for identification (the "Wallet" string).
-     */
-    objectType: string;
-
-    /**
-     * Get the Bech32 representation of the address. (Can be shared for receiving funds.)
-     * @returns The Bech32 representation of the address.
-     */
-    getAddressBech32(): Promise<string>;
-
-    /**
-     * Get the Bech32 representation of the verification key of the wallet. (Can be shared for verification.)
-     * @returns The Bech32 representation of the verification key.
-     */
-    getBech32ForVerificationKey(): Promise<string>;
-
-    /**
-     * Get the Bech32 representation of the signing key of the wallet. (Must be kept secret.)
-     * @returns The Bech32 representation of the signing key.
-     */
-    getBech32ForSigningKey(): Promise<string>;
-
-    /**
-     * Get the base16 representation of the hash of the verification key of the wallet.
-     * @returns The base16 representation of the verification key hash.
-     */
-    getBase16ForVerificationKeyHash(): Promise<string>;
-}
+import Wallet from './wallet';
 
 /**
  * The main Cardano API object with static methods.
@@ -207,3 +56,11 @@ declare interface CardanoApi {
      */
     restoreTestnetPaymentWalletFromSigningKeyBech32(networkMagic: number, signingKeyBech32: string): Promise<Wallet>;
 }
+
+/**
+ * Initialises the Cardano API.
+ * @returns A promise that resolves to the main `CardanoApi` object.
+ */
+declare function initialise(): Promise<CardanoApi>;
+
+export default initialise;

cardano-wasm/lib-wrapper/grpc-connection.d.ts

@@ -0,0 +1,45 @@
+// grpc-connection.d.ts
+
+/**
+ * Represents a gRPC-web client connection to a Cardano node.
+ */
+declare interface GrpcConnection {
+    /**
+     * The type of the object, used for identification (the "GrpcConnection" string).
+     */
+    objectType: string;
+
+    /**
+     * Get the era from the Cardano Node using a GRPC-web client.
+     * @returns A promise that resolves to the current era number.
+     */
+    getEra(): Promise<number>;
+
+    /**
+     * Submit a signed and CBOR-encoded transaction to the Cardano node.
+     * @param txCbor The CBOR-encoded transaction as a hex string.
+     * @returns A promise that resolves to the transaction ID.
+     */
+    submitTx(txCbor: string): Promise<string>;
+
+    /**
+     * Get the protocol parameters in the cardano-ledger format from the Cardano Node using a GRPC-web client.
+     * @returns A promise that resolves to the current protocol parameters.
+     */
+    getProtocolParams(): Promise<any>;
+
+    /**
+     * Get all UTXOs from the node using a GRPC-web client.
+     * @returns A promise that resolves to the current UTXO set.
+     */
+    getAllUtxos(): Promise<{ address: string, txId: string, txIndex: number, lovelace: bigint, assets: any[], datum?: any, script?: any }[]>;
+
+    /**
+     * Get UTXOs for a given address using a GRPC-web client.
+     * @param address The address to get UTXOs for.
+     * @returns A promise that resolves to the UTXOs for the given address.
+     */
+    getUtxosForAddress(address: string): Promise<{ txId: string, txIndex: number, lovelace: bigint, assets: any[], datum?: any, script?: any }[]>;
+}
+
+export default GrpcConnection;

cardano-wasm/lib-wrapper/signed-tx.d.ts

@@ -0,0 +1,26 @@
+// signed-tx.d.ts
+
+/**
+ * Represents a signed transaction.
+ */
+declare interface SignedTx {
+    /**
+     * The type of the object, used for identification (the "SignedTx" string).
+     */
+    objectType: string;
+
+    /**
+     * Adds an extra signature to the transaction with a payment key.
+     * @param signingKey The signing key to witness the transaction.
+     * @returns The `SignedTx` object with the additional signature.
+     */
+    alsoSignWithPaymentKey(signingKey: string): SignedTx;
+
+    /**
+     * Converts the signed transaction to its CBOR representation.
+     * @returns A promise that resolves to the CBOR representation of the transaction as a hex string.
+     */
+    txToCbor(): Promise<string>;
+}
+
+export default SignedTx;

cardano-wasm/lib-wrapper/unsigned-tx.d.ts

@@ -0,0 +1,55 @@
+// unsigned-tx.d.ts
+
+import SignedTx from './signed-tx';
+
+/**
+ * Represents an unsigned transaction.
+ */
+declare interface UnsignedTx {
+    /**
+     * The type of the object, used for identification (the "UnsignedTx" string).
+     */
+    objectType: string;
+
+    /**
+     * Adds a simple transaction input to the transaction.
+     * @param txId The transaction ID of the input UTxO.
+     * @param txIx The index of the input within the UTxO.
+     * @returns The `UnsignedTx` object with the added input.
+     */
+    addTxInput(txId: string, txIx: number): UnsignedTx;
+
+    /**
+     * Adds a simple transaction output to the transaction.
+     * @param destAddr The destination address.
+     * @param lovelaceAmount The amount in lovelaces to output.
+     * @returns The `UnsignedTx` object with the added output.
+     */
+    addSimpleTxOut(destAddr: string, lovelaceAmount: bigint): UnsignedTx;
+
+    /**
+     * Sets the fee for the transaction.
+     * @param lovelaceAmount The fee amount in lovelaces.
+     * @returns The `UnsignedTx` object with the set fee.
+     */
+    setFee(lovelaceAmount: bigint): UnsignedTx;
+
+    /**
+     * Estimates the minimum fee for the transaction.
+     * @param protocolParams The protocol parameters.
+     * @param numKeyWitnesses The number of key witnesses.
+     * @param numByronKeyWitnesses The number of Byron key witnesses.
+     * @param totalRefScriptSize The total size of reference scripts in bytes.
+     * @returns A promise that resolves to the estimated minimum fee in lovelaces.
+     */
+    estimateMinFee(protocolParams: any, numKeyWitnesses: number, numByronKeyWitnesses: number, totalRefScriptSize: number): Promise<bigint>;
+
+    /**
+     * Signs the transaction with a payment key.
+     * @param signingKey The signing key to witness the transaction.
+     * @returns A promise that resolves to a `SignedTx` object.
+     */
+    signWithPaymentKey(signingKey: string): Promise<SignedTx>;
+}
+
+export default UnsignedTx;

cardano-wasm/lib-wrapper/wallet.d.ts

@@ -0,0 +1,37 @@
+// wallet.d.ts
+
+/**
+ * Represents a wallet.
+ */
+declare interface Wallet {
+    /**
+     * The type of the object, used for identification (the "Wallet" string).
+     */
+    objectType: string;
+
+    /**
+     * Get the Bech32 representation of the address. (Can be shared for receiving funds.)
+     * @returns The Bech32 representation of the address.
+     */
+    getAddressBech32(): Promise<string>;
+
+    /**
+     * Get the Bech32 representation of the verification key of the wallet. (Can be shared for verification.)
+     * @returns The Bech32 representation of the verification key.
+     */
+    getBech32ForVerificationKey(): Promise<string>;
+
+    /**
+     * Get the Bech32 representation of the signing key of the wallet. (Must be kept secret.)
+     * @returns The Bech32 representation of the signing key.
+     */
+    getBech32ForSigningKey(): Promise<string>;
+
+    /**
+     * Get the base16 representation of the hash of the verification key of the wallet.
+     * @returns The base16 representation of the verification key hash.
+     */
+    getBase16ForVerificationKeyHash(): Promise<string>;
+}
+
+export default Wallet;