# Sologenic NFT Manager This Class is to (bulk) mint NFTs on the Sologenic NFT marketplace (sologenic.org/nfts/marketplace). After the minting process is completed, the NFTs will take a few minutes show up in the marketplace. DUE TO THE REQUIREMENTS OF USING THE WALLET SECRET, DO NOT USE THIS LIBRARY AT THE CLIENT SIDE !!!!!!!!!! ## Contents - [Usage](#usage) - [Methods](#methods) - [getApiURL](#getApiURL) - [setAccount](#setAccount) - [getAccountNFTS](#getAccountNfts) - [getNFTData](#getNFTData) - [getWalletAddress](#getWalletAddress) - [getBurnConfiguration](#getBurnConfiguration) - [generateNFTSlots](#generateNFTSlots) - [createCollection](#createCollection) - [updateCollection](#updateCollection) - [getAllCollections](#getAllCollections) - [getCollectionAddress](#getCollectionAddress) - [getCollectionData](#getCollectionData) - [getCollectionNFTSlots](#getCollectionNFTSlots) - [mint](#mint) - [mintMultipleCopies](#mintmultiplecopies) ## Usage ```js import { SologenicNFTManager } from "sologenic-nft-sdk"; import fs from "fs"; const minter = new SologenicNFTManager({ mode: "mainnet" | "testnet" | "devnet", xrpl_node: XRPL_NODE, }); // Example of how to submit the files const collectionCoverBuffer = fs.readFileSync("PATH_TO_COLLECTION_COVER_FILE"); const collectionThumbnailBuffer = fs.readFileSync("PATH_TO_COLLECTION_THUMBNAIL_FILE"); const nftFileBuffer = fs.readFileSync("PATH_TO_NFT_FILE"); const nftThumbnailBuffer = fs.readFileSync("PATH_TO_NFT_THUMBNAIL_FILE"); // Set the account to mint with const connected_account = minter.setAccount(YOUR_WALLET_SECRET); // After initializing the Minter, we need to set the collection address in which we want to mint // Use setCollectionAddress() if you know the collection you want to mint in // minter.setCollectionAddress(YOUR_DESIRED_COLLECTION); // or create a new collection with createCollection(). This method sets the recently created collection as the default to mint on, it can be overriden with setCollectionAddress(). await minter.createCollection({ name: "Test Collection", // REQUIRED: The name of the collection description: "Collection description", // OPTIONAL: The description of the collection cover: collectionCoverBuffer, // Cover of the Collection, can be only JPG, JPEG, PNG or GIF, recommended to be a compressed version, as this is for display purposes, it's not stored on the ledger thumbnail: collectionThumbnailBuffer // Thumbnail of the Collection, can be only JPG, JPEG, PNG or GIF, recommended to be a compressed version, as this is for display purposes, it's not stored on the ledger transfer_fee: 10000, // OPTIONAL (Defaults to 0): Sets the Royalty percentage for all the NFTs within this collection. Can be overwritten per NFT. A number between 0 and 50000 i.e to get 10% royalty transfer_fee must be 10000 }); // Once the collection is set. If you have available Slot (or burns) you can start minting. const { mint_tx_hash, NFTokenID } = await minter.mint({ file: nftFileBuffer, // Original data of the NFT can be any of the supported files Sologenic accepts thumbnail: nftThumbnailBuffer, // Thumbnail of the NFT, can be only JPG, JPEG, PNG or GIF, recommended to be a compressed version, as this is for display purposes, it's not stored on the ledger name: "Testing NFT 3", // REQUIRED: The name of the NFT category: "arts", // REQUIRED: Sets the category on the NFT for the Marketplace only_xrp: false, // REQUIRED (Defaults to false): Sets if the NFT can only be traded for XRP is_explicit: false, // REQUIRED (Default to false): Sets if the NFT contains Explicit content transfer_fee: 10000, // OPTIONAL (Defaults to 0): A number between 0 and 50000 i.e to get 10% royalty transfer_fee must be 10000. If set, it will override the Collection Transfer fee. description: "Testing NFT description", // OPTIONAL: Description of the NFT external_url: "https://sologenic.org", // OPTIONAL: URL for more information of the NFT attributes: [ //OPTIONAL: Attributes of the NFT, what makes it unique { trait_type: "attribute", value: "attr", }, { trait_type: "attribute 2", value: 1, max_value: 2, }, ], }); ``` ## Methods ### `getApiURL` Returns information about the Sologenic API mode connection ```js const url = minter.getApiURL(); ``` _Returns_ This method returns an object with the following properties: | Property | Value | | :------- | ---------------------------: | | mode | mainnet or testnet or devnet | | url | Sologenic Api URL | ### `setAccount` This method sets the default account to use. _Example_ ```js const wallet_address = minter.setAccount(YOUR_WALLET_SECRET); // rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG ``` ### `getAccountNFTS` This method returns ALL the NFTs owned by this account in reference to the ledger; to get the NFT metadata (name, description, etc) you will need to call the method [getNFTData](#getNFTData). _Example_ ```js const nfts = await minter.getAccountNFTS(); ``` _Params_ This method takes one OPTIONAL parameter; an account address. If they account address is not passed, it will default to the connected account. If there is no parameter passed nor account connected (See [setAccount](#setAccount)), this method will throw an exception. | Param | Type | | :------ | -----: | | address | string | _Returns_ This method returns an array of the NFTs owned by the passed account (or default account) on reference with the XRP Ledger. These are the properties on each NFT object | Property | Description | Example | | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | TransferFee | The royalty set for this NFT. 10000 = 10% | 10000 | | Flags | Flags are properties or other options associated with the NFT object. | 8 | | NFTokenTaxon | The taxon associated with the token. | 34356 | | NFTokenID | Unique identifier of the NFT on the XRPL Ledger | 000A2134C4E16036D649C037D2DE7C58780DE1D985EEB986483AE3C9000001AC | | nft_serial | Serial number of the NFT | 8 | | Issuer | Minter of the NFT. | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | URI (Optional) | Up to 256 bytes of arbitrary data. You can use the xrpl.convertHexToString utility to convert the HEX string to its string equivalent. The contents could decode to an HTTP or HTTPS URL, an IPFS URI, a magnet link, immediate data encoded as an RFC 2379 "data" URL , or even an issuer-specific encoding. | 68747470733A2F2F697066732E696F2F697066732F62616679626569666F76696766743578636B6A696C6C6A666E636F756F74716A626E7669697070326F636A35323471347675747161736D6B7378612F6D657461646174612E6A736F6E | ### `getNFTData` This method returns the data of an specific NFT using its NFTokenID. Note: If the NFT exists on the XRP Ledger but this method returns a NFT_NOT_FOUND, maybe the NFT was not minted on the Sologenic NFT Marketplace. _Params_ This method takes one parameter. | Property | Type | Description | | :-------- | -----: | :--------------------------------------------------------------- | | NFTokenID | string | 000A2134C4E16036D649C037D2DE7C58780DE1D985EEB986483AE3C9000001AC | _Returns_ This method returns an object with 2 objects inside. `sologenic_info` and `xrpl_info`. If the NFT exists, `xrpl_info` should always be returned, if `sologenic_info` is `NULL` then it means the NFT was not minted on the sologenic platform. #### `xrpl_info` | Property | Description | Example | | :----------- | ----------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------- | | nft_id | NFTokenID | 000827107022610A05BAA45AE04D5B022D1FF298795EF9AB000083F100000000 | | ledger_index | Current Ledger index of the XRPL Server | 76545315 | | is_burned | Whether the NFT has been burned or not | `false` | | issuer | Issuing address | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | owner | Current owner address | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | flags | Flags of the settings enabled in the NFT | 8 | | transfer_fee | Royalty percentage the issuer gets after every sale of the NFT | 10000 (10%) | | nft_taxon | Taxon for the NFT set on the NFTokenMint transaction | 12345 | | nft_sequence | Serial number of the NFT. Referenced to the Issuer account | 12 | | uri | Arbitrary data set on the URI field of the NFTokenMint transaction. | https://ipfs.io/ipfs/bafybeie7cd4s2pv4e5tode7xjvqjlkpp5kuflqcl73keadixevqjoq3r3y/metadata.json | | validated | States that the ledger index when this request was made has been validated on the XRP Ledger servers. | true | _Example_ ```js const nft_data = await minter.getNFTData(NFTokenID); ``` #### `sologenic_info` | Property | Description | Example | | :--------------------- | -------------------------------------------------------------------: | :------------------------------------------------------------------------------------ | | id | NFTokenID | 000827107022610A05BAA45AE04D5B022D1FF298795EF9AB000083F100000000 | | standard | NFT Standard minted on | XLS-20d | | collection_id | Collection address | rDZj8PN21gmtWwqFY1SAqyubRHeT87NSVC | | minter | Minter address | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | owner | Current owner address | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | ipfs_cid | CID of the NFT on IPFS | bafybeihly7rjgfypze7hcruuss3vgzl7wh2e7zcplsbsj75ecrnuwjlydi | | md5_hash | MD5 hash of the contents of the NFT | cfe2892441f41d6ea15f1e4e71614f3f | | minted_txid | Transaction Hash of the NFTokenMint Transaction that minted this NFT | 590B998100CCA720D0BA77BC73EF69E6358A53AE9A86A8E706DAC8498DBA0738 | | metadata.animation_url | IPFS Url of the NFT Animation | ipfs://ipfs/bafybeiacwbv46qb7mnnjppxpshenoo5dc65uvucz3nggfimriz2hoqtsiq/animation.png | | metadata.attributes | Array of attributes pertaining the NFT | See [mint()](#mint) for details of this property | | metadata.category | Category of the NFT | art | | metadata.content_type | Mime type of the NFT | image/png | | metadata.description | Description of the NFT | Testing NFT Description | | metadata.external_url | External URL minted on the NFT | https://sologenic.org | | metadata.image_url | IPFS URL of the NFT Image | ipfs://ipfs/bafybeiacwbv46qb7mnnjppxpshenoo5dc65uvucz3nggfimriz2hoqtsiq/image.png | | metadata.is_explicit | Whether the NFT includes explicit or sensitive content | `false` | | metadata.md5hash | MD5 hash of the contents of the NFT | cfe2892441f41d6ea15f1e4e71614f3f | | metadata.name | Name of the NFT | Testing NFT | ### `getWalletAddress` Returns the address of the wallet which was used to initialize the Sologenic Minter _Example_ ```js const address = minter.getWalletAddress(); // rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG ``` ### `getBurnConfiguration` Returns the current burn configuration to get NFT Slots _Returns_ | Property | Value | | :------------ | ---------------------------------------: | | burn_amount | 3 | | burn_currency | 534F4C4F00000000000000000000000000000000 | | burn_issuer | rsoLo2S1kiGeCcn6hCUXVrCpGMWLrRrLZz | _Example_ ```js const config = await minter.getBurnConfiguration(); ``` ### `generateNFTSlots` Generates NFT Slots by burning SOLO. NOTE: This method requires the connected wallet to have a positive SOLO Balance _Params_ | Param | Type | Required | Example | | :----- | :--- | :------: | :-----: | | amount | int | `true` | 1 | _Returns_ | Property | Description | Example | | :---------- | --------------------------: | ---------------------------------------------------------------: | | address | Wallet address used to burn | rBDu1BC6f1SKRvRxPiHZdeML5CRwByQTFG | | hash | Burn Transaction Hash | 1016EC6C70C9C2CD9D3C6B8A8439AA538409181DBE1E5D56698BDAE61AE03608 | | burns_count | Amount of Slots acquired | 1 | _Example_ ```js const slots_generation = await generateNFTSlots(1); ``` ### `createCollection` Creates a new collection or returns the current unfinished collection. NOTE: If there is an unfinished collection, the data passed will override the current collection information. NOTE: This method sets the recently created (or updated) collection as the default to mint NFTs on _Params_ This method takes an object with all the data for the Collection. | Property | Type | Required | Description | Example | | :----------- | :----- | :------: | :--------------------------------------------------------------------------------------------- | :----------------------------------------: | | name | string | `true` | The name for the collection. | "My Awesome Collection" | | description | string | `false` | The description for the collection. | "My Awesome Description for my Collection" | | cover | Buffer | `false` | Buffer for the cover of the collection | | | thumbnail | Buffer | `false` | Buffer for the thumbnail of the collection | | | transfer_fee | int | `false` | Royalties for the NFTs within this collection. NOTE: This can be overriden when minting an NFT | 10000 | _Returns_ | Property | Description | Example | | :------------ | -----------------------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------: | | issuer | Identifier of the collection | rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg | | name | Name of the collection | "My Awesome collection" | | description | Description of the collection | "My Awesome Description for my collection" | | nfts | List of NFT Slots, any slot can be empty (available) or filled (an nft has been uploaded but not minted yet) | See [`getCollectionNFTSlots`](#getcollectionnftslots) | | cover | URL of the uploaded cover | https://storage.googleapis.com/sg-nft-images/cover/rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg | | thumbnail | URL of the uploaded thumbnail | https://storage.googleapis.com/sg-nft-images/thumbnail/rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg | | unusued_burns | Amount of available slots to mint | 5 | | minted_nfts | List of ALL minted NFTs within this collections | NFT[] | _Example_ ```js import fs from "fs"; // Example of how to submit the files const collectionCoverBuffer = fs.readFileSync("PATH_TO_COLLECTION_COVER_FILE"); const collectionThumbnailBuffer = fs.readFileSync("PATH_TO_COLLECTION_THUMBNAIL_FILE"); const collectionData = { name: "New Collection", description: "New Collection Description" cover: collectionCoverBuffer, thumbnail: collectionThumbnailBuffer, transfer_fee: 10000 // 10% }; const new_collection = await minter.createCollection(collectionData); ``` ### `updateCollection` Updates the current set collection. _Params_ This method takes an object with all the data for the Collection. NOTE: Only unfinished collections can be updated. | Property | Type | Required | Description | Example | | :----------- | :----- | :------: | :--------------------------------------------------------------------------------------------- | :----------------------------------------: | | name | string | `true` | The name for the collection. | "My Awesome Collection" | | description | string | `false` | The description for the collection. | "My Awesome Description for my Collection" | | cover | Buffer | `false` | Buffer for the cover of the collection | | | thumbnail | Buffer | `false` | Buffer for the thumbnail of the collection | | | transfer_fee | int | `false` | Royalties for the NFTs within this collection. NOTE: This can be overriden when minting an NFT | 10000 | _Returns_ This method doesn't return a response. After calling this method, you need to call `await minter.getCollectionData()` to see the updated collection data. _Example_ ```js import fs from "fs"; // Example of how to submit the files const collectionCoverBuffer = fs.readFileSync("PATH_TO_COLLECTION_COVER_FILE"); const collectionThumbnailBuffer = fs.readFileSync("PATH_TO_COLLECTION_THUMBNAIL_FILE"); const collectionData = { name: "New Updated Collection", description: "New Collection Description Update" cover: collectionCoverBuffer, thumbnail: collectionThumbnailBuffer, transfer_fee: 10000 // 10% }; // Set the default collection await minter.setCollectionAddress("rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg"); // Update default collection await minter.updateCollection(collectionData); // Get updated default collection const collection = await minter.getCollectionData(); ``` ### `getAllCollections` This method returns an Array of all the collections available to the account. _Returns_ An array of Collection Objects. These are the properties of the Collection object. Please see [`getCollectionData`](#getcollectiondata) to see properties of the Collection object _Example_ ```js const collections = await minter.getAllCollections(); ``` ### `getCollectionAddress` This method returns the address of the default collection ```js const collection_address = await minter.getCollectionAddress(); // rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg ``` ### `getCollectionData` This method returns the data of the default collection _Returns_ | Property | Description | Example | | :----------- | :----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------: | | name | Name of the collection | "My Awesome Collection" | | description | Description of the collection | 1016EC6C70C9C2CD9D3C6B8A8439AA538409181DBE1E5D56698BDAE61AE03608 | | cover | URL of the cover uploaded | "https://storage.googleapis.com/sg-nft-images/cover/rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg" | | thumbnail | URL of the thumbnail uploaded | "https://storage.googleapis.com/sg-nft-images/thumbnail/rN7DsVCsJ6vRQtNMD8yMLeKvovSXM5P3Dg" | | transfer_fee | Royalty set for all the NFTs within this collection. NOTE: Can be overriden when minting an NFT. | 10000 | | cid | Collection ID on IPFS | bafybeiba6su6ni3dfwhmjbzi5fz4pqehtnnwgg5yjwhss6mak3wqnwglhm | | created_at | Date of creation | 2022-12-30T17:23:26.000Z | | minted_nfts | Amount of NFTs minted in this collection | 5 | ### `getCollectionNFTSlots` This method returns an Array of all the NFT Slots of the default collection, both available and already uploaded, but not minted, NFTs. _Returns_ These are the properties of each NFT Slot. | Property | Description | Example | | :----------- | -----------------------------------------------------------------------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------: | | id | ID of the slot | 12345 | | uid | UID of the slot | 829df87d-0e2e-48f6-8387-b6a2e1a26462 | | currency | Legacy ID for the NFT | 023031516D656A664E4654393331363900000000 | | name | Name of the NFT | My Awesome NFT | | location | IPFS ID of the NFT | bafybeihtuck5qncoo2img32zvyjm54r6t6are2xelbrrtqhp7lb73zlulq | | content_type | Type and extension of the NFT file | image/png | | thumbnail | URL of the uploaded thumbnail | https://storage.googleapis.com/sg-nft-images/thumbnail/rDZj8PN21gmtWwqFY1SAqyubRHeT87NSVC/35449 | | md5_hash | md5_hash of the NFT file | 96cc419020a6f55a6c05e38968ec5bb4 | | transfer_fee | Royalty for this NFT, if 0 and Collection Royalty is set, Collection royalty will be added to the NFT. If this is set, Collection Royalty will be overriden. | 10000 | | only_xrp | This sets if the NFT can only be sold for XRP | 0 or 1 (0 = false, 1 = true) | | sealed | Indicates if NFT has been set for minting | 0 or 1 (0 = false, 1 = true) | ### `mint` This method mints and NFT within the default collection if there are any NFT Slots available. _Params_ This method takes two parameters an Object with all the data of the NFT and an Object with options. #### NFT DATA | Property | Type | Required | | :----------- | :------------- | :------: | | file | Buffer | `true` | | thumbnail | Buffer | `true` | | name | string | `true` | | category | string | `true` | | only_xrp | boolean | `true` | | is_explicit | boolean | `true` | | transfer_fee | int | `false` | | description | string | `false` | | external_url | URL | `false` | | attributes | NFTAttribute[] | `false` | ```js interface NFTAttribute { trait_type: string; value: string | number; max_value?: number; } ``` _Example_ ```js import fs from "fs"; const nftFileBuffer = fs.readFileSync("PATH_TO_NFT_FILE"); const nftThumbnailBuffer = fs.readFileSync("PATH_TO_NFT_THUMBNAIL_FILE"); const nft = { file: nftFileBuffer, thumbnail: nftThumbnailBuffer, name: "Testing NFT 3", category: "art", only_xrp: false, is_explicit: false, transfer_fee: 10000, description: "Testing NFT description", external_url: "https://sologenic.org", attributes: [ { trait_type: "attribute", value: "attr", }, { trait_type: "attribute 2", value: 1, max_value: 2, }, ], }; const { NFTokenID, mint_tx_hash } = await minter.mint(nft); ``` #### OPTIONS | Property | Type | Required | Description | | :------- | :------ | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | autoBurn | boolean | `false` | If the minter should attempt to burn SOLO for more NFT Slots if required | | onBehalf | string | `false` | If this NFT is being minted on behalf of another account. The other account should have the initating address as Minter on their AccountRoot object. See [NFTokenMint](https://xrpl.org/nftokenmint.html#issuing-on-behalf-of-another-account) | _Returns_ This method returns an object, these are the properties of the object | Property | Example | | :----------- | ---------------------------------------------------------------: | | mint_tx_hash | B1561A148081359BECA7D4F309820B88DB9940A58458D5D363B8BED02EDB9D3A | | NFTokenID | 000827107022610A05BAA45AE04D5B022D1FF298795EF9ABE4FAB9DF0000000A | ### `mintMultipleCopies` _Params_ This method takes two parameters. | Param | Type | Required | | :------ | :-------------------------------------- | :------: | | nft | [See `mint()` method for params](#mint) | `true` | | options | MintMultipleCopiesOptions | `true` | _Example_ ```js import fs from "fs"; const nftFileBuffer = fs.readFileSync("PATH_TO_NFT_FILE"); const nftThumbnailBuffer = fs.readFileSync("PATH_TO_NFT_THUMBNAIL_FILE"); const nft = { file: nftFileBuffer, thumbnail: nftThumbnailBuffer, name: "Testing NFT 3", category: "art", only_xrp: false, is_explicit: false, transfer_fee: 10000, description: "Testing NFT description", external_url: "https://sologenic.org", attributes: [ { trait_type: "attribute", value: "attr", }, { trait_type: "attribute 2", value: 1, max_value: 2, }, ], }; const options = { numberOfCopies: 5, autoBurn: true, }; const copies_result = await minter.mintMultipleCopies(nft, options); ``` #### OPTIONS These are the properties of the Options object. | Param | Type | Required | Description | | :------------- | :------ | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | numberOfCopies | number | `true` | Amount of copies of the same NFT to mint | | autoBurn | boolean | `false` | If the minter should attempt to burn SOLO for more NFT Slots if required | | onBehalf | string | `false` | If this NFT is being minted on behalf of another account. The other account should have the initating address as Minter on their AccountRoot object. See [NFTokenMint](https://xrpl.org/nftokenmint.html#issuing-on-behalf-of-another-account) | _Returns_ This method returns an object with the next properties | Property | Example | Description | | :------------ | ---------------: | :---------------------------------------------------------------------------------------- | | copies_minted | 5 | Amount of copies successfully minted | | nfts | NFTResult[] | Array of the successfully minted NFTs. [See `mint()` response for properties of each NFT] | | error | `Object or null` | If null, means the method ran successfully and all nfts were minted. |