emblem-vault-sdk 1.2.2 → 1.3.0

package/dist/bundle.js

@@ -684189,7 +684189,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("./utils");
-const SDK_VERSION = '1.2.2';
+const SDK_VERSION = '1.3.0';
 class EmblemVaultSDK {
     constructor(apiKey, baseUrl) {
         this.apiKey = apiKey;
@@ -684203,6 +684203,23 @@ class EmblemVaultSDK {
     generateUploadUrl() {
         // Implementation goes here
     }
+    // ** Asset Metadata **
+    //
+    getAssetMetadata(projectName, strict = false) {
+        (0, utils_1.genericGuard)(projectName, "string", "projectName");
+        const NFT_DATA_ARR = (0, utils_1.metadataObj2Arr)(utils_1.NFT_DATA);
+        let filtered = strict ?
+            NFT_DATA_ARR.filter(item => item.projectName === projectName) :
+            NFT_DATA_ARR.filter(item => item.projectName.toLowerCase() === projectName.toLowerCase());
+        return filtered;
+    }
+    getAllProjects() {
+        const NFT_DATA_ARR = (0, utils_1.metadataObj2Arr)(utils_1.NFT_DATA);
+        const projects = (0, utils_1.metadataAllProjects)(NFT_DATA_ARR);
+        return projects;
+    }
+    // ** Curated **
+    //
     fetchCuratedContracts(hideUnMintable = false) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = `${this.baseUrl}/curated`;
@@ -684266,9 +684283,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COIN_TO_NETWORK = exports.genericGuard = exports.templateGuard = exports.generateTemplate = exports.generateImageTemplate = exports.generateAttributeTemplate = exports.fetchData = exports.evaluateFacts = exports.pad = void 0;
+exports.COIN_TO_NETWORK = exports.genericGuard = exports.templateGuard = exports.generateTemplate = exports.generateImageTemplate = exports.generateAttributeTemplate = exports.fetchData = exports.metadataAllProjects = exports.metadataObj2Arr = exports.evaluateFacts = exports.pad = exports.NFT_DATA = void 0;
 const metadata_json_1 = __importDefault(require("./curated/metadata.json"));
-const NFT_DATA = metadata_json_1.default;
+exports.NFT_DATA = metadata_json_1.default;
 const pad = (num, size) => {
     if (!num)
         return null;
@@ -684292,6 +684309,15 @@ const evaluateFacts = (allowed, facts, msgCallback) => {
     return allowed;
 };
 exports.evaluateFacts = evaluateFacts;
+const metadataObj2Arr = (data) => Object.keys(data).map(key => (Object.assign(Object.assign({}, data[key]), { assetName: key })));
+exports.metadataObj2Arr = metadataObj2Arr;
+const metadataAllProjects = (projects) => projects.reduce((unique, item) => {
+    if (!unique.includes(item.projectName)) {
+        unique.push(item.projectName);
+    }
+    return unique;
+}, []);
+exports.metadataAllProjects = metadataAllProjects;
 const fetchData = (url, apiKey, method = 'GET', body = null) => __awaiter(void 0, void 0, void 0, function* () {
     const fetch = typeof window !== 'undefined' && typeof window.fetch === 'function' ? window.fetch : require('node-fetch');
     const options = {
@@ -684325,28 +684351,28 @@ function generateAttributeTemplate(record) {
                 "trait_type": "Series",
                 "value": (metadata) => {
                     var _a, _b;
-                    return (_b = (0, exports.pad)((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.series, 2)) === null || _b === void 0 ? void 0 : _b.toString();
+                    return (_b = (0, exports.pad)((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.series, 2)) === null || _b === void 0 ? void 0 : _b.toString();
                 }
             },
             {
                 "trait_type": "Card",
                 "value": (metadata) => {
                     var _a, _b;
-                    return (_b = (0, exports.pad)((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.order, 2)) === null || _b === void 0 ? void 0 : _b.toString();
+                    return (_b = (0, exports.pad)((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.order, 2)) === null || _b === void 0 ? void 0 : _b.toString();
                 }
             },
             {
                 "trait_type": "Total Supply",
                 "value": (metadata) => {
                     var _a, _b, _c, _d;
-                    return (_d = (0, exports.pad)(((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.remaining) || ((_c = (_b = NFT_DATA[metadata.targetAsset.name]) === null || _b === void 0 ? void 0 : _b.raw) === null || _c === void 0 ? void 0 : _c.supply), 2)) === null || _d === void 0 ? void 0 : _d.toString();
+                    return (_d = (0, exports.pad)(((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.remaining) || ((_c = (_b = exports.NFT_DATA[metadata.targetAsset.name]) === null || _b === void 0 ? void 0 : _b.raw) === null || _c === void 0 ? void 0 : _c.supply), 2)) === null || _d === void 0 ? void 0 : _d.toString();
                 }
             },
             {
                 "trait_type": "Artist",
                 "value": (metadata) => {
                     var _a, _b, _c;
-                    return (_c = (0, exports.pad)((_b = (_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.raw) === null || _b === void 0 ? void 0 : _b.artist.name, 2)) === null || _c === void 0 ? void 0 : _c.toString();
+                    return (_c = (0, exports.pad)((_b = (_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.raw) === null || _b === void 0 ? void 0 : _b.artist.name, 2)) === null || _c === void 0 ? void 0 : _c.toString();
                 }
             }
         ];
@@ -684354,9 +684380,9 @@ function generateAttributeTemplate(record) {
             template.push({
                 "trait_type": "Year",
                 "value": (metadata) => {
-                    return (NFT_DATA[metadata.targetAsset.name].series < 10 ? '2016' :
-                        NFT_DATA[metadata.targetAsset.name].series > 9 &&
-                            NFT_DATA[metadata.targetAsset.name].series < 31 ? '2017' :
+                    return (exports.NFT_DATA[metadata.targetAsset.name].series < 10 ? '2016' :
+                        exports.NFT_DATA[metadata.targetAsset.name].series > 9 &&
+                            exports.NFT_DATA[metadata.targetAsset.name].series < 31 ? '2017' :
                             '2018');
                 }
             });
@@ -684532,7 +684558,7 @@ function generateTemplate(record) {
                 allowedName = asset ? true : false;
             }
             else { // XCP
-                let curatedItemFound = NFT_DATA[asset];
+                let curatedItemFound = exports.NFT_DATA[asset];
                 allowedName = asset && curatedItemFound ? true : false;
             }
             return allowedName;
@@ -684603,7 +684629,7 @@ function generateTemplate(record) {
                 }
             }
             // handle xcp image urls
-            let assetInformation = NFT_DATA[nameAndImage.name] ? NFT_DATA[nameAndImage.name] : false;
+            let assetInformation = exports.NFT_DATA[nameAndImage.name] ? exports.NFT_DATA[nameAndImage.name] : false;
             if (assetInformation) {
                 if (assetInformation.image) {
                     nameAndImage.image = assetInformation.image;

package/docs/bundle.js

@@ -684189,7 +684189,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("./utils");
-const SDK_VERSION = '1.2.2';
+const SDK_VERSION = '1.3.0';
 class EmblemVaultSDK {
     constructor(apiKey, baseUrl) {
         this.apiKey = apiKey;
@@ -684203,6 +684203,23 @@ class EmblemVaultSDK {
     generateUploadUrl() {
         // Implementation goes here
     }
+    // ** Asset Metadata **
+    //
+    getAssetMetadata(projectName, strict = false) {
+        (0, utils_1.genericGuard)(projectName, "string", "projectName");
+        const NFT_DATA_ARR = (0, utils_1.metadataObj2Arr)(utils_1.NFT_DATA);
+        let filtered = strict ?
+            NFT_DATA_ARR.filter(item => item.projectName === projectName) :
+            NFT_DATA_ARR.filter(item => item.projectName.toLowerCase() === projectName.toLowerCase());
+        return filtered;
+    }
+    getAllProjects() {
+        const NFT_DATA_ARR = (0, utils_1.metadataObj2Arr)(utils_1.NFT_DATA);
+        const projects = (0, utils_1.metadataAllProjects)(NFT_DATA_ARR);
+        return projects;
+    }
+    // ** Curated **
+    //
     fetchCuratedContracts(hideUnMintable = false) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = `${this.baseUrl}/curated`;
@@ -684266,9 +684283,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COIN_TO_NETWORK = exports.genericGuard = exports.templateGuard = exports.generateTemplate = exports.generateImageTemplate = exports.generateAttributeTemplate = exports.fetchData = exports.evaluateFacts = exports.pad = void 0;
+exports.COIN_TO_NETWORK = exports.genericGuard = exports.templateGuard = exports.generateTemplate = exports.generateImageTemplate = exports.generateAttributeTemplate = exports.fetchData = exports.metadataAllProjects = exports.metadataObj2Arr = exports.evaluateFacts = exports.pad = exports.NFT_DATA = void 0;
 const metadata_json_1 = __importDefault(require("./curated/metadata.json"));
-const NFT_DATA = metadata_json_1.default;
+exports.NFT_DATA = metadata_json_1.default;
 const pad = (num, size) => {
     if (!num)
         return null;
@@ -684292,6 +684309,15 @@ const evaluateFacts = (allowed, facts, msgCallback) => {
     return allowed;
 };
 exports.evaluateFacts = evaluateFacts;
+const metadataObj2Arr = (data) => Object.keys(data).map(key => (Object.assign(Object.assign({}, data[key]), { assetName: key })));
+exports.metadataObj2Arr = metadataObj2Arr;
+const metadataAllProjects = (projects) => projects.reduce((unique, item) => {
+    if (!unique.includes(item.projectName)) {
+        unique.push(item.projectName);
+    }
+    return unique;
+}, []);
+exports.metadataAllProjects = metadataAllProjects;
 const fetchData = (url, apiKey, method = 'GET', body = null) => __awaiter(void 0, void 0, void 0, function* () {
     const fetch = typeof window !== 'undefined' && typeof window.fetch === 'function' ? window.fetch : require('node-fetch');
     const options = {
@@ -684325,28 +684351,28 @@ function generateAttributeTemplate(record) {
                 "trait_type": "Series",
                 "value": (metadata) => {
                     var _a, _b;
-                    return (_b = (0, exports.pad)((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.series, 2)) === null || _b === void 0 ? void 0 : _b.toString();
+                    return (_b = (0, exports.pad)((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.series, 2)) === null || _b === void 0 ? void 0 : _b.toString();
                 }
             },
             {
                 "trait_type": "Card",
                 "value": (metadata) => {
                     var _a, _b;
-                    return (_b = (0, exports.pad)((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.order, 2)) === null || _b === void 0 ? void 0 : _b.toString();
+                    return (_b = (0, exports.pad)((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.order, 2)) === null || _b === void 0 ? void 0 : _b.toString();
                 }
             },
             {
                 "trait_type": "Total Supply",
                 "value": (metadata) => {
                     var _a, _b, _c, _d;
-                    return (_d = (0, exports.pad)(((_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.remaining) || ((_c = (_b = NFT_DATA[metadata.targetAsset.name]) === null || _b === void 0 ? void 0 : _b.raw) === null || _c === void 0 ? void 0 : _c.supply), 2)) === null || _d === void 0 ? void 0 : _d.toString();
+                    return (_d = (0, exports.pad)(((_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.remaining) || ((_c = (_b = exports.NFT_DATA[metadata.targetAsset.name]) === null || _b === void 0 ? void 0 : _b.raw) === null || _c === void 0 ? void 0 : _c.supply), 2)) === null || _d === void 0 ? void 0 : _d.toString();
                 }
             },
             {
                 "trait_type": "Artist",
                 "value": (metadata) => {
                     var _a, _b, _c;
-                    return (_c = (0, exports.pad)((_b = (_a = NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.raw) === null || _b === void 0 ? void 0 : _b.artist.name, 2)) === null || _c === void 0 ? void 0 : _c.toString();
+                    return (_c = (0, exports.pad)((_b = (_a = exports.NFT_DATA[metadata.targetAsset.name]) === null || _a === void 0 ? void 0 : _a.raw) === null || _b === void 0 ? void 0 : _b.artist.name, 2)) === null || _c === void 0 ? void 0 : _c.toString();
                 }
             }
         ];
@@ -684354,9 +684380,9 @@ function generateAttributeTemplate(record) {
             template.push({
                 "trait_type": "Year",
                 "value": (metadata) => {
-                    return (NFT_DATA[metadata.targetAsset.name].series < 10 ? '2016' :
-                        NFT_DATA[metadata.targetAsset.name].series > 9 &&
-                            NFT_DATA[metadata.targetAsset.name].series < 31 ? '2017' :
+                    return (exports.NFT_DATA[metadata.targetAsset.name].series < 10 ? '2016' :
+                        exports.NFT_DATA[metadata.targetAsset.name].series > 9 &&
+                            exports.NFT_DATA[metadata.targetAsset.name].series < 31 ? '2017' :
                             '2018');
                 }
             });
@@ -684532,7 +684558,7 @@ function generateTemplate(record) {
                 allowedName = asset ? true : false;
             }
             else { // XCP
-                let curatedItemFound = NFT_DATA[asset];
+                let curatedItemFound = exports.NFT_DATA[asset];
                 allowedName = asset && curatedItemFound ? true : false;
             }
             return allowedName;
@@ -684603,7 +684629,7 @@ function generateTemplate(record) {
                 }
             }
             // handle xcp image urls
-            let assetInformation = NFT_DATA[nameAndImage.name] ? NFT_DATA[nameAndImage.name] : false;
+            let assetInformation = exports.NFT_DATA[nameAndImage.name] ? exports.NFT_DATA[nameAndImage.name] : false;
             if (assetInformation) {
                 if (assetInformation.image) {
                     nameAndImage.image = assetInformation.image;

package/docs/index.html

@@ -29,7 +29,7 @@
                 selectElement().removeChild(selectElement().firstChild);
             }
             const defaultOptionElement = document.createElement('option');
-            defaultOptionElement.value = '0';
+            defaultOptionElement.value = '-1';
             defaultOptionElement.text = 'Select contract';
             selectElement().appendChild(defaultOptionElement);
             curatedContracts.forEach((contract, index) => {                
@@ -42,6 +42,29 @@
             });
             selectElement().style.display = 'block';
         }
+
+        function generateAssetDropdown(curatedContract) {
+            const selectElement = function () { return document.getElementById('vaultAssetSelect') }
+            // let hide = document.getElementById('hideNotMintableCheckbox').checked
+            while (selectElement().firstChild) {
+                selectElement().removeChild(selectElement().firstChild);
+            }
+            const defaultOptionElement = document.createElement('option');
+            defaultOptionElement.value = '0';
+            defaultOptionElement.text = 'Select asset';
+            selectElement().appendChild(defaultOptionElement);
+            let assets = sdk.getAssetMetadata(curatedContract.name)
+            window.assets = assets
+            assets.forEach((contract, index) => {                
+                // if (!hide || (hide && contract.mintable)) {
+                    const optionElement = document.createElement('option');
+                    optionElement.value = index.toString();
+                    optionElement.text = assets[index].assetName;
+                    selectElement().appendChild(optionElement);
+                // }
+            });
+            selectElement().style.display = 'block';
+        }
         
         async function createVault() {
             document.getElementById('vaultDetails').display = 'none';
@@ -51,8 +74,7 @@
             console.log("--------- Vault Details ---------");
             console.log(vault)
             document.getElementById('tokenId').value = vault.tokenId;
-            await getMetadata();
-           
+            await getMetadata();           
         }
 
         async function createMultipleVaults(index = 0, vaultCount = document.getElementById('vaultCount').value) {
@@ -72,16 +94,33 @@
         function selectContract(index) {
             let contract = window.curatedContracts[index];
             let template = contract.generateCreateTemplate(contract)
+            template.toAddress = document.getElementById('ethAddress').value;
+            template.fromAddress = document.getElementById('ethAddress').value;
+            window.contract = contract;
+            window.template = template;
+            
             console.log("--------- Contract Details ---------");
             console.log(contract);
             console.log("---------- Create Template ----------");
             console.log(template);
+            console.log("--------- Populated Template ---------");            
+            console.log(template);
+
+            
+            if (contract.loadTypes.includes('select')) {
+                generateAssetDropdown(contract);
+            } else {
+                document.getElementById('vaultAssetSelect').style.display = 'none';
+            }
+        }
+
+        function selectAsset(index) {
+            console.log("--------- Asset Details ---------");   
+            console.log(window.assets[index]);
+            template.targetAsset.name = window.assets[index].assetName;
+            template.targetAsset.image = window.assets[index].image;
             console.log("--------- Populated Template ---------");
-            template.toAddress = document.getElementById('ethAddress').value;
-            template.fromAddress = document.getElementById('ethAddress').value;
             console.log(template);
-            window.contract = contract;
-            window.template = template;
         }
 
         async function getMetadata() {
@@ -111,9 +150,12 @@
         }
 
         document.body.addEventListener('change', (event) => {
-            if (event.target.tagName.toLowerCase() === 'select' && event.target.value != '0') {
+            if (event.target.id === 'contractSelect' && event.target.value != '-1') {
                 selectContract(event.target.value);
             }
+            if (event.target.id === 'vaultAssetSelect' && event.target.value != '-1') {
+                selectAsset(event.target.value);
+            }
         });
     </script>
 
@@ -124,10 +166,11 @@
     <label for="hideNotMintableCheckbox">Hide Not Mintable</label>
 
     <select id="contractSelect" style="display: none;"></select>
-    <input type="number" id="vaultCount" min="1" value="1">
-    <button id="createButton" onclick="createMultipleVaults()">Create Multiple</button>
 
-    <button id="createButton" onclick="createVault()">Create</button>
+    <select id="vaultAssetSelect" style="display: none;"></select>
+
+    <input type="number" id="vaultCount" min="1" value="1">
+    <button id="createButton" onclick="createMultipleVaults()">Create</button>
 
     <hr>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "emblem-vault-sdk",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -13,7 +13,8 @@
     "test:all": "npm run test:node && npm run test:browser",
     "build": "tsc && npm run postbuild",
     "postbuild": "node ./script/version.js",
-    "bundle": "npm run build && browserify build/index.js -o dist/bundle.js && cp dist/bundle.js docs/bundle.js"
+    "bundle": "npm run build && browserify build/index.js -o dist/bundle.js && cp dist/bundle.js docs/bundle.js",
+    "watch": "onchange 'src/*.ts' -- npm run bundle"
   },
   "keywords": [],
   "author": "",

package/readme.md

@@ -47,6 +47,30 @@ const TEST_ADDRESS = "0x9dE9ffB62c159A10cbcC19BdAc7962e9C19a1baa"
 sdk.fetchVaultsOfType("created", TEST_ADDRESS).then(vaults => {
     console.log(vaults);
 });
+
+// Get all projects that contain Asset Metadata
+projects = sdk.getAllProjects()
+// [
+//     "Emblem Test",
+//     "Age of Chains",
+//     "Age of Rust",
+//     "..."
+// ]
+
+// Get asset metadata
+const projectName = projects[1]; // valid item from getAllProjects() above
+assets = sdk.getAssetMetadata(projectName)
+console.log(assets)
+// [
+//     {
+//     "image":"ELECTRUMCARD.jpg",
+//     "projectName":"Age of Chains",
+//     "projectLogo":"age-of-chains.jpg",
+//     "projectSite":"https://www.ageofchains.com/",
+//     "assetName":"ELECTRUMCARD"
+//     },...
+// ]
+
 ```
 
 ## Simple Html Demo

package/src/index.ts

@@ -1,5 +1,5 @@
 import { Collection, CuratedCollectionsResponse, MetaData, Vault } from './types';
-import { COIN_TO_NETWORK, evaluateFacts, fetchData, generateTemplate, genericGuard, pad, templateGuard } from './utils';
+import { COIN_TO_NETWORK, NFT_DATA, evaluateFacts, fetchData, generateTemplate, genericGuard, metadataAllProjects, metadataObj2Arr, pad, templateGuard } from './utils';
 
 const SDK_VERSION = '__SDK_VERSION__'; 
 class EmblemVaultSDK {
@@ -18,6 +18,25 @@ class EmblemVaultSDK {
         // Implementation goes here
     }
 
+    // ** Asset Metadata **
+    //
+    getAssetMetadata(projectName: string, strict: boolean = false) {
+        genericGuard(projectName, "string", "projectName");
+        const NFT_DATA_ARR = metadataObj2Arr(NFT_DATA)
+        let filtered = strict ? 
+            NFT_DATA_ARR.filter(item => item.projectName === projectName) :
+            NFT_DATA_ARR.filter(item => item.projectName.toLowerCase() === projectName.toLowerCase());
+        return filtered
+    }
+
+    getAllProjects() {
+        const NFT_DATA_ARR = metadataObj2Arr(NFT_DATA)
+        const projects = metadataAllProjects(NFT_DATA_ARR)
+        return projects
+    }
+
+    // ** Curated **
+    //
     async fetchCuratedContracts(hideUnMintable: boolean = false): Promise<CuratedCollectionsResponse> {
         let url = `${this.baseUrl}/curated`;
         let data = await fetchData(url, this.apiKey);

package/src/utils.ts

@@ -1,6 +1,6 @@
 import { MetaData } from "./types";
 import metadataJson from './curated/metadata.json';
-const NFT_DATA: any = metadataJson
+export const NFT_DATA: any = metadataJson
 
 export const pad = (num: string | any[], size: number) => {
     if (!num) return null;
@@ -23,6 +23,18 @@ export const evaluateFacts = (allowed: boolean, facts: { eval: any; msg: string
     return allowed
 }
 
+export const metadataObj2Arr = (data: any) => Object.keys(data).map(key => ({
+    ...data[key],
+    assetName: key
+}));
+
+export const metadataAllProjects = (projects: any[]) => projects.reduce((unique: any[], item: any) => {
+    if (!unique.includes(item.projectName)) {
+      unique.push(item.projectName);
+    }
+    return unique;
+  }, []);
+
 export const fetchData = async (url: string, apiKey: string, method: string = 'GET', body: any = null) => {
     const fetch = typeof window !== 'undefined' && typeof window.fetch === 'function' ? window.fetch : require('node-fetch');
     const options: any = {