EthAvatar.JS is a JavaScript API for EthAvatar.
EthAvatar associates an avatar of your choice with an Ethereum address that you own. It is using IPFS and Ethereum Smart Sontract to store avatars of addresses.
The avatar image is stored on IPFS and is bound to your address via an Ethereum smart contract.
EthAvatar.JS requires Node.js and NPM or Yarn. It works with Node.js 10 or later, but it is recommended to use supported and maintained versions. Note that if you want to use it with Node.js 12 or later, you must use Yarn instead of NPM (because of Truffle and Web3 bug).
You could globally install EthAvatar.JS to get command line interface:
npm install -g ethavatar // Using NPM
yarn global add ethavatar // Using Yarn
You could also install EthAvatar.JS locally, so you could use it in your application:
npm install --save ethavatar // Using NPM
yarn add ethavatar // Using Yarn
If you want to use EthAvatar.JS in browser, you could include scripts from one of our CDNs in your HTML website:
<!-- Normal Versions -->
<script src="https://cdn.jsdelivr.net/npm/ethavatar/dist/index.js"></script>
<script src="https://unpkg.com/ethavatar/dist/index.js"></script>
<!-- Minified Versions -->
<script src="https://cdn.jsdelivr.net/npm/ethavatar/dist/index.min.js"></script>
<script src="https://unpkg.com/ethavatar/dist/index.min.js"></script>
Command line program allows you to get and set avatars using files.
First you should specify Web3 and IPFS connection using ethavatar config:
$ ethavatar config --web3 http://127.0.0.1:8545/
$ ethavatar config --ipfs https://ipfs.infura.io:5001/
Program will save them in ~/.ethavatar file. Web3 connection is required and all providers are supported. IPFS connection is optional and it uses Infura IPFS API by default.
You can get avatar to file using ethavatar get <filename>:
$ ethavatar get avatar.jpg # Save avatar of current address to file avatar.jpg
$ ethavatar get avatar.jpg --address 0x0000000000000000000000000000000000000000 # Save avatar of address 0x0000000000000000000000000000000000000000 to file avatar.jpg
You can set avatar using ethavatar set <filename>:
$ ethavatar set avatar.jpg # Uplaod avatar of current address from fileavatar.jpg
The whole class is asynchronous, so you would need to use promises or async/await in your application.
First, include this library and instantiate the class in your file:
const EthAvatar = require('ethavatar')
const ethavatar = new EthAvatar()
Class is using injected Web3 provider (like Mist or MetaMask) and Infura IPFS API. It is using official smart contract for detected network. You could also change them when instantiating the class:
/// Load Web3 and IPFS
const Web3 = require('web3')
const IpfsAPI = require('ipfs-api')
// Load EthAvatar
const EthAvatar = require('ethavatar')
// Use local Web3 Provider
const web3Provider = new Web3.providers.HttpProvider('http://127.0.0.1:8545/')
const web3Connection = new Web3(web3Provider)
/// Use Infura IPFS API
const ipfsConnection = IpfsAPI('ipfs.infura.io', '5001', {protocol: 'https'})
// Use custom contract address
const contractAddress = '0x96fc5a0b46e9e4b5d114c42d4daeaa1c2517078a'
const ethavatar = new EthAvatar(
web3Connection,
ipfsConnection,
contractAddress
)
You should use method get() to get avatar of address. It uses current address as default, but you could specify any other address:
ethavatar.get()
.then((avatar) => {
if (typeof avatar === 'undefined') {
throw new Error('Avatar of address not set')
} else {
return avatar
}
}).then((avatar) => {
// Load FileSystem module
const fs = require('fs')
// Write avatar to file
fs.writeFile(
'avatar.jpg',
avatar,
'binary',
(err) => {
if (err) {
throw err
}
}
)
}).catch((error) => {
console.error(error.message)
})
The avatar is returned as buffer, so you could directly write it to file.
You should use set() to set avatar of address. It's parameter must be buffer of avatar, so it is possible to upload it from a file:
let avatar = Buffer.from(['00', '01', '03', '04', '05', '06', '07', '08', '09'])
ethavatar.set(avatar)
.then((avatar) => {
console.log('Avatar uploaded!')
}).catch((error) => {
console.error(error.message)
})
You should use remove() to remove avatar of address. It doesn't have any parameters and you could only remove avatar of your address:
ethavatar.remove()
.then(() => {
console.log('Avatar removed!')
}).catch((error) => {
console.error(error.message)
})
You can also watch for avatar changes of specific address. It uses current address as default, but you could specify any other address:
ethavatar.watch((result => {
console.log('User address: ' + result.hashAddress)
console.log('IPFS hash: ' + result.hash)
}, '0xe12Aa5FB5659bb0DB3f488e29701fE303bcBAf65')
File operations are possible with FileHelper class:
const FileHelper = require('ethavatar').fileHelper
const fileHelper = new FileHelper(ethavatar)
You can then save avatar directly to file:
fileHelper.toFile('avatar.png', '0xe12Aa5FB5659bb0DB3f488e29701fE303bcBAf65')
.then((avatar) => {
console.log('Avatar saved!')
}).catch((error) => {
console.error(error.message)
})
You can also upload avatar from file:
fileHelper.fromFile('avatar.png')
.then((avatar) => {
console.log('Avatar uploaded!')
}).catch((error) => {
console.error(error.message)
})
URL operations are possible with UrlHelper class:
const UrlHelper = require('ethavatar').urlHelper
const urlHelper = new UrlHelper(ethavatar)
You can then post avatar as multipart form data:
urlHelper.toUrl('https://example.com/', '0xe12Aa5FB5659bb0DB3f488e29701fE303bcBAf65')
.then((avatar) => {
console.log('Avatar downloaded!')
}).catch((error) => {
console.error(error.message)
})
The request will have multipart/form-data content type and include address and avatar form values.
You can also get avatar from URL:
urlHelper.fromUrl('https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg')
.then((avatar) => {
console.log('Avatar uploaded!')
}).catch((error) => {
console.error(error.message)
})
You could also look to example.js or API documentation. Source code of console application is also great way to learn how this works.
Please read CONTRIBUTING.md for details.
This project uses SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT license. See the LICENSE file for details.
FAQs
Gravatar for Ethereum address
We found that ethavatar demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.