Chore/223 (#290)

* chore: missing docs * chore: remove public --------- Co-authored-by: Fabio Rigamonti <[email protected]>
vechain · Nov 23, 2023 · 0a94b66 · 0a94b66 · github-actions · Nov 23, 2023
1 parent 7a7b173
commit 0a94b66
Show file tree

Hide file tree

Showing 39 changed files with 143 additions and 159 deletions.
diff --git a/package.json b/package.json
@@ -15,7 +15,8 @@
         "format": "turbo format",
         "test:examples": "turbo test:examples",
         "merge-coverage": "ts-node scripts/merge-coverage.ts",
-        "generate:apidocs": "typedoc --options typedoc.json --logLevel Verbose"
+        "generate:apidocs": "typedoc --options typedoc.json --logLevel Error",
+        "generate:apidocs-debug": "typedoc --options typedoc.json --logLevel Verbose --plugin typedoc-plugin-missing-exports --validation.notDocumented"
     },
     "private": true,
     "workspaces": [
@@ -50,6 +51,7 @@
         "tsup": "^7.2.0",
         "turbo": "^1.10.15",
         "typedoc": "^0.25.3",
+        "typedoc-plugin-missing-exports": "^2.1.0",
         "typescript": "*"
     }
 }
diff --git a/packages/core/src/abi/fragment.ts b/packages/core/src/abi/fragment.ts
@@ -47,14 +47,11 @@ class Function<ABIType> {
     /**
      * The main fragment handled by ethers.js.
      *
-     * @public
      */
     public fragment: FunctionFragment;
 
     /**
      * The main interface handled by ethers.js.
-     *
-     * @public
      */
     public iface: Interface;
 
@@ -146,15 +143,11 @@ class Function<ABIType> {
 class Event<ABIType> {
     /**
      * The main fragment handled by ethers.js.
-     *
-     * @public
      */
     public fragment: ethers.EventFragment;
 
     /**
      * The main interface handled by ethers.js.
-     *
-     * @public
      */
     public iface: Interface;
 

diff --git a/packages/core/src/abi/types.d.ts b/packages/core/src/abi/types.d.ts
@@ -2,45 +2,33 @@ import { type ethers } from 'ethers';
 
 /**
  * Represents a wrapped Param Type for ethers.js types.
- *
- * @public
  */
 type ParamType = ethers.ParamType;
 
 /**
  * Represents a wrapped Function Fragment for ethers.js types.
- *
- * @public
  */
 type FunctionFragment = ethers.FunctionFragment;
 
 /**
  * Represents a wrapped Interface for ethers.js types.
- *
- * @public
  */
 type Interface = ethers.Interface;
 
 /**
  * Represents a wrapped Result for ethers.js types.
  * It represents the decoded data from a transaction (after decoding).
- *
- * @public
  */
 type Result = ethers.Result;
 
 /**
  * Represents a wrapped BytesLike for ethers.js types.
- *
- * @public
  */
 type BytesLike = ethers.BytesLike;
 
 /**
  * Represents a wrapped FormatType for ethers.js types.
  * It is used to represents the format of the signature of a function.
- *
- * @public
  */
 type FormatType = ethers.FormatType;
 

diff --git a/packages/core/src/hash/types.d.ts b/packages/core/src/hash/types.d.ts
@@ -2,8 +2,6 @@ import { type BytesLike } from 'ethers';
 
 /**
  * Input to hash function.
- *
- * @public
  */
 type HashInput = BytesLike;
 

diff --git a/packages/core/src/hdnode/types.d.ts b/packages/core/src/hdnode/types.d.ts
@@ -3,8 +3,6 @@
  *
  * BIP32 HD nodes allow for the derivation of child nodes from a master node,
  * enabling the generation of a tree structure of key pairs from a single seed.
- *
- * @public
  */
 interface IHDNode {
     /**

diff --git a/packages/core/src/keystore/types.d.ts b/packages/core/src/keystore/types.d.ts
@@ -1,14 +1,10 @@
 /**
  * Types of ciphers for keystore encryption
- *
- * @public
  */
 type Cipher = 'aes-128-ctr' | 'aes-128-cbc' | 'aes-256-cbc';
 
 /**
  * Scrypt parameters for keystore encryption
- *
- * @public
  */
 interface ScryptParams {
     dklen: number;
@@ -20,8 +16,6 @@ interface ScryptParams {
 
 /**
  * PBKDF2SHA256 parameters for keystore encryption
- *
- * @public
  */
 interface PBKDF2SHA256Params {
     c: number;
@@ -33,8 +27,6 @@ interface PBKDF2SHA256Params {
 /**
  * Keystore type.
  * Output of encryption function.
- *
- * @public
  */
 interface Keystore {
     crypto: {
@@ -55,8 +47,6 @@ interface Keystore {
 /**
  * Keystore account type
  * Output of decryption function.
- *
- * @public
  */
 interface KeystoreAccount {
     address: string;

diff --git a/packages/core/src/mnemonic/types.d.ts b/packages/core/src/mnemonic/types.d.ts
@@ -1,7 +1,6 @@
 /**
  * Type of the wordlist size.
  * Every 4 bytes produce 3 words.
- * @public
  */
 type WordlistSizeType = 12 | 15 | 18 | 21 | 24;
 

diff --git a/packages/core/src/transaction/types.d.ts b/packages/core/src/transaction/types.d.ts
@@ -1,6 +1,5 @@
 /**
  * Simple type for transaction clause.
- * @public
  */
 interface TransactionClause {
     /**
@@ -25,7 +24,6 @@ interface TransactionClause {
 
 /**
  * Type for transaction body.
- * @public
  */
 interface TransactionBody {
     /**
@@ -105,6 +103,9 @@ interface TransactionBody {
          * Tx feature bits
          */
         features?: number;
+        /**
+         * Unused
+         */
         unused?: Buffer[];
     };
 }

diff --git a/packages/core/src/utils/const/data.ts b/packages/core/src/utils/const/data.ts
@@ -1,6 +1,6 @@
 /**
  * Zero buffer
- * @public
+ * @internal
  *
  * @example ZERO_BUFFER(8) -> 0x00000000 , ... , ZERO_BUFFER(n) -> 0x0...0
  */
@@ -9,7 +9,6 @@ const ZERO_BUFFER = (size: number): Buffer => Buffer.alloc(size, 0);
 /**
  * Regular expression for validating hexadecimal strings.
  * Allows optional "0x" prefix and validates both lower and uppercase hex characters.
- * @public
  */
 const HEX_REGEX_OPTIONAL_PREFIX = /^(0x)?[0-9a-fA-F]*$/;
 

diff --git a/packages/core/src/utils/const/hdnode.ts b/packages/core/src/utils/const/hdnode.ts
@@ -1,20 +1,17 @@
 /**
  * Default VET derivation path.
- * @public
  *
  * See https://github.com/satoshilabs/slips/blob/master/slip-0044.md for more info.
  */
 const VET_DERIVATION_PATH = "m/44'/818'/0'/0";
 
 /**
  * Prefix for extended public key
- * @public
  */
 const X_PUB_PREFIX = Buffer.from('0488b21e000000000000000000', 'hex');
 
 /**
  * Prefix for extended private key
- * @public
  */
 const X_PRIV_PREFIX = Buffer.from('0488ade4000000000000000000', 'hex');
 

diff --git a/packages/core/src/utils/const/keystore.ts b/packages/core/src/utils/const/keystore.ts
@@ -1,6 +1,5 @@
 /**
  * Keystore Scrypt params
- * @public
  */
 const SCRYPT_PARAMS = {
     N: 131072,

diff --git a/packages/core/src/utils/const/mnemonic.ts b/packages/core/src/utils/const/mnemonic.ts
@@ -2,7 +2,6 @@ import { type WordlistSizeType } from '../../mnemonic';
 
 /**
  * Mnemonic wordlist size
- * @public
  */
 const MNEMONIC_WORDLIST_ALLOWED_SIZES: WordlistSizeType[] = [
     12, 15, 18, 21, 24

diff --git a/packages/core/src/utils/const/network.ts b/packages/core/src/utils/const/network.ts
@@ -97,8 +97,8 @@ const soloGenesisBlock = {
 };
 
 /**
- * @ignore since no relevant information is displayed in the documentation
  * Constants defining Vechain mainnet and testnet network information
+ * @internal
  */
 const networkInfo = {
     mainnet: {

diff --git a/packages/core/src/utils/const/secp256k1.ts b/packages/core/src/utils/const/secp256k1.ts
@@ -1,6 +1,6 @@
 /**
  * Biggest value of private key
- * @public
+ * @internal
  */
 const PRIVATE_KEY_MAX_VALUE = Buffer.from(
     'fffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141',

diff --git a/packages/core/src/utils/const/transaction.ts b/packages/core/src/utils/const/transaction.ts
@@ -2,38 +2,42 @@ import { RLP } from '../../encoding';
 
 /**
  * Transaction gas constants
- * @public
  */
 const TRANSACTIONS_GAS_CONSTANTS = {
     /**
      * Default gas for a transaction
+     * @internal
      */
     TX_GAS: 5000,
 
     /**
      * Default gas for a clause
+     * @internal
      */
     CLAUSE_GAS: 16000,
 
     /**
      * Default gas for a contract creation clause
+     * @internal
      */
     CLAUSE_GAS_CONTRACT_CREATION: 48000,
 
     /**
      * Zero gas data
+     * @internal
      */
     ZERO_GAS_DATA: 4,
 
     /**
      * Non-zero gas data
+     * @internal
      */
     NON_ZERO_GAS_DATA: 68
 };
 
 /**
  * Main transaction fields
- * @private
+ * @internal
  */
 const TRANSACTION_FIELDS = [
     /**
@@ -96,7 +100,7 @@ const TRANSACTION_FIELDS = [
 
 /**
  * Kind for transaction features
- * @public
+ * @internal
  */
 const TRANSACTION_FEATURES_KIND = {
     name: 'reserved.features',
@@ -105,6 +109,7 @@ const TRANSACTION_FEATURES_KIND = {
 
 /**
  * Kind for transaction signature
+ * @internal
  */
 const TRANSACTION_SIGNATURE_KIND = {
     name: 'signature',
@@ -113,7 +118,7 @@ const TRANSACTION_SIGNATURE_KIND = {
 
 /**
  * RLP profiler for simple unsigned transactions
- * @public
+ * @internal
  */
 const UNSIGNED_TRANSACTION_RLP = new RLP.Profiler({
     name: 'tx',
@@ -122,7 +127,7 @@ const UNSIGNED_TRANSACTION_RLP = new RLP.Profiler({
 
 /**
  * RLP profiler for simple signed transactions
- * @public
+ * @internal
  */
 const SIGNED_TRANSACTION_RLP = new RLP.Profiler({
     name: 'tx',
@@ -133,11 +138,13 @@ const SIGNED_TRANSACTION_RLP = new RLP.Profiler({
 
 /**
  * Signature length
+ * @internal
  */
 const SIGNATURE_LENGTH = 65;
 
 /**
  * Block ref field length
+ * @internal
  */
 const BLOCK_REF_LENGTH = 8;
 

diff --git a/packages/core/src/utils/data/types.d.ts b/packages/core/src/utils/data/types.d.ts
@@ -1,8 +1,6 @@
 /**
  * Confirugation for hex values.
  * In particular, whether or not to include the `0x` prefix.
- *
- * @public
  */
 interface HexConfig {
     withPrefix: boolean;

diff --git a/packages/errors/src/model/core/abi.ts b/packages/errors/src/model/core/abi.ts
@@ -75,8 +75,6 @@ class ContractInterfaceError extends ErrorBase<
 
 /**
  * Errors enum.
- *
- * @public
  */
 enum ABI {
     INVALID_FUNCTION = 'INVALID_FUNCTION',

diff --git a/packages/errors/src/model/core/address.ts b/packages/errors/src/model/core/address.ts
@@ -15,8 +15,6 @@ class InvalidAddressError extends ErrorBase<
 
 /**
  * Errors enum.
- *
- * @public
  */
 enum ADDRESS {
     INVALID_ADDRESS = 'INVALID_ADDRESS'

diff --git a/packages/errors/src/model/core/bloom.ts b/packages/errors/src/model/core/bloom.ts
@@ -24,8 +24,6 @@ class InvalidKError extends ErrorBase<BLOOM.INVALID_K, DefaultErrorData> {}
 
 /**
  * Errors enum.
- *
- * @public
  */
 enum BLOOM {
     INVALID_BLOOM = 'INVALID_BLOOM',

diff --git a/packages/errors/src/model/core/certificate.ts b/packages/errors/src/model/core/certificate.ts
@@ -42,8 +42,6 @@ class CertificateInvalidSignerError extends ErrorBase<
 
 /**
  * Errors enum.
- *
- * @public
  */
 enum CERTIFICATE {
     CERTIFICATE_NOT_SIGNED = 'CERTIFICATE_NOT_SIGNED',
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,8 +2,6 @@ import { type BytesLike } from 'ethers'; @@
     /**
      * Input to hash function.
-     *
-     * @public
      */
     type HashInput = BytesLike;
@@ Expand Down @@
Title	Tests	Time
core	319	1m 16s ⏱️
network	71	37.986s ⏱️
errors	30	9.383s ⏱️