Merge commit 'refs/pull/107/head' of github.com:BitBoxSwiss/bitbox02-…

…api-go

api/firmware/eth.go

@@ -141,6 +141,22 @@ func (device *Device) handleSignerNonceCommitment(response *messages.ETHResponse
  return signature, nil
 }
 
+// ETHIdentifyCase identifies the case of the recipient address given as hexadecimal string.
+// This function exists as a convenience to potentially help clients to determine the case of the
+// recipient address. The output of the function goes to ETHSign and ETHSignEIP1559 as the
+// recipientAddressCase parameter, which is forwarded to BitBox02 device to reconstruct the address
+// in the correct case(the one that the user enters).
+func ETHIdentifyCase(recipientAddress string) messages.ETHAddressCase {
+ switch {
+ case strings.ToUpper(recipientAddress) == recipientAddress:
+ return messages.ETHAddressCase_ETH_ADDRESS_CASE_UPPER
+ case strings.ToLower(recipientAddress) == recipientAddress:
+ return messages.ETHAddressCase_ETH_ADDRESS_CASE_LOWER
+ default:
+ return messages.ETHAddressCase_ETH_ADDRESS_CASE_MIXED
+ }
+}
+
 // ETHSign signs an ethereum transaction. It returns a 65 byte signature (R, S, and 1 byte recID).
 func (device *Device) ETHSign(
  chainID uint64,
@@ -150,7 +166,8 @@ func (device *Device) ETHSign(
  gasLimit uint64,
  recipient [20]byte,
  value *big.Int,
- data []byte) ([]byte, error) {
+ data []byte,
+ recipientAddressCase messages.ETHAddressCase) ([]byte, error) {
  supportsAntiklepto := device.version.AtLeast(semver.NewSemVer(9, 5, 0))
 
  var hostNonceCommitment *messages.AntiKleptoHostNonceCommitment
@@ -168,6 +185,7 @@ func (device *Device) ETHSign(
  if err != nil {
  return nil, err
  }
+
  request := &messages.ETHRequest{
  Request: &messages.ETHRequest_Sign{
  Sign: &messages.ETHSignRequest{
@@ -181,6 +199,7 @@ func (device *Device) ETHSign(
  Value: value.Bytes(),
  Data: data,
  HostNonceCommitment: hostNonceCommitment,
+ AddressCase: recipientAddressCase,
  },
  },
  }
@@ -213,7 +232,8 @@ func (device *Device) ETHSignEIP1559(
  gasLimit uint64,
  recipient [20]byte,
  value *big.Int,
- data []byte) ([]byte, error) {
+ data []byte,
+ recipientAddressCase messages.ETHAddressCase) ([]byte, error) {
 
  if !device.version.AtLeast(semver.NewSemVer(9, 16, 0)) {
  return nil, UnsupportedError("9.16.0")
@@ -237,6 +257,7 @@ func (device *Device) ETHSignEIP1559(
  Value: value.Bytes(),
  Data: data,
  HostNonceCommitment: hostNonceCommitment,
+ AddressCase: recipientAddressCase,
  },
  },
  }

api/firmware/eth_test.go

@@ -15,6 +15,7 @@
 package firmware
 
 import (
+ "math/big"
  "testing"
 
  "github.com/BitBoxSwiss/bitbox02-api-go/api/firmware/messages"
@@ -378,3 +379,75 @@ func TestSimulatorETHSignTypedMessage(t *testing.T) {
  require.Len(t, sig, 65)
  })
 }
+
+func TestSimulatorETHSign(t *testing.T) {
+ testInitializedSimulators(t, func(t *testing.T, device *Device) {
+ t.Helper()
+ chainID := uint64(1)
+ keypath := []uint32{
+ 44 + hardenedKeyStart,
+ 60 + hardenedKeyStart,
+ 0 + hardenedKeyStart,
+ 0,
+ 10,
+ }
+ nonce := uint64(8156)
+ gasPrice := new(big.Int).SetUint64(6000000000)
+ gasLimit := uint64(21000)
+ recipient := [20]byte{0x04, 0xf2, 0x64, 0xcf, 0x34, 0x44, 0x03, 0x13, 0xb4, 0xa0,
+ 0x19, 0x2a, 0x35, 0x28, 0x14, 0xfb, 0xe9, 0x27, 0xb8, 0x85}
+ value := new(big.Int).SetUint64(530564000000000000)
+
+ sig, err := device.ETHSign(
+ chainID,
+ keypath,
+ nonce,
+ gasPrice,
+ gasLimit,
+ recipient,
+ value,
+ nil,
+ messages.ETHAddressCase_ETH_ADDRESS_CASE_MIXED,
+ )
+ require.NoError(t, err)
+
+ require.Len(t, sig, 65, "The signature should have exactly 65 bytes")
+ })
+}
+
+func TestSimulatorETHSignEIP1559(t *testing.T) {
+ testInitializedSimulators(t, func(t *testing.T, device *Device) {
+ t.Helper()
+ chainID := uint64(1)
+ keypath := []uint32{
+ 44 + hardenedKeyStart,
+ 60 + hardenedKeyStart,
+ 0 + hardenedKeyStart,
+ 0,
+ 10,
+ }
+ nonce := uint64(8156)
+ maxPriorityFeePerGas := new(big.Int)
+ maxFeePerGas := new(big.Int).SetUint64(6000000000)
+ gasLimit := uint64(21000)
+ recipient := [20]byte{0x04, 0xf2, 0x64, 0xcf, 0x34, 0x44, 0x03, 0x13, 0xb4, 0xa0,
+ 0x19, 0x2a, 0x35, 0x28, 0x14, 0xfb, 0xe9, 0x27, 0xb8, 0x85}
+ value := new(big.Int).SetUint64(530564000000000000)
+
+ sig, err := device.ETHSignEIP1559(
+ chainID,
+ keypath,
+ nonce,
+ maxPriorityFeePerGas,
+ maxFeePerGas,
+ gasLimit,
+ recipient,
+ value,
+ nil,
+ messages.ETHAddressCase_ETH_ADDRESS_CASE_MIXED,
+ )
+ require.NoError(t, err)
+
+ require.Len(t, sig, 65, "The signature should have exactly 65 bytes")
+ })
+}