Sign Message and Structured Data
Contents
Sign Message and Structured Data¶
Run this example online by clicking 🚀 -> Binder on the top bar!
In Ethereum, it is recommended to follow EIP-712 to sign data and verify signatures, while in Conflux, we follow CIP-23 to sign and verify data.
The way to sign and verify data is consistent with eth-account, here are the examples
Sign Message¶
from cfx_account import Account
from cfx_account.messages import encode_defunct
message = "Hello World"
acct = Account.create()
# message should be preprocessed before signing
signable_message = encode_defunct(text=message)
# sign
signed = acct.sign_message(signable_message)
# verify signature
assert acct.address == Account.recover_message(signable_message, signature=signed.signature)
Sign Structured Data¶
As is shown below, typed_data is an example of structured data defined by CIP-23. The difference from the requirements from EIP-712 is that the field EIP712Domain is replaced by CIP23Domain and chainId of domain field is required rather than optional.
from cfx_account.messages import encode_structured_data
typed_data = {
"types": {
"CIP23Domain": [
{
"name": "name",
"type": "string"
},
{
"name": "version",
"type": "string"
},
{
"name": "chainId",
"type": "uint256"
},
{
"name": "verifyingContract",
"type": "address"
}
],
"Person": [
{
"name": "name",
"type": "string"
},
{
"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",
"wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
},
"to": {
"name": "Bob",
"wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
},
"contents": "Hello, Bob!"
}
}
# preprocess structured data
signable_message = encode_structured_data(primitive=typed_data)
# sign
signed = acct.sign_message(signable_message)
# verify signature
assert acct.address == Account.recover_message(signable_message, signature=signed.signature)