Skip to content

Commit cd92519

Browse files
jcramerjcramer
committed
1.0.0
0 parents  commit cd92519

18 files changed

+3487
-0
lines changed

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
*.js
3+
*.js.map
4+
dist

‎.vscode/launch.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"type": "node",
9+
"request": "launch",
10+
"name": "Launch Current File",
11+
"program": "${file}",
12+
"outFiles": ["${workspaceFolder}/**/*.js"],
13+
"console": "integratedTerminal"
14+
},
15+
{
16+
"type": "node",
17+
"request": "launch",
18+
//"preLaunchTask": "tsc",
19+
"name": "Run Mocha",
20+
"program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
21+
"args": ["${workspaceRoot}/test/**/*.js"],
22+
"cwd": "${workspaceRoot}",
23+
"outFiles": []
24+
}
25+
]
26+
}

‎README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# slp-validate
2+
3+
Lightweight SLP validator with pre-broadcast validation and burn protection.
4+
5+
[![NPM](https://nodei.co/npm/slp-validate.png)](https://nodei.co/npm/slp-validate/)
6+
7+
8+
9+
## Installation
10+
11+
#### For node.js
12+
`npm install slp-validate`
13+
14+
#### For browser
15+
```<script src='https://unpkg.com/slp-validate'></script>```
16+
17+
18+
19+
## Example Usage
20+
21+
The recommended method to use for validation is `ValidatorType1.isValidSlpTxn()`. This method can check transaction validity before it is broadcast to the network to prevent accidental burning.
22+
23+
The following examples are provided in the examples directory:
24+
25+
- `1-validate-tx-rpc-burn-valid-stop.ts`: Prevents accidental sending of a valid burn transaction
26+
- `2-validate-tx-rpc-burn-valid-allow.ts`: Allows sending a valid burn transaction
27+
- `3-validate-txid-rpc.ts`: Traditional SLP validate method by txid (offers no extra burn protection).
28+
- `4-validate-txid-bchd.ts`: Similar to example 3, but uses BCHD's gRPC instead of JSON RPC.
29+
30+
31+
32+
## Change Log
33+
34+
### 1.0.0
35+
- ported validator from slpjs 0.21.3
36+
- store cached transactions as buffer instead of a string
37+
- Add max cache size parameters in ValidatorType1 constructor
38+
39+
40+
41+
## Acknowledgements
42+
43+
Thanks to [cryptophyl.com](https://cryptophyl.com) for sponsoring the initial effort required to create this library.

‎examples/1-validate-tx-rpc-burn-valid-stop.ts

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/***************************************************************************************
2+
*
3+
* Example 1: Check transaction validity pre-broadcast. This example prevents burning
4+
* tokens in otherwise valid SLP transactions. Even though both
5+
* transactions listed below are both valid in terms of SLP consensus rules,
6+
* this example code catches Error thrown when "valid inputs > outputs" and
7+
* returns invalid.
8+
*
9+
* See Example 2 to learn how to allow burning.
10+
*
11+
* Instructions:
12+
* (1) - Set bitcoind RPC user, password, and URL.
13+
* (2) - Optional: set custom transaciton hex data.
14+
*
15+
* ************************************************************************************/
16+
17+
import { ValidatorType1 } from '../index';
18+
import { Big } from 'big.js';
19+
const RpcClient = require('bitcoin-rpc-promise-retry');
20+
21+
const RPC_USER_NAME = 'bitcoin';
22+
const RPC_PASSWORD = 'password';
23+
const RPC_URL = 'localhost:8332';
24+
25+
// valid. (valid inputs === outputs)
26+
//const txn = "01000000067fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9020000006441bcf1bd79e139931c9132b72f184223573169367e12bedf407a83b02ab743449f5f7bab144f1ac6514e7cdcab644a4d84e93aeccb26328ce29a860b565a781732412102f706e233e38f92c854093350cca74f03989ade992cad5e9c2f37fd3591e2a745feffffff09e43bbe31136a69856a1d82b18e43be2f6654bb5ed34e762142c003da70ad3a020000006441b8f2c9216c68831c87f59706180f6370c7058e55dc7e566879cbc72b539b44a686a3f0a86f84e190d56498ff303135a1167e1bafbbe218a670ca3ae822d3063f4121023d538f5640dbcb1bca0cab14d9eacf19fb6558ab884aaaf5fa18268eccda8e1afeffffff79fd9c6d020ff90625ede1eca3d63836f11e6a774e022f306cf260b5a20fe077010000006441a4d16b13aa4a8ce8648872359cdcd56c6652280d4514f12be1362fa2a49c619a948c96f18b8d0f15d8b042e65315cf0f84dca2912430357f53cc6bb198d944324121027f76d0cef47d1ca5480fb61475b8a8dda3c150db24e7878e5054a2677f68ed09feffffff3f916feaac6fd543f2b4c1a0bd0cf8cdd67a051d9148b983ff89651cae6448a8010000006441e9e66ad5228bf7cea1be41a0b9cc0abc14fb533751cadd56d925be167f6dd130e608c94d6554059c8651d5814067390f705a7d4febb4e5d43ce2992ec048da45412102c4abc5997c7e1dad05fd8bacd51e5124e6f45c4956dc5cf81cd05af2b30a2a71feffffffb04c1d306f823540686c02899bfcc343e10537be36006b372885bf176b37e68a01000000644105934999a2b5b08469d91a44657353e43a3537a26ecfb85302d9109833b709f7cf6772273357cbbdfa94e1c98f010307ea42e31e6f66f5d01ebe387298ed30774121028cdd539d1c2ebe21e712121928a0e9f1244038cffaf88dd3f646a93f6e1babaffeffffff7fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9030000006441bbff4b3a6cb5b616a28210f4c6a07b92ca3c2d483f7f85439e8761a037ba725ea6ac164b36c1ab6f172635d4fbb8792a52f2b4bed5c40b8f5aa1305180f42866412103a08f93fed637daf62c1663c634d9034a2bfb6631c9f6ceba0c2ea7099c17fae2feffffff030000000000000000376a04534c500001010453454e4420c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca47908000000000000019522020000000000001976a91446e33d57e44125f02fc71a754fff13317ee8fc5088acb10f0000000000001976a9149c22bf7f6bb779237b2318dcbb1272f39a02d52e88accd2d0900";
27+
28+
// valid, but we call it invalid becuase it burns 5 tokoshis (valid inputs > outputs)
29+
const txn = "01000000067fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9020000006441bcf1bd79e139931c9132b72f184223573169367e12bedf407a83b02ab743449f5f7bab144f1ac6514e7cdcab644a4d84e93aeccb26328ce29a860b565a781732412102f706e233e38f92c854093350cca74f03989ade992cad5e9c2f37fd3591e2a745feffffff09e43bbe31136a69856a1d82b18e43be2f6654bb5ed34e762142c003da70ad3a020000006441b8f2c9216c68831c87f59706180f6370c7058e55dc7e566879cbc72b539b44a686a3f0a86f84e190d56498ff303135a1167e1bafbbe218a670ca3ae822d3063f4121023d538f5640dbcb1bca0cab14d9eacf19fb6558ab884aaaf5fa18268eccda8e1afeffffff79fd9c6d020ff90625ede1eca3d63836f11e6a774e022f306cf260b5a20fe077010000006441a4d16b13aa4a8ce8648872359cdcd56c6652280d4514f12be1362fa2a49c619a948c96f18b8d0f15d8b042e65315cf0f84dca2912430357f53cc6bb198d944324121027f76d0cef47d1ca5480fb61475b8a8dda3c150db24e7878e5054a2677f68ed09feffffff3f916feaac6fd543f2b4c1a0bd0cf8cdd67a051d9148b983ff89651cae6448a8010000006441e9e66ad5228bf7cea1be41a0b9cc0abc14fb533751cadd56d925be167f6dd130e608c94d6554059c8651d5814067390f705a7d4febb4e5d43ce2992ec048da45412102c4abc5997c7e1dad05fd8bacd51e5124e6f45c4956dc5cf81cd05af2b30a2a71feffffffb04c1d306f823540686c02899bfcc343e10537be36006b372885bf176b37e68a01000000644105934999a2b5b08469d91a44657353e43a3537a26ecfb85302d9109833b709f7cf6772273357cbbdfa94e1c98f010307ea42e31e6f66f5d01ebe387298ed30774121028cdd539d1c2ebe21e712121928a0e9f1244038cffaf88dd3f646a93f6e1babaffeffffff7fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9030000006441bbff4b3a6cb5b616a28210f4c6a07b92ca3c2d483f7f85439e8761a037ba725ea6ac164b36c1ab6f172635d4fbb8792a52f2b4bed5c40b8f5aa1305180f42866412103a08f93fed637daf62c1663c634d9034a2bfb6631c9f6ceba0c2ea7099c17fae2feffffff030000000000000000376a04534c500001010453454e4420c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca47908000000000000019022020000000000001976a91446e33d57e44125f02fc71a754fff13317ee8fc5088acb10f0000000000001976a9149c22bf7f6bb779237b2318dcbb1272f39a02d52e88accd2d0900";
30+
31+
(async function() {
32+
console.time("SLP-VALIDATE-RPC");
33+
const connectionString = `http://${RPC_USER_NAME}:${RPC_PASSWORD}@${RPC_URL}`;
34+
const rpc = new RpcClient(connectionString);
35+
const slpValidator = new ValidatorType1({ getRawTransaction: async (txid) => await rpc.getRawTransaction(txid) });
36+
console.log("This may take a several seconds...");
37+
let isValid;
38+
try {
39+
isValid = await slpValidator.isValidSlpTxn({ txn, burnQuantity: Big(0) });
40+
} catch(error) {
41+
console.log(error);
42+
isValid = false;
43+
}
44+
console.log("Final Result:", isValid);
45+
console.log("NOTE: THIS IS A VALID SLP TRANSACTION, BUT WE CALL IT INVALID SINCE IT WAS BURNING INPUTS.")
46+
console.timeEnd("SLP-VALIDATE-RPC");
47+
})();

‎examples/2-validate-tx-rpc-burn-valid-allow.ts

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/***************************************************************************************
2+
*
3+
* Example 2: Check transaction validity pre-broadcast. This example allows burning
4+
* tokens in a valid SLP transaction.
5+
*
6+
* Instructions:
7+
* (1) - Set bitcoind RPC user, password, and URL.
8+
* (2) - Optional: set custom transaciton hex data.
9+
*
10+
* ************************************************************************************/
11+
12+
import { ValidatorType1 } from '../index';
13+
import { Big } from 'big.js';
14+
const RpcClient = require('bitcoin-rpc-promise-retry');
15+
16+
const RPC_USER_NAME = 'bitcoin';
17+
const RPC_PASSWORD = 'password';
18+
const RPC_URL = 'localhost:8332';
19+
20+
const txn = "01000000067fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9020000006441bcf1bd79e139931c9132b72f184223573169367e12bedf407a83b02ab743449f5f7bab144f1ac6514e7cdcab644a4d84e93aeccb26328ce29a860b565a781732412102f706e233e38f92c854093350cca74f03989ade992cad5e9c2f37fd3591e2a745feffffff09e43bbe31136a69856a1d82b18e43be2f6654bb5ed34e762142c003da70ad3a020000006441b8f2c9216c68831c87f59706180f6370c7058e55dc7e566879cbc72b539b44a686a3f0a86f84e190d56498ff303135a1167e1bafbbe218a670ca3ae822d3063f4121023d538f5640dbcb1bca0cab14d9eacf19fb6558ab884aaaf5fa18268eccda8e1afeffffff79fd9c6d020ff90625ede1eca3d63836f11e6a774e022f306cf260b5a20fe077010000006441a4d16b13aa4a8ce8648872359cdcd56c6652280d4514f12be1362fa2a49c619a948c96f18b8d0f15d8b042e65315cf0f84dca2912430357f53cc6bb198d944324121027f76d0cef47d1ca5480fb61475b8a8dda3c150db24e7878e5054a2677f68ed09feffffff3f916feaac6fd543f2b4c1a0bd0cf8cdd67a051d9148b983ff89651cae6448a8010000006441e9e66ad5228bf7cea1be41a0b9cc0abc14fb533751cadd56d925be167f6dd130e608c94d6554059c8651d5814067390f705a7d4febb4e5d43ce2992ec048da45412102c4abc5997c7e1dad05fd8bacd51e5124e6f45c4956dc5cf81cd05af2b30a2a71feffffffb04c1d306f823540686c02899bfcc343e10537be36006b372885bf176b37e68a01000000644105934999a2b5b08469d91a44657353e43a3537a26ecfb85302d9109833b709f7cf6772273357cbbdfa94e1c98f010307ea42e31e6f66f5d01ebe387298ed30774121028cdd539d1c2ebe21e712121928a0e9f1244038cffaf88dd3f646a93f6e1babaffeffffff7fb42e8fdf232ae50f8dc5e558252fba30336ae83b6e45e138f5b922205143d9030000006441bbff4b3a6cb5b616a28210f4c6a07b92ca3c2d483f7f85439e8761a037ba725ea6ac164b36c1ab6f172635d4fbb8792a52f2b4bed5c40b8f5aa1305180f42866412103a08f93fed637daf62c1663c634d9034a2bfb6631c9f6ceba0c2ea7099c17fae2feffffff030000000000000000376a04534c500001010453454e4420c4b0d62156b3fa5c8f3436079b5394f7edc1bef5dc1cd2f9d0c4d46f82cca47908000000000000019022020000000000001976a91446e33d57e44125f02fc71a754fff13317ee8fc5088acb10f0000000000001976a9149c22bf7f6bb779237b2318dcbb1272f39a02d52e88accd2d0900";
21+
22+
(async function() {
23+
console.time("SLP-VALIDATE-RPC");
24+
const connectionString = `http://${RPC_USER_NAME}:${RPC_PASSWORD}@${RPC_URL}`;
25+
const rpc = new RpcClient(connectionString);
26+
const slpValidator = new ValidatorType1({ getRawTransaction: async (txid) => await rpc.getRawTransaction(txid) });
27+
console.log("This may take a several seconds...");
28+
let isValid;
29+
try {
30+
isValid = await slpValidator.isValidSlpTxn({ txn, burnQuantity: Big(5) }); // <--- Use "burnQuantity" to allow an exact burn amount
31+
} catch(error) {
32+
console.log(error);
33+
isValid = false;
34+
}
35+
console.log("Final Result:", isValid);
36+
console.log("NOTE: IN CONTRAST TO EXAMPLE 1, WE SPECIFICALLY ALLOWED BURNING IN THIS EXAMPLE");
37+
console.timeEnd("SLP-VALIDATE-RPC");
38+
})();

‎examples/3-validate-txid-rpc.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/***************************************************************************************
2+
*
3+
* Example 3: Validate a specific txid. This method comes with no burn protections.
4+
*
5+
* Instructions:
6+
* (1) - Set bitcoind RPC user, password, and URL.
7+
* (2) - Optional: set custom txid.
8+
*
9+
* ************************************************************************************/
10+
11+
import { ValidatorType1 } from '../index';
12+
const RpcClient = require('bitcoin-rpc-promise-retry');
13+
14+
const RPC_USER_NAME = 'bitcoin';
15+
const RPC_PASSWORD = 'password';
16+
const RPC_URL = 'localhost:8332';
17+
18+
const txid = "9cd705998fcc233ccf0a840f4ee7fcbc1eb678eba79e708560ecc95fedecfec9";
19+
20+
(async function() {
21+
console.time("SLP-VALIDATE-RPC");
22+
const connectionString = `http://${RPC_USER_NAME}:${RPC_PASSWORD}@${RPC_URL}`;
23+
const rpc = new RpcClient(connectionString);
24+
const slpValidator = new ValidatorType1({ getRawTransaction: async (txid) => await rpc.getRawTransaction(txid) });
25+
console.log("Validating:", txid);
26+
console.log("This may take a several seconds...");
27+
let isValid = await slpValidator.isValidSlpTxid({ txid });
28+
console.log("Final Result:", isValid);
29+
console.log("WARNING: THIS VALIDATION METHOD COMES WITH NO BURN PROTECTION.")
30+
console.timeEnd("SLP-VALIDATE-RPC");
31+
})();

‎examples/4-validate-txid-bchd.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/***************************************************************************************
2+
*
3+
* Example 4: Validate a specific txid using BCHD gRPC.
4+
*
5+
* Instructions:
6+
* (1) - Set bitcoind RPC user, password, and URL.
7+
* (2) - Optional: set custom txid.
8+
*
9+
* ************************************************************************************/
10+
11+
import { ValidatorType1 } from '../index';
12+
import { GrpcClient } from 'grpc-bchrpc-node';
13+
14+
const GRPC_URL = 'localhost:8335';
15+
//const GRPC_CERT = '/Users/jamescramer/Library/Application Support/Bchd/rpc.cert';
16+
const GRPC_CERT = '<path to your BCHD cert>';
17+
18+
const txid = "9cd705998fcc233ccf0a840f4ee7fcbc1eb678eba79e708560ecc95fedecfec9";
19+
20+
(async function() {
21+
console.time("SLP-VALIDATE-GRPC");
22+
const rpc = new GrpcClient({ url: GRPC_URL, rootCertPath: GRPC_CERT });
23+
const slpValidator = new ValidatorType1({ getRawTransaction: async (txid: string) => {
24+
let res = await rpc.getRawTransaction({ hash: txid, reverseOrder: true});
25+
return Buffer.from(res.getTransaction_asU8());
26+
} });
27+
console.log("Validating:", txid);
28+
console.log("This may take a several seconds...");
29+
let isValid = await slpValidator.isValidSlpTxid({ txid });
30+
console.log("Final Result:", isValid);
31+
console.log("WARNING: THIS VALIDATION METHOD COMES WITH NO BURN PROTECTION.")
32+
console.timeEnd("SLP-VALIDATE-GRPC");
33+
})();

‎index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export * from './lib/validation';
2+
export * from './lib/transaction';
3+
export * from './lib/slp';
4+
export * from './lib/crypto';

‎lib/crypto.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import * as crypto from 'crypto';
2+
3+
export class Crypto {
4+
static hash256(message: Buffer): Buffer {
5+
let hash1 = crypto.createHash('sha256');
6+
let hash2 = crypto.createHash('sha256');
7+
hash1.update(message);
8+
hash2.update(hash1.digest());
9+
return Buffer.from(hash2.digest().toJSON().data.reverse());
10+
}
11+
}

‎lib/script.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
export class Script {
2+
static opcodes = {
3+
OP_0: 0,
4+
OP_16: 96,
5+
OP_PUSHDATA1: 76,
6+
OP_PUSHDATA2: 77,
7+
OP_PUSHDATA4: 78,
8+
OP_1NEGATE : 79,
9+
OP_RETURN: 106,
10+
}
11+
}

0 commit comments

Comments
 (0)