package blockdag // This file functions are not considered safe for regular use, and should be used for test purposes only. import ( "fmt" "os" "path/filepath" "github.com/daglabs/btcd/util/subnetworkid" "github.com/daglabs/btcd/database" _ "github.com/daglabs/btcd/database/ffldb" // blank import ffldb so that its init() function runs before tests "github.com/daglabs/btcd/txscript" "github.com/daglabs/btcd/util/daghash" "github.com/daglabs/btcd/wire" ) const ( // testDbType is the database backend type to use for the tests. testDbType = "ffldb" // testDbRoot is the root directory used to create all test databases. testDbRoot = "testdbs" // blockDataNet is the expected network in the test block data. blockDataNet = wire.MainNet ) // isSupportedDbType returns whether or not the passed database type is // currently supported. func isSupportedDbType(dbType string) bool { supportedDrivers := database.SupportedDrivers() for _, driver := range supportedDrivers { if dbType == driver { return true } } return false } // filesExists returns whether or not the named file or directory exists. func fileExists(name string) bool { if _, err := os.Stat(name); err != nil { if os.IsNotExist(err) { return false } } return true } // DAGSetup is used to create a new db and chain instance with the genesis // block already inserted. In addition to the new chain instance, it returns // a teardown function the caller should invoke when done testing to clean up. func DAGSetup(dbName string, config Config) (*BlockDAG, func(), error) { if !isSupportedDbType(testDbType) { return nil, nil, fmt.Errorf("unsupported db type %s", testDbType) } var teardown func() if config.DB == nil { // Create the root directory for test databases. if !fileExists(testDbRoot) { if err := os.MkdirAll(testDbRoot, 0700); err != nil { err := fmt.Errorf("unable to create test db "+ "root: %s", err) return nil, nil, err } } dbPath := filepath.Join(testDbRoot, dbName) _ = os.RemoveAll(dbPath) var err error config.DB, err = database.Create(testDbType, dbPath, blockDataNet) if err != nil { return nil, nil, fmt.Errorf("error creating db: %s", err) } // Setup a teardown function for cleaning up. This function is // returned to the caller to be invoked when it is done testing. teardown = func() { config.DB.Close() os.RemoveAll(dbPath) os.RemoveAll(testDbRoot) } } config.TimeSource = NewMedianTime() config.SigCache = txscript.NewSigCache(1000) // Create the DAG instance. dag, err := New(&config) if err != nil { teardown() err := fmt.Errorf("failed to create dag instance: %s", err) return nil, nil, err } return dag, teardown, nil } // OpTrueScript is script returning TRUE var OpTrueScript = []byte{txscript.OpTrue} type txSubnetworkData struct { subnetworkID *subnetworkid.SubnetworkID Gas uint64 Payload []byte } func createTxForTest(numInputs uint32, numOutputs uint32, outputValue uint64, subnetworkData *txSubnetworkData) *wire.MsgTx { txIns := []*wire.TxIn{} txOuts := []*wire.TxOut{} for i := uint32(0); i < numInputs; i++ { txIns = append(txIns, &wire.TxIn{ PreviousOutpoint: *wire.NewOutpoint(&daghash.TxID{}, i), SignatureScript: []byte{}, Sequence: wire.MaxTxInSequenceNum, }) } for i := uint32(0); i < numOutputs; i++ { txOuts = append(txOuts, &wire.TxOut{ PkScript: OpTrueScript, Value: outputValue, }) } if subnetworkData != nil { return wire.NewSubnetworkMsgTx(wire.TxVersion, txIns, txOuts, subnetworkData.subnetworkID, subnetworkData.Gas, subnetworkData.Payload) } return wire.NewNativeMsgTx(wire.TxVersion, txIns, txOuts) } // VirtualForTest is an exported version for virtualBlock, so that it can be returned by exported test_util methods type VirtualForTest *virtualBlock // SetVirtualForTest replaces the dag's virtual block. This function is used for test purposes only func SetVirtualForTest(dag *BlockDAG, virtual VirtualForTest) VirtualForTest { oldVirtual := dag.virtual dag.virtual = virtual return VirtualForTest(oldVirtual) } // GetVirtualFromParentsForTest generates a virtual block with the given parents. func GetVirtualFromParentsForTest(dag *BlockDAG, parentHashes []*daghash.Hash) (VirtualForTest, error) { parents := newSet() for _, hash := range parentHashes { parent := dag.index.LookupNode(hash) if parent == nil { return nil, fmt.Errorf("GetVirtualFromParentsForTest: didn't found node for hash %s", hash) } parents.add(parent) } virtual := newVirtualBlock(parents, dag.dagParams.K) pastUTXO, acceptanceData, err := dag.pastUTXO(&virtual.blockNode) if err != nil { return nil, err } diffFromAcceptanceData, err := virtual.blockNode.diffFromAcceptanceData(pastUTXO, acceptanceData) if err != nil { return nil, err } utxo, err := pastUTXO.WithDiff(diffFromAcceptanceData) if err != nil { return nil, err } diffUTXO := utxo.clone().(*DiffUTXOSet) err = diffUTXO.meldToBase() if err != nil { return nil, err } virtual.utxoSet = diffUTXO.base return VirtualForTest(virtual), nil }