Edit

Sign API

The Sign API

This is the API we define to sign things with. It takes in an arbitrary byte vector and returns a Future[ECDigitalSignature]. The reason we incorporate Futures here is for extensibility of this API. We would like to provide implementations of this API for hardware devices, which need to be asynchrnous since they may require user input.

From Sign.scala:

import scodec.bits._
import org.bitcoins.crypto._
import scala.concurrent._
import scala.concurrent.duration._

trait Sign {
  def signFunction: ByteVector => Future[ECDigitalSignature]

  def signFuture(bytes: ByteVector): Future[ECDigitalSignature] =
    signFunction(bytes)

  def sign(bytes: ByteVector): ECDigitalSignature = {
    Await.result(signFuture(bytes), 30.seconds)
  }

  def publicKey: ECPublicKey
}

The ByteVector that is input to the signFunction should be the hash that is output from TransactionSignatureSerializer's hashForSignature method. Our in-memory BaseECKey types implement the Sign API.

If you wanted to implement a new Sign api for a hardware wallet, you can easily pass it into the TxBuilder/Signer classes to allow for you to use those devices to sign with Bitcoin-S.

This API is currently used to sign ordinary transactions with our Signers. The Signer subtypes (i.e. P2PKHSigner) implement the specific functionality needed to produce a valid digital signature for their corresponding script type.

The ExtSign API.

An ExtKey is a data structure that can be used to generate more keys from a parent key. For more information look at hd-keys.md

You can sign with ExtPrivateKey the same way you could with a normal ECPrivateKey.

import org.bitcoins.core.hd._
import org.bitcoins.core.crypto._

val extPrivKey = ExtPrivateKey(ExtKeyVersion.SegWitMainNetPriv)
// extPrivKey: ExtPrivateKey = Masked(ExtPrivateKeyImpl)

extPrivKey.sign(DoubleSha256Digest.empty.bytes)
// res0: ECDigitalSignature = ECDigitalSignature(30440220478dcf5f04b8923a6e5195eef976b6a98c6e9e6b5e18f899a69166b26a5e7e0202200e05fbf7c67693430ca4309846e133a8d285262799c244b08e49b18d795334bf)

val path = BIP32Path(Vector(BIP32Node(0,false)))
// path: BIP32Path = m/0

extPrivKey.sign(DoubleSha256Digest.empty.bytes,path)
// res1: ECDigitalSignature = ECDigitalSignature(3044022057deb86912f4a949328b2bf17625fb6992006b5bbfcce10af26d7b3bd09c4c1f0220174abe2daf9e06e5b69c8e8b943e6471ace8fcfde801b2a16e5f05bb19f91329)

With ExtSign, you can use ExtPrivateKey to sign transactions inside of TxBuilder since UTXOSpendingInfo takes in Sign as a parameter.

You can also provide a path to use to derive a child ExtPrivateKey, and then sign with that child private key