mirror of
https://github.com/privacy-scaling-explorations/p0tion.git
synced 2026-04-21 03:00:07 -04:00
a6dcd6862e
* V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * V1.1.1 (#98) * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo * V1.1.1 * V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Separate deployment and testing --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Dev (#100) * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo * V1.1.1 * V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Separate deployment and testing --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> * Separate deploy and test (#99) --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * merge(dev) - ready to deploy on staging (#109) * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo * V1.1.1 * V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Separate deployment and testing --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> * Separate deploy and test (#99) * feat(setup): non interactive setup with artifacts download * feat(setup): add cloud function for file transfer and unit tests * feat(setup): add transfer of object inside phase2cli * feat(setup): remove return value and amend tests * fix(setup): revert transfer of object and add region to config * feat(setup) fix test template * fix(setup): fix not waiting for file download * fix(setup): remove redundant function * chore(release): publish 1.0.1 * fix(vms): specify region in sns command * fix(vms) - missing param * fix(vms): missing doc * fix(vms): fix default region * chore(release): publish 1.0.2 * fix(setup): fix vm command due to differences in AMI config between regions * chore(release): publish 1.0.4 * fix (ceremony) - fix various bugs (#116) * fix(setup): add spinners * fix(bugs): fix backend and cli bugs * fix(regions): move cloud functions to same region as firestore and s3 * fix(tests): add new region on test utils --------- Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: daodesigner <designerdao.eth@gmail.com> * merge dev (#123) * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo * V1.1.1 * V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Separate deployment and testing --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> * Separate deploy and test (#99) * feat(setup): non interactive setup with artifacts download * feat(setup): add cloud function for file transfer and unit tests * feat(setup): add transfer of object inside phase2cli * feat(setup): remove return value and amend tests * fix(setup): revert transfer of object and add region to config * feat(setup) fix test template * fix(setup): fix not waiting for file download * fix(setup): remove redundant function * chore(release): publish 1.0.1 * fix(vms): specify region in sns command * fix(vms) - missing param * fix(vms): missing doc * fix(vms): fix default region * chore(release): publish 1.0.2 * fix(setup): fix vm command due to differences in AMI config between regions * chore(release): publish 1.0.4 * fix (ceremony) - fix various bugs (#116) * fix(setup): add spinners * fix(bugs): fix backend and cli bugs * fix(regions): move cloud functions to same region as firestore and s3 * fix(tests): add new region on test utils * Ensure all CFs are deployed into `europe-west1` region * fix(verification): set concurrency to 1 and ensure that files are downloaded * chore(release): publish 1.0.5 (#120) * fix(verify): revert removing concurrency and add unique filenames (#122) --------- Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: daodesigner <designerdao.eth@gmail.com> * Promote dev into staging (#126) * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo * V1.1.1 * V1.1 * fix: set cli as a es module * fix: bump 0.3.0; minor missing imports for enums * feat (EC2-demo) testing VMs * feat(ec2) - continuing with poc * fix(sybil) - add tests * fix(sybil) - added prod test switch * build: update external packages dependencies * feat(public ceremonies) - allow to download ceremony data to everyone * refactor: move auto-generated types to root * refactor: improve package configuration; remove unused files * refactor: complete configuration; lint and small fix * fix: wrong prod Firebase project for CI * refactor: update phase2cli package config; fixed bin overwrite when installing * refactor: use meta import to optimize repository file read * refactor: use ts-node instead of dist to execute phase2cli * refactor: update .env and package.json imports * fix: wrong path for environment config file * fix(public-data) remove cloud function * fix(public-data) remove function from index.ts * fix(public data) yarn.locl * fix: missing skipLibCheck option was causing docs script to exit * fix: add missing options to ts config * chore(release): publish 0.3.0 * build: update yarn version * fix: spinner does not stop correctly after contribution verification * chore(release): publish 0.3.1 * fix: missing updates for current contributor fields when coordinating * fix: duplicate messages when waiting for contribution; remove wrong listener * chore(release): publish 0.3.5 * fix(sybil checks): amended env var name and added to the backend * fix(s3): creating public bucket with object ACL enabled configuring S3 to allow download of verification transcript * fix(tests): fixed tests * fix: unconsistency when resuming a contribution * fix: add missing alternative case; fix wrong tests * chore(release): publish 0.4.0 * fix: wrong ci env project * fix: missing sort for ceremony circuits * fix: wrong document property lead to error when checking github antisybil * build: missing dependencies on actions package * chore(release): publish 0.4.1 * chore(release): publish 0.4.2 * test: update github anti-sybil tests * fix(ux): added more verbose messages to inform the user of waiting times and errors * feat(ec2): added tests and ip function * feat(ec2): merge udpates and add tests * feat(vms): added ssm code and more tests + changes on backend * feat(vms): refactoring * fix: imports and package version * feat(vms): added tests * fix(vms): tests * feat(ec2): fixed bug in running commands at deployment and refactored setup * test(ec2): added setup e2e test * fix(vms): refactoring and code fixes * fix(vm): bug fix * fix(vm): missing files * feat(vms): implemented e2e test for contribution verification * feat(vms): tests and refactoring * fix(vms): remove redundant code * test(vms): completed e2e tests with VMs * fix(vms): cleanup test * fix(vms): remove redundant parameter on VM startup - ssh keypair * fix(vms): add tags on EC2 creation * refactor: add missing hash computation; minor conflicts and changes * fix(vms): fix VM commands * test(vms): fix test to also delete the verification transcript * chore: publish 0.4.7 * test(vms): refactoring of VM tests with extra debug options * test(vms): fixed finalize test and cloud function. Adding extra debugging for verification * fix(vms): fixed wrong path in blake3 bin command and various fixes on the verification CF * chore: publish 0.4.8 * fix(vms): removed stdin/stdout redirection in VM command and added regex match for blake3 hash * fix(vms): fixed cloud function for VM verification * chore: publish 0.4.9 * fix(vms): fix cloud function bug related to the wrong verification transcript path * test(vms): fix broken tests due to VM upgrade * fix(vms): disable eslint rule for regex * feat(vms): implement SNS topic command to trigger Lambda that stops the VM after initialization * feat(vms): add marker file in userData to avoid running initialization code more than once * fix(vms): fix userData commands * refactor: add VM prices * refactor: add selector for VM disk type * test: update tests * refactor: complete and remove old todos * refactor: add retry mechanism for VM * fix: wrong path to Verifier smart contract template * feat(vms): implement terraform script to deploy AWS inf * fix(vms): fix import error * fix: correct failing tests * fix(vms): fix cloud function multipartupload wrong parameter name * chore: publish 0.4.10 * fix(vms): fix terraform and lambda config * fix(vms): temp revert of retry feature in verifyContribution * fix(vms): fix emulator tests * fix(vms): fix prod tests * refactor: improve verifycontribution function code; minor changes to code readability * fix(vms): fix prod test - wrong parameter order in ec2 tests * chore: publish 0.5.0 * fix: missing else statement for verifycontribution function; wrong return on custom promise * fix(vms): revert part of the verifyContribution refactoring and update terraform * fix(vms): retry mechanism for VM startup * refactor: add options for contribute command * refactor: make coordinator artifacts publicly downloadable by default * chore: update backend firebase default prod project * fix(tests): add extra sleep when setting custom claims to allow propagation * fix(tests): skip a test that would fail due to environment not clean * fix(tests): fix issues with user not being recognized as coordinator * fix(tests): add extra sleep and coordinator checks within tests * refactor: avoid mandatory memory check; add missing loader and messages to improve ux * feat(setup): start to implement non interactive setup * feat(setup): implement non interactive setup * fix(setup): change test file * fix(setup): remove non working test * fix(setup): change setup test file * fix(setup): amend after PR review * feat(setup): add option to pass the authentication token as cli param passing the cli token as param one could easily use p0tion non interactive setup in a CI/CD env like GitHub actions. * fix(tests): add extra coordinator user to resolve random test failure * fix(tests): add extra sleep after user creation * fix(auth): fix non interactive auth and force token refresh for coordinator * fix(setup): fix local path to circuit artifacts + change error in security tests * fix(setup): add missing circuit artifacts local path allow circuit artifacts to be in a separate folder for setup so that it can be used with definitelySetup * fix(tests): fix tests * refactor: improve ux ui of auth and logout commands * feat(setup): add a cli command to validate the ceremony setup file and the constraints * refactor: add spinners to avoid delays; add custom feedback messages for contributor * chore: correct text * feat(list ceremonies): add a command to list all ceremonies * feat(list): exit with code 1 when calling showError with exit=true * fix(tests and setup): fix tests and cleanup config file * chore: publish 1.0.0 * fix(verifycontribution): fix issue with failing to deconstruct undefined object (vm) * Revise workflow * Fix a typo --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: Daehyun Paik <paik@a30a.dev> * Separate deployment and testing --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> * Separate deploy and test (#99) * feat(setup): non interactive setup with artifacts download * feat(setup): add cloud function for file transfer and unit tests * feat(setup): add transfer of object inside phase2cli * feat(setup): remove return value and amend tests * fix(setup): revert transfer of object and add region to config * feat(setup) fix test template * fix(setup): fix not waiting for file download * fix(setup): remove redundant function * chore(release): publish 1.0.1 * fix(vms): specify region in sns command * fix(vms) - missing param * fix(vms): missing doc * fix(vms): fix default region * chore(release): publish 1.0.2 * fix(setup): fix vm command due to differences in AMI config between regions * chore(release): publish 1.0.4 * fix (ceremony) - fix various bugs (#116) * fix(setup): add spinners * fix(bugs): fix backend and cli bugs * fix(regions): move cloud functions to same region as firestore and s3 * fix(tests): add new region on test utils * Ensure all CFs are deployed into `europe-west1` region * fix(verification): set concurrency to 1 and ensure that files are downloaded * chore(release): publish 1.0.5 (#120) * fix(verify): revert removing concurrency and add unique filenames (#122) * ci: add npm publish pipeline * fix(ceremony): fix various bugs * fix(verification): revert download check --------- Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: daodesigner <designerdao.eth@gmail.com> --------- Co-authored-by: daodesigner <58278045+daodesigner@users.noreply.github.com> Co-authored-by: ctrlc03 <93448202+ctrlc03@users.noreply.github.com> Co-authored-by: cedoor <me@cedoor.dev> Co-authored-by: Jeeiii <giacomo.corrias7@gmail.com> Co-authored-by: daodesigner <designerdao.eth@gmail.com>
4.9 KiB
4.9 KiB
Contributing
🎉 Thank you for being interested in contributing to p0tion! 🎉
Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. There is a lot we want to achieve, and this can only be made possible thanks to your support. 👏
Issues
The best way to contribute to our projects is by opening a new issue or tackling one of the issues listed here.
Pull Requests
Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:
-
Fork the repo.
-
Run the tests. We only take pull requests with passing tests.
-
Add a test for your change. Only refactoring and documentation changes require no new tests.
-
Make sure to check out the Style Guide and ensure that your code complies with the rules.
-
Make the test pass.
-
Commit your changes.
-
Push to your fork and submit a pull request on our
devbranch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
CI (Github Actions) Tests
We use GitHub Actions to test each PR before it is merged.
When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.
Please note that CI tests will run on the Firebase emulator, and thus not cover the full suite. Make sure that production tests run first, as these will be checked by the maintainers before any code review. For reference, production tests can be run with yarn test:prod.
Style Guide
Code rules
We always use ESLint and Prettier. To check that your code follows the rules, simply run the npm script yarn lint. When committing, eslint is run automatically, so you will be required to fix any error before being able to push a commit. We highly recommend to tackle warnings as well.
Commits rules
For commits it is recommended to use Conventional Commits.
Don't worry if it looks complicated, after git add, git commit will make the next steps interactive.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header must contain the name of the component you are working on.
Type
The type must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
- perf: A code change that improves the performance
- test: Adding missing or correcting existing tests
- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
- chore: Other changes that don't modify src or test files
- revert: Reverts a previous commit
Scope
The scope should be the name of the feature or package modified (as perceived by the person reading the changelog generated from commit messages).
Subject
The subject contains a succinct description of the change:
- Use the imperative, present tense: "change" not "changed" nor "changes"
- Don't capitalize the first letter
- No dot (.) at the end
Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Branch rules
- There must be a
mainbranch, used only for the releases. - There must be a
devbranch, used to merge all the branches under it. - Avoid long descriptive names for long-lived branches.
- Use kebab-case (no CamelCase).
- Use grouping tokens (words) at the beginning of your branch names (in a similar way to the
typeof commit). - Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
- Use slashes to separate parts of your branch names.
- Remove branch after merge if it is not important.
Examples:
git branch -b docs/readme
git branch -b test/a-feature
git branch -b feat/sidebar
git branch -b fix/b-feature