txscript: add new ScriptTemplate DSL for writing Scripts #2216
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In this commit, we add a new function, `ScriptTemplate` to make the process of making custom Bitcoin scripts a bit less verbose. ScriptTemplate processes a script template with parameters and returns the corresponding script bytes. This functions allows Bitcoin scripts to be created using a DSL-like syntax, based on Go's templating system. An example of a simple p2pkh template would be: `OP_DUP OP_HASH160 0x14e8948c7afa71b6e6fad621256474b5959e0305 OP_EQUALVERIFY OP_CHECKSIG` Strings that have the `0x` prefix are assumed to byte strings to be pushed ontop of the stack. Integers can be passed as normal. If a value can't be parsed as an integer, then it's assume that it's a byte slice without the 0x prefix. Normal go template operations can be used as well. The params argument houses paramters to pass into the script, for example a local variable storing a computed public key.
Pull Request Test Coverage Report for Build 9984164707Details
💛 - Coveralls |
yyforyongyu
reviewed
Aug 29, 2024
| // processScript converts the template output to actual script bytes. We scan | ||
| // each line, then go through each element one by one, deciding to either add a | ||
| // normal op code, a push data, or an integer value. | ||
| func processScript(script string) ([]byte, error) { |
There was a problem hiding this comment.
let's add a unit test?
| // looksLikeInt checks if a string looks like an integer. | ||
| func looksLikeInt(s string) bool { | ||
| // Check if the string starts with an optional sign | ||
| if len(s) > 0 && (s[0] == '+' || s[0] == '-') { |
There was a problem hiding this comment.
when will + or - be used?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this commit, we add a new function,
ScriptTemplateto make the process of making custom Bitcoin scripts a bit less verbose.ScriptTemplate processes a script template with parameters and returns the corresponding script bytes. This functions allows Bitcoin scripts to be created using a DSL-like syntax, based on Go's templating system.
An example of a simple p2pkh template would be:
OP_DUP OP_HASH160 0x14e8948c7afa71b6e6fad621256474b5959e0305 OP_EQUALVERIFY OP_CHECKSIGStrings that have the
0xprefix are assumed to byte strings to be pushed ontop of the stack. Integers can be passed as normal. If a value can't be parsed as an integer, then it's assume that it's a byte slice without the 0x prefix.Normal go template operations can be used as well. The params argument houses paramters to pass into the script, for example a local variable storing a computed public key.