Skip to content
This repository has been archived by the owner on May 11, 2024. It is now read-only.

Commit

Permalink
feat: update encoding package
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidtaikocha
davidtaikocha committed Sep 29, 2023
1 parent b33d725 commit 28f660f
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 369 deletions.
1 change: 1 addition & 0 deletions .github/workflows/test.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ jobs:
with:
repository: taikoxyz/taiko-mono
path: ${{ env.TAIKO_MONO_DIR }}
ref: contestable-zkrollup

- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
Expand Down
219 changes: 22 additions & 197 deletions bindings/encoding/input.go
View file
Original file line number Diff line number Diff line change
@@ -1,103 +1,16 @@
package encoding

import (
"bytes"
"errors"
"fmt"

"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/log"
"github.com/ethereum/go-ethereum/rlp"
"github.com/taikoxyz/taiko-client/bindings"
)

// ABI arguments marshaling components.
var (
blockMetadataInputComponents = []abi.ArgumentMarshaling{
{
Name: "txListHash",
Type: "bytes32",
},
{
Name: "proposer",
Type: "address",
},
{
Name: "txListByteStart",
Type: "uint24",
},
{
Name: "txListByteEnd",
Type: "uint24",
},
{
Name: "cacheTxListInfo",
Type: "bool",
},
}
blockMetadataComponents = []abi.ArgumentMarshaling{
{
Name: "id",
Type: "uint64",
},
{
Name: "timestamp",
Type: "uint64",
},
{
Name: "l1Height",
Type: "uint64",
},
{
Name: "l1Hash",
Type: "bytes32",
},
{
Name: "mixHash",
Type: "bytes32",
},
{
Name: "txListHash",
Type: "bytes32",
},
{
Name: "txListByteStart",
Type: "uint24",
},
{
Name: "txListByteEnd",
Type: "uint24",
},
{
Name: "gasLimit",
Type: "uint32",
},
{
Name: "proposer",
Type: "address",
},
{
Name: "depositsProcessed",
Type: "tuple[]",
Components: []abi.ArgumentMarshaling{
{
Name: "recipient",
Type: "address",
},
{
Name: "amount",
Type: "uint96",
},
{
Name: "id",
Type: "uint64",
},
},
},
}
evidenceComponents = []abi.ArgumentMarshaling{
{
Name: "metaHash",
Expand All @@ -120,11 +33,11 @@ var (
Type: "bytes32",
},
{
Name: "prover",
Type: "address",
Name: "tier",
Type: "uint16",
},
{
Name: "proofs",
Name: "proof",
Type: "bytes",
},
}
Expand All @@ -134,48 +47,41 @@ var (
Type: "address",
},
{
Name: "expiry",
Type: "uint64",
},
{
Name: "data",
Type: "bytes",
},
}
proposeBlockDataComponents = []abi.ArgumentMarshaling{
{
Name: "input",
Type: "tuple",
Components: blockMetadataInputComponents,
Name: "feeToken",
Type: "address",
},
{
Name: "fee",
Type: "uint256",
Name: "tierFees",
Type: "tuple[]",
Components: []abi.ArgumentMarshaling{
{
Name: "tier",
Type: "uint64",
},
{
Name: "fee",
Type: "uint256",
},
},
},

{
Name: "expiry",
Type: "uint64",
},
{
Name: "signature",
Type: "bytes",
},
}
)

var (
// BlockMetadataInput
blockMetadataInputType, _ = abi.NewType("tuple", "TaikoData.BlockMetadataInput", blockMetadataInputComponents)
blockMetadataInputArgs = abi.Arguments{{Name: "BlockMetadataInput", Type: blockMetadataInputType}}
// BlockMetadata
blockMetadataType, _ = abi.NewType("tuple", "TaikoData.BlockMetadata", blockMetadataComponents)
blockMetadataArgs = abi.Arguments{{Name: "BlockMetadata", Type: blockMetadataType}}
// Evidence
EvidenceType, _ = abi.NewType("tuple", "TaikoData.BlockEvidence", evidenceComponents)
EvidenceArgs = abi.Arguments{{Name: "Evidence", Type: EvidenceType}}
// ProverAssignment
proverAssignmentType, _ = abi.NewType("tuple", "ProverAssignment", proverAssignmentComponents)
proverAssignmentArgs = abi.Arguments{{Name: "ProverAssignment", Type: proverAssignmentType}}
// ProposeBlockData
proposeBlockDataType, _ = abi.NewType("tuple", "ProposeBlockData", proposeBlockDataComponents)
proposeBlockDataArgs = abi.Arguments{{Name: "ProposeBlockData", Type: proposeBlockDataType}}
)

// Contract ABIs.
Expand All @@ -196,24 +102,6 @@ func init() {
}
}

// EncodeBlockMetadataInput performs the solidity `abi.encode` for the given blockMetadataInput.
func EncodeBlockMetadataInput(meta *TaikoL1BlockMetadataInput) ([]byte, error) {
b, err := blockMetadataInputArgs.Pack(meta)
if err != nil {
return nil, fmt.Errorf("failed to abi.encode block metadata input, %w", err)
}
return b, nil
}

// EncodeBlockMetadata performs the solidity `abi.encode` for the given blockMetadata.
func EncodeBlockMetadata(meta *bindings.TaikoDataBlockMetadata) ([]byte, error) {
b, err := blockMetadataArgs.Pack(meta)
if err != nil {
return nil, fmt.Errorf("failed to abi.encode block metadata, %w", err)
}
return b, nil
}

// EncodeProverAssignment performs the solidity `abi.encode` for the given proverAssignment.
func EncodeProverAssignment(assignment *ProverAssignment) ([]byte, error) {
b, err := proverAssignmentArgs.Pack(assignment)
Expand All @@ -223,78 +111,15 @@ func EncodeProverAssignment(assignment *ProverAssignment) ([]byte, error) {
return b, nil
}

// EncodeProposeBlockData performs the solidity `abi.encode` for the given proposeBlockData.
func EncodeProposeBlockData(data *ProposeBlockData) ([]byte, error) {
b, err := proposeBlockDataArgs.Pack(data)
if err != nil {
return nil, fmt.Errorf("failed to abi.encode proposeBlock data, %w", err)
}
return b, nil
}

// EncodeEvidence performs the solidity `abi.encode` for the given evidence.
func EncodeEvidence(e *TaikoL1Evidence) ([]byte, error) {
func EncodeEvidence(e *BlockEvidence) ([]byte, error) {
b, err := EvidenceArgs.Pack(e)
if err != nil {
return nil, fmt.Errorf("failed to abi.encode evidence, %w", err)
}
return b, nil
}

// EncodeCommitHash performs the solidity `abi.encodePacked` for the given
// commitHash components.
func EncodeCommitHash(beneficiary common.Address, txListHash [32]byte) []byte {
// keccak256(abi.encodePacked(beneficiary, txListHash));
return crypto.Keccak256(
bytes.Join([][]byte{beneficiary.Bytes(), txListHash[:]}, nil),
)
}

// EncodeProposeBlockInput encodes the input params for TaikoL1.proposeBlock.
func EncodeProposeBlockInput(metadataInput *TaikoL1BlockMetadataInput) ([]byte, error) {
metaBytes, err := EncodeBlockMetadataInput(metadataInput)
if err != nil {
return nil, err
}
return metaBytes, nil
}

// EncodeProveBlockInput encodes the input params for TaikoL1.proveBlock.
func EncodeProveBlockInput(
evidence *TaikoL1Evidence,
) ([]byte, error) {
evidenceBytes, err := EncodeEvidence(evidence)
if err != nil {
return nil, err
}

return evidenceBytes, nil
}

// EncodeProveBlockInvalidInput encodes the input params for TaikoL1.proveBlockInvalid.
func EncodeProveBlockInvalidInput(
evidence *TaikoL1Evidence,
target *bindings.TaikoDataBlockMetadata,
receipt *types.Receipt,
) ([][]byte, error) {
evidenceBytes, err := EncodeEvidence(evidence)
if err != nil {
return nil, err
}

metaBytes, err := EncodeBlockMetadata(target)
if err != nil {
return nil, err
}

receiptBytes, err := rlp.EncodeToBytes(receipt)
if err != nil {
return nil, err
}

return [][]byte{evidenceBytes, metaBytes, receiptBytes}, nil
}

// UnpackTxListBytes unpacks the input data of a TaikoL1.proposeBlock transaction, and returns the txList bytes.
func UnpackTxListBytes(txData []byte) ([]byte, error) {
method, err := TaikoL1ABI.MethodById(txData)
Expand Down
Loading

0 comments on commit 28f660f

Please sign in to comment.