ghost/core/server/services/oembed/NFTOEmbedProvider.js

The professional publishing platform

/**
 * @typedef {import('./oembed').ICustomProvider} ICustomProvider
 * @typedef {import('./oembed').IExternalRequest} IExternalRequest
 */

const OPENSEA_ETH_PATH_REGEX = /^\/assets\/ethereum\/(0x[a-f0-9]+)\/(\d+)/;

/**
 * @implements ICustomProvider
 */
class NFTOEmbedProvider {
    /**
     * @param {object} dependencies
     * @param {object} dependencies.config
     * @param {string} [dependencies.config.apiKey] - An OpenSea API key
     */
    constructor(dependencies) {
        this.dependencies = dependencies;
    }

    /**
     * @param {URL} url
     * @returns {Promise<boolean>}
     */
    async canSupportRequest(url) {
        return url.host === 'opensea.io' && OPENSEA_ETH_PATH_REGEX.test(url.pathname);
    }

    /**
     * @param {URL} url
     * @param {IExternalRequest} externalRequest
     *
     * @returns {Promise<object>}
     */
    async getOEmbedData(url, externalRequest) {
        const [match, transaction, asset] = url.pathname.match(OPENSEA_ETH_PATH_REGEX);
        if (!match) {
            return null;
        }
        const headers = {};
        if (this.dependencies.config.apiKey) {
            headers['X-API-KEY'] = this.dependencies.config.apiKey;
        }
        const result = await externalRequest(`https://api.opensea.io/api/v1/asset/${transaction}/${asset}/?format=json`, {
            headers
        }).json();
        return {
            version: '1.0',
            type: 'nft',
            title: result.body.name ? result.body.name : `#${result.body.token_id}`,
            author_name: result.body.creator.user.username,
            author_url: `https://opensea.io/${result.body.creator.user.username}`,
            provider_name: 'OpenSea',
            provider_url: 'https://opensea.io',
            image_url: result.body.image_url,
            creator_name: result.body.creator.user.username,
            description: result.body.description,
            collection_name: result.body.collection.name
        };
    }
}

module.exports = NFTOEmbedProvider;