Skip to content

Commit 0a94b66

Browse files
Chore/223 (#290)
* chore: missing docs * chore: remove public --------- Co-authored-by: Fabio Rigamonti <73019897+fabiorigam@users.noreply.github.com>
1 parent 7a7b173 commit 0a94b66

39 files changed

+143
-159
lines changed

package.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"format": "turbo format",
1616
"test:examples": "turbo test:examples",
1717
"merge-coverage": "ts-node scripts/merge-coverage.ts",
18-
"generate:apidocs": "typedoc --options typedoc.json --logLevel Verbose"
18+
"generate:apidocs": "typedoc --options typedoc.json --logLevel Error",
19+
"generate:apidocs-debug": "typedoc --options typedoc.json --logLevel Verbose --plugin typedoc-plugin-missing-exports --validation.notDocumented"
1920
},
2021
"private": true,
2122
"workspaces": [
@@ -50,6 +51,7 @@
5051
"tsup": "^7.2.0",
5152
"turbo": "^1.10.15",
5253
"typedoc": "^0.25.3",
54+
"typedoc-plugin-missing-exports": "^2.1.0",
5355
"typescript": "*"
5456
}
5557
}

packages/core/src/abi/fragment.ts

-7
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,11 @@ class Function<ABIType> {
4747
/**
4848
* The main fragment handled by ethers.js.
4949
*
50-
* @public
5150
*/
5251
public fragment: FunctionFragment;
5352

5453
/**
5554
* The main interface handled by ethers.js.
56-
*
57-
* @public
5855
*/
5956
public iface: Interface;
6057

@@ -146,15 +143,11 @@ class Function<ABIType> {
146143
class Event<ABIType> {
147144
/**
148145
* The main fragment handled by ethers.js.
149-
*
150-
* @public
151146
*/
152147
public fragment: ethers.EventFragment;
153148

154149
/**
155150
* The main interface handled by ethers.js.
156-
*
157-
* @public
158151
*/
159152
public iface: Interface;
160153

packages/core/src/abi/types.d.ts

-12
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,33 @@ import { type ethers } from 'ethers';
22

33
/**
44
* Represents a wrapped Param Type for ethers.js types.
5-
*
6-
* @public
75
*/
86
type ParamType = ethers.ParamType;
97

108
/**
119
* Represents a wrapped Function Fragment for ethers.js types.
12-
*
13-
* @public
1410
*/
1511
type FunctionFragment = ethers.FunctionFragment;
1612

1713
/**
1814
* Represents a wrapped Interface for ethers.js types.
19-
*
20-
* @public
2115
*/
2216
type Interface = ethers.Interface;
2317

2418
/**
2519
* Represents a wrapped Result for ethers.js types.
2620
* It represents the decoded data from a transaction (after decoding).
27-
*
28-
* @public
2921
*/
3022
type Result = ethers.Result;
3123

3224
/**
3325
* Represents a wrapped BytesLike for ethers.js types.
34-
*
35-
* @public
3626
*/
3727
type BytesLike = ethers.BytesLike;
3828

3929
/**
4030
* Represents a wrapped FormatType for ethers.js types.
4131
* It is used to represents the format of the signature of a function.
42-
*
43-
* @public
4432
*/
4533
type FormatType = ethers.FormatType;
4634

packages/core/src/hash/types.d.ts

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ import { type BytesLike } from 'ethers';
22

33
/**
44
* Input to hash function.
5-
*
6-
* @public
75
*/
86
type HashInput = BytesLike;
97

packages/core/src/hdnode/types.d.ts

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
*
44
* BIP32 HD nodes allow for the derivation of child nodes from a master node,
55
* enabling the generation of a tree structure of key pairs from a single seed.
6-
*
7-
* @public
86
*/
97
interface IHDNode {
108
/**

packages/core/src/keystore/types.d.ts

-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
/**
22
* Types of ciphers for keystore encryption
3-
*
4-
* @public
53
*/
64
type Cipher = 'aes-128-ctr' | 'aes-128-cbc' | 'aes-256-cbc';
75

86
/**
97
* Scrypt parameters for keystore encryption
10-
*
11-
* @public
128
*/
139
interface ScryptParams {
1410
dklen: number;
@@ -20,8 +16,6 @@ interface ScryptParams {
2016

2117
/**
2218
* PBKDF2SHA256 parameters for keystore encryption
23-
*
24-
* @public
2519
*/
2620
interface PBKDF2SHA256Params {
2721
c: number;
@@ -33,8 +27,6 @@ interface PBKDF2SHA256Params {
3327
/**
3428
* Keystore type.
3529
* Output of encryption function.
36-
*
37-
* @public
3830
*/
3931
interface Keystore {
4032
crypto: {
@@ -55,8 +47,6 @@ interface Keystore {
5547
/**
5648
* Keystore account type
5749
* Output of decryption function.
58-
*
59-
* @public
6050
*/
6151
interface KeystoreAccount {
6252
address: string;

packages/core/src/mnemonic/types.d.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/**
22
* Type of the wordlist size.
33
* Every 4 bytes produce 3 words.
4-
* @public
54
*/
65
type WordlistSizeType = 12 | 15 | 18 | 21 | 24;
76

packages/core/src/transaction/types.d.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/**
22
* Simple type for transaction clause.
3-
* @public
43
*/
54
interface TransactionClause {
65
/**
@@ -25,7 +24,6 @@ interface TransactionClause {
2524

2625
/**
2726
* Type for transaction body.
28-
* @public
2927
*/
3028
interface TransactionBody {
3129
/**
@@ -105,6 +103,9 @@ interface TransactionBody {
105103
* Tx feature bits
106104
*/
107105
features?: number;
106+
/**
107+
* Unused
108+
*/
108109
unused?: Buffer[];
109110
};
110111
}

packages/core/src/utils/const/data.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Zero buffer
3-
* @public
3+
* @internal
44
*
55
* @example ZERO_BUFFER(8) -> 0x00000000 , ... , ZERO_BUFFER(n) -> 0x0...0
66
*/
@@ -9,7 +9,6 @@ const ZERO_BUFFER = (size: number): Buffer => Buffer.alloc(size, 0);
99
/**
1010
* Regular expression for validating hexadecimal strings.
1111
* Allows optional "0x" prefix and validates both lower and uppercase hex characters.
12-
* @public
1312
*/
1413
const HEX_REGEX_OPTIONAL_PREFIX = /^(0x)?[0-9a-fA-F]*$/;
1514

packages/core/src/utils/const/hdnode.ts

-3
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
/**
22
* Default VET derivation path.
3-
* @public
43
*
54
* See https://github.com/satoshilabs/slips/blob/master/slip-0044.md for more info.
65
*/
76
const VET_DERIVATION_PATH = "m/44'/818'/0'/0";
87

98
/**
109
* Prefix for extended public key
11-
* @public
1210
*/
1311
const X_PUB_PREFIX = Buffer.from('0488b21e000000000000000000', 'hex');
1412

1513
/**
1614
* Prefix for extended private key
17-
* @public
1815
*/
1916
const X_PRIV_PREFIX = Buffer.from('0488ade4000000000000000000', 'hex');
2017

packages/core/src/utils/const/keystore.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/**
22
* Keystore Scrypt params
3-
* @public
43
*/
54
const SCRYPT_PARAMS = {
65
N: 131072,

packages/core/src/utils/const/mnemonic.ts

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import { type WordlistSizeType } from '../../mnemonic';
22

33
/**
44
* Mnemonic wordlist size
5-
* @public
65
*/
76
const MNEMONIC_WORDLIST_ALLOWED_SIZES: WordlistSizeType[] = [
87
12, 15, 18, 21, 24

packages/core/src/utils/const/network.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ const soloGenesisBlock = {
9797
};
9898

9999
/**
100-
* @ignore since no relevant information is displayed in the documentation
101100
* Constants defining Vechain mainnet and testnet network information
101+
* @internal
102102
*/
103103
const networkInfo = {
104104
mainnet: {

packages/core/src/utils/const/secp256k1.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Biggest value of private key
3-
* @public
3+
* @internal
44
*/
55
const PRIVATE_KEY_MAX_VALUE = Buffer.from(
66
'fffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141',

packages/core/src/utils/const/transaction.ts

+12-5
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,42 @@ import { RLP } from '../../encoding';
22

33
/**
44
* Transaction gas constants
5-
* @public
65
*/
76
const TRANSACTIONS_GAS_CONSTANTS = {
87
/**
98
* Default gas for a transaction
9+
* @internal
1010
*/
1111
TX_GAS: 5000,
1212

1313
/**
1414
* Default gas for a clause
15+
* @internal
1516
*/
1617
CLAUSE_GAS: 16000,
1718

1819
/**
1920
* Default gas for a contract creation clause
21+
* @internal
2022
*/
2123
CLAUSE_GAS_CONTRACT_CREATION: 48000,
2224

2325
/**
2426
* Zero gas data
27+
* @internal
2528
*/
2629
ZERO_GAS_DATA: 4,
2730

2831
/**
2932
* Non-zero gas data
33+
* @internal
3034
*/
3135
NON_ZERO_GAS_DATA: 68
3236
};
3337

3438
/**
3539
* Main transaction fields
36-
* @private
40+
* @internal
3741
*/
3842
const TRANSACTION_FIELDS = [
3943
/**
@@ -96,7 +100,7 @@ const TRANSACTION_FIELDS = [
96100

97101
/**
98102
* Kind for transaction features
99-
* @public
103+
* @internal
100104
*/
101105
const TRANSACTION_FEATURES_KIND = {
102106
name: 'reserved.features',
@@ -105,6 +109,7 @@ const TRANSACTION_FEATURES_KIND = {
105109

106110
/**
107111
* Kind for transaction signature
112+
* @internal
108113
*/
109114
const TRANSACTION_SIGNATURE_KIND = {
110115
name: 'signature',
@@ -113,7 +118,7 @@ const TRANSACTION_SIGNATURE_KIND = {
113118

114119
/**
115120
* RLP profiler for simple unsigned transactions
116-
* @public
121+
* @internal
117122
*/
118123
const UNSIGNED_TRANSACTION_RLP = new RLP.Profiler({
119124
name: 'tx',
@@ -122,7 +127,7 @@ const UNSIGNED_TRANSACTION_RLP = new RLP.Profiler({
122127

123128
/**
124129
* RLP profiler for simple signed transactions
125-
* @public
130+
* @internal
126131
*/
127132
const SIGNED_TRANSACTION_RLP = new RLP.Profiler({
128133
name: 'tx',
@@ -133,11 +138,13 @@ const SIGNED_TRANSACTION_RLP = new RLP.Profiler({
133138

134139
/**
135140
* Signature length
141+
* @internal
136142
*/
137143
const SIGNATURE_LENGTH = 65;
138144

139145
/**
140146
* Block ref field length
147+
* @internal
141148
*/
142149
const BLOCK_REF_LENGTH = 8;
143150

packages/core/src/utils/data/types.d.ts

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
/**
22
* Confirugation for hex values.
33
* In particular, whether or not to include the `0x` prefix.
4-
*
5-
* @public
64
*/
75
interface HexConfig {
86
withPrefix: boolean;

packages/errors/src/model/core/abi.ts

-2
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,6 @@ class ContractInterfaceError extends ErrorBase<
7575

7676
/**
7777
* Errors enum.
78-
*
79-
* @public
8078
*/
8179
enum ABI {
8280
INVALID_FUNCTION = 'INVALID_FUNCTION',

packages/errors/src/model/core/address.ts

-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ class InvalidAddressError extends ErrorBase<
1515

1616
/**
1717
* Errors enum.
18-
*
19-
* @public
2018
*/
2119
enum ADDRESS {
2220
INVALID_ADDRESS = 'INVALID_ADDRESS'

packages/errors/src/model/core/bloom.ts

-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ class InvalidKError extends ErrorBase<BLOOM.INVALID_K, DefaultErrorData> {}
2424

2525
/**
2626
* Errors enum.
27-
*
28-
* @public
2927
*/
3028
enum BLOOM {
3129
INVALID_BLOOM = 'INVALID_BLOOM',

packages/errors/src/model/core/certificate.ts

-2
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ class CertificateInvalidSignerError extends ErrorBase<
4242

4343
/**
4444
* Errors enum.
45-
*
46-
* @public
4745
*/
4846
enum CERTIFICATE {
4947
CERTIFICATE_NOT_SIGNED = 'CERTIFICATE_NOT_SIGNED',

0 commit comments

Comments
 (0)