Module: Tapyrus

Extended by:
Util
Defined in:
lib/tapyrus/tx.rb,
lib/tapyrus.rb,
lib/tapyrus/ext.rb,
lib/tapyrus/jws.rb,
lib/tapyrus/key.rb,
lib/tapyrus/rpc.rb,
lib/tapyrus/node.rb,
lib/tapyrus/util.rb,
lib/tapyrus/block.rb,
lib/tapyrus/store.rb,
lib/tapyrus/tx_in.rb,
lib/tapyrus/base58.rb,
lib/tapyrus/bip175.rb,
lib/tapyrus/errors.rb,
lib/tapyrus/logger.rb,
lib/tapyrus/slip39.rb,
lib/tapyrus/tx_out.rb,
lib/tapyrus/wallet.rb,
lib/tapyrus/ext_key.rb,
lib/tapyrus/message.rb,
lib/tapyrus/network.rb,
lib/tapyrus/opcodes.rb,
lib/tapyrus/tip0137.rb,
lib/tapyrus/version.rb,
lib/tapyrus/key_path.rb,
lib/tapyrus/mnemonic.rb,
lib/tapyrus/node/cli.rb,
lib/tapyrus/node/spv.rb,
lib/tapyrus/store/db.rb,
lib/tapyrus/constants.rb,
lib/tapyrus/out_point.rb,
lib/tapyrus/secp256k1.rb,
lib/tapyrus/wallet/db.rb,
lib/tapyrus/message/tx.rb,
lib/tapyrus/slip39/sss.rb,
lib/tapyrus/tx_builder.rb,
lib/tapyrus/validation.rb,
lib/tapyrus/merkle_tree.rb,
lib/tapyrus/message/inv.rb,
lib/tapyrus/wallet/base.rb,
lib/tapyrus/block_header.rb,
lib/tapyrus/bloom_filter.rb,
lib/tapyrus/chain_params.rb,
lib/tapyrus/message/addr.rb,
lib/tapyrus/message/base.rb,
lib/tapyrus/message/ping.rb,
lib/tapyrus/message/pong.rb,
lib/tapyrus/network/peer.rb,
lib/tapyrus/network/pool.rb,
lib/tapyrus/script/color.rb,
lib/tapyrus/slip39/share.rb,
lib/tapyrus/message/block.rb,
lib/tapyrus/message/error.rb,
lib/tapyrus/script/script.rb,
lib/tapyrus/message/reject.rb,
lib/tapyrus/secp256k1/ruby.rb,
lib/tapyrus/wallet/account.rb,
lib/tapyrus/ext/json_parser.rb,
lib/tapyrus/message/headers.rb,
lib/tapyrus/message/ver_ack.rb,
lib/tapyrus/message/version.rb,
lib/tapyrus/rpc/http_server.rb,
lib/tapyrus/script/debugger.rb,
lib/tapyrus/script/multisig.rb,
lib/tapyrus/store/spv_chain.rb,
lib/tapyrus/message/get_addr.rb,
lib/tapyrus/message/get_data.rb,
lib/tapyrus/message/mem_pool.rb,
lib/tapyrus/secp256k1/native.rb,
lib/tapyrus/message/block_txn.rb,
lib/tapyrus/message/inventory.rb,
lib/tapyrus/message/not_found.rb,
lib/tapyrus/script/tx_checker.rb,
lib/tapyrus/secp256k1/rfc6979.rb,
lib/tapyrus/store/chain_entry.rb,
lib/tapyrus/store/db/level_db.rb,
lib/tapyrus/wallet/master_key.rb,
lib/tapyrus/message/fee_filter.rb,
lib/tapyrus/message/filter_add.rb,
lib/tapyrus/message/get_blocks.rb,
lib/tapyrus/message/send_cmpct.rb,
lib/tapyrus/network/connection.rb,
lib/tapyrus/node/configuration.rb,
lib/tapyrus/message/cmpct_block.rb,
lib/tapyrus/message/filter_load.rb,
lib/tapyrus/message/get_headers.rb,
lib/tapyrus/rpc/request_handler.rb,
lib/tapyrus/script/script_error.rb,
lib/tapyrus/message/filter_clear.rb,
lib/tapyrus/message/merkle_block.rb,
lib/tapyrus/message/network_addr.rb,
lib/tapyrus/message/prefilled_tx.rb,
lib/tapyrus/message/send_headers.rb,
lib/tapyrus/message/get_block_txn.rb,
lib/tapyrus/message/headers_parser.rb,
lib/tapyrus/network/peer_discovery.rb,
lib/tapyrus/network/message_handler.rb,
lib/tapyrus/rpc/tapyrus_core_client.rb,
lib/tapyrus/script/script_interpreter.rb,
lib/tapyrus/message/block_transactions.rb,
lib/tapyrus/message/inventories_parser.rb,
lib/tapyrus/message/header_and_short_ids.rb,
lib/tapyrus/message/block_transaction_request.rb

Overview

Porting part of the code from bitcoin-ruby. see the license. github.com/lian/bitcoin-ruby/blob/master/COPYING

Defined Under Namespace

Modules: Base58, Color, Errors, Ext, HexConverter, JWS, KeyPath, Logger, Message, Multisig, Network, Node, Opcodes, RPC, SLIP39, Secp256k1, Store, TIP0137, Util, Wallet Classes: BIP175, Block, BlockHeader, BloomFilter, ChainParams, EmptyTxChecker, ExtKey, ExtPubkey, Key, MerkleTree, Mnemonic, OutPoint, Script, ScriptDebugger, ScriptError, ScriptInterpreter, StepResult, Tx, TxBuilder, TxChecker, TxIn, TxOut, TxUnspecifiedError, Validation, ValidationState

Constant Summary collapse

CURVE_ORDER =

Integers modulo the order of the curve(secp256k1)

ECDSA::Group::Secp256k1.order
VERSION = 
"0.3.5"
COIN = 
100_000_000
MAX_MONEY = 
21_000_000 * COIN
MAX_BLOCK_SERIALIZED_SIZE =

The maximum allowed size for a serialized block, in bytes (only for buffer size limits)

4_000_000
MAX_BLOCK_WEIGHT =

The maximum allowed weight for a block, see BIP 141 (network rule)

4_000_000
MAX_BLOCK_SIGOPS_COST =

The maximum allowed number of signature check operations in a block (network rule)

80_000
COINBASE_MATURITY =

Coinbase transaction outputs can only be spent after this number of new blocks (network rule)

100
WITNESS_SCALE_FACTOR = 
4
MIN_TRANSACTION_WEIGHT =

60 is the lower bound for the size of a valid serialized Tx

WITNESS_SCALE_FACTOR * 60
MIN_SERIALIZABLE_TRANSACTION_WEIGHT =

10 is the lower bound for the size of a serialized Tx

WITNESS_SCALE_FACTOR * 10
LOCKTIME_VERIFY_SEQUENCE =

Flags for nSequence and nLockTime locks

(1 << 0)
LOCKTIME_MEDIAN_TIME_PAST = 
(1 << 1)
DUST_RELAY_TX_FEE =

Min feerate for defining dust.

3000
SCRIPT_VERIFY_NONE =

script verify flags

0
SCRIPT_VERIFY_P2SH = 
(1 << 0)
SCRIPT_VERIFY_STRICTENC = 
(1 << 1)
SCRIPT_VERIFY_DERSIG = 
(1 << 2)
SCRIPT_VERIFY_LOW_S = 
(1 << 3)
SCRIPT_VERIFY_NULLDUMMY = 
(1 << 4)
SCRIPT_VERIFY_SIGPUSHONLY = 
(1 << 5)
SCRIPT_VERIFY_MINIMALDATA = 
(1 << 6)
SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_NOPS = 
(1 << 7)
SCRIPT_VERIFY_CLEANSTACK = 
(1 << 8)
SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY =

Verify CHECKLOCKTIMEVERIFY (BIP-65)

(1 << 9)
SCRIPT_VERIFY_CHECKSEQUENCEVERIFY =

support CHECKSEQUENCEVERIFY opcode (BIP-112)

(1 << 10)
SCRIPT_VERIFY_MINIMALIF =

Segwit script only: Require the argument of OP_IF/NOTIF to be exactly 0x01 or empty vector

(1 << 13)
SCRIPT_VERIFY_NULLFAIL =

Signature(s) must be empty vector if an CHECK(MULTI)SIG operation failed

(1 << 14)
SCRIPT_VERIFY_CONST_SCRIPTCODE =

Making OP_CODESEPARATOR and FindAndDelete fail any non-segwit scripts

(1 << 16)
MANDATORY_SCRIPT_VERIFY_FLAGS = 
SCRIPT_VERIFY_P2SH
STANDARD_SCRIPT_VERIFY_FLAGS =

Standard script verification flags that standard transactions will comply with.

[
  MANDATORY_SCRIPT_VERIFY_FLAGS,
  SCRIPT_VERIFY_DERSIG,
  SCRIPT_VERIFY_STRICTENC,
  SCRIPT_VERIFY_MINIMALDATA,
  SCRIPT_VERIFY_NULLDUMMY,
  SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_NOPS,
  SCRIPT_VERIFY_CLEANSTACK,
  SCRIPT_VERIFY_MINIMALIF,
  SCRIPT_VERIFY_NULLFAIL,
  SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY,
  SCRIPT_VERIFY_CHECKSEQUENCEVERIFY,
  SCRIPT_VERIFY_LOW_S,
  SCRIPT_VERIFY_CONST_SCRIPTCODE
].inject(SCRIPT_VERIFY_NONE) { |flags, f| flags |= f }
MAX_SCRIPT_SIZE =

Maximum script length in bytes

10_000
MAX_PUBKEYS_PER_MULTISIG =

Maximum number of public keys per multisig

20
MAX_OPS_PER_SCRIPT =

Maximum number of non-push operations per script

201
MAX_SCRIPT_ELEMENT_SIZE =

Maximum number of bytes pushable to the stack

520
MAX_STACK_SIZE =

Maximum number of size in the stack

1000
LOCKTIME_THRESHOLD =

Threshold for nLockTime: below this value it is interpreted as block number, otherwise as UNIX timestamp.

500_000_000
SIGHASH_TYPE =

Signature hash types/flags

{ all: 1, none: 2, single: 3, anyonecanpay: 128 }
DEFAULT_MAX_NUM_SIZE =

Maximum number length in bytes

4
MAX_OP_RETURN_RELAY =

80 bytes of data, 1 for OP_RETURN, 2 for the pushdata opcodes.

83
SCRIPT_ERR_OK =

for script error

0
SCRIPT_ERR_UNKNOWN_ERROR = 
1
SCRIPT_ERR_EVAL_FALSE = 
2
SCRIPT_ERR_OP_RETURN = 
3
SCRIPT_ERR_SCRIPT_SIZE =

Max sizes

10
SCRIPT_ERR_PUSH_SIZE = 
11
SCRIPT_ERR_OP_COUNT = 
12
SCRIPT_ERR_STACK_SIZE = 
13
SCRIPT_ERR_SIG_COUNT = 
14
SCRIPT_ERR_PUBKEY_COUNT = 
15
SCRIPT_ERR_VERIFY =

Failed verify operations

20
SCRIPT_ERR_EQUALVERIFY = 
21
SCRIPT_ERR_CHECKMULTISIGVERIFY = 
22
SCRIPT_ERR_CHECKSIGVERIFY = 
23
SCRIPT_ERR_NUMEQUALVERIFY = 
24
SCRIPT_ERR_CHECKDATASIGVERIFY = 
25
SCRIPT_ERR_BAD_OPCODE =

Logical/Format/Canonical errors

30
SCRIPT_ERR_DISABLED_OPCODE = 
31
SCRIPT_ERR_INVALID_STACK_OPERATION = 
32
SCRIPT_ERR_INVALID_ALTSTACK_OPERATION = 
33
SCRIPT_ERR_UNBALANCED_CONDITIONAL = 
34
SCRIPT_ERR_MIXED_SCHEME_MULTISIG = 
35
SCRIPT_ERR_NEGATIVE_LOCKTIME =

CHECKLOCKTIMEVERIFY and CHECKSEQUENCEVERIFY

40
SCRIPT_ERR_UNSATISFIED_LOCKTIME = 
41
SCRIPT_ERR_SIG_HASHTYPE =

Malleability

50
SCRIPT_ERR_SIG_DER = 
51
SCRIPT_ERR_MINIMALDATA = 
52
SCRIPT_ERR_SIG_PUSHONLY = 
53
SCRIPT_ERR_SIG_HIGH_S = 
54
SCRIPT_ERR_SIG_NULLDUMMY = 
55
SCRIPT_ERR_PUBKEYTYPE = 
56
SCRIPT_ERR_CLEANSTACK = 
57
SCRIPT_ERR_MINIMALIF = 
58
SCRIPT_ERR_SIG_NULLFAIL = 
59
SCRIPT_ERR_DISCOURAGE_UPGRADABLE_NOPS =

softfork safeness

60
SCRIPT_ERR_OP_CODESEPARATOR =

Constant scriptCode

77
SCRIPT_ERR_SIG_FINDANDDELETE = 
78
SCRIPT_ERR_OP_COLOR_UNEXPECTED = 
79
SCRIPT_ERR_OP_COLOR_ID_INVALID = 
80
SCRIPT_ERR_OP_COLOR_MULTIPLE = 
81
SCRIPT_ERR_OP_COLOR_IN_BRANCH = 
82
SCRIPT_ERR_ERROR_COUNT = 
83
ERRCODES_MAP = 


NAME_MAP =





COINBASE_WTXID =



"00" * 32


MESSAGE_HEADER_SIZE =





for message












24


PARALLEL_THREAD =





for peer












3


MAX_FUTURE_BLOCK_TIME =





Maximum amount of time that a block timestamp is allowed to exceed the current network-adjusted time before the block will be accepted.












2 * 60 * 60


MEDIAN_TIME_SPAN =





Size of set to pick median time from.












11


BIP32_EXTKEY_WITH_VERSION_SIZE =



78


HARDENED_THRESHOLD =





2**31












2_147_483_648




Constants included
from Util


Util::DIGEST_NAME_SHA256



Class Method Summary
collapse




Methods included from Util


byte_to_bit, calc_checksum, decode_base58_address, double_sha256, encode_base58_address, hash160, hmac_sha256, pack_boolean, pack_var_int, pack_var_string, padding_zero, sha256, unpack_boolean, unpack_var_int, unpack_var_int_from_io, unpack_var_string, valid_address?




Class Method Details





.base_dir ⇒ Object







base dir path that store blockchain data and wallet data















86
87
88




# File 'lib/tapyrus.rb', line 86

def self.base_dir
  "#{Dir.home}/.tapyrusrb/#{@chain_param}"
end












.chain_params ⇒ Object







current tapyrus network chain params.















74
75
76
77
78
79
80
81
82
83




# File 'lib/tapyrus.rb', line 74

def self.chain_params
  return @current_chain if @current_chain
  case @chain_param
  when :prod
    @current_chain = Tapyrus::ChainParams.prod
  when :dev
    @current_chain = Tapyrus::ChainParams.dev
  end
  @current_chain
end












.chain_params=(name) ⇒ Object







set tapyrus network chain params















67
68
69
70
71




# File 'lib/tapyrus.rb', line 67

def self.chain_params=(name)
  raise "chain params for #{name} is not defined." unless %i[prod dev].include?(name.to_sym)
  @current_chain = nil
  @chain_param = name.to_sym
end












.hmac_sha256(key, data) ⇒ Object










100
101
102




# File 'lib/tapyrus.rb', line 100

def self.hmac_sha256(key, data)
  OpenSSL::HMAC.digest(OpenSSL::Digest.new("SHA256"), key, data)
end












.hmac_sha512(key, data) ⇒ Object










96
97
98




# File 'lib/tapyrus.rb', line 96

def self.hmac_sha512(key, data)
  OpenSSL::HMAC.digest(OpenSSL::Digest.new("SHA512"), key, data)
end












.secp_impl ⇒ Object







get secp implementation module















91
92
93
94




# File 'lib/tapyrus.rb', line 91

def self.secp_impl
  path = ENV["SECP256K1_LIB_PATH"]
  (path && File.exist?(path)) ? Tapyrus::Secp256k1::Native : Tapyrus::Secp256k1::Ruby
end