RandomChad/functions/nft-media/rocketeer.js

const name = require( 'random-name' )
const { db } = require( '../modules/firebase' )
const { getTotalSupply } = require( '../modules/contract' )
const { pickRandomArrayEntry, pickRandomAttributes, randomNumberBetween, globalAttributes, heavenlyBodies, web2domain, getColorName } = require( '../modules/helpers' )
const svgFromAttributes = require( './svg-generator' )
const { forceOpenseaToUpdateMetadataForRocketeer } = require( '../integrations/opensea' )

// ///////////////////////////////
// Caching
// ///////////////////////////////
async function isInvalidRocketeerId( id, network='mainnet' ) {

    // Force type onto id 
    id = Number( id )

    // Chech if this is an illegal ID
    try {

        // Get the last know total supply
        let { cachedTotalSupply } = await db.collection( 'meta' ).doc( network ).get().then( doc => doc.data() ) || {}

        // Cast total supply into number
        cachedTotalSupply = Number( cachedTotalSupply )

        // If the requested ID is larger than that, check if the new total supply is more
        if( !cachedTotalSupply || cachedTotalSupply < id ) {

            // Get net total supply through infura, if infura fails, return the cached value just in case
            const totalSupply = Number( await getTotalSupply( network ) )

            // Write new value to cache
            await db.collection( 'meta' ).doc( network ).set( { cachedTotalSupply: totalSupply }, { merge: true } )

            // If the requested ID is larger than total supply, exit
            if( totalSupply < id ) return `Invalid ID ${ id }, total supply is ${ totalSupply }`

            // If all good, return true
            return false

        }

    } catch( e ) {
        return e
    }


}

async function getExistingRocketeer( id, network='mainnet' ) {

    return db.collection( `${ network }Rocketeers` ).doc( id ).get().then( doc => doc.data() ).catch( f => false )

}

// ///////////////////////////////
// Rocketeer generator
// ///////////////////////////////
async function generateRocketeer( id, network='mainnet' ) {

    // Put dibs on the Rocketeer ID to make race conditions more unlikely
    await db.collection( `${ network }Rocketeers` ).doc( id ).set( {}, { merge: true } )

    // The base object of a new Rocketeer
    const rocketeer = {
        name: `${ name.first() } ${ name.middle() } ${ name.last() } of ${ id % 42 == 0 ? 'the Towel' : pickRandomArrayEntry( heavenlyBodies ) }`,
        description: '',
        image: ``,
        external_url: `https://viewer.rocketeer.fans/?rocketeer=${ id }` + ( network == 'mainnet' ? '' : '&testnet=true' ),
        attributes: []
    }

    // Generate randomized attributes
    rocketeer.attributes = pickRandomAttributes( globalAttributes )

    // Generate color attributes
    rocketeer.attributes.push( {
        "trait_type": "outfit color",
        value: `rgb( ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) } )`
    } )
    rocketeer.attributes.push( {
        "trait_type": "outfit accent color",
        value: `rgb( ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) } )`
    } )
    rocketeer.attributes.push( {
        "trait_type": "backpack color",
        value: `rgb( ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) } )`
    } )
    rocketeer.attributes.push( {
        "trait_type": "visor color",
        value: `rgb( ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) }, ${ randomNumberBetween( 0, 255 ) } )`
    } )

    // Set birthday
    rocketeer.attributes.push( {
      "display_type": "date", 
      "trait_type": "birthday", 
      "value": Math.floor( Date.now() / 1000 )
    } )

    // Special editions
    const edition = { "trait_type": "edition", value: "regular" }
    if( id <= 50 ) edition.value = 'genesis'
    if( id % 42 === 0 ) edition.value = 'hitchhiker'
    if( ( id - 1 ) % 42 == 0 ) edition.value = 'generous'
    rocketeer.attributes.push( edition )

    // Generate, compile and upload image
    rocketeer.image = await svgFromAttributes( rocketeer.attributes, `${ network }Rocketeers/${id}` )

    // Namify the attributes
    rocketeer.attributes = rocketeer.attributes.map( attribute => {

        if( !attribute.trait_type.includes( 'color' ) ) return attribute
        return {
            ...attribute,
            value: getColorName( attribute.value )
        }

    } )

    // Create description
    rocketeer.description = `${ rocketeer.name } is a proud member of the ${ rocketeer.attributes.find( ( { trait_type } ) => trait_type == 'patch' ).value } guild.`

    // Save new Rocketeer
    await db.collection( `${ network }Rocketeers` ).doc( id ).set( rocketeer, { merge: true } )

    // Force opensea to update metadata
    await forceOpenseaToUpdateMetadataForRocketeer( id, network )

    return rocketeer

}

async function safelyReturnRocketeer( id, network ) {

    // Chech if this is an illegal ID
    const invalidId = await isInvalidRocketeerId( id, network )
    if( invalidId ) throw invalidId

    // Get old rocketeer if it exists
    const oldRocketeer = await getExistingRocketeer( id, network )
    if( oldRocketeer ) return oldRocketeer

    // If no old rocketeer exists, make a new one and save it
    return generateRocketeer( id, network )

}

module.exports = {
    web2domain: web2domain,
    safelyReturnRocketeer: safelyReturnRocketeer
}