Merge pull request #34 from libsv/feat/bscript-interpreter

Author: Jad Wahab

.gitignore

@@ -7,11 +7,17 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# linter binary
+golangci-lint
+
 # Notes
 todo.md
 
 # Distribution directory for releases
 dist
 
 # Converage
-coverage.txt
+coverage.txt
+
+# vim
+*.swp

.golangci.yml

@@ -339,9 +339,9 @@ linters:
     - golint
     - unconvert
     - dupl
-    - maligned
     - misspell
     - dogsled
+    - revive
     - prealloc
     - exportloopref
     - exhaustive
@@ -356,6 +356,8 @@ linters:
     - gci
     - wsl
     - goerr113
+    - scopelint
+    - maligned
     - godot
     - testpackage
     - nestif
@@ -385,6 +387,7 @@ issues:
         - errcheck
         - dupl
         - gosec
+        - govet
         - maligned
         - lll
 
@@ -462,4 +465,4 @@ severity:
   rules:
     - linters:
         - dupl
-      severity: info
+      severity: info

.make/go.mk

@@ -41,16 +41,10 @@ install-go: ## Install the application (Using Native Go)
 	@go install $(GIT_DOMAIN)/$(REPO_OWNER)/$(REPO_NAME)
 
 lint: ## Run the golangci-lint application (install if not found)
-	@#Travis (has sudo)
-	@if [ "$(shell command -v golangci-lint)" = "" ] && [ $(TRAVIS) ]; then curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.33.0 && sudo cp ./bin/golangci-lint $(go env GOPATH)/bin/; fi;
-	@#AWS CodePipeline
-	@if [ "$(shell command -v golangci-lint)" = "" ] && [ "$(CODEBUILD_BUILD_ID)" != "" ]; then curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.33.0; fi;
-	@#Github Actions
-	@if [ "$(shell command -v golangci-lint)" = "" ] && [ "$(GITHUB_WORKFLOW)" != "" ]; then curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b $(go env GOPATH)/bin v1.33.0; fi;
-	@#Brew - MacOS
-	@if [ "$(shell command -v golangci-lint)" = "" ] && [ "$(shell command -v brew)" != "" ]; then brew install golangci-lint; fi;
+	@echo "downloading golangci-lint..."
+	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- v1.33.0
 	@echo "running golangci-lint..."
-	@golangci-lint run
+	@GOGC=20 ./bin/golangci-lint run
 
 test: ## Runs vet, lint and ALL tests
 	@$(MAKE) lint
@@ -97,4 +91,4 @@ update-linter: ## Update the golangci-lint package (macOS only)
 
 vet: ## Run the Go vet application
 	@echo "running go vet..."
-	@go vet -v ./...
+	@go vet -v ./...

bscript/interpreter/README.md

@@ -0,0 +1,36 @@
+interpreter
+========
+
+[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
+[![GoDoc](https://pkg.go.dev/badge/github.com/libsv/go-bt/bscript/interpreter?utm_source=godoc)](http://godoc.org/github.com/libsv/got-bt/bscript/interpreter)
+
+Package interpreter implements the an interpreter for the bitcoin transaction language.  There is
+a comprehensive test suite.
+
+This package has intentionally been designed so it can be used as a standalone
+package for any projects needing to use or validate bitcoin transaction scripts.
+
+## Bitcoin Scripts
+
+Bitcoin provides a stack-based, FORTH-like language for the scripts in
+the bitcoin transactions.  This language is not turing complete
+although it is still fairly powerful.  A description of the language
+can be found at https://wiki.bitcoinsv.io/index.php/Script
+
+## Installation and Updating
+
+```bash
+$ go get -u github.com/libsv/go-bt/bscript/interpreter
+```
+
+## Examples
+
+* [Standard Pay-to-pubkey-hash Script](http://github.com/libsv/go-bt/bscript/interpreter#example-PayToAddrScript)  
+  Demonstrates creating a script which pays to a bitcoin address.  It also
+  prints the created script hex and uses the DisasmString function to display
+  the disassembled script.
+
+## License
+
+Package interpreter is licensed under the [copyfree](http://copyfree.org) ISC
+License.

bscript/interpreter/config.go

@@ -0,0 +1,63 @@
+package interpreter
+
+import "math"
+
+type config interface {
+	MaxOps() int
+	MaxStackSize() int
+	MaxScriptSize() int
+	MaxScriptElementSize() int
+	MaxPubKeysPerMultiSig() int
+}
+
+// Limits applied to transactions before genesis
+const (
+	MaxOpsBeforeGenesis                = 500
+	MaxStackSizeBeforeGenesis          = 1000
+	MaxScriptSizeBeforeGenesis         = 10000
+	MaxScriptElementSizeBeforeGenesis  = 520
+	MaxPubKeysPerMultiSigBeforeGenesis = 20
+)
+
+type beforeGenesisConfig struct{}
+type afterGenesisConfig struct{}
+
+func (a *afterGenesisConfig) MaxStackSize() int {
+	return math.MaxInt32
+}
+
+func (b *beforeGenesisConfig) MaxStackSize() int {
+	return MaxStackSizeBeforeGenesis
+}
+
+func (a *afterGenesisConfig) MaxScriptSize() int {
+	return math.MaxInt32
+}
+
+func (b *beforeGenesisConfig) MaxScriptSize() int {
+	return MaxScriptSizeBeforeGenesis
+}
+
+func (a *afterGenesisConfig) MaxScriptElementSize() int {
+	return math.MaxInt32
+}
+
+func (b *beforeGenesisConfig) MaxScriptElementSize() int {
+	return MaxScriptElementSizeBeforeGenesis
+}
+
+func (a *afterGenesisConfig) MaxOps() int {
+	return math.MaxInt32
+}
+
+func (b *beforeGenesisConfig) MaxOps() int {
+	return MaxOpsBeforeGenesis
+}
+
+func (a *afterGenesisConfig) MaxPubKeysPerMultiSig() int {
+	return math.MaxInt32
+}
+
+func (b *beforeGenesisConfig) MaxPubKeysPerMultiSig() int {
+	return MaxPubKeysPerMultiSigBeforeGenesis
+}

bscript/interpreter/consensus.go

@@ -0,0 +1,13 @@
+// Copyright (c) 2015-2016 The btcsuite developers
+// Use of this source code is governed by an ISC
+// license that can be found in the LICENSE file.
+
+package interpreter
+
+const (
+	// LockTimeThreshold is the number below which a lock time is
+	// interpreted to be a block number.  Since an average of one block
+	// is generated per 10 minutes, this allows blocks for about 9,512
+	// years.
+	LockTimeThreshold = 5e8 // Tue Nov 5 00:53:20 1985 UTC
+)

bscript/interpreter/data/LICENSE

@@ -0,0 +1,8 @@
+The json files in this directory come from the bitcoind project
+(https://github.com/bitcoin/bitcoin) and is released under the following
+license:
+
+    Copyright (c) 2012-2014 The Bitcoin Core developers
+    Distributed under the MIT/X11 software license, see the accompanying
+    file COPYING or http://www.opensource.org/licenses/mit-license.php.
+