From 5b8055c85ead2d6f305e6211b01460308172789c Mon Sep 17 00:00:00 2001 From: Jacques Dafflon Date: Fri, 6 Apr 2018 14:39:26 +0200 Subject: [PATCH] Move EIP assets to assets folder (#977) - Create `assets` folder - Move existing EIPs (1, 107, 858) assets into the `assets` folder - Update link to assets in EIPs 1, 107 and 858 - Describe the inclusion of assets for EIPs in `README.md` --- EIPS/eip-1.md | 7 ++++--- EIPS/eip-107.md | 6 +++--- EIPS/eip-858.md | 2 +- README.md | 2 ++ {EIPS => assets}/eip-1/process.png | Bin {EIPS => assets}/eip-107/authorization-locked.png | Bin {EIPS => assets}/eip-107/authorization-password.png | Bin {EIPS => assets}/eip-107/authorization.png | Bin {EIPS => assets}/eip-858/calculations.md | 0 9 files changed, 10 insertions(+), 7 deletions(-) rename {EIPS => assets}/eip-1/process.png (100%) rename {EIPS => assets}/eip-107/authorization-locked.png (100%) rename {EIPS => assets}/eip-107/authorization-password.png (100%) rename {EIPS => assets}/eip-107/authorization.png (100%) rename {EIPS => assets}/eip-858/calculations.md (100%) diff --git a/EIPS/eip-1.md b/EIPS/eip-1.md index 79df47c8..73390cd5 100644 --- a/EIPS/eip-1.md +++ b/EIPS/eip-1.md @@ -44,7 +44,7 @@ Each EIP must have a champion - someone who writes the EIP using the style and f Vetting an idea publicly before going as far as writing an EIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your EIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your EIP. -Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. +Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft EIP should be presented as a [pull request]. If the EIP collaborators approve, the EIP editor will assign the EIP a number (generally the issue or PR number related to the EIP) and merge your pull request. The EIP editor will not unreasonably deny an EIP. Reasons for denying EIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the Ethereum philosophy. @@ -64,7 +64,7 @@ EIPs can also be superseded by a different EIP, rendering the original obsolete. The possible paths of the status of EIPs are as follows: -![EIP Process](eip-1/process.png) +![EIP Process](../assets/eip-1/process.png) Some Informational and Process EIPs may also have a status of “Active” if they are never meant to be completed. E.g. EIP 1 (this EIP). @@ -114,7 +114,8 @@ Each EIP should have the following parts: EIP Formats and Templates ------------------------- -EIPs should be written in [markdown] format. Image files should be included in a subdirectory for that EIP. +EIPs should be written in [markdown] format. +Image files should be included in a subdirectory of the `assets` folder for that EIP as follow: `assets/eip-X` (for eip **X**). When linking to an image in the EIP, use relative links such as `../assets/eip-X/image.png`. EIP Header Preamble ------------------- diff --git a/EIPS/eip-107.md b/EIPS/eip-107.md index 494fdca1..48b13a03 100644 --- a/EIPS/eip-107.md +++ b/EIPS/eip-107.md @@ -29,19 +29,19 @@ Account unlocked : ----------------- When the account is already unlocked, the user is presented with the following popup for every transaction that the dapp attempts to make: -![](eip-107/authorization.png) +![](../assets/eip-107/authorization.png) Account locked and no "personal" api exposed via rpc: ----------------- When the account is locked, and the node does not provide access to account unlocking via its rpc interface, the following popup will be presented. This is not ideal since this requires the user to know how to unlock an account: -![](eip-107/authorization-locked.png) +![](../assets/eip-107/authorization-locked.png) Account locked but node exposing the "personal" api via rpc : ----------------- A better option is to ask the user for their password, but this is only possible if the node allows access to the "personal" api via rpc. In such case, the following dialog will be presented to the user so he/she can accept the transaction by providing the password required to unlock the account: -![](eip-107/authorization-password.png) +![](../assets/eip-107/authorization-password.png) Specification diff --git a/EIPS/eip-858.md b/EIPS/eip-858.md index b40ed5a4..71ca2b96 100644 --- a/EIPS/eip-858.md +++ b/EIPS/eip-858.md @@ -15,7 +15,7 @@ Reduce the block reward to 1 ETH. The current public Ethereum network has a hashrate that corresponds to a tremendous level of energy consumption. As this energy consumption has a correlated environmental cost the network participants have an ethical obligation to ensure this cost is not higher than necessary. At this time, the most direct way to reduce this cost is to lower the block reward in order to limit the appeal of ETH mining. Unchecked growth in hashrate is also counterproductive from a security standpoint. ## Motivation -The current public Ethereum network has a hashrate of 232 TH/s). This hashrate corresponds to a **lower bound** for power usage of roughly [821 MW](eip-858/calculations.md) and yearly energy consumption of 7.2 TWh (roughly 0.033% of [total](https://en.wikipedia.org/wiki/List_of_countries_by_electricity_consumption) global electricity consumption). A future switch to full Proof of Stake will solve this issue entirely. Yet that switch remains enough in the future that action should be taken in the interim to limit excess harmful side affects of the present network. +The current public Ethereum network has a hashrate of 232 TH/s). This hashrate corresponds to a **lower bound** for power usage of roughly [821 MW](../assets/eip-858/calculations.md) and yearly energy consumption of 7.2 TWh (roughly 0.033% of [total](https://en.wikipedia.org/wiki/List_of_countries_by_electricity_consumption) global electricity consumption). A future switch to full Proof of Stake will solve this issue entirely. Yet that switch remains enough in the future that action should be taken in the interim to limit excess harmful side affects of the present network. ## Specification Block reward to be changed to 1 ETH / block. diff --git a/README.md b/README.md index 0469ec30..2c9856a7 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ A browsable version of all current and draft EIPs can be found on [the official Your first PR should be a first draft of the final EIP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new EIP and assign it a number before merging it. Make sure you include a `discussions-to` header with the URL to a discussion forum or open GitHub issue where people can discuss the EIP as a whole. +If your EIP requires images, the image files should be included in a subdirectory of the `assets` folder for that EIP as follow: `assets/eip-X` (for eip **X**). When linking to an image in the EIP, use relative links such as `../assets/eip-X/image.png`. + Once your first PR is merged, we have a bot that helps out by automatically merging PRs to draft EIPs. For this to work, it has to be able to tell that you own the draft being edited. Make sure that the 'author' line of your EIP contains either your Github username or your email address inside . If you use your email address, that address must be the one publicly shown on [your GitHub profile](https://github.com/settings/profile). When you believe your EIP is mature and ready to progress past the draft phase, you should do one of two things: diff --git a/EIPS/eip-1/process.png b/assets/eip-1/process.png similarity index 100% rename from EIPS/eip-1/process.png rename to assets/eip-1/process.png diff --git a/EIPS/eip-107/authorization-locked.png b/assets/eip-107/authorization-locked.png similarity index 100% rename from EIPS/eip-107/authorization-locked.png rename to assets/eip-107/authorization-locked.png diff --git a/EIPS/eip-107/authorization-password.png b/assets/eip-107/authorization-password.png similarity index 100% rename from EIPS/eip-107/authorization-password.png rename to assets/eip-107/authorization-password.png diff --git a/EIPS/eip-107/authorization.png b/assets/eip-107/authorization.png similarity index 100% rename from EIPS/eip-107/authorization.png rename to assets/eip-107/authorization.png diff --git a/EIPS/eip-858/calculations.md b/assets/eip-858/calculations.md similarity index 100% rename from EIPS/eip-858/calculations.md rename to assets/eip-858/calculations.md