@xrplkit/xls26 2.1.0 → 2.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@xrplkit/xls26",
     "type": "module",
-    "version": "2.1.0",
+    "version": "2.3.0",
     "main": "xls26.js",
     "dependencies": {
         "@xrplkit/toml": "1.0.0"

package/readme.md

@@ -22,24 +22,29 @@ console.log(xls26Data)
 
 ```toml
 [[ISSUERS]]
-address = "rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr"
-name = "CasinoCoin"
+address = "rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg"
+name = "Aesthetes"
 
-[[TOKENS]]
-issuer = "rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr"
-currency = "CSC"
-name = "CasinoCoin"
-desc = "CasinoCoin (CSC) is a digital currency, developed specifically for the regulated gaming industry."
-icon = "https://static.xrplmeta.org/icons/csc.png"
-
-[[TOKENS.WEBLINKS]]
-url = "https://casinocoin.im"
-type = "website"
+[[ISSUERS.WEBLINKS]]
+url = "https://aesthetes.art"
+type = "info"
 title = "Official Website"
 
-[[TOKENS.WEBLINKS]]
-url = "https://twitter.com/CasinoCoin"
+[[ISSUERS.WEBLINKS]]
+url = "https://twitter.com/aesthetes_art"
 type = "socialmedia"
+
+[[TOKENS]]
+issuer = "rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg"
+currency = "ELS"
+name = "Elysian"
+desc = "The first Token for the Art and NFT Industry running on the XRPL."
+icon = "https://static.xrplmeta.org/icons/els.png"
+asset_class = "cryptocurrency"
+
+[[TOKENS.WEBLINKS]]
+url = "https://twitter.com/Elysianers"
+type = "community"
 ```
 
 
@@ -49,30 +54,37 @@ type = "socialmedia"
 {
     issuers: [
         {
-            address: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
-            name: 'CasinoCoin'
-        }
-    ],
-    tokens: [
-        {
-            currency: 'CSC',
-            issuer: 'rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr',
-            name: 'CasinoCoin',
-            desc: 'CasinoCoin (CSC) is a digital currency, developed specifically for the regulated gaming industry.',
-            icon: 'https://static.xrplmeta.org/icons/csc.png',
+            address: 'rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg',
+            name: 'Aesthetes',
             weblinks: [
                 {
-                    url: 'https://casinocoin.im',
-                    type: 'website',
+                    url: 'https://aesthetes.art',
+                    type: 'info',
                     title: 'Official Website'
                 },
                 {
-                    url: 'https://twitter.com/CasinoCoin', 
+                    url: 'https://twitter.com/aesthetes_art', 
                     type: 'socialmedia' 
                 }
             ]
         }
     ],
+    tokens: [
+        {
+            currency: 'ELS',
+            issuer: 'rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg',
+            name: 'Elysian',
+            desc: 'The first Token for the Art and NFT Industry running on the XRPL.',
+            icon: 'https://static.xrplmeta.org/icons/els.png',
+            asset_class: 'cryptocurrency',
+            weblinks: [
+                {
+                    url: 'https://twitter.com/Elysianers', 
+                    type: 'community' 
+                }
+            ]
+        }
+    ],
     issues: []
 }
 

package/xls26.js

@@ -6,13 +6,27 @@
 import { parse as parseToml } from '@xrplkit/toml'
 
 const validWeblinkTypes = [
-	'website',
+	'info',
 	'socialmedia',
+	'community',
 	'support',
-	'sourcecode',
 	'whitepaper',
-	'audit',
-	'report'
+	'certificate'
+]
+
+const validAdvisoryTypes = [
+	'scam',
+	'spam',
+	'illegal',
+	'offensive',
+	'hijacked'
+]
+
+const validAssetClasses = [
+	'fiat',
+	'commodity',
+	'stocks',
+	'cryptocurrency'
 ]
 
 const issuerFields = [
@@ -115,6 +129,13 @@ const tokenFields = [
 			if(v < 0 || v > 3)
 				throw 'has to be between 0 and 3'
 		}
+	},
+	{
+		key: 'asset_class',
+		validate: v => {
+			if(!validAssetClasses.includes(v))
+				throw `needs to be one of the following: ${validAssetClasses.join(', ')}`
+		}
 	}
 ]
 
@@ -143,6 +164,31 @@ const weblinkFields = [
 	},
 ]
 
+const advisoryFields = [
+	{
+		key: 'address',
+		essential: true,
+		validate: v => {
+			if(!/^[rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz]{25,35}$/.test(v))
+				throw 'is not a valid XRPL address'
+		},
+	},
+	{
+		key: 'type',
+		validate: v => {
+			if(!validAdvisoryTypes.includes(v))
+				throw `has to be one of (${validAdvisoryTypes.join(', ')})`
+		}
+	},
+	{
+		key: 'description',
+		alternativeKeys: ['desc'],
+		validate: v => {
+			if(typeof v !== 'string' || v.length === 0)
+				throw 'has to be a non empty string'
+		}
+	}
+]
 
 export function parse(str){
 	try{
@@ -154,6 +200,7 @@ export function parse(str){
 	let issuers = []
 	let tokens = []
 	let issues = []
+	let advisories = []
 
 
 	if(toml.ISSUERS){
@@ -224,11 +271,27 @@ export function parse(str){
 		}
 	}
 
+	if(toml.ADVISORIES){
+		for(let stanza of toml.ADVISORIES){
+			let { valid, parsed: advisory, issues: advisoryIssues } = parseStanza(stanza, advisoryFields)
+
+			if(valid)
+				advisories.push(advisory)
+				
+			issues.push(
+				...advisoryIssues.map(
+					issue => `[[ADVISORIES]] ${issue}`
+				)
+			)
+		}
+	}
+
 
 	return {
 		issuers,
 		tokens,
-		issues
+		issues,
+		advisories
 	}
 }
 
@@ -253,12 +316,12 @@ function parseStanza(stanza, schemas){
 				try{
 					validate(value)
 				}catch(issue){
-					issues.push(`${key} field: ${issue}`)
+					issues.push(`${k} field: ${issue}`)
 					break
 				}
 			}
 
-			parsed[k] = value
+			parsed[key] = value
 			break
 		}