BitcoinLib v0.4.7

View Source BitcoinLib.Script (BitcoinLib v0.4.7)

Script manipulation module

Link to this section Summary

Functions

encode(script)

Transforms a list of opcodes into a compact integer reprensenting the size of the script, and the script itself

execute(script, stack)
identify(script)
parse!(script)

Transforms a script in the bitstring form into a list of opcodes

parse(script)

Transforms a script in the bitstring form into a list of opcodes

validate(script, stack)

Link to this section Functions

Link to this function

encode(script)

View Source 
@spec encode(list()) :: {bitstring(), bitstring()}

Transforms a list of opcodes into a compact integer reprensenting the size of the script, and the script itself

examples

 Examples 

iex> [
...>   %BitcoinLib.Script.Opcodes.Stack.Dup{},
...>   %BitcoinLib.Script.Opcodes.Crypto.Hash160{},
...>   %BitcoinLib.Script.Opcodes.Data{
...>     value: <<0xfde0a08625e327ba400644ad62d5c571d2eec3de::160>>
...>   },
...>   %BitcoinLib.Script.Opcodes.BitwiseLogic.EqualVerify{},
...>   %BitcoinLib.Script.Opcodes.Crypto.CheckSig{}
...> ] |> BitcoinLib.Script.encode
{<<0x19>>, <<0x76a914fde0a08625e327ba400644ad62d5c571d2eec3de88ac::200>>}
Link to this function

execute(script, stack)

View Source 
@spec execute(bitstring(), list()) :: {:ok, boolean()} | {:error, binary()}
@spec execute(list(), list()) :: {:ok, boolean()} | {:error, binary()}
Link to this function

identify(script)

View Source 
@spec identify(bitstring() | list()) ::
  {:unknown} | {:p2pk | :p2pkh | :p2sh | :p2wsh | :p2wpkh, bitstring()}
Link to this function

parse!(script)

View Source 
@spec parse!(bitstring()) :: list()

Transforms a script in the bitstring form into a list of opcodes

examples

 Examples 

iex> <<0x76a914fde0a08625e327ba400644ad62d5c571d2eec3de88ac::200>>
...> |> BitcoinLib.Script.parse!()
[
  %BitcoinLib.Script.Opcodes.Stack.Dup{},
  %BitcoinLib.Script.Opcodes.Crypto.Hash160{},
  %BitcoinLib.Script.Opcodes.Data{
    value: <<0xfde0a08625e327ba400644ad62d5c571d2eec3de::160>>
  },
  %BitcoinLib.Script.Opcodes.BitwiseLogic.EqualVerify{},
  %BitcoinLib.Script.Opcodes.Crypto.CheckSig{
    script: <<0x76a914fde0a08625e327ba400644ad62d5c571d2eec3de88ac::200>>
  }
]
Link to this function

parse(script)

View Source 
@spec parse(bitstring()) :: {:ok, list()} | {:error, binary()}

Transforms a script in the bitstring form into a list of opcodes

examples

 Examples 

iex> <<0x76a914fde0a08625e327ba400644ad62d5c571d2eec3de88ac::200>>
...> |> BitcoinLib.Script.parse()
{
  :ok,
  [
    %BitcoinLib.Script.Opcodes.Stack.Dup{},
    %BitcoinLib.Script.Opcodes.Crypto.Hash160{},
    %BitcoinLib.Script.Opcodes.Data{
      value: <<0xfde0a08625e327ba400644ad62d5c571d2eec3de::160>>
    },
    %BitcoinLib.Script.Opcodes.BitwiseLogic.EqualVerify{},
    %BitcoinLib.Script.Opcodes.Crypto.CheckSig{
      script: <<0x76a914fde0a08625e327ba400644ad62d5c571d2eec3de88ac::200>>
    }
  ]
}
Link to this function

validate(script, stack)

View Source 
@spec validate(bitstring(), list()) :: {:ok, boolean()} | {:error, binary()}
@spec validate(list(), list()) :: {:ok, boolean()} | {:error, binary()}