zervo/vanity-eth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve README & description

Browse source
This commit is contained in:
Boris Kubiak 2023-06-26 14:39:17 +02:00
parent 4637b5df9d
commit 3f112321fd
3 changed files with 96 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -13,43 +13,58 @@ Just type [`vanity-eth.tk`](https://vanity-eth.tk) to use it ⚡️
## What's a vanity address? ## What's a vanity address?
A vanity address is an address which part of it is chosen by yourself, making it look less random. A vanity address is an address in which you can choose a part of it to make it appear less random.
Examples: `0xc0ffee254729296a45a3885639AC7E10F9d54979`, or `0x999999cf1046e68e36E1aA2E0E07105eDDD1f08E` Examples:
- `0xc0ffee254729296a45a3885639AC7E10F9d54979`
- `0x999999cf1046e68e36E1aA2E0E07105eDDD1f08E`
## Usage ## Usage
First of all, visit [`vanity-eth.tk`](https://vanity-eth.tk) First of all, visit [`vanity-eth.tk`](https://vanity-eth.tk)
Enter as short prefix/suffix of your choice at the bottom of the page, and click ‘generate’ to start. Your browser will Enter a short prefix and/or suffix of your choice and click _Generate_ to start. Your browser will
generate lots of random addresses until one matches your input. generate lots of random addresses until it finds one that matches your input.
Once an address is found, you can reveal the private key, or click the 'save' button to download a password-encrypted keystore file. Once an address is found, you can choose to reveal the private key or click the _Save_ button to download a password-encrypted keystore file.
You can increase the number of working threads to reach higher speeds, or decrease it if your computer struggles. Adjusting the number of working threads can increase or decrease the speed, depending on your computer's capabilities.
## Security ## Security
As explained above, everything is computed only in your browser. Nothing ever leaves your machine, or even your browser tab. As mentioned earlier, all computations occur solely within your browser. Nothing ever leaves your machine, or even your browser tab.
There is no database, no server-side code. Everything vanishes when you close your tab. There is no database, no server-side code. Everything vanishes when you close your browser tab.
**Vanity-ETH cannot and will never store your private key**, and if you don't trust it, you have 3 ways to ensure your key remains private: **Vanity-ETH cannot and will never store your private key.** If you have concerns about its trustworthiness, you have three options to ensure the privacy of your key:
- Once the web page is loaded, you can turn off the internet and continue playing, it will work seamlessly - After loading the web page, you can disconnect from the internet and continue using it seamlessly
- You can also download the latest build of Vanity-ETH [here](https://git.io/veth-dl) - Alternatively, you can download the latest build of Vanity-ETH [here](https://git.io/veth-dl)
and use it on a completely offline computer and use it on an offline computer
- The code is 100% open source and available on GitHub. You can review it as much as you want before using it - The code is 100% open source and available on GitHub, allowing you to review it thoroughly before usage.
Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate Ethereum addresses. Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate Ethereum addresses.
The keystore file is encrypted with a AES-128-CTR cipher using the PBKDF2-SHA256 derivation function with 65536 hashing rounds. The keystore file is encrypted with an AES-128-CTR cipher using the PBKDF2-SHA256 derivation function with 65536 hashing rounds.
## Other browser-based tools
Be aware that due to its popularity and open-source nature, Vanity-ETH has been widely copied, leading to the existence of websites claiming to provide the same functionality. Sometimes, they are perfect clones hosted on very similar domains.
Most of them do not credit the original code, are not open-source, and may contain malicious code.
Vanity-ETH has always been the **first** browser-based ETH vanity address generator, and remains the most popular and trusted one.
To be sure you're on the real Vanity-ETH website, search for [Vanity-ETH on GitHub](https://github.com/search?o=desc&q=Vanity-ETH&s=stars), find the repository with the most stars (> 600), and click the link in the description. Double check by searching [Vanity-ETH on Google](https://www.google.com/search?q=Vanity-ETH).
## Performance ## Performance
For some reason, the performance of Vanity-ETH can vary a lot from a browser to another. Vanity-ETH's performance may vary significantly across different browsers. Currently, Chrome provides the best results.
Currently, Chrome provides the best results.
Using Vanity-ETH on your phone or tablet will work, but don't expect to reach the speed of a good computer. While you can use Vanity-ETH on your phone or tablet, it is unlikely to match the speed of a traditional computer.
**N.B:** Vanity-ETH is designed to be a user-friendly tool that runs directly in your browser, providing easy accessibility without the need to download or install additional software.
However, browser-based tools have inherent limitations that may affect their performance and efficiency. Some dedicated command-line tools are more difficult to use, but may offer better performance.
## Compatibility ## Compatibility

6
public/index.html
View file

@ -7,8 +7,8 @@
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
/> />
<meta http-equiv="X-UA-Compatible" content="ie=edge" /> <meta http-equiv="X-UA-Compatible" content="ie=edge" />
<title>Vanity ETH | Ethereum vanity address generator</title> <title>Vanity-ETH | Ethereum vanity address generator</title>
<meta property="og:title" content="Vanity ETH" /> <meta property="og:title" content="Vanity-ETH" />
<meta property="og:locale" content="en_US" /> <meta property="og:locale" content="en_US" />
<meta <meta
name="description" name="description"
@ -24,7 +24,7 @@
/> />
<link rel="canonical" href="https://vanity-eth.tk/" /> <link rel="canonical" href="https://vanity-eth.tk/" />
<meta property="og:url" content="https://vanity-eth.tk/" /> <meta property="og:url" content="https://vanity-eth.tk/" />
<meta property="og:site_name" content="Vanity ETH" /> <meta property="og:site_name" content="Vanity-ETH" />
<meta name="google-site-verification" content="DFWJVWz9IRrh-wjBxn0Y8ith5FTqMeJTSUtuJ595BEs" /> <meta name="google-site-verification" content="DFWJVWz9IRrh-wjBxn0Y8ith5FTqMeJTSUtuJ595BEs" />
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" /> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" /> <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />

98
src/vue/Description.vue
View file

@ -1,56 +1,80 @@
<template> <template>
<div class="panel"> <div class="panel">
<p> <p>
Vanity-ETH is an open source tool using your web browser to generate Ethereum vanity addresses.<br> Vanity-ETH is an open-source tool that uses your web browser to generate Ethereum vanity addresses.<br />
Enter a short prefix/suffix of your choice, and click ‘generate’ to start. Enter a short prefix and/or suffix of your choice and click <i>Generate</i> to start.
</p> </p>
<div class="shortcut"> <div class="shortcut">
<button type="button" class="button-large" @click="scrollDown">Start now</button> <button type="button" class="button-large" @click="scrollDown">Start now</button>
</div> </div>
<h2>What's a vanity address?</h2> <h2>What's a vanity address?</h2>
<p> <div class="p">
A vanity address is an address which part of it is chosen by yourself, making it look less random.<br> A vanity address is an address in which you can choose a part of it to make it appear less random.<br />
Examples: <span class="monospace">0xc0ffee254729296a45a3885639AC7E10F9d54979</span>, or Examples:
<span class="monospace">0x999999cf1046e68e36E1aA2E0E07105eDDD1f08E</span> <ul>
</p> <li><span class="monospace">0xc0ffee254729296a45a3885639AC7E10F9d54979</span></li>
<li><span class="monospace">0x999999cf1046e68e36E1aA2E0E07105eDDD1f08E</span></li>
</ul>
</div>
<h2>How it works</h2> <h2>How it works</h2>
<p> <p>
Enter the prefix/suffix of your choice, and click ‘generate’ to start. Your browser will generate lots of random Enter a short prefix and/or suffix of your choice and click <i>Generate</i> to start. Your browser will
addresses until one matches your input.<br> generate lots of random addresses until it finds one that matches your input.<br />
Once an address is found, you can reveal the private key, or click the 'save' button to download Once an address is found, you can choose to reveal the private key or click the <i>Save</i> button to
a password-encrypted keystore file.<br> download a password-encrypted keystore file.<br /><br />
You can increase the number of working threads to reach higher speeds, or decrease it if you computer Adjusting the number of working threads can increase or decrease the speed, depending on your computer's
struggles.<br> capabilities.<br />
</p> </p>
<h2>Security</h2> <h2>Security</h2>
<p> <p>
As explained above, everything is computed only in your browser. Nothing ever leaves your machine, or even As mentioned earlier, all computations occur solely within your browser. Nothing ever leaves your machine,
your browser tab. There is no database, no server-side code. Everything vanishes when you close your tab.<br><br> or even your browser tab. There is no database, no server-side code. Everything vanishes when you close your
<b>Vanity-ETH cannot and will never store your private key</b>, and if you don't trust it, you have 3 ways to ensure browser tab.<br /><br />
your key remains private:<br> <b>Vanity-ETH cannot and will never store your private key.</b> If you have concerns about its
&nbsp;-&nbsp;Once the web page is loaded, you can turn off the internet and continue playing, it will work seamlessly<br> trustworthiness, you have three options to ensure the privacy of your key:<br />
&nbsp;-&nbsp;You can also download the latest build of Vanity-ETH &nbsp;-&nbsp;After loading the web page, you can disconnect from the internet and continue using it
<a href="https://git.io/veth-dl" target="_blank">here</a> and use it on a completely offline computer<br> seamlessly<br />
&nbsp;-&nbsp;Alternatively, you can download the latest build of Vanity-ETH
<a href="https://git.io/veth-dl" target="_blank">here</a> and use it on an offline computer<br />
&nbsp;-&nbsp;The code is 100% open source and available on &nbsp;-&nbsp;The code is 100% open source and available on
<a href="https://github.com/bokub/vanity-eth" target="_blank">GitHub</a>. You can review it as much as you want before using it<br> <a href="https://github.com/bokub/vanity-eth" target="_blank">GitHub</a>, allowing you to review it
<br> thoroughly before usage<br />
Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate <br />
Ethereum addresses.<br> Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate Ethereum
The keystore file is encrypted with a AES-128-CTR cipher using the PBKDF2-SHA256 derivation function with 65536 hashing rounds. addresses.<br />
The keystore file is encrypted with an AES-128-CTR cipher using the PBKDF2-SHA256 derivation function with
65536 hashing rounds.
</p>
<h2>Other browser-based tools</h2>
<p>
Be aware that due to its popularity and open-source nature, Vanity-ETH has been widely copied, leading to
the existence of websites claiming to provide the same functionality. Sometimes, they are perfect clones
hosted on very similar domains.<br />
Most of them do not credit the original code, are not open-source, and may contain malicious code.<br /><br />
Vanity-ETH has always been the <b>first</b> browser-based ETH vanity address generator, and remains the most
popular and trusted one.<br /><br />
To be sure you're on the real Vanity-ETH website, search for
<a href="https://github.com/search?o=desc&q=Vanity-ETH&s=stars" target="_blank">Vanity-ETH on GitHub</a>,
find the repository with the most stars (> 600), and click the link in the description. Double check by
searching <a href="https://www.google.com/search?q=Vanity-ETH" target="_blank">Vanity-ETH on Google</a>.
</p> </p>
<h2>Performance</h2> <h2>Performance</h2>
<p> <p>
For some reason, the performance of Vanity-ETH can vary a lot from a browser to another. Vanity-ETH's performance may vary significantly across different browsers. Currently, Chrome provides the
Currently, Chrome provides the best results.<br> best results.<br />
Using Vanity-ETH on your phone or tablet will work, but don't expect to reach the speed of a good old computer. While you can use Vanity-ETH on your phone or tablet, it is unlikely to match the speed of a traditional
computer.<br /><br />
<b>N.B:</b> Vanity-ETH is designed to be a user-friendly tool that runs directly in your browser, providing
easy accessibility without the need to download or install additional software.<br />
However, browser-based tools have inherent limitations that may affect their performance and efficiency.
Some dedicated command-line tools are more difficult to use, but may offer better performance.
</p> </p>
<h2>Compatibility</h2> <h2>Compatibility</h2>
<p> <p>
Any address generated with Vanity-ETH is ERC-20 compatible, which means you can use it for an ICO, an Any address generated with Vanity-ETH is ERC-20 compatible, which means you can use it for an ICO, an
airdrop, or just to withdraw your funds from an exchange.<br> airdrop, or just to withdraw your funds from an exchange.<br />
The keystore file is 100% compatible with MyEtherWallet, MetaMask, Mist, and geth. The keystore file is 100% compatible with MyEtherWallet, MetaMask, Mist, and geth.
</p> </p>
</div> </div>
@ -60,8 +84,8 @@
export default { export default {
data: function () { data: function () {
return { return {
scrollTimeOut: null scrollTimeOut: null,
} };
}, },
methods: { methods: {
scrollDown() { scrollDown() {
@ -71,19 +95,19 @@
let currentValue = window.scrollY; let currentValue = window.scrollY;
let diff = element.getBoundingClientRect().top / 6; let diff = element.getBoundingClientRect().top / 6;
if (Math.abs(diff) > 1 && currentValue > lastValue) { if (Math.abs(diff) > 1 && currentValue > lastValue) {
window.scrollTo(0, (window.scrollY + diff)); window.scrollTo(0, window.scrollY + diff);
this.scrollTimeOut = setTimeout(this.scrollTo, 30, element, currentValue) this.scrollTimeOut = setTimeout(this.scrollTo, 30, element, currentValue);
} else if (currentValue >= lastValue) { } else if (currentValue >= lastValue) {
document.getElementById('input').focus(); document.getElementById('input').focus();
} }
} },
} },
}; };
</script> </script>
<style lang="sass" scoped> <style lang="sass" scoped>
@import "../css/variables" @import "../css/variables"
p p, .p
margin: 15px 0 20px margin: 15px 0 20px
color: $text-alt color: $text-alt
overflow-x: hidden overflow-x: hidden