The unlock from unlock-protocol

remove after we have implemented a CSS template using styled-component

Lines 4 to 9 in ed90342

    
            * TODO remove after we have implemented a CSS template using styled-component 
        
            */ 
        
           @import url('https://fonts.googleapis.com/css?family=IBM+Plex+Sans:400,500,600,700'); 
        
           @import url('https://fonts.googleapis.com/css?family=IBM+Plex+Mono:200,500');

This issue was generated by todo based on a `TODO` comment in `ed90342` when #236 was merged. cc @unlock-protocol.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Stricter Lint rules

The current lint rules are fairly limited. We need a set of much stricter rules.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Allowing Lock owners to update the price of keys

The keyPrice for each Lock is set upon creation of the Lock smart contract.
We expect most creators to actually "price" the keys to their lock based on a fiat value ($ or else). As such we should allow creators to update the price of the keys (keyPrice) on the locks easily at any point. This will require additions to the Lock smart contract but also changes in the web app.

Show truncated balances

The balance on accounts is showing too many numbers. We need to only show relevant decimals.
If the user has more than 1Eth, let's show only 2 decimals.
If the user has less than 0.0001 Eth let's show < 0.0001 (about 2cts at current prices).
For anything in between, let's show at most 2 non zero values.

Smart Contracts Improvements

The current smart contracts are extremely basic and present a large number of challenges.

Unlock smart contract needs to be upgradeable, without losing the "link" from the Locks
Most of the Lock "code" should actually be shared between all deployed locks so we can save on gas
Locks themselves do not need to be upgradeable but we should assume that newer versions of the Lock smart contract will be deployed over time
Gas fees: we should ensure that gas fees are minimal for all Lock actions

Improved About page with links

We need to update the about page to include profiles for employees.

Show name of network on interface...

When a user visits an unlock-protocol.com page they should instantly see which Ethereum network is being used (Main net, Rinkeby, Ropsten...)

Ideally this would take the form of a small persistent label at the bottom or top of the screen.

implement me\n totalDiscountGranted += _discount;\n return;\n }\n\n}\n",

unlock/smart-contracts/build/contracts/Unlock.json

Lines 84 to 89 in b31941a

    
             "stateMutability": "nonpayable", 
        
             "type": "function" 
        
           }, 
        
           { 
        
             "anonymous": false, 
        
             "inputs": [

This issue was generated by todo based on a `TODO` comment in `b31941a` when #216 was merged. cc @unlock-protocol.

Unlock dashboard doesn't release local storage cache

Describe the bug
The web dashboard doesn't update based on completed transactions. The values for balance, outstanding tokens, and amount to withdraw stay static unless action is taken to force the dashboard to release the cache.

To Reproduce
Steps to reproduce the behavior:

Visit the dashboard.
Perform a balance-changing action such as purchasing a key - or simply change your network in Metamask.
Reload the page.
Note that the values have not updated as expected.

Expected behavior
On each reload, the Unlock dashboard should reflect current confirmed transactions on the current network.

Desktop (please complete the following information):

Chrome on OSX

add USD values to lock

unlock/unlock-app/src/components/creator/CreatorLock.js

Lines 16 to 21 in 4eb93e2

    
           // TODO add USD values to lock 
        
           // TODO add all-time balance to lock 
        
           return ( 
        
             <CreatorLockRow> 
        
               <CreatorLockSaved> 
        
                 <CreatorLockIcon><Icon lock={lock} address={lock.address} size={'3'} /></CreatorLockIcon>

This issue was generated by todo based on a `TODO` comment in `4eb93e2` when #244 was merged. cc @unlock-protocol.

Infinite number of keys!

Locks have the ability to have an infinite number of keys.
We should implement that feature both in the UI and the smart contract.

Hover state on icon is broken

On the layout icons, the over state should not be solid blue but should also show the actual icon for the button.

Is there a way to test hover states with storybook?

Group pending and saved locks, rather than displaying them by time

The order is jarring - really pending locks should show up at the top, newest first.

Documentation site

As an open source project, we should have a well-described documentation site, as well as in-line code documentation.

I recommend using Read the Docs to establish a documentation site at docs.unlock-protocol.com, which would be configured to automatically rebuild from markdown files stored in the Unlock repository itself. New commits to master would automatically rebuild the documentation site.

For in-line documentation, I think we should use JSDoc-style syntax, which can then be automatically compiled into a reference site.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Ether Symbol & Monaco Font

@benwerd I looked into why the design specified the Manaco font (which it shouldn't). The Eth symbol isnt available in Plex (the font we're using) and hence it reverted to Monaco. I've created an SVG which you call pull from Zeplin or from here

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Rename Provider

The Provider component has a name that could easily be confused with Redux's own <Provider> tag, which is a bit confusing now but could lead to larger issues down the road. Already it's forcing us to use import { Provider as ReduxProvider } or a similar alias in cases where both could be used.

I suggest giving it a more descriptive name - eg Web3Provider.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Requiring a web3 provider, not Metamask

Right now we require users to use Metamask... which is too conservative.
We should only require them to use a web3 provider.

See how Opera does it.

Upgradability for the Unlock Smart Contract

Some characteristics of the smart contract (variables such as max available discount %... etc) will need to be modifiable by the smart contract owner.

However, we may also need to upgrade the logic in the smart contract. In that context, it may be useful to have a way to upgrade it.

In that context, we should explore the proxy patterns exposed by Zeppelin.

One of the key challenges though is that this needs to ensure that all deployed Locks are also pointing to the current version of the Unlock smart contract.

CI not failing when truffle tests fail

As identified by @HardlyDifficult, our CI does not fail when truffle tests are failing. This is not right.

Enforce rinkeby on staging.unlock-protocol.com

In order to avoid mistakes we should enforce networks on different versions of Unlock.
In dev, enforce the use of a local testnet, on staging, enforce Rinkeby... and on the main site, enforce the use of the main net.

Server side rendering

Multiple "pages" from the application need to be rendered on the server. This will allow for better SEO but also for tools to extract data. For example the home page, about page and jobs page should be rendered on the server side.

It is important though that we let react "rehydrate" these pages once loaded so that the regular react app takes over and resumes once the pages have been loaded by a web browser.

border around logo?

@chrisvanpatten It would be really cool if one of the settings of the asset building script was the ability to add margins... possible?

Customize position of circles

In order to get more unique lock icons we should also position (x, y and z) the inner circles

unlock/unlock-app/src/components/lock/Icon.js

Lines 9 to 14 in b31941a

    
            * @todo Customize position of circles 
        
            * @body In order to get more unique lock icons we should also position (x, y and z) the inner circles 
        
            * more uniquely based on the lock address... the challenge is to not have any white space. 
        
            * @param {lock} lock 
        
            */ 
        
           const Icon = ({ lock }) => {

This issue was generated by todo based on a `@todo` comment in `b31941a` when #216 was merged. cc @unlock-protocol.

"Refreshing" data from localStorage

Since we do not have a server side component for now, we use the blockchain as the source of truth and store (cache!) data using localStorage.
We use a redux middleware to make sure that our redux store is always 'synced' to localStorage.

The challenge is that data might have changed in the blockchain while the app is not running on the front end, and we need a mechanism to "sync" the redux store again after the web application has loaded.

Tests coverage

We need a way to run full test coverage across all code and include coverage on the main README page.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

A better CI setup

We are using Travis-CI to run our tests on Pull Requests.
The current setup involves using docker-compose to build an setup in which we can do tests. This setup has 2 services:

ganache-cli which runs an instance of ganache
a container with all the Unlock code with a single command to run all the tests from tests.sh.

When adding new test suites (we currently only test smart-contracts and unlock-app) you need to update tests.sh.

The travis-ci config is "strange":

before_install:
- docker-compose -f docker/docker-compose.ci.yml build
- docker-compose -f docker/docker-compose.ci.yml up --abort-on-container-exit

We first build the cluster: so far so good, but then we also run it and ask it to terminate when a container exits. That second instruction should probably not in before_install. Also we should probably terminate properly.

This setup is probably what is causing #194? (the error does happen but for some reason test.sh continues it execution...

Finally, running CI already takes about 5 minutes while this is a very early project. There are ways to optimize that building process.

Allow user to retrieve embeddable JavaScript for a lock they own

This way they can deploy a lock to a website of their choice.

this test is flaky

unlock/smart-contracts/test/Lock/purchaseFor.js

Lines 222 to 227 in 4342319

    
           // TODO this test is flaky 
        
           it('should succeed if the sending account was pre-approved', () => { 
        
             return locks['RESTRICTED'] 
        
               .approve(accounts[3], accounts[3], { 
        
                 from: owner 
        
               })

This issue was generated by todo based on a `TODO` comment in `4342319` when #212 was merged. cc @unlock-protocol.

Content should remained locked when the user does not have metamask

When a user without metamask (or a web3 provider) we currently trigger an error which means that the content which should be locked remains unlocked.

Broken story for Home page

We probably need to see how to include react-router in storybook.

Documentation and use cases.

Great project, just wondering if you have some early docs you can share and maybe a document showing some possible alternative use cases apart from a publishing paywall.

Thanks!

We need to make this is payable because at some point we want to allow the LOCK ...

unlock/smart-contracts/contracts/Lock.sol

Lines 28 to 33 in 8a28962

    
           struct Key { 
        
             uint expirationTimestamp; 
        
             bytes data; // Note: This can be expensive? 
        
           } 
        
           // Fields

This issue was generated by todo based on a `TODO` comment in `8a28962` when #243 was merged. cc @unlock-protocol.

ERC721 compatibility

The current implementation of the Lock smart contract is not fully compatible with the ERC721 spec.
The main reason for this is that we use the owner's address as the tokenId which means that when ownership is changed, the tokenId itself is changed, which is not how the spec works.

One approach would be to actually have unique tokenId for each key, but that would incure more gas fees. Is there any other option to achieve this?

Enable "consistent" mining

When developing locally with ganache-cli, we currently have a setting which only mines transactions "on demand". This means that transactions are immediately mined and that they are also immediately confirmed.

This is not consistent with the deployments on both rinkeby and the main network. We should then change that setting so that blocks are mined consistently, even when they're empty.

A good default would be one every 3 seconds for example.

Visually replace form with pending lock on submission

Currently new locks show up at the bottom of the screen.

Adding guidelines for contributing, opening issues

We need to work on making it easy to onboard contributors of all kinds (code, issues, docs... etc).
For this we need clear guidelines and I believe Github provides tools to do that.
We should also set up Gitcoin.

Detect when Metamask is locked

Metamask is "locked" by default, we should be able to detect that and show an error to the user asking them to unlock it.

default account

There should always be a default account which the user can switch away from to another one.
It should be set when the network connects (if none is previously set)

Multiple Lock types/smart contracts

At this point we have only a single Lock smart contract which covers multiple use cases (Public, Private, Restricted...).

A better approach would be to have a single Lock interface which implements the "core" behavior of the Unlock protocol and then have multple contracts PublicLock, PrivateLock, RestrictedLock which would have different characteristics.
This would allow for lower deployment costs and maybe easier maintainability.

save name to the redux store

unlock/unlock-app/src/components/creator/CreatorLockForm.js

Lines 35 to 40 in 42fa9d7

    
           handleSubmit () { // TODO save name to the redux store 
        
             const lockParams = { 
        
               keyReleaseMechanism: this.state.keyReleaseMechanism, 
        
               expirationDuration: this.state.expirationDuration * this.state.expirationDurationUnit, 
        
               keyPrice: Web3Utils.toWei(this.state.keyPrice.toString(10), this.state.keyPriceCurrency), 
        
               maxNumberOfKeys: this.state.maxNumberOfKeys,

This issue was generated by todo based on a `TODO` comment in `42fa9d7` when #319 was merged. cc @unlock-protocol.

If there is more than the required price, then let's return whatever is extra\n ...

unlock/smart-contracts/build/contracts/Lock.json

Lines 217 to 222 in c41992a

    
             "indexed": true, 
        
             "name": "_approved", 
        
             "type": "address" 
        
           }, 
        
           { 
        
             "indexed": false,

This issue was generated by todo based on a `TODO` comment in `c41992a` when #286 was merged. cc @unlock-protocol.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Upgradable Unlock Smart Contract

The Unlock smart contract needs to be upgradable, without changing its address and its data (balances of Unlock points or deployed Locks).

The Unlock.sol smart contract has 3 main purposes:

Deploy locks and keep track of them
Keep track of the the Discount Token supply: grant them upon referrals.
Grant corresponding discounts on key purchases

A lot of the logic will be implemented later and will be adjusted as we make progress in understanding how the Unlock network is functioning. For that reason, it is important that we use an Upgradeable approach so that we can incrementally add and update the functionality of that smart contract.

For this we want to use the "Unstructured Storage Proxy" described by @leanthebean in this article

change account to base level

unlock/unlock-app/src/components/creator/Dashboard.js

Lines 25 to 30 in d65d363

    
             account: UnlockPropTypes.account, 
        
             network: UnlockPropTypes.network, 
        
             transactions: UnlockPropTypes.transactions, 
        
             locks: UnlockPropTypes.locks, 
        
           }

	* TODO remove after we have implemented a CSS template using styled-component
	*/

	@import url('https://fonts.googleapis.com/css?family=IBM+Plex+Sans:400,500,600,700');
	@import url('https://fonts.googleapis.com/css?family=IBM+Plex+Mono:200,500');

	"stateMutability": "nonpayable",
	"type": "function"
	},
	{
	"anonymous": false,
	"inputs": [

	// TODO add USD values to lock
	// TODO add all-time balance to lock
	return (
	<CreatorLockRow>
	<CreatorLockSaved>
	<CreatorLockIcon><Icon lock={lock} address={lock.address} size={'3'} /></CreatorLockIcon>

	* @todo Customize position of circles
	* @body In order to get more unique lock icons we should also position (x, y and z) the inner circles
	* more uniquely based on the lock address... the challenge is to not have any white space.
	* @param {lock} lock
	*/
	const Icon = ({ lock }) => {

	// TODO this test is flaky
	it('should succeed if the sending account was pre-approved', () => {
	return locks['RESTRICTED']
	.approve(accounts[3], accounts[3], {
	from: owner
	})

	struct Key {
	uint expirationTimestamp;
	bytes data; // Note: This can be expensive?
	}

	// Fields

	handleSubmit () { // TODO save name to the redux store
	const lockParams = {
	keyReleaseMechanism: this.state.keyReleaseMechanism,
	expirationDuration: this.state.expirationDuration * this.state.expirationDurationUnit,
	keyPrice: Web3Utils.toWei(this.state.keyPrice.toString(10), this.state.keyPriceCurrency),
	maxNumberOfKeys: this.state.maxNumberOfKeys,

	"indexed": true,
	"name": "_approved",
	"type": "address"
	},
	{
	"indexed": false,

	account: UnlockPropTypes.account,
	network: UnlockPropTypes.network,
	transactions: UnlockPropTypes.transactions,
	locks: UnlockPropTypes.locks,
	}

unlock-protocol / unlock Goto Github PK

unlock's Introduction

Demo

Contributing

Getting started

The code

The protocol

Deploy and provision the contracts

Run one of the app

Secrets

Thank you

unlock's People

Contributors

Stargazers

Watchers

Forkers

unlock's Issues

This issue was generated by todo based on a TODO comment in ed90342 when #236 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in b31941a when #216 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in 4eb93e2 when #244 was merged. cc @unlock-protocol.

This issue was generated by todo based on a @todo comment in b31941a when #216 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in 4342319 when #212 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in 8a28962 when #243 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in 42fa9d7 when #319 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in c41992a when #286 was merged. cc @unlock-protocol.

This issue was generated by todo based on a TODO comment in d65d363 when #281 was merged. cc @unlock-protocol.

Recommend Projects

Recommend Topics

Recommend Org

This issue was generated by todo based on a `TODO` comment in `ed90342` when #236 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `b31941a` when #216 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `4eb93e2` when #244 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `@todo` comment in `b31941a` when #216 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `4342319` when #212 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `8a28962` when #243 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `42fa9d7` when #319 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `c41992a` when #286 was merged. cc @unlock-protocol.

This issue was generated by todo based on a `TODO` comment in `d65d363` when #281 was merged. cc @unlock-protocol.