signer/core: move EIP-712 types to package apitypes (ethereum#24029)

Fixes ethereum#23972
Kapoio · Dec 5, 2021 · 619a3e7 · 619a3e7
1 parent 93f196c
commit 619a3e7
Show file tree

Hide file tree

Showing 9 changed files with 776 additions and 771 deletions.
diff --git a/cmd/clef/main.go b/cmd/clef/main.go
@@ -898,7 +898,7 @@ func testExternalUI(api *core.SignerAPI) {
  addr, _ := common.NewMixedcaseAddressFromString("0x0011223344556677889900112233445566778899")
  data := `{"types":{"EIP712Domain":[{"name":"name","type":"string"},{"name":"version","type":"string"},{"name":"chainId","type":"uint256"},{"name":"verifyingContract","type":"address"}],"Person":[{"name":"name","type":"string"},{"name":"test","type":"uint8"},{"name":"wallet","type":"address"}],"Mail":[{"name":"from","type":"Person"},{"name":"to","type":"Person"},{"name":"contents","type":"string"}]},"primaryType":"Mail","domain":{"name":"Ether Mail","version":"1","chainId":"1","verifyingContract":"0xCCCcccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC"},"message":{"from":{"name":"Cow","test":"3","wallet":"0xcD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"},"to":{"name":"Bob","wallet":"0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB","test":"2"},"contents":"Hello, Bob!"}}`
  //_, err := api.SignData(ctx, accounts.MimetypeTypedData, *addr, hexutil.Encode([]byte(data)))
- var typedData core.TypedData
+ var typedData apitypes.TypedData
  json.Unmarshal([]byte(data), &typedData)
  _, err := api.SignTypedData(ctx, *addr, typedData)
  expectApprove("sign 712 typed data", err)
@@ -1025,7 +1025,7 @@ func GenDoc(ctx *cli.Context) {
  "of the work in canonicalizing and making sense of the data, and it's up to the UI to present" +
  "the user with the contents of the `message`"
  sighash, msg := accounts.TextAndHash([]byte("hello world"))
- messages := []*core.NameValueType{{Name: "message", Value: msg, Typ: accounts.MimetypeTextPlain}}
+ messages := []*apitypes.NameValueType{{Name: "message", Value: msg, Typ: accounts.MimetypeTextPlain}}
 
  add("SignDataRequest", desc, &core.SignDataRequest{
  Address: common.NewMixedcaseAddress(a),

diff --git a/signer/core/api.go b/signer/core/api.go
@@ -57,7 +57,7 @@ type ExternalAPI interface {
  // SignData - request to sign the given data (plus prefix)
  SignData(ctx context.Context, contentType string, addr common.MixedcaseAddress, data interface{}) (hexutil.Bytes, error)
  // SignTypedData - request to sign the given structured data (plus prefix)
- SignTypedData(ctx context.Context, addr common.MixedcaseAddress, data TypedData) (hexutil.Bytes, error)
+ SignTypedData(ctx context.Context, addr common.MixedcaseAddress, data apitypes.TypedData) (hexutil.Bytes, error)
  // EcRecover - recover public key from given message and signature
  EcRecover(ctx context.Context, data hexutil.Bytes, sig hexutil.Bytes) (common.Address, error)
  // Version info about the APIs
@@ -235,7 +235,7 @@ type (
  ContentType string `json:"content_type"`
  Address common.MixedcaseAddress `json:"address"`
  Rawdata []byte `json:"raw_data"`
- Messages []*NameValueType  `json:"messages"`
+ Messages []*apitypes.NameValueType `json:"messages"`
  Callinfo []apitypes.ValidationInfo `json:"call_info"`
  Hash hexutil.Bytes `json:"hash"`
  Meta Metadata `json:"meta"`

diff --git a/signer/core/signed_data_internal_test.go → ...ore/apitypes/signed_data_internal_test.go b/signer/core/signed_data_internal_test.go → ...ore/apitypes/signed_data_internal_test.go
@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
 
-package core
+package apitypes
 
 import (
  "bytes"