187 lines
4.6 KiB
TypeScript
187 lines
4.6 KiB
TypeScript
import {
|
|
LoggerInstance,
|
|
Asset,
|
|
getHash,
|
|
Nft,
|
|
ProviderInstance,
|
|
DDO,
|
|
MetadataAndTokenURI,
|
|
NftCreateData
|
|
} from '@oceanprotocol/lib'
|
|
import { SvgWaves } from './SvgWaves'
|
|
import Web3 from 'web3'
|
|
import { TransactionReceipt } from 'web3-core'
|
|
|
|
// https://docs.opensea.io/docs/metadata-standards
|
|
export interface NftMetadata {
|
|
name: string
|
|
symbol: string
|
|
description: string
|
|
image?: string
|
|
/* eslint-disable camelcase */
|
|
external_url?: string
|
|
image_data?: string
|
|
background_color?: string
|
|
/* eslint-enable camelcase */
|
|
}
|
|
|
|
function encodeSvg(svgString: string): string {
|
|
return svgString
|
|
.replace(
|
|
'<svg',
|
|
~svgString.indexOf('xmlns')
|
|
? '<svg'
|
|
: '<svg xmlns="http://www.w3.org/2000/svg"'
|
|
)
|
|
.replace('></path>', '/>')
|
|
.replace(/"/g, "'")
|
|
.replace(/%/g, '%25')
|
|
.replace(/#/g, '%23')
|
|
.replace(/{/g, '%7B')
|
|
.replace(/}/g, '%7D')
|
|
.replace(/</g, '%3C')
|
|
.replace(/>/g, '%3E')
|
|
.replace(/\s+/g, ' ')
|
|
}
|
|
|
|
export function generateNftMetadata(): NftMetadata {
|
|
const waves = new SvgWaves()
|
|
const svg = waves.generateSvg()
|
|
const imageData = `data:image/svg+xml,${encodeSvg(svg.outerHTML)}`
|
|
|
|
const newNft: NftMetadata = {
|
|
name: 'Ocean Data NFT',
|
|
symbol: 'OCEAN-NFT',
|
|
description: `This NFT represents an asset in the Ocean Protocol v4 ecosystem.`,
|
|
external_url: 'https://market.oceanprotocol.com',
|
|
background_color: '141414', // dark background
|
|
image_data: imageData
|
|
}
|
|
|
|
return newNft
|
|
}
|
|
|
|
const tokenUriPrefix = 'data:application/json;base64,'
|
|
|
|
export function generateNftCreateData(
|
|
nftMetadata: NftMetadata,
|
|
accountId: string,
|
|
transferable = true
|
|
): any {
|
|
const nftCreateData: NftCreateData = {
|
|
name: nftMetadata.name,
|
|
symbol: nftMetadata.symbol,
|
|
templateIndex: 1,
|
|
tokenURI: '',
|
|
transferable,
|
|
owner: accountId
|
|
}
|
|
|
|
return nftCreateData
|
|
}
|
|
|
|
export function decodeTokenURI(tokenURI: string): NftMetadata {
|
|
if (!tokenURI) return undefined
|
|
|
|
try {
|
|
const nftMeta = tokenURI.includes('data:application/json')
|
|
? (JSON.parse(
|
|
Buffer.from(tokenURI.replace(tokenUriPrefix, ''), 'base64').toString()
|
|
) as NftMetadata)
|
|
: ({ image: tokenURI } as NftMetadata)
|
|
|
|
return nftMeta
|
|
} catch (error) {
|
|
LoggerInstance.error(`[NFT] ${error.message}`)
|
|
}
|
|
}
|
|
|
|
export async function setNftMetadata(
|
|
asset: Asset | DDO,
|
|
accountId: string,
|
|
web3: Web3,
|
|
signal: AbortSignal
|
|
): Promise<TransactionReceipt> {
|
|
const encryptedDdo = await ProviderInstance.encrypt(
|
|
asset,
|
|
asset.chainId,
|
|
asset.services[0].serviceEndpoint,
|
|
signal
|
|
)
|
|
LoggerInstance.log('[setNftMetadata] Got encrypted DDO', encryptedDdo)
|
|
|
|
const metadataHash = getHash(JSON.stringify(asset))
|
|
const nft = new Nft(web3)
|
|
|
|
// theoretically used by aquarius or provider, not implemented yet, will remain hardcoded
|
|
const flags = '0x2'
|
|
|
|
const setMetadataTx = await nft.setMetadata(
|
|
asset.nftAddress,
|
|
accountId,
|
|
0,
|
|
asset.services[0].serviceEndpoint,
|
|
'',
|
|
flags,
|
|
encryptedDdo,
|
|
'0x' + metadataHash
|
|
)
|
|
|
|
return setMetadataTx
|
|
}
|
|
|
|
export async function setNFTMetadataAndTokenURI(
|
|
asset: Asset | DDO,
|
|
accountId: string,
|
|
web3: Web3,
|
|
nftMetadata: NftMetadata,
|
|
signal: AbortSignal
|
|
): Promise<TransactionReceipt> {
|
|
const encryptedDdo = await ProviderInstance.encrypt(
|
|
asset,
|
|
asset.chainId,
|
|
asset.services[0].serviceEndpoint,
|
|
signal
|
|
)
|
|
LoggerInstance.log(
|
|
'[setNFTMetadataAndTokenURI] Got encrypted DDO',
|
|
encryptedDdo
|
|
)
|
|
|
|
const metadataHash = getHash(JSON.stringify(asset))
|
|
|
|
// add final did to external_url and asset link to description in nftMetadata before encoding
|
|
const externalUrl = `${nftMetadata.external_url}/asset/${asset.id}`
|
|
const encodedMetadata = Buffer.from(
|
|
JSON.stringify({
|
|
...nftMetadata,
|
|
description: `${nftMetadata.description}\n\nView on Ocean Market: ${externalUrl}`,
|
|
external_url: externalUrl
|
|
})
|
|
).toString('base64')
|
|
const nft = new Nft(web3)
|
|
|
|
// theoretically used by aquarius or provider, not implemented yet, will remain hardcoded
|
|
const flags = '0x02'
|
|
|
|
const metadataAndTokenURI: MetadataAndTokenURI = {
|
|
metaDataState: 0,
|
|
metaDataDecryptorUrl: asset.services[0].serviceEndpoint,
|
|
metaDataDecryptorAddress: '',
|
|
flags,
|
|
data: encryptedDdo,
|
|
metaDataHash: '0x' + metadataHash,
|
|
tokenId: 1,
|
|
tokenURI: `data:application/json;base64,${encodedMetadata}`,
|
|
metadataProofs: []
|
|
}
|
|
|
|
const setMetadataAndTokenURITx = await nft.setMetadataAndTokenURI(
|
|
asset.nftAddress,
|
|
accountId,
|
|
metadataAndTokenURI
|
|
)
|
|
|
|
return setMetadataAndTokenURITx
|
|
}
|