@leocuvee/turtlecoin-utils 0.0.14

package/tests/blocktemplate.json

@@ -0,0 +1,6 @@
+{
+  "blocktemplate": "0500b4318c1249164393f7b9d691e60aba81ca9bbffb9e0b23e6b01c93d9c621ab800000b5f9abe605000000000000000000000000000000000000000000000000000000000000000000000000010000000023032100000000000000000000000000000000000000000000000000000000000000000001b9fe5801ff91fe58070802959f9d01c4cbd664e7c937687e7ae847f75745614ba4a11a6f5c0b25a5ca42c314026840ba5dc6c84a533d005f0a6f9758c4eb4d19bffa3b4a73547596dac17b7d169003022f88b7b85f42c789721e7ee44bded4b6e1e48f7fb9bb73dc87cda264adf06a54f02e02175cea7cf09b914749c650b9321678d3f0e4390cad20ac6896be7ac14ba4f31ab0ea01021192fdc86fd815642850c0f50bc11df8ba1d39581d2c0642aa83f72f1c3fb22580ea3002c28a03fb9b3b7f6e4f9cdf2e74e93c8282580d8134722302b9978cdc3a35f39980897a02a4978ee1742da6f77791f065326922ff8c713687d2b52215ce7911b08922a7602901296929051bf0b258b717ffdca80c8b0822063c9d3f70f0dbed9b3f2e0aca2fa1020600000000000012f6b48f1800c368e046252e50165620fbb155176d17ddfdb98fd3227237760cf579af90593ec64a4a5549bd219969dc9aa1aac2dc3eab529c90b2f8c20221f99f02bdfb9a7efb5e5e85b710ef442b3cc82431173db142947a4f755a22f45915e5f2d53027a4aee505305c7cde822f960578417779ef71c1c8b611e95f1643fd125a39df66f40ce82794c9debc342381f26763c80968f8bf8e5378b433c583a6078348457ebe6ad61e5487ac3bebe22e03c46d9c894a511561ffbe9612809c17207493941d607b152f4ce193f828085ee8afcc0a351a9cecac0f01b2729df67af831637f76a8430848d86beb643df918af6cc554a8d0b42899671ee02cfbe64905b4458647a90a50aa307be48f3db57ff7f5446926ee70cee0c0cf7ad9021de727b2f97b5e2f0fd0103b24725d0c11ddd876de27a7b837bdd43eb4d9ca479883ad2dcd853ece92e6a7544b24e44051411e6b913760b9d997ca986985b92d51ccbc5708f0cd93c0ce2d1aea46a6744cc81a3df394cd099518cb3c3a5fa43e187c9d72bc3a245256fa60b450411b56d2258d4001b6133f58a5d48af0cc12af652c202b3c9de3f426026500c493c075340ca713a49843db16bda542fd76fb597914e1c975a70d12971baf70b8f7f6f452fd669f3cc00d0a0f36a3312f7c51cadf24cac9c24841eeaa742b5d1e74a750e5763afbd2a75e341edb4439801ac665dd0a3b16cc648a651546c7a3633f0a0274bb3815d6bda05e12fb7cbb908ceb582590a84a30ba6043178279343f5107713390b8e2ca2a8723ee7e5855c6af674bbd9b5a",
+  "difficulty": 9796275295,
+  "height": 1457937,
+  "reservedOffset": 411
+}

package/tests/tests.js

@@ -0,0 +1,215 @@
+// Copyright (c) 2018-2019, The TurtleCoin Developers
+//
+// Please see the included LICENSE file for more information.
+
+'use strict'
+
+const assert = require('assert')
+const BlockTemplateSample = require('./blocktemplate.json')
+const TurtleCoinUtils = require('../').CryptoNote
+const config = require('../config.json')
+const cnUtil = new TurtleCoinUtils(config)
+
+const rawSeed = 'dd0c02d3202634821b4d9d91b63d919725f5c3e97e803f3512e52fb0dc2aab0c'
+const rawMnemonic = 'teeming taken piano ramped vegan jazz earth enjoy suture quick lied awkward ferry python often exotic cube hexagon ionic joyous cage abnormal hull jigsaw lied'
+
+console.log('')
+console.log('In Seed:          ', rawSeed)
+console.log('In Mnemonic:      ', rawMnemonic)
+
+const outputMnemonic = cnUtil.createAddressFromSeed(rawSeed)
+const outputSeed = cnUtil.createAddressFromMnemonic(rawMnemonic)
+
+console.log('')
+console.log('Out Seed:         ', outputSeed.seed)
+console.log('Out Mnemonic:     ', outputMnemonic.mnemonic)
+
+assert(rawSeed === outputSeed.seed)
+assert(rawMnemonic === outputMnemonic.mnemonic)
+
+const testAddress = 'TRTLv3nzumGSpRsZWxkcbDhiVEfy9rAgX3X9b7z8XQAy9gwjB6cwr6BJ3P52a6TQUSfA4eXf3Avwz7W89J4doLuigLjUzQjvRqX'
+const testAddressRaw = '9df6ee01f71e440f9a5aab08dbdab0f4f36bba813660a0600f109b1371dc53be33f23c99f0ba225065e1b9c2e43165b3e41f10fcb768853126dfa7e612a3df2deb332492cc073a66'
+
+console.log('')
+console.log('In  Test Address: ', testAddress)
+console.log('In  Raw Address:  ', testAddressRaw)
+
+const outputAddress = cnUtil.encodeRawAddress(testAddressRaw)
+const outputRaw = cnUtil.decodeAddress(testAddress)
+
+console.log('')
+console.log('Out Test Address: ', outputAddress)
+console.log('Out Raw Address:  ', outputRaw.rawAddress)
+
+assert(testAddressRaw === outputRaw.rawAddress)
+assert(testAddress === outputAddress)
+
+const newAddress = cnUtil.createNewAddress(testAddress, 'english')
+const newAddressByKey = cnUtil.createAddressFromKeys(newAddress.spend.privateKey, newAddress.view.privateKey)
+
+console.log('')
+console.log('New Address: ', newAddress.address)
+console.log('New Address Keys: ', newAddress.spend.privateKey, newAddress.view.privateKey)
+console.log('New Address By Keys: ', newAddressByKey.address)
+
+assert(newAddress.address === newAddressByKey.address)
+
+const testPrivateKey = '4a078e76cd41a3d3b534b83dc6f2ea2de500b653ca82273b7bfad8045d85a400'
+const testPublicKey = '7849297236cd7c0d6c69a3c8c179c038d3c1c434735741bb3c8995c3c9d6f2ac'
+
+const derivedPublicKey = cnUtil.privateKeyToPublicKey(testPrivateKey)
+
+console.log('')
+console.log('In Test Private Key: ', testPrivateKey)
+console.log('In Test Public Key: ', testPublicKey)
+console.log('Out Derived Public Key: ', derivedPublicKey)
+
+assert(derivedPublicKey === testPublicKey)
+
+const mnemonicAddressByKey = cnUtil.createAddressFromKeys(outputSeed.spend.privateKey, outputSeed.view.privateKey)
+
+console.log('')
+console.log('In Mnemonic Private Spend Key: ', outputSeed.spend.privateKey)
+console.log('In Mnemonic Private View Key: ', outputSeed.view.privateKey)
+console.log('In Mnemonic Seed: ', mnemonicAddressByKey.mnemonic)
+
+assert(mnemonicAddressByKey.mnemonic === outputSeed.mnemonic)
+
+const nonMnemonicPrivateSpendKey = '7a4a9a5b174e5713433fb5735a35b8fe8ce5bf411d5f6a587002e455a2b33703'
+const nonMnemonicPrivateViewKey = '3c986487d9b85e979e4f30eca56558874d2792ec73326d7aa0b2cf24c099ad0f'
+const nonMnemonicAddressByKey = cnUtil.createAddressFromKeys(nonMnemonicPrivateSpendKey, nonMnemonicPrivateViewKey)
+
+console.log('')
+console.log('In Non Mnemonic Private Spend Key: ', nonMnemonicPrivateSpendKey)
+console.log('In Non Mnemonic Private View Key: ', nonMnemonicPrivateViewKey)
+console.log('In Non Mnemonic Seed: ', nonMnemonicAddressByKey.mnemonic)
+
+assert(nonMnemonicAddressByKey.mnemonic === null)
+
+var amount = 1234567
+console.log('')
+console.log('Creating outputs for amount %s to %s', amount, newAddress.address)
+var transfers = cnUtil.createTransactionOutputs(newAddress.address, amount)
+var amounts = []
+transfers.forEach((elem) => {
+  amounts.push(elem.amount)
+})
+console.log('Created %s outputs [%s]', transfers.length, amounts.join(','))
+
+assert(transfers.length === 7)
+
+amount = 101010
+console.log('')
+console.log('Creating outputs for amount %s to %s', amount, newAddress.address)
+transfers = cnUtil.createTransactionOutputs(newAddress.address, amount)
+amounts = []
+transfers.forEach((elem) => {
+  amounts.push(elem.amount)
+})
+console.log('Created %s outputs [%s]', transfers.length, amounts.join(','))
+
+assert(transfers.length === 3)
+
+console.log('')
+console.log('Validating prefix detection for alternate chain...')
+console.log('')
+
+const athenaAddress = 'athena28QHa49cTHWjRLYN1XW46Xj8D2mPiu7bovQ67V4z1C84R16VSJvbHmD2Yfq5Yvw5GKVTnfuS5pX3LXH3LNPezfLhhe5Lc27'
+const athenaPrefix = { prefix: 'ca9f97c218',
+  base58: 'athena',
+  decimal: 6581243850,
+  hexadecimal: '18845cfca' }
+
+const calculatedPrefix = cnUtil.decodeAddressPrefix(athenaAddress)
+
+console.log('Athena Address: ', athenaAddress)
+console.log('Athena Calculated Prefix: ', calculatedPrefix.base58)
+assert(athenaPrefix.base58 === calculatedPrefix.base58)
+
+console.log('Athena Calculated Raw Prefix: ', calculatedPrefix.decimal)
+assert(athenaPrefix.decimal === calculatedPrefix.decimal)
+
+const newAthenaAddress = cnUtil.encodeAddress(newAddress.view.publicKey, newAddress.spend.publicKey, false, athenaPrefix.decimal)
+const newAthenaAddressByKey = cnUtil.createAddressFromKeys(newAddress.spend.privateKey, newAddress.view.privateKey, athenaPrefix.decimal)
+
+console.log('New Athena Address: ', newAthenaAddress)
+console.log('New Athena Address By Keys: ', newAthenaAddressByKey.address)
+
+assert(newAthenaAddress === newAthenaAddressByKey.address)
+
+console.log('')
+console.log('Verifying output discovery...')
+console.log('')
+
+/* For reference, this is transaction fd9b0767c18752610833a8138e4bbb31d02b29bf50aa3af1557e2974a45c629c */
+const txPublicKey = '3b0cc2b066812e6b9fcc42a797dc3c723a7344b604fd4be0b22e06254ff57f94'
+
+const walletPrivateViewKey = '6968a0b8f744ec4b8cea5ec124a1b4bd1626a2e6f31e999f8adbab52c4dfa909'
+
+/* Not using this right now, but will probably need this later to test something else */
+const walletPrivateSpendKey = 'd9d555a892a85f64916cae1a168bd3f7f400b6471c7b12b438b599601298210b'
+
+const walletPublicSpendKey = '854a637b2863af9e8e8216eb2382f3d16616b3ac3e53d0976fbd6f8da6c56418'
+
+const derivation = cnUtil.generateKeyDerivation(txPublicKey, walletPrivateViewKey)
+
+const ourOutputIndex = 2
+
+/* (First output) This is not our output. */
+const publicSpendKey1 = cnUtil.underivePublicKey(derivation, 0, 'aae1b90b4d0a7debb417d91b7f7aa8fdfd80c42ebc6757e1449fd1618a5a3ff1')
+
+console.log('Derived public spend key: ', publicSpendKey1)
+console.log('Our public spend key: ', walletPublicSpendKey)
+
+assert(publicSpendKey1 !== walletPublicSpendKey)
+
+/* (Third output) This is our output. */
+const publicSpendKey2 = cnUtil.underivePublicKey(derivation, ourOutputIndex, 'bb55bef919d1c9f74b5b52a8a6995a1dc4af4c0bb8824f5dc889012bc748173d')
+
+console.log('Derived public spend key: ', publicSpendKey2)
+console.log('Our public spend key: ', walletPublicSpendKey)
+
+assert(publicSpendKey2 === walletPublicSpendKey)
+
+console.log('')
+console.log('Verifying key images are correctly created...')
+console.log('')
+
+const [keyImage] = cnUtil.generateKeyImage(txPublicKey, walletPrivateViewKey, walletPublicSpendKey, walletPrivateSpendKey, ourOutputIndex)
+const [keyImagePrimitive] = cnUtil.generateKeyImagePrimitive(walletPublicSpendKey, walletPrivateSpendKey, ourOutputIndex, derivation)
+
+console.log('Generated key image: ', keyImage)
+console.log('Generated key image (primitive): ', keyImagePrimitive)
+
+assert(keyImage === keyImagePrimitive)
+
+const expectedKeyImage = '5997cf23543ce2e05c327297a47f26e710af868344859a6f8d65683d8a2498b0'
+
+console.log('Expected key image: ', expectedKeyImage)
+
+assert(keyImage === expectedKeyImage)
+
+const inputData = '0100fb8e8ac805899323371bb790db19218afd8db8e3755d8b90f39b3d5506a9abce4fa912244500000000ee8146d49fa93ee724deb57d12cbc6c6f3b924d946127c7a97418f9348828f0f02'
+const expectedHash = 'b542df5b6e7f5f05275c98e7345884e2ac726aeeb07e03e44e0389eb86cd05f0'
+const calculatedHash = cnUtil.cnFastHash(inputData)
+
+console.log('')
+console.log('Hashing Tests...')
+console.log('')
+console.log('CN Fast Hash')
+console.log('Expected Hash: %s', expectedHash)
+console.log('Calculated Hash: %s', calculatedHash)
+
+assert(expectedHash === calculatedHash)
+
+const BlockTemplate = cnUtil.blockTemplate(BlockTemplateSample)
+
+console.log('')
+console.log('Block Template: %s', BlockTemplate.blockTemplate)
+console.log('')
+console.log('Block Version: %s.%s', BlockTemplate.block.majorVersion, BlockTemplate.block.minorVersion)
+console.log('Transaction Count: %s', BlockTemplate.block.transactions.length)
+console.log('')
+console.log('Re-serialized Block Template: %s', BlockTemplate.blob)
+
+assert(BlockTemplate.blockTemplate === BlockTemplate.blob)

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": [
+      "es2017",
+      "dom",
+      "scripthost"
+    ],
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "downlevelIteration": true
+  }
+}

package/tslint.json

@@ -0,0 +1,36 @@
+{
+    "defaultSeverity": "error",
+    "extends": [
+        "tslint:latest"
+    ],
+    "jsRules": {},
+    "rules": {
+        "quotemark": [
+            true,
+            "single"
+        ],
+        "max-classes-per-file": false,
+        "interface-name": false,
+        "no-console": true,
+        "no-implicit-dependencies": [
+            true,
+            "dev"
+        ],
+        "no-namespace": false,
+        "no-var-requires": false,
+        "prefer-object-spread": false,
+        "unified-signatures": false,
+        "object-literal-shorthand": false,
+        "ordered-imports": false,
+        "object-literal-sort-keys": false,
+        "no-bitwise": false,
+        "variable-name": {
+            "options": [
+                "check-format",
+                "allow-pascal-case",
+                "allow-snake-case"
+            ]
+        }
+    },
+    "rulesDirectory": []
+}

package/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "name": "TurtleCoin-Utils",
+    "out": "./docs",
+    "excludeExternals": true,
+    "excludeNotExported": true,
+    "excludePrivate": true,
+    "excludeProtected": true,
+    "listInvalidSymbolLinks": true,
+    "mode": "file"
+}

package/webpack.config.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  mode: 'production',
+  entry: './dist/index.js',
+  output: {
+    filename: 'TurtleCoinUtils.js',
+    library: 'TurtleCoinUtils',
+    libraryTarget: 'umd'
+  },
+  node: {
+    fs: 'empty'
+  },
+  target: 'web'
+}