zcash-fpga/apps/python/zcash_fpga.py

class zcash_fpga:
    import serial
    import codecs
    import struct

    def byt_to_ver(a):
        return 'v{}.{}.{}'.format(a[2], a[1], a[0])

    def byt_to_str(a):
        return a[::-1].decode("utf-8")

    def byt_to_hex(a):
        return a.hex()

    fpga_msg_type_dict = {'FPGA_IGNORE_RPL':int('80000002', 16),
                          'FPGA_STATUS_RPL':int('80000001', 16),
                          'RESET_FPGA_RPL':int('80000000', 16),
                          'VERIFY_SECP256K1_SIG_RPL':int('80000101', 16)}

    fpga_msg_dict = {fpga_msg_type_dict['VERIFY_SECP256K1_SIG_RPL']:{'name':'VERIFY_SECP256K1_SIG_RPL', 'feilds':[(8, 'index', byt_to_hex), (1, 'bm', byt_to_hex), (2, 'cycle_cnt', byt_to_hex)]},
                     fpga_msg_type_dict['FPGA_IGNORE_RPL']:{'name':'FPGA_IGNORE_RPL', 'feilds':[(8, 'ignored_header', byt_to_hex)]},
                     fpga_msg_type_dict['FPGA_STATUS_RPL']:{'name':'FPGA_STATUS_RPL', 'feilds':[(4, 'version', byt_to_ver), (8, 'build_date', byt_to_str), (8, 'buid_host', byt_to_str), (8, 'cmd_cap', byt_to_hex)]},
                     fpga_msg_type_dict['RESET_FPGA_RPL']:{'name':'RESET_FPGA_RPL', 'feilds':[]}}


    def __init__(self, COM='COM4'):
        self.s = self.serial.Serial(COM, 921600, timeout=1)
        #Test getting FPGA status
        self.get_status()
        print("Connected...")

    # FPGA status
    def get_status(self):
        self.s.write(self.codecs.decode('0800000001000000', 'hex'))
        # Parse reply
        self.get_reply()

    def reset_fpga(self):
        self.s.write(self.codecs.decode('0800000000000000', 'hex'))
        # Parse reply - should be reset
        res = self.get_reply()
        if (self.struct.unpack('<I', res[4:8])[0] != self.fpga_msg_type_dict['RESET_FPGA_RPL']):
            print("ERROR: Reply type was not RESET_FPGA_RPL")

    def get_reply(self):
        res = self.s.read(1024)
        if len(res) > 0:
            self.print_reply(res)
            return res
        else:
            print ("INFO: No reply received")
            return None

    def secp256k1_verify_sig(self, index, hsh, r, s, Qx, Qy):
        cmd = '00000101000000B0'
        cmd = format(index, 'x').ljust(16, '0') + cmd
        cmd = format(s, 'x').ljust(64, '0') + cmd
        cmd = format(r, 'x').ljust(64, '0') + cmd
        cmd = format(hsh, 'x').ljust(64, '0') + cmd
        cmd = format(Qx, 'x').ljust(64, '0') + cmd
        cmd = format(Qy, 'x').ljust(64, '0') + cmd
        #Need to swap cmd byte order
        cmd = "".join(reversed([cmd[i:i+2] for i in range(0, len(cmd), 2)]))

        self.s.write(self.codecs.decode(cmd, 'hex'))
        res = self.get_reply()
        if res is not None and (self.struct.unpack('<I', res[4:8])[0] != self.fpga_msg_type_dict['VERIFY_SECP256K1_SIG_RPL']):
            print("ERROR: Reply type was not VERIFY_SECP256K1_SIG_RPL")
            return False
        if (self.struct.unpack('<Q', res[8:16])[0] != index):
            print("ERROR: Index did not match")
            return False
        if (self.struct.unpack('<B', res[16:17])[0] != 0):
            print("ERROR: Result bitmask was non-zero")
            return False
        print("INFO: Secp256k1 signature verified correctly")
        return True

    def close(self):
        self.s.close()
        print("Closed...")

    def print_reply(self, msg):
        if (len(msg) < 8):
            print("ERROR: Message too small")
            return None
        length = (self.struct.unpack('<I', msg[0:4])[0])
        if (len(msg) != length):
            print("ERROR: Message length mismatch")
        cmd = (self.struct.unpack('<I', msg[4:8])[0])
        if (cmd not in self.fpga_msg_dict):
            print("ERROR: Unknown message type:", cmd)

        print ("INFO: Received ", self.fpga_msg_dict[cmd]['name'])
        offset = 8
        for i in range(len(self.fpga_msg_dict[cmd]['feilds'])):
            length = self.fpga_msg_dict[cmd]['feilds'][i][0]
            print(self.fpga_msg_dict[cmd]['feilds'][i][1], ":", self.fpga_msg_dict[cmd]['feilds'][i][2](bytes(msg[offset:offset+length])))
            offset += length

#Example usages:
def example_secp256k1_sig():
    zf = zcash_fpga()
    zf.reset_fpga() # Reset incase somethign went wrong last run

    index = 1234
    hsh = 34597931798561447004034205848155169322219865803759328163562698792725658370004
    r = 550117237093786687120086685263208063857013211911888854762107796665370524299
    s = 100440748044460701692736849796872767381221821858945401325418288486792652245963
    Qx = 58140175961173984744358741087164846868370435294166601807987768465943227655092
    Qy = 108022006572115270940875378266056879700669412417454111206384551596343133676105
    zf.secp256k1_verify_sig(index, hsh, r, s, Qx, Qy)

    zf.close()

example_secp256k1_sig()