feat(typedoc) - add typedoc to the repo #755

ctrlc03 · 2023-10-19T15:28:54Z

baumstern · 2023-10-26T01:20:28Z

Before we proceed with this PR, could you please elaborate on the benefits of adding typedoc in the associated issue?

ctrlc03 · 2023-10-27T22:45:23Z

Before we proceed with this PR, could you please elaborate on the benefits of adding typedoc in the associated issue?

replied on the issue..

baumstern · 2023-10-30T11:10:39Z

Before we proceed with this PR, could you please elaborate on the benefits of adding typedoc in the associated issue?

replied on the issue..

First off, great initiative on adding TypeDoc for auto-generating documentation. This could be a huge win for developer experience and maintainability of this project. However, I do have some clarifications I'd like to ask about this PR:

I see that HTML files have been added to the PR. Is the expectation that developers will run the TypeDoc generation script manually before raising each PR to update these?
If we're committing to hosting this on GitHub Pages, will the setup for that be handled in a separate PR or task?

ctrlc03 · 2023-10-30T11:15:24Z

Before we proceed with this PR, could you please elaborate on the benefits of adding typedoc in the associated issue?

replied on the issue..

First off, great initiative on adding TypeDoc for auto-generating documentation. This could be a huge win for developer experience and maintainability of this project. However, I do have some clarifications I'd like to ask about this PR:

I see that HTML files have been added to the PR. Is the expectation that developers will run the TypeDoc generation script manually before raising each PR to update these?

If we're committing to hosting this on GitHub Pages, will the setup for that be handled in a separate PR or task?

this could be done via the CI, a pre commit hook, etc. We should document this feature for sure
Evaluate MACI documentation needs #780 there is a separate issue tracking how we can aggregate documentation and/or host it going forward

baumstern · 2023-11-01T04:04:22Z

I wonder if it might be more common for users to view TypeDoc files via a web page rather than opening HTML files locally. Perhaps it could be beneficial to automatically generate the latest documentation and serve it through a web page. Then we don't have to include html files in our VCS. What are your thoughts on this approach?

ctrlc03 · 2023-11-01T08:55:02Z

I wonder if it might be more common for users to view TypeDoc files via a web page rather than opening HTML files locally. Perhaps it could be beneficial to automatically generate the latest documentation and serve it through a web page. Then we don't have to include html files in our VCS. What are your thoughts on this approach?

Yea exactly what is mentioned in the comment above. For now the typedocs are saved in the docs folder, which is hosted via github pages -> one could navigate through there but it's not very user friendly without any navbar to navigate there directly. Hence we need to think about how we will display all our documentation going forward.

samajammin · 2023-11-02T13:10:49Z

Nice @ctrlc03 !

Are you able to generate the pages locally?

I tried pulling this down locally & running it. Got these errors:

~/code/pse/maci on  feat/typedocs via ⬢ v18.18.2
➜ npm run docs

> [email protected] docs
> typedoc --options typedoc.json

circuits/ts/__tests__/Hasher.test.ts:201:17 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

201                 random50bitBigInt(),
                    ~~~~~~~~~~~~~~~~~~~

circuits/ts/__tests__/MessageToCommand.test.ts:36:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

36             random50bitBigInt(),
               ~~~~~~~~~~~~~~~~~~~

circuits/ts/__tests__/TallyVotes.test.ts:264:22 - error TS2554: Expected 1 arguments, but got 0.

264                 poll.processMessages()
                         ~~~~~~~~~~~~~~~~~

  core/build/MaciState.d.ts:74:23
    74     processMessages: (_pollId: number) => any;
                             ~~~~~~~~~~~~~~~
    An argument for '_pollId' was not provided.

circuits/ts/__tests__/utils.ts:4:8 - error TS2307: Cannot find module 'circom-helper' or its corresponding type declarations.

4 } from 'circom-helper'
         ~~~~~~~~~~~~~~~

cli/ts/genProofs.ts:8:10 - error TS2305: Module '"maci-core"' has no exported member 'genTallyResultCommitment'.

8 import { genTallyResultCommitment } from 'maci-core'
           ~~~~~~~~~~~~~~~~~~~~~~~~

cli/ts/genProofs.ts:235:9 - error TS2740: Type 'Promise<any>' is missing the following properties from type 'VerifyingKey': alpha1, beta2, gamma2, delta2, and 4 more.

235         subsidyVk = extractVk(args.subsidy_zkey)
            ~~~~~~~~~

cli/ts/verify.ts:3:10 - error TS2305: Module '"maci-core"' has no exported member 'genTallyResultCommitment'.

3 import { genTallyResultCommitment } from 'maci-core'
           ~~~~~~~~~~~~~~~~~~~~~~~~

contracts/ts/__tests__/AccQueue.test.ts:398:53 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

398     const aq = new AccQueue(SUB_DEPTH, HASH_LENGTH, ZERO)
                                                        ~~~~

contracts/ts/__tests__/AccQueueBenchmark.test.ts:35:53 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

35     const aq = new AccQueue(SUB_DEPTH, HASH_LENGTH, ZERO)
                                                       ~~~~

contracts/ts/__tests__/MACI.test.ts:91:5 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

91     maxUsers: 25,
       ~~~~~~~~~~~~

contracts/ts/__tests__/MACI.test.ts:599:17 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

599                 maxValues.maxVoteOptions,
                    ~~~~~~~~~~~~~~~~~~~~~~~~

contracts/ts/__tests__/MACI.test.ts:666:53 - error TS2554: Expected 0 arguments, but got 1.

666             const generatedInputs = poll.tallyVotes(pollId)
                                                        ~~~~~~

contracts/ts/__tests__/MACI_overflow.test.ts:29:5 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

29     maxUsers: 25,
       ~~~~~~~~~~~~

contracts/ts/__tests__/MACI_overflow.test.ts:132:13 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

132             maxUsers: 25,
                ~~~~~~~~~~~~

contracts/ts/genZerosContract.ts:39:38 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

39                 hashed = sha256Hash([z, z])
                                        ~

contracts/ts/genZerosContract.ts:39:41 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

39                 hashed = sha256Hash([z, z])
                                           ~

contracts/ts/genZerosContract.ts:41:38 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                        ~

contracts/ts/genZerosContract.ts:41:41 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                           ~

contracts/ts/genZerosContract.ts:41:44 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                              ~

contracts/ts/genZerosContract.ts:41:47 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                                 ~

contracts/ts/genZerosContract.ts:41:50 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                                    ~

contracts/ts/genZerosContract.ts:45:40 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

45                 hashed = hashLeftRight(z, z)
                                          ~

contracts/ts/genZerosContract.ts:47:33 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                   ~

contracts/ts/genZerosContract.ts:47:36 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                      ~

contracts/ts/genZerosContract.ts:47:39 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                         ~

contracts/ts/genZerosContract.ts:47:42 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                            ~

contracts/ts/genZerosContract.ts:47:45 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                               ~

core/ts/MaciState.ts:860:13 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

860             newSubsidyCommitment
                ~~~~~~~~~~~~~~~~~~~~

core/ts/MaciState.ts:1157:48 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1157         return hashLeftRight(resultsTree.root, _salt)
                                                    ~~~~~

core/ts/MaciState.ts:1174:40 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1174         return hashLeftRight(subtotal, _salt)
                                            ~~~~~

core/ts/MaciState.ts:1212:48 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1212         return hashLeftRight(resultsTree.root, _salt)
                                                    ~~~~~

core/ts/MaciState.ts:1382:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1382             _initialVoiceCreditBalance,
                 ~~~~~~~~~~~~~~~~~~~~~~~~~~

core/ts/MaciState.ts:1591:37 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1591     return hashLeftRight(tree.root, salt)
                                         ~~~~

domainobjs/ts/index.ts:415:12 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

415            ...[this.msgType],
               ~~~~~~~~~~~~~~~~~

domainobjs/ts/index.ts:416:12 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

416            ...this.data,
               ~~~~~~~~~~~~

domainobjs/ts/index.ts:417:12 - error TS2322: Type 'bigint | BigInt' is not assignable to type 'bigint'.
  Type 'BigInt' is not assignable to type 'bigint'.

417            ..._encPubKey.rawPubKey,
               ~~~~~~~~~~~~~~~~~~~~~~~

domainobjs/ts/index.ts:473:30 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

473         return hashLeftRight(vals[0], vals[1])
                                 ~~~~~~~

domainobjs/ts/index.ts:618:22 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Plaintext'.
  Type 'BigInt' is not assignable to type 'bigint'.

618         return hash4(this.asArray())
                         ~~~~~~~~~~~~~~

domainobjs/ts/index.ts:793:22 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Plaintext'.

793         return hash4(this.asArray())
                         ~~~~~~~~~~~~~~

domainobjs/ts/index.ts:803:41 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

803         return sign(privKey.rawPrivKey, this.hash())
                                            ~~~~~~~~~~~

domainobjs/ts/index.ts:817:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

817             this.hash(),
                ~~~~~~~~~~~

domainobjs/ts/index.ts:846:48 - error TS2345: Argument of type '(bigint | BigInt)[]' is not assignable to parameter of type 'Plaintext'.
  Type 'bigint | BigInt' is not assignable to type 'bigint'.
    Type 'BigInt' is not assignable to type 'bigint'.

846         const ciphertext: Ciphertext = encrypt(plaintext, sharedKey, BigInt(0))
                                                   ~~~~~~~~~

domainobjs/ts/index.ts:861:35 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Ciphertext'.

861         const decrypted = decrypt(message.data, sharedKey, BigInt(0), 7)
                                      ~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:45:13 - error TS2554: Expected 0 arguments, but got 5.

 45             coordinatorKeypair,
                ~~~~~~~~~~~~~~~~~~~
 46             config.constants.maci.stateTreeDepth,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...
 48             config.constants.maci.voteOptionTreeDepth,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 49             config.constants.maci.maxVoteOptions,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:125:19 - error TS2339: Property 'maxUsers' does not exist on type 'MaxValues'.

125         maxValues.maxUsers = config.constants.maci.maxUsers
                      ~~~~~~~~

integrationTests/ts/__tests__/suites.ts:131:13 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

131             (Date.now() + (config.constants.poll.duration * 60000)),
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:163:17 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

163                 Date.now()
                    ~~~~~~~~~~

baumstern · 2023-11-02T14:30:47Z

Nice @ctrlc03 !

Are you able to generate the pages locally?

I tried pulling this down locally & running it. Got these errors:

~/code/pse/maci on  feat/typedocs via ⬢ v18.18.2
➜ npm run docs

> [email protected] docs
> typedoc --options typedoc.json

circuits/ts/__tests__/Hasher.test.ts:201:17 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

201                 random50bitBigInt(),
                    ~~~~~~~~~~~~~~~~~~~

circuits/ts/__tests__/MessageToCommand.test.ts:36:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

36             random50bitBigInt(),
               ~~~~~~~~~~~~~~~~~~~

circuits/ts/__tests__/TallyVotes.test.ts:264:22 - error TS2554: Expected 1 arguments, but got 0.

264                 poll.processMessages()
                         ~~~~~~~~~~~~~~~~~

  core/build/MaciState.d.ts:74:23
    74     processMessages: (_pollId: number) => any;
                             ~~~~~~~~~~~~~~~
    An argument for '_pollId' was not provided.

circuits/ts/__tests__/utils.ts:4:8 - error TS2307: Cannot find module 'circom-helper' or its corresponding type declarations.

4 } from 'circom-helper'
         ~~~~~~~~~~~~~~~

cli/ts/genProofs.ts:8:10 - error TS2305: Module '"maci-core"' has no exported member 'genTallyResultCommitment'.

8 import { genTallyResultCommitment } from 'maci-core'
           ~~~~~~~~~~~~~~~~~~~~~~~~

cli/ts/genProofs.ts:235:9 - error TS2740: Type 'Promise<any>' is missing the following properties from type 'VerifyingKey': alpha1, beta2, gamma2, delta2, and 4 more.

235         subsidyVk = extractVk(args.subsidy_zkey)
            ~~~~~~~~~

cli/ts/verify.ts:3:10 - error TS2305: Module '"maci-core"' has no exported member 'genTallyResultCommitment'.

3 import { genTallyResultCommitment } from 'maci-core'
           ~~~~~~~~~~~~~~~~~~~~~~~~

contracts/ts/__tests__/AccQueue.test.ts:398:53 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

398     const aq = new AccQueue(SUB_DEPTH, HASH_LENGTH, ZERO)
                                                        ~~~~

contracts/ts/__tests__/AccQueueBenchmark.test.ts:35:53 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

35     const aq = new AccQueue(SUB_DEPTH, HASH_LENGTH, ZERO)
                                                       ~~~~

contracts/ts/__tests__/MACI.test.ts:91:5 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

91     maxUsers: 25,
       ~~~~~~~~~~~~

contracts/ts/__tests__/MACI.test.ts:599:17 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

599                 maxValues.maxVoteOptions,
                    ~~~~~~~~~~~~~~~~~~~~~~~~

contracts/ts/__tests__/MACI.test.ts:666:53 - error TS2554: Expected 0 arguments, but got 1.

666             const generatedInputs = poll.tallyVotes(pollId)
                                                        ~~~~~~

contracts/ts/__tests__/MACI_overflow.test.ts:29:5 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

29     maxUsers: 25,
       ~~~~~~~~~~~~

contracts/ts/__tests__/MACI_overflow.test.ts:132:13 - error TS2322: Type '{ maxUsers: number; maxMessages: number; maxVoteOptions: number; }' is not assignable to type 'MaxValues'.
  Object literal may only specify known properties, and 'maxUsers' does not exist in type 'MaxValues'.

132             maxUsers: 25,
                ~~~~~~~~~~~~

contracts/ts/genZerosContract.ts:39:38 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

39                 hashed = sha256Hash([z, z])
                                        ~

contracts/ts/genZerosContract.ts:39:41 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

39                 hashed = sha256Hash([z, z])
                                           ~

contracts/ts/genZerosContract.ts:41:38 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                        ~

contracts/ts/genZerosContract.ts:41:41 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                           ~

contracts/ts/genZerosContract.ts:41:44 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                              ~

contracts/ts/genZerosContract.ts:41:47 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                                 ~

contracts/ts/genZerosContract.ts:41:50 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

41                 hashed = sha256Hash([z, z, z, z, z])
                                                    ~

contracts/ts/genZerosContract.ts:45:40 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

45                 hashed = hashLeftRight(z, z)
                                          ~

contracts/ts/genZerosContract.ts:47:33 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                   ~

contracts/ts/genZerosContract.ts:47:36 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                      ~

contracts/ts/genZerosContract.ts:47:39 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                         ~

contracts/ts/genZerosContract.ts:47:42 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                            ~

contracts/ts/genZerosContract.ts:47:45 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

47                 hashed = hash5([z, z, z, z, z])
                                               ~

core/ts/MaciState.ts:860:13 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

860             newSubsidyCommitment
                ~~~~~~~~~~~~~~~~~~~~

core/ts/MaciState.ts:1157:48 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1157         return hashLeftRight(resultsTree.root, _salt)
                                                    ~~~~~

core/ts/MaciState.ts:1174:40 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1174         return hashLeftRight(subtotal, _salt)
                                            ~~~~~

core/ts/MaciState.ts:1212:48 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1212         return hashLeftRight(resultsTree.root, _salt)
                                                    ~~~~~

core/ts/MaciState.ts:1382:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1382             _initialVoiceCreditBalance,
                 ~~~~~~~~~~~~~~~~~~~~~~~~~~

core/ts/MaciState.ts:1591:37 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

1591     return hashLeftRight(tree.root, salt)
                                         ~~~~

domainobjs/ts/index.ts:415:12 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

415            ...[this.msgType],
               ~~~~~~~~~~~~~~~~~

domainobjs/ts/index.ts:416:12 - error TS2322: Type 'BigInt' is not assignable to type 'bigint'.

416            ...this.data,
               ~~~~~~~~~~~~

domainobjs/ts/index.ts:417:12 - error TS2322: Type 'bigint | BigInt' is not assignable to type 'bigint'.
  Type 'BigInt' is not assignable to type 'bigint'.

417            ..._encPubKey.rawPubKey,
               ~~~~~~~~~~~~~~~~~~~~~~~

domainobjs/ts/index.ts:473:30 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

473         return hashLeftRight(vals[0], vals[1])
                                 ~~~~~~~

domainobjs/ts/index.ts:618:22 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Plaintext'.
  Type 'BigInt' is not assignable to type 'bigint'.

618         return hash4(this.asArray())
                         ~~~~~~~~~~~~~~

domainobjs/ts/index.ts:793:22 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Plaintext'.

793         return hash4(this.asArray())
                         ~~~~~~~~~~~~~~

domainobjs/ts/index.ts:803:41 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

803         return sign(privKey.rawPrivKey, this.hash())
                                            ~~~~~~~~~~~

domainobjs/ts/index.ts:817:13 - error TS2345: Argument of type 'BigInt' is not assignable to parameter of type 'bigint'.

817             this.hash(),
                ~~~~~~~~~~~

domainobjs/ts/index.ts:846:48 - error TS2345: Argument of type '(bigint | BigInt)[]' is not assignable to parameter of type 'Plaintext'.
  Type 'bigint | BigInt' is not assignable to type 'bigint'.
    Type 'BigInt' is not assignable to type 'bigint'.

846         const ciphertext: Ciphertext = encrypt(plaintext, sharedKey, BigInt(0))
                                                   ~~~~~~~~~

domainobjs/ts/index.ts:861:35 - error TS2345: Argument of type 'BigInt[]' is not assignable to parameter of type 'Ciphertext'.

861         const decrypted = decrypt(message.data, sharedKey, BigInt(0), 7)
                                      ~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:45:13 - error TS2554: Expected 0 arguments, but got 5.

 45             coordinatorKeypair,
                ~~~~~~~~~~~~~~~~~~~
 46             config.constants.maci.stateTreeDepth,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...
 48             config.constants.maci.voteOptionTreeDepth,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 49             config.constants.maci.maxVoteOptions,
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:125:19 - error TS2339: Property 'maxUsers' does not exist on type 'MaxValues'.

125         maxValues.maxUsers = config.constants.maci.maxUsers
                      ~~~~~~~~

integrationTests/ts/__tests__/suites.ts:131:13 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

131             (Date.now() + (config.constants.poll.duration * 60000)),
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

integrationTests/ts/__tests__/suites.ts:163:17 - error TS2345: Argument of type 'number' is not assignable to parameter of type 'bigint'.

163                 Date.now()
                    ~~~~~~~~~~

fyi: I was able to generate typedocs.

my environment:

OS: MacOS Ventura 13.4.1
processor arch: M1
Node.js: v18.17.0
npm: 9.6.7

my steps:

cd maci
npm install
npm run bootstrap
npm run build

npm run docs

ctrlc03 · 2023-11-02T14:32:24Z

my environment:

did you run install, bootstrap, build before? @samajammin

samajammin · 2023-11-02T19:34:30Z

Ok so ran:

gco feat/typedocs
npm i

All good, but failed on bootstrap (same issue as earlier this week):

~/code/pse/maci on  feat/typedocs via ⬢ v18.18.2
➜ npm run bootstrap

> [email protected] bootstrap
> lerna bootstrap

lerna notice cli v6.0.3
lerna info Bootstrapping 9 packages
lerna info Installing external dependencies
lerna ERR! npm install exited 1 in 'maci-circuits'
lerna ERR! npm install stderr:
npm ERR! code 1
npm ERR! path /Users/samrichards/code/pse/maci/circuits/node_modules/better-sqlite3
npm ERR! command failed
npm ERR! command sh -c prebuild-install || npm run build-release

So I tried rebasing this branch off dev, which got me past bootstrap step, but then build fails 🤷

~/code/pse/maci on  feat/typedocs [⇕$!] via ⬢ v18.18.2
➜ npm run build

> [email protected] build
> lerna run build

lerna notice cli v6.0.3

    ✔  maci-crypto:build (2s)
    ✔  maci-domainobjs:build (2s)
    ✔  maci-core:build (2s)

    ✖  maci-circuits:build
       > [email protected] build
       > tsc

       ../node_modules/@types/jest/index.d.ts(2,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'beforeEach' must be of type 'HookFunction', but here has type 'Lifecycle'.
       ../node_modules/@types/jest/index.d.ts(4,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'afterEach' must be of type 'HookFunction', but here has type 'Lifecycle'.
       ../node_modules/@types/jest/index.d.ts(5,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'describe' must be of type 'SuiteFunction', but here has type 'Describe'.
       ../node_modules/@types/jest/index.d.ts(7,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'xdescribe' must be of type 'PendingSuiteFunction', but here has type 'Describe'.
       ../node_modules/@types/jest/index.d.ts(8,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'it' must be of type 'TestFunction', but here has type 'It'.
       ../node_modules/@types/jest/index.d.ts(10,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'xit' must be of type 'PendingTestFunction', but here has type 'It'.
       ../node_modules/@types/jest/index.d.ts(11,13): error TS2403: Subsequent variable declarations must have the same type.  Variable 'test' must be of type 'TestFunction', but here has type 'It'.
       ../node_modules/@types/jest/index.d.ts(1198,22): error TS2344: Type 'T' does not satisfy the constraint 'new (...args: any) => any'.
         Type 'abstract new (...args: any) => any' is not assignable to type 'new (...args: any) => any'.
           Cannot assign an abstract constructor type to a non-abstract constructor type.
       ../node_modules/@types/jest/index.d.ts(1199,31): error TS2344: Type 'T' does not satisfy the constraint 'new (...args: any) => any'.
         Type 'abstract new (...args: any) => any' is not assignable to type 'new (...args: any) => any'.
           Cannot assign an abstract constructor type to a non-abstract constructor type.


 ————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  Lerna (powered by Nx)   Ran target build for 7 projects (7s)

    ✔    3/4 succeeded [0 read from cache]

    ✖    1/4 targets failed, including the following:
         - maci-circuits:build

Any ideas?

samajammin · 2023-11-02T19:41:41Z

Here's my env:

~/code/pse/maci on  feat/typedocs [⇕$!] via ⬢ v18.18.2
➜ volta list
⚡️ Currently active tools:

    Node: v18.18.2 (default)
    npm: v10.2.1 (default)
    Yarn: v1.22.19 (default)
    Tool binaries available:
        phase2cli (default)
        ethportocli (default)
        gatsby (default)
        ntl, netlify (default)
        pnpm, pnpx (default)

samajammin · 2023-11-02T19:48:54Z

Also confirming that if I go through everything on dev branch, it completes successfully... 😕

~/code/pse/maci on  dev [$!] via ⬢ v18.18.2
➜ npm run build

> [email protected] build
> lerna run build

lerna notice cli v6.0.3

    ✔  maci-crypto:build (2s)
    ✔  maci-domainobjs:build (2s)
    ✔  maci-core:build (2s)
    ✔  maci-circuits:build (1s)
    ✔  maci-contracts:build (2s)
    ✔  maci-cli:build (2s)
    ✔  maci-integrationtests:build (2s)

 ————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  Lerna (powered by Nx)   Successfully ran target build for 7 projects (13s)

samajammin · 2023-11-02T19:51:27Z

package.json

  },
  "author": "",
  "devDependencies": {
+    "@types/jest": "^29.5.6",


I wonder if this is why builds fail for me? Something related to the jest types is failing...

~/code/pse/maci on  feat/typedocs [⇕$!] via ⬢ v18.18.2 ➜ npm run build > [email protected] build > lerna run build lerna notice cli v6.0.3 ✔ maci-crypto:build (2s) ✔ maci-domainobjs:build (2s) ✔ maci-core:build (2s) ✖ maci-circuits:build > [email protected] build > tsc ../node_modules/@types/jest/index.d.ts(2,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'beforeEach' must be of type 'HookFunction', but here has type 'Lifecycle'. ../node_modules/@types/jest/index.d.ts(4,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'afterEach' must be of type 'HookFunction', but here has type 'Lifecycle'. ../node_modules/@types/jest/index.d.ts(5,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'describe' must be of type 'SuiteFunction', but here has type 'Describe'. ../node_modules/@types/jest/index.d.ts(7,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'xdescribe' must be of type 'PendingSuiteFunction', but here has type 'Describe'. ../node_modules/@types/jest/index.d.ts(8,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'it' must be of type 'TestFunction', but here has type 'It'. ../node_modules/@types/jest/index.d.ts(10,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'xit' must be of type 'PendingTestFunction', but here has type 'It'. ../node_modules/@types/jest/index.d.ts(11,13): error TS2403: Subsequent variable declarations must have the same type. Variable 'test' must be of type 'TestFunction', but here has type 'It'. ../node_modules/@types/jest/index.d.ts(1198,22): error TS2344: Type 'T' does not satisfy the constraint 'new (...args: any) => any'. Type 'abstract new (...args: any) => any' is not assignable to type 'new (...args: any) => any'. Cannot assign an abstract constructor type to a non-abstract constructor type. ../node_modules/@types/jest/index.d.ts(1199,31): error TS2344: Type 'T' does not satisfy the constraint 'new (...args: any) => any'. Type 'abstract new (...args: any) => any' is not assignable to type 'new (...args: any) => any'. Cannot assign an abstract constructor type to a non-abstract constructor type. ———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— > Lerna (powered by Nx) Ran target build for 7 projects (7s) ✔ 3/4 succeeded [0 read from cache] ✖ 1/4 targets failed, including the following: - maci-circuits:build

samajammin · 2023-11-02T19:55:03Z

Ah, interesting, looks like maybe some jest <> mocha clashing on the type defintions?

~/code/pse/maci/circuits on  feat/typedocs [⇕$!] via ⬢ v18.18.2
➜ npm run build

> [email protected] build
> tsc

../node_modules/@types/jest/index.d.ts:2:13 - error TS2403: Subsequent variable declarations must have the same type.  Variable 'beforeEach' must be of type 'HookFunction', but here has type 'Lifecycle'.

2 declare var beforeEach: jest.Lifecycle;
              ~~~~~~~~~~

  node_modules/@types/mocha/index.d.ts:2638:13
    2638 declare var beforeEach: Mocha.HookFunction;
                     ~~~~~~~~~~
    'beforeEach' was also declared here.

samajammin · 2023-11-02T20:00:25Z

This seems to fix the issue: https://stackoverflow.com/questions/55680391/typescript-error-ts2403-subsequent-variable-declarations-must-have-the-same-typ

i.e. adding this to tsconfig.json:

"compilerOptions": {
    "skipLibCheck": true
},

Not sure if we SHOULD add that though... any thoughts? 🤔

samajammin · 2023-11-02T20:08:36Z

So now build passes but still failures running docs 😖

~/code/pse/maci on  feat/typedocs [⇕$!] via ⬢ v18.18.2
➜ npm run docs

> [email protected] docs
> typedoc --options typedoc.json

circuits/ts/__tests__/CalculateTotal.test.ts:12:5 - error TS2304: Cannot find name 'before'.

12     before(async () => {
       ~~~~~~
...

I suspect more mocha/jest clash or import issues?

netlify · 2023-11-03T01:54:02Z

❌ Deploy Preview for candid-cranachan-1cd06a failed.

Name	Link
🔨 Latest commit	`d3981bc`
🔍 Latest deploy log	https://app.netlify.com/sites/candid-cranachan-1cd06a/deploys/6550ad2655e4ef0008c2e997

…e same across all packages

samajammin

Everything now working on my end! I believe #819 fixed all my dependency issues.

baumstern

LGTM

ctrlc03 requested review from baumstern, samajammin and 0xjei October 19, 2023 15:28

ctrlc03 self-assigned this Oct 19, 2023

ctrlc03 linked an issue Oct 23, 2023 that may be closed by this pull request

add typedoc for better TS documentation #754

Closed

ctrlc03 mentioned this pull request Oct 31, 2023

feat(refactor) - refactor the crypto package #749

Merged

7 tasks

baumstern mentioned this pull request Nov 2, 2023

Setup CI to build/publish Typedoc #809

Closed

samajammin reviewed Nov 2, 2023

View reviewed changes

baumstern force-pushed the feat/typedocs branch from e919a70 to 22f0029 Compare November 3, 2023 01:53

samajammin mentioned this pull request Nov 9, 2023

Consolidate testing libraries across the monorepo #818

Closed

5 tasks

ctrlc03 added 2 commits November 12, 2023 10:17

docs(typedocs) - fix build issue and ensure @types/node version is th…

5d95ec0

…e same across all packages

feat(typedoc) - add typedoc to the repo

a89c32f

ctrlc03 force-pushed the feat/typedocs branch from 22f0029 to a89c32f Compare November 12, 2023 10:18

docs(typedoc) - add output folder to .gitignore

3e45203

samajammin approved these changes Nov 12, 2023

View reviewed changes

docs(typedoc) - add missing ts-node dependency on contracts package

d3981bc

baumstern approved these changes Nov 13, 2023

View reviewed changes

baumstern merged commit 16628dd into dev Nov 13, 2023
8 of 11 checks passed

ctrlc03 deleted the feat/typedocs branch November 23, 2023 09:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(typedoc) - add typedoc to the repo #755

feat(typedoc) - add typedoc to the repo #755

ctrlc03 commented Oct 19, 2023

baumstern commented Oct 26, 2023

ctrlc03 commented Oct 27, 2023

baumstern commented Oct 30, 2023

ctrlc03 commented Oct 30, 2023 •

edited

Loading

baumstern commented Nov 1, 2023

ctrlc03 commented Nov 1, 2023

samajammin commented Nov 2, 2023

baumstern commented Nov 2, 2023 •

edited

Loading

ctrlc03 commented Nov 2, 2023 •

edited

Loading

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023

samajammin Nov 2, 2023

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023 •

edited

Loading

samajammin commented Nov 2, 2023

netlify bot commented Nov 3, 2023 •

edited

Loading

samajammin left a comment

baumstern left a comment

feat(typedoc) - add typedoc to the repo #755

feat(typedoc) - add typedoc to the repo #755

Conversation

ctrlc03 commented Oct 19, 2023

baumstern commented Oct 26, 2023

ctrlc03 commented Oct 27, 2023

baumstern commented Oct 30, 2023

ctrlc03 commented Oct 30, 2023 • edited Loading

baumstern commented Nov 1, 2023

ctrlc03 commented Nov 1, 2023

samajammin commented Nov 2, 2023

baumstern commented Nov 2, 2023 • edited Loading

ctrlc03 commented Nov 2, 2023 • edited Loading

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023

samajammin Nov 2, 2023

Choose a reason for hiding this comment

samajammin commented Nov 2, 2023

samajammin commented Nov 2, 2023 • edited Loading

samajammin commented Nov 2, 2023

netlify bot commented Nov 3, 2023 • edited Loading

❌ Deploy Preview for candid-cranachan-1cd06a failed.

samajammin left a comment

Choose a reason for hiding this comment

baumstern left a comment

Choose a reason for hiding this comment

ctrlc03 commented Oct 30, 2023 •

edited

Loading

baumstern commented Nov 2, 2023 •

edited

Loading

ctrlc03 commented Nov 2, 2023 •

edited

Loading

samajammin commented Nov 2, 2023 •

edited

Loading

netlify bot commented Nov 3, 2023 •

edited

Loading