joincivil / civil Goto Github PK

• TMZ challenge exposes bug

• The DApp is deployed to https://joincivil.github.io/Civil, however, react-router only works correctly when Civil is removed from the end of the URL.
• The DApp should work correctly with https://joincivil.github.io/Civil as the root/homepage

• Right now, if a branch is pushed that breaks something (or has no tests, such as the gh-pages branch), the badge shown in the README of the root of monorepo shows an error.
• The badge should only reflect the status of the last master build, not any branch

lerna run test is not a best way to run tests, as lerna has problem with printing them to CLI in a fashionable manner.

@walfly suggested using this code as a way around this.

echo */package.json | \
xargs -n1 dirname | \
xargs -n1 -I % \
sh -c "cd % && npm install && npm run lint && npm test || exit 255"

Multiple packages in the monorepo have .circleci rules from when they were seperate git repos. A way to build all packages, seperatly lint all packages and test all packages are needed.

When that's done, .circleci rules need to be written for testing all packages

• on branch nickreynolds/tcr_wrapper I made some changed to debug-ui, separating functionality into different pages
• When I try to use "fs" in any file in the code folder, I get the error Module not found: Error: Can't resolve 'fs' in '/Users/nickreynolds/Civil/Civil/packages/debug-ui/src/code' even though it has definitely been added, and that's reflected in package.json
• I think this has something to do with the gulpfile, but I'm not sure how to fix it

• UI shows token balance of 0 (and voting balance of 0) when there is no metamask account unlocked
• should say "no metamask account found" and block drawer as well

• https://medium.com/metamask/https-medium-com-metamask-breaking-change-injecting-web3-7722797916a8
• we should replace the user-balance section with a button/link that kicks off this enable flow

• transactions could take much longer than 1-3 minutes and we should try to have more helpful text

• was viewing listing awaiting appeal as member of council, switched accounts in metamask and the page crashed
• stack trace indicates a is undefined and issue is related to getUserChallengesWithUnrevealedVotes

There's a bug in truffle test that makes our tests fail randomly, fixing it is of utmost importance due to hugely increased rates of circleci tests failing.

• It is easy to deploy a Newsroom contract via the Factory, but right now the Newsroom contract wrapper doesn't support applying to the TCR (or other listing owner transactions) via the multisig proxy. Once we get that support, we can use the factory again.

• on branch nickreynolds/tcr_wrapper I've made changes to debug-ui to support testing TCR transactions.
• After deploying a newsroom, you are taken to a page for that newsroom where you can attempt to apply to the TCR, but that fails (check console log).
• Error message doesn't seem too helpful on debug-ui, but I first encountered issue on civil-web and got the Invalid number of arguments to Solidity function error. I've tried other functions as well (like deposit) but they also fail.
• Adding some logging that leads me to believe the issue is related to estimate gas sync. Doesn't seem to get past that point.

• The code coverage test takes a long time and it can be annoying to wait for it when you know there will be no changes.
• We should only run that check when there are changes in the contracts package, since that is the only way the code coverage could change.

• when user tries to submit transaction with no account found, should be prompted to unlock metamask
• if metamask not found, should be prompted to download it

• right now, before generating .ts wrappers in core, the artifacts must be copied over manually from contracts package. When we migrate contracts via truffle, the artifacts in core become outdated, and don't contain correct per-network deployed addresses.
• modify build process so that artifacts are kept in sync between the 2 packages, so that when accessing deployed addresses via core we have the most recent deployed contracts.

• so user doesn't have to input which way they voted
• double check that it's part of calendar meeting too

Currently debug-ui is not yet tested or functional, to make it work, it needs to be able to display an article.
Load newsroom, load a specific article from there and than parse it as a markdown and display it.

• Listing that had an appeal requested and not granted is ready to complete, but the listing card doesn't show that

Newsroom-manager has a Civil context, which creates a separate instance of Civil for it's own purposes. This is especially noticeable in the DApp, when both the Newsroom Manager and DApp listen for network and account updates duplicating calls

• user is redirected to listing page after apply transaction completes, but it doesn't populate with data

Sometimes gas estimates from web3 are too low for the call to succeed which then throws a EVM error. Add a safe minimum to the estimated gas to avoid this problem, decide whether this should be a constant or a multiplier.

• current TMZ challenge exposes this bug

Right now ACL-based contracts have a lot of separate logic for maintaining superusers. By leveraging multi-sig wallets we can obtain the same functionality while still maintaining separation of concerns as well as having a singe contract acting as a Will of ACL-based contracts.

ACLs would have a single owner, god contract, that in most of the cases be a multi-sig wallet

In PR #484, two breaking changes were made regarding Newsroom Charters:

• the schema for Newsroom Charters was changed
• an update was made to @joincivil/core to parse the charter content from IPFS into a JS object directly in core. previously, this field was a string and the DApp was parsing that string into an object.

PR #500 was merged as a temporary fix for rendering legacy charter data, but the DApp needs to be updated to use the new Charter schema

Dependabot couldn't authenticate with registry.npmjs.org.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

You can mention @dependabot in the comments below to contact the Dependabot team.

Right now contract tests (packages/contrats/test) use Truffle wrappers on all contracts we have, while our library (packages/civil.ts) has better support for compile time errors.

Using one wrapper in both places would decrease the amount of dependencies we have and increase security due to possible different behaviours of both. Using our own abi-generated contracts is a preferable option, so updating contract tests is better

The main monorepo doesn't have a readable and one with core information needed readme. Stuff like explaining what's here, how is it useful, how to use it in your project, how to start contributing, licenses, stuff like this.

Things needed for new developers to become on-board and are able to use and contribute to our packages effectively

Typescript 2.9 and later changes on how the JSON files are imported. Due to lack of time we've decided to freeze the version to <2.9.0 but in the future we'd be happy to updated it to the newest version.

Work needed to be done:

• Update all package.json
• Add support for esModuleInterop
• Update all packages to use esModuleInterop
• Add support for resolveJsonModule
• Update all imports to use esModuleInterop
• Add support for declarationMap
• Fix all dependencies

• The Drawer should not open when the login button is pressed (button should consume click)
• In fact, the drawer should not be able to be opened when there is no account

• Add unit tests to increase code coverage
• Use this issue to keep track of increases in coverage, not only when we hit 100% (which might be nearly impossible)

• your open PR might already address this

Each open-source has either Apache 2.0 or LGPLv2.1 license in it. Add those licenses to the respective packages, package.json and explain in the main Monorepo README

Solhint doesn't error-out on a glob usage.

We previously used glob src/contracts/**/*.sol which is not parsed properly, linting only contracts in subfolders, omitting main ones. Proper linting path is needed (src/contracts/*.sol src/contracts/test/*.sol).

This also introduces 500+ (!) linting errors and warnings into our codebase which all need to be fixed.

When a package.json inside packages/* change, the cache key doesn't change, meaning CircleCI builds use outdates node_modules/ folder

• FOAM does this on their DApp and it appears to be the intended design, I imagine this is easy to implement but haven't found documentation for it

• previously we were able to get the DApp to load in Safari and other browsers without injected web3, using infura's websockets. At some point that stopped working, but it would be great to get it back.

• this is no longer a parameter, should be removed from UI and anywhere else

If the user leaves fields blank in these views, they are still able to click the transaction button and the transaction silently fails in the UI.

So we need to add some validation that disables the transaction button and message the user about missing fields.

Currently the only way to store and load content is through InMemoryProvider, an abstraction of ContentProvider, which destroys the content on website refresh. We need a more permanent way to store content in a way that allows easy debugging and editing.

Using Gists for this scenario is pretty cheeky and a functional and easy to maintain way to achieve this goal. A new implementation of a ContentProvider is needed.

Currently to use our packages in Typescript projects, the end user has to include @joincivil/typescript-typings package in their typeRoots directive of Typescript.

This is not a standard step and might confuse users, removing it would greatly benefit on-boarding of new developers.

My own suggestion is to find a way on how to pack all the custom and used types from @joincivil/typescript-typings into one .d.ts file.

• Right now listings "awaiting appeal challenge" don't make it very clear that the appeal has been granted (even though logically it must have been)

• after performing the updateStatus transaction on a newsroom that should be whitelisted, the page does not update properly once the transaction is confirmed, have to refresh page to get correct data

• Right now Listings in the judge appeal phase (awaiting council decision) have cards that don't show anything about the phase
• There should be a countdown and something that says "awaiting council decision"