@xrplkit/xls26 1.0.0

package/package.json

@@ -0,0 +1,12 @@
+{
+    "name": "@xrplkit/xls26",
+    "type": "module",
+    "version": "1.0.0",
+    "main": "xls26.js",
+    "dependencies": {
+        "@xrplkit/toml": "1.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/readme.md

@@ -0,0 +1,55 @@
+# XLS-26 Parsing Library
+
+This is an implementation of the [XLS-26 Standard](https://github.com/XRPLF/XRPL-Standards/discussions/71).
+This package exports one single function called `parse` that converts a string of a `xrp-ledger.toml` file to a JavaScript object.
+
+## Example
+Assuming you have a file named `xrp-ledger.toml` in the current working directory. [Example File here](http://xrpl.works/.well-known/xrp-ledger.toml)
+
+    import fs from 'fs'
+    import { parse } from '@xrplkit/xls26'
+    
+    const tomlString = fs.readFileSync('./xrp-ledger.toml', 'utf-8')
+    const xls26Data = parse(tomlString)
+    
+    console.log(xls26Data)
+
+### Example Input
+
+    [[ACCOUNTS]]
+    address = "rxworksy7717V3w1nSQhUpaGNqydGYCaS"
+    name = "XRPL Works"
+    websites = ["https://xrpl.works"]
+    description = "XRPL Works is a non-profit organization. Our goal is to simplify the ledger."
+    
+    [[CURRENCIES]]
+    code = "58574F524B530000000000000000000000000000"
+    issuer = "rxworksy7717V3w1nSQhUpaGNqydGYCaS"
+    name = "XWORKS"
+    icon = "https://xrpl.works/token/icon.png"
+    description = "This token serves the purpose of demonstrating the benefits of the XLS-26 standard."
+  
+
+### Example Output
+
+```
+{
+	"accounts": [
+		{
+			"address": "rxworksy7717V3w1nSQhUpaGNqydGYCaS",
+			"name": "XRPL Works",
+			"description": "XRPL Works is a non-profit organization. Our goal is to simplify the ledger."
+		}
+	],
+	"currencies": [
+		{
+			"code": "58574F524B530000000000000000000000000000",
+			"issuer": "rxworksy7717V3w1nSQhUpaGNqydGYCaS",
+			"name": "XWORKS",
+			"description": "This token serves the purpose of demonstrating the benefits of the XLS-26 standard.",
+			"icon": "https://xrpl.works/token/icon.png"
+		}
+	]
+}
+
+```

package/xls26.js

@@ -0,0 +1,118 @@
+// The XLS-26 standard adds additional asset metadata fields to the existing xrp-ledger.toml standard,
+// https://github.com/XRPLF/XRPL-Standards/discussions/71
+// This package provides an implementation of a parser according to this standard.
+
+
+import { parse as parseToml } from '@xrplkit/toml'
+
+
+const accountFields = [
+	{
+		key: 'address',
+		validate: v => /^[rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz]{25,35}$/.test(v)
+	},
+	{
+		key: 'name',
+		validate: v => typeof v === 'string' && v.length > 0
+	},
+	{
+		key: 'description',
+		alternativeKeys: ['desc'],
+		validate: v => typeof v === 'string' && v.length > 0
+	},
+	{
+		key: 'icon',
+		validate: v => /^https?:\/\/.*$/.test(v)
+	},
+	{
+		key: 'links',
+		type: 'array',
+		validate: v => Array.isArray(v) && v.every(v => typeof v === 'string'),
+	},
+	{
+		key: 'trusted',
+		validate: v => typeof v === 'boolean'
+	}
+]
+
+
+const currencyFields = [
+	{
+		key: 'code',
+		validate: v => /^[0-9A-F]{40}$/
+	},
+	{
+		key: 'issuer',
+		validate: v => /^[rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz]{25,35}$/.test(v)
+	},
+	{
+		key: 'name',
+		validate: v => typeof v === 'string' && v.length > 0
+	},
+	{
+		key: 'description',
+		alternativeKeys: ['desc'],
+		validate: v => typeof v === 'string' && v.length > 0
+	},
+	{
+		key: 'icon',
+		validate: v => /^https?:\/\/.*$/.test(v)
+	},
+	{
+		key: 'links',
+		type: 'array',
+		validate: v => Array.isArray(v) && v.every(v => typeof v === 'string'),
+	},
+	{
+		key: 'trusted',
+		validate: v => typeof v === 'boolean'
+	}
+]
+
+
+export function parse(str){
+	let toml = parseToml(str, 'camelCase')
+	let accounts = []
+	let currencies = []
+
+	if(toml.accounts){
+		accounts = toml.accounts
+			.map(account => parseStanza(account, accountFields))
+	}
+
+	if(toml.currencies){
+		currencies = toml.currencies
+			.map(currency => parseStanza(currency, currencyFields))
+	}
+
+	return {
+		accounts,
+		currencies
+	}
+}
+
+function parseStanza(stanza, schemas){
+	let parsed = {}
+
+	for(let { key, alternativeKeys, validate } of schemas){
+		let keys = [key]
+
+		if(alternativeKeys)
+			keys.push(...alternativeKeys)
+
+		for(let k of keys){
+			if(!stanza.hasOwnProperty(k))
+				continue
+
+			let value = stanza[k]
+
+			if(validate && !validate(value))
+				continue
+
+			parsed[k] = value
+			break
+		}
+	}
+
+	return parsed
+}