public static Block Load(byte[] hex, ConsensusFactory consensusFactory)
{
if (hex == null)
{
throw new ArgumentNullException(nameof(hex));
}
if (consensusFactory == null)
{
throw new ArgumentNullException(nameof(consensusFactory));
}
var block = consensusFactory.CreateBlock();
block.ReadWrite(hex, consensusFactory);
return(block);
}
public static Block Parse(string hex, ConsensusFactory consensusFactory)
{
if (hex == null)
{
throw new ArgumentNullException(nameof(hex));
}
if (consensusFactory == null)
{
throw new ArgumentNullException(nameof(consensusFactory));
}
var block = consensusFactory.CreateBlock();
block.ReadWrite(Encoders.Hex.DecodeData(hex), consensusFactory);
return(block);
}
public static Block CreateBlock(BlockHeader header, ConsensusFactory consensusFactory)
{
var ms = new MemoryStream(100);
BitcoinStream bs = new BitcoinStream(ms, true);
bs.ConsensusFactory = consensusFactory;
bs.ReadWrite(header);
var block = consensusFactory.CreateBlock();
ms.Position = 0;
bs = new BitcoinStream(ms, false);
block.Header.ReadWrite(bs);
return(block);
}
public Block CreateNextBlockWithCoinbase(PubKey pubkey, Money value, DateTimeOffset now, ConsensusFactory consensusFactory)
{
Block block = consensusFactory.CreateBlock();
block.Header.Nonce = RandomUtils.GetUInt32();
block.Header.HashPrevBlock = this.GetHash();
block.Header.BlockTime = now;
var tx = block.AddTransaction(consensusFactory.CreateTransaction());
tx.Inputs.Add(scriptSig: new Script(Op.GetPushOp(RandomUtils.GetBytes(30))));
tx.Outputs.Add(new TxOut()
{
Value = value,
ScriptPubKey = PayToPubkeyHashTemplate.Instance.GenerateScriptPubKey(pubkey)
});
return(block);
}
/// <summary>
/// Create a block with the specified option only. (useful for stripping data from a block).
/// </summary>
/// <param name="consensusFactory">The network consensus factory.</param>
/// <param name="options">Options to keep.</param>
/// <returns>A new block with only the options wanted.</returns>
public Block WithOptions(ConsensusFactory consensusFactory, TransactionOptions options)
{
if (this.Transactions.Count == 0)
{
return(this);
}
if ((options == TransactionOptions.Witness) && this.Transactions[0].HasWitness)
{
return(this);
}
if ((options == TransactionOptions.None) && !this.Transactions[0].HasWitness)
{
return(this);
}
Block instance = consensusFactory.CreateBlock();
using (var ms = new MemoryStream())
{
var bms = new BitcoinStream(ms, true)
{
TransactionOptions = options,
ConsensusFactory = consensusFactory
};
this.ReadWrite(bms);
ms.Position = 0;
bms = new BitcoinStream(ms, false)
{
TransactionOptions = options,
ConsensusFactory = consensusFactory
};
instance.ReadWrite(bms);
}
return(instance);
}
/// <summary>
/// Mines a new genesis block, to use with a new network.
/// Typically, 3 such genesis blocks need to be created when bootstrapping a new coin: for Main, Test and Reg networks.
/// </summary>
/// <param name="consensusFactory">
/// The consensus factory used to create transactions and blocks.
/// Use <see cref="PosConsensusFactory"/> for proof-of-stake based networks.
/// </param>
/// <param name="coinbaseText">
/// Traditionally a news headline from the day of the launch, but could be any string or link.
/// This will be inserted in the input coinbase transaction script.
/// It should be shorter than 92 characters.
/// </param>
/// <param name="target">
/// The difficulty target under which the hash of the block need to be.
/// Some more details: As an example, the target for the Stratis Main network is 00000fffffffffffffffffffffffffffffffffffffffffffffffffffffffffff.
/// To make it harder to mine the genesis block, have more zeros at the beginning (keeping the length the same). This will make the target smaller, so finding a number under it will be more difficult.
/// To make it easier to mine the genesis block ,do the opposite. Example of an easy one: 00ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff.
/// Make the Test and Reg targets ones easier to find than the Main one so that you don't wait too long to mine the genesis block.
/// </param>
/// <param name="genesisReward">
/// Specify how many coins to put in the genesis transaction's output. These coins are unspendable.
/// </param>
/// <param name="version">
/// The version of the transaction and the block header set in the genesis block.
/// </param>
/// <example>
/// The following example shows the creation of a genesis block.
/// <code>
/// Block genesis = MineGenesisBlock(new PosConsensusFactory(), "Some topical headline.", new Target(new uint256("000fffff00000000000000000000000000000000000000000000000000000000")), Money.Coins(50m));
/// BlockHeader header = genesis.Header;
/// Console.WriteLine("Make a note of the following values:");
/// Console.WriteLine("bits: " + header.Bits);
/// Console.WriteLine("nonce: " + header.Nonce);
/// Console.WriteLine("time: " + header.Time);
/// Console.WriteLine("version: " + header.Version);
/// Console.WriteLine("hash: " + header.GetHash());
/// Console.WriteLine("merkleroot: " + header.HashMerkleRoot);
/// </code>
/// </example>
/// <returns>A genesis block.</returns>
public static Block MineGenesisBlock(ConsensusFactory consensusFactory, string coinbaseText, Target target, Money genesisReward, int version = 1)
{
if (target == null)
{
throw new ArgumentException($"Parameter '{nameof(target)}' cannot be null. Example use: new Target(new uint256(\"0000ffff00000000000000000000000000000000000000000000000000000000\"))");
}
if (consensusFactory == null)
{
throw new ArgumentException($"Parameter '{nameof(consensusFactory)}' cannot be null. Use 'new ConsensusFactory()' for Bitcoin-like proof-of-work blockchains" +
"and 'new PosConsensusFactory()' for Stratis-like proof-of-stake blockchains.");
}
if (string.IsNullOrEmpty(coinbaseText))
{
throw new ArgumentException($"Parameter '{nameof(coinbaseText)}' cannot be null. Use a news headline or any other appropriate string.");
}
if (coinbaseText.Length >= 92)
{
throw new ArgumentException($"Parameter '{nameof(coinbaseText)}' should be shorter than 92 characters.");
}
if (genesisReward == null)
{
throw new ArgumentException($"Parameter '{nameof(genesisReward)}' cannot be null. Example use: 'Money.Coins(50m)'.");
}
DateTimeOffset time = DateTimeOffset.Now;
uint unixTime = Utils.DateTimeToUnixTime(time);
Transaction txNew = consensusFactory.CreateTransaction();
txNew.Version = (uint)version;
txNew.Time = unixTime;
txNew.AddInput(new TxIn()
{
ScriptSig = new Script(
Op.GetPushOp(0),
new Op()
{
Code = (OpcodeType)0x1,
PushData = new[] { (byte)42 }
},
Op.GetPushOp(Encoders.ASCII.DecodeData(coinbaseText)))
});
txNew.AddOutput(new TxOut()
{
Value = genesisReward,
});
Block genesis = consensusFactory.CreateBlock();
genesis.Header.BlockTime = time;
genesis.Header.Bits = target;
genesis.Header.Nonce = 0;
genesis.Header.Version = version;
genesis.Transactions.Add(txNew);
genesis.Header.HashPrevBlock = uint256.Zero;
genesis.UpdateMerkleRoot();
// Iterate over the nonce until the proof-of-work is valid.
// This will mean the block header hash is under the target.
while (!genesis.CheckProofOfWork())
{
genesis.Header.Nonce++;
if (genesis.Header.Nonce == 0)
{
genesis.Header.Time++;
}
}
return(genesis);
}
public static Block CreateBlock(ConsensusFactory consensusFactory)
{
return(consensusFactory.CreateBlock());
}