mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-03-30 15:08:33 +00:00
d984151549
* [NOD-517] Remove copyright notices from all doc.go. * [NOD-517] Updated the root doc.go. * [NOD-517] Remove all cov_report.sh and test_coverage.txt. * [NOD-517] Make all doc.go use the same style of comment. * [NOD-517] Update dagconfig doc.go. * [NOD-517] Update blockdag doc.go. * [NOD-517] Update doc.go in connmgr. * [NOD-517] Update doc.go in fullblocktests. * [NOD-517] Update doc.go in database. * [NOD-517] Update doc.go in ecc. * [NOD-517] Update doc.go in rpctest. * [NOD-517] Removed superfluous license in logs. * [NOD-517] Update doc.go in mempool. * [NOD-517] Updated doc.go in peer. * [NOD-517] Update doc.go in rpcclient. * [NOD-517] Update doc.go in txscript. * [NOD-517] Update doc.go in util. * [NOD-517] Update doc.go in base58. * [NOD-517] Update doc.go in bech32. * [NOD-517] Update doc.go in txsort. * [NOD-517] Update doc.go in wire. * [NOD-517] Fix indentation. * [NOD-517] Add a copyright notice to the main doc.go. * [NOD-517] Add Conformal to the license notices. * [NOD-517] Remove superfluous language from a doc. * [NOD-517] Fix bad example.
35 lines
1.5 KiB
Go
35 lines
1.5 KiB
Go
/*
|
|
Package txscript implements the kaspa transaction script language.
|
|
|
|
This package provides data structures and functions to parse and execute
|
|
kaspa transaction scripts.
|
|
|
|
Script Overview
|
|
|
|
Kaspa transaction scripts are written in a stack-base, FORTH-like language.
|
|
|
|
The kaspa script language consists of a number of opcodes which fall into
|
|
several categories such pushing and popping data to and from the stack,
|
|
performing basic and bitwise arithmetic, conditional branching, comparing
|
|
hashes, and checking cryptographic signatures. Scripts are processed from left
|
|
to right and intentionally do not provide loops.
|
|
|
|
Typical kaspa scripts at the time of this writing are of several standard
|
|
forms which consist of a spender providing a public key and a signature
|
|
which proves the spender owns the associated private key. This information
|
|
is used to prove the the spender is authorized to perform the transaction.
|
|
|
|
One benefit of using a scripting language is added flexibility in specifying
|
|
what conditions must be met in order to spend kaspa.
|
|
|
|
Errors
|
|
|
|
Errors returned by this package are of type txscript.Error. This allows the
|
|
caller to programmatically determine the specific error by examining the
|
|
ErrorCode field of the type asserted txscript.Error while still providing rich
|
|
error messages with contextual information. A convenience function named
|
|
IsErrorCode is also provided to allow callers to easily check for a specific
|
|
error code. See ErrorCode in the package documentation for a full list.
|
|
*/
|
|
package txscript
|