pns-avatar

Avatar resolver library for both nodejs and browser.

Getting started

Prerequisites

• Have your web3 provider ready (web3.js, ethers.js)
• [Only for node env] Have jsdom installed.

And good to go!

Installation

# npm
npm i @pnsdomains/pns-avatar
# yarn
yarn add @pnsdomains/pns-avatar

Usage

import { StaticJsonRpcProvider } from '@ethersproject/providers';
import { AvatarResolver, utils as avtUtils } from '@pnsdomains/pns-avatar';

// const { JSDOM } = require('jsdom'); on nodejs
// const jsdom = new JSDOM().window; on nodejs

const provider = new StaticJsonRpcProvider(
    ...
  );
...
async function getAvatar() {
    const avt = new AvatarResolver(provider);
    const avatarURI = await avt.getAvatar('tanrikulu.pls', { /* jsdomWindow: jsdom (on nodejs) */ });
    // avatarURI = https://ipfs.io/ipfs/QmUShgfoZQSHK3TQyuTfUpsc8UfeNfD8KwPUvDBUdZ4nmR
}

async function getAvatarMetadata() {
    const avt = new AvatarResolver(provider);
    const avatarMetadata = await avt.getMetadata('tanrikulu.pls');
    // avatarMetadata = { image: ... , uri: ... , name: ... , description: ... }
    const avatarURI = avtUtils.getImageURI({ metadata /*, jsdomWindow: jsdom (on nodejs) */ });
    // avatarURI = https://ipfs.io/ipfs/QmUShgfoZQSHK3TQyuTfUpsc8UfeNfD8KwPUvDBUdZ4nmR
}

Supported avatar specs

NFTs

• ERC721
• ERC1155

URIs

• HTTP
• Base64
• IPFS

Options

Cache (Default: Disabled)

const avt = new AvatarResolver(provider, { cache: 300 }); // 5 min response cache in memory

Custom IPFS Gateway (Default: https://ipfs.io)

const avt = new AvatarResolver(provider, { ipfs: 'https://dweb.link' });

Custom Arweave Gateway (Default: https://arweave.net)

const avt = new AvatarResolver(provider, { arweave: 'https://arweave.net' });

Marketplace Api Keys (Default: {})

const avt = new AvatarResolver(provider, { 
    apiKey: {
        mintra: 'YOUR_API_KEY'
    }
});

URL DenyList (Default: [])

const avt = new AvatarResolver(provider, { urlDenyList: ['https://maliciouswebsite.com'] });

Demo

• Create .env file with RPC_URL env variable

• Build the library

• Node example

node example/node.js PNS_NAME

• Browser example

yarn build:demo
http-server example