net

Documentation

Index

• Constants
• type Node
  • func NewNode(conn *rlpx.Connection, lkey *ecdsa.PrivateKey, rkey *ecdsa.PublicKey) (*Node, error)
  • func (node *Node) Close() error
  • func (node *Node) RecvNegoAck(dst io.Writer) (uint64, error)
  • func (node *Node) RecvNegoAckReq(resp, req io.Writer) (uint64, uint64, error)
  • func (node *Node) RecvNegoRequest(dst io.Writer) (uint64, error)
  • func (node *Node) RecvSessionAck(needFurtherAck bool) (*SessionRequest, error)
  • func (node *Node) RecvSessionRequest() (*SessionRequest, error)
  • func (node *Node) RecvTxReceipt() ([]byte, []byte, error)
  • func (node *Node) RecvTxRequest(dst io.Writer) (uint64, error)
  • func (node *Node) RecvTxResponse(dst io.Writer) (uint64, error)
  • func (node *Node) SendNegoAck(resp io.Reader, size uint64) error
  • func (node *Node) SendNegoAckReq(resp, req io.Reader, respSize, reqSize uint64) error
  • func (node *Node) SendNegoRequest(request io.Reader, size uint64) error
  • func (node *Node) SendNewSessionRequest(mode uint8, sigmaMklRoot []byte, extraInfo []byte) error
  • func (node *Node) SendSessionAck(id uint64, mode uint8, mklroot []byte, extra []byte, needFurtherAck bool) error
  • func (node *Node) SendTxReceipt(receipt io.Reader, size uint64) error
  • func (node *Node) SendTxRequest(req io.Reader, size uint64) error
  • func (node *Node) SendTxResponse(response io.Reader, size uint64) error
  • func (node Node) String() string
• type SessionRequest

Constants

const (
	ModePlainComplaintPoD = iota
	ModePlainOTComplaintPoD
	ModePlainAtomicSwapPoD
	ModePlainAtomicSwapVcPoD
	ModeTableVRFQuery
	ModeTableOTVRFQuery
	ModeTableComplaintPoD
	ModeTableOTComplaintPoD
	ModeTableAtomicSwapPoD
	ModeTableAtomicSwapVcPoD
)

Types

type Node

type Node struct {
	// contains filtered or unexported fields
}

Node represents a communication node.

func NewNode

func NewNode(
	conn *rlpx.Connection, lkey *ecdsa.PrivateKey, rkey *ecdsa.PublicKey,
) (*Node, error)

Create a node for communication. A non-nil connection must be provided.

PreState : N/A PostState: Connected

Parameters:

• conn: a network connection
• lkey: the ethereum private key of the node to be created
• rkey: the ethereum public key of the remote node

Return:

If no error occurs, return a node for communication and a nil error.
Otherwise, return a nil node and the non-nil error.

Examples:

1. Create a communication node for Alice. ``` import ( "crypto/ecdsa" pod_net "github.com/sec-bit/zkPoD-node/net" "github.com/sec-bit/zkPoD-node/net/rlpx" )

   func Alice(AliceTCPAddr string, AliceEthPrivkey *ecdsa.PrivateKey) error { addr, err := rlpx.NewAddr(AliceTCOAddr, AliceEthPrivkey.PublicKey) if err != nil { return err }

   l, err := rlpx.Listen(addr) if err != nil { return err } defer l.Close()

   conn, err := l.Accept() if err != nil { return err } // Note: conn should be alive until the node is closed. defer conn.Close()

   BobEthPubkey, err := conn.Handshake(AliceEthPrivkey, false) if err != nil { return err }

   node, err := pod_net.NewNode(conn, AliceEthPrivkey, BobEthPubkey) if err != nil { return err } defer node.Close()

   // do something with the node // ...

   return nil } ```

2. Create a communication node for Bob. ``` import ( "crypto/ecdsa" "net" "github.com/ethereum/go-ethereum/common" pod_net "github.com/sec-bit/zkPoD-node/net" "github.com/sec-bit/zkPoD-node/net/rlpx" )

   func Bob(AliceTCPAddr, AliceEthAddr string, BobEthPrivkey *ecdsa.PrivateKey) error { tcpAddr, err := net.ResolveTCPAddr("tcp", AliceTCPAddr) if err != nil { return err } ethAddr := common.HexToAddress(AliceEthAddr) addr := rlpx.Addr{TCPAddr: tcpAddr, EthAddr: ethAddr}

   conn, err := rlpx.Dial(addr) if err != nil { return err } defer conn.Close()

   AliceEthPubkey, err := conn.Handshake(BobEthPrivkey, true) if err != nil { return err }

   node, err := pod_net.NewNode(conn, BobEthPrivkey, AliceEthPubkey) if err != nil { return nil } defer node.Close()

   // do something with the node // ...

   return nil } ```

func (*Node) Close

func (node *Node) Close() error

Close closes the node.

PreState : any PostState: Closed

func (*Node) RecvNegoAck

func (node *Node) RecvNegoAck(dst io.Writer) (uint64, error)

RecvNegoAck receives the OT negotiation ack. It can be used only in OT mode.

This function is a block operation, which returns when any of following events occurs:

• the ack+request is received
• any timeout occurs
• any error occurs

PreState : NegoAckWait PostState: Negotiated

Parameters:

• dst: the location where the response is saved

Return:

If no error occurs, return the number of bytes of the response
and a nil error. Otherwise, return 0 and the non-nil error.

func (*Node) RecvNegoAckReq

func (node *Node) RecvNegoAckReq(resp, req io.Writer) (uint64, uint64, error)

RecvNegoAckReq receives the OT negotiation ack+request. It can be used only in OT mode.

This function is a block operation, which returns when any of following events occurs:

• the ack+request is received
• any timeout occurs
• any error occurs

PreState : stateNegoAckReqWait PostState: stateNegoAckReqRecvd

Parameters:

• resp: the OT negotiation response returned from PoD library
• req: the OT negotiation request returned from Pod library

Return:

If no error occurs, return the number of bytes of the OT
negotiation response, the number of bytes of the OT negotiation
request and a nil error. Otherwise, return 0, 0 and the non-nil
error.

func (*Node) RecvNegoRequest

func (node *Node) RecvNegoRequest(dst io.Writer) (uint64, error)

RecvNegoRequest receives the OT negotiation request. It can be used only in OT mode.

This function is a block operation, which returns when any of following events occurs:

• the request is received
• any timeout occurs
• any error occurs

PreState : stateSessionEstablished PostState: stateNegoRequestRecvd

Parameters:

• dst: the location where the request is saved

Return:

If no error occurs, return the number of bytes of the request and
a nil error. Otherwise, return 0 and a non-nil error.

func (*Node) RecvSessionAck

func (node *Node) RecvSessionAck(needFurtherAck bool) (*SessionRequest, error)

RecvSessionAck receives a session acknowledgment.

This function is a block operation, which returns when any of following events occurs:

• the ack is received
• any timeout occurs
• any error occurs

When called by the node that receives the session request:

PreState : SessionAckWait
PostState: SessionEstablished

When called by the node that sends the session request:

PreState : SessionAckWait
PostState: SessionAckRecvd

Parameters:

• needFurtherAck: does the caller need to echo the acknowledgment?

Return:

If no error occurs, return the acknowledgment and a nil error.
Otherwise, return a nil acknowledgment and the error.

func (*Node) RecvSessionRequest

func (node *Node) RecvSessionRequest() (*SessionRequest, error)

RecvSessionRequest receives a session request.

This function is a block operation, which returns when any of following events occurs:

• the request is received
• any timeout occurs
• any error occurs

PreState : Connected PostState: SessionReqRecvd

Return:

If no error occurs, return the session request and a nil error.
Otherwise, return nil request and a non-nil error.

func (*Node) RecvTxReceipt

func (node *Node) RecvTxReceipt() ([]byte, []byte, error)

RecvTxReceipt receives the transaction receipt and it signature. This function also validates the signature against the public key of the remote node.

This function is a block operation, which returns when any of following events occurs:

• the receipt is received
• any timeout occurs
• any error occurs

PreState : TxReceiptWait PostState: TxReceiptRecvd

Returns:

If no error occurs, return the receipt, the receipt signature,
and a nil error. Otherwise, return a nil receipt, a nil signature,
and a non-nil error.

func (*Node) RecvTxRequest

func (node *Node) RecvTxRequest(dst io.Writer) (uint64, error)

RecvTxRequest receives a transaction request.

This function is a block operation, which returns when any of following events occurs:

• the request is received
• any timeout occurs
• any error occurs

In non-OT mode:

PreState : SessionEstablished
PostState: TxResponseWait

In OT mode:

PreState : Negotiated
PostState: TxResponseWait

Parameters:

• dst: the location where the request is saved

Returns:

If no error occurs, return the number of bytes of the request
and a nil error. Otherwise, return 0 and the non-nil error.

func (*Node) RecvTxResponse

func (node *Node) RecvTxResponse(dst io.Writer) (uint64, error)

RecvTxResponse receives the transaction response.

This function is a block operation, which returns when any of following events occurs:

• the response is received
• any timeout occurs
• any error occurs

PreState : TxResponseWait PostState: TxResponseRecvd

Parameters:

• dst: the location where the response is saved

Return:

If no error occurs, return the number of bytes of the response
and a nil error. Otherwise, return 0 and a non-nil error.

func (*Node) SendNegoAck

func (node *Node) SendNegoAck(resp io.Reader, size uint64) error

SendNegoAck sends the OT negotiation ack. It can be used only in OT mode.

This function is a block operation, which returns when any of following events occurs:

• the ack is sent out
• any timeout occurs
• any error occurs

PreState : NegoAckReqRecvd PostState: Negotiated

Parameters:

• resp: the OT negotiation response returned from PoD library
• size: the number of bytes of the response

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendNegoAckReq

func (node *Node) SendNegoAckReq(
	resp, req io.Reader, respSize, reqSize uint64,
) error

SendNegoAckReq sends the OT negotiation ack+request. It can be used only in OT mode.

The ack is the response to the OT negotiation request received from the remote PoD node.

The request is the OT negotiation request from the current PoD node.

This function is a block operation, which returns when any of following events occurs:

• the ack+request is sent out
• any timeout occurs
• any error occurs

PreState : stateNegoRequestRecvd PostState: stateNegoAckWait

Parameters:

• resp: the OT negotiation response returned from PoD library
• req: the OT negotiation request returned from Pod library
• respSize: the number of bytes of the response
• reqSize: the number of bytes of the request

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendNegoRequest

func (node *Node) SendNegoRequest(request io.Reader, size uint64) error

SendNegoRequest sends the OT negotiation request. It can be used only in OT mode.

This function is a block operation, which returns when any of following events occurs:

• the request is sent out
• any timeout occurs
• any error occurs

PreState : stateSessionEstablished PostState: stateNegoAckReqWait

Parameters:

• request: the negotiation request returned from PoD library
• size: the number of bytes of the request

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendNewSessionRequest

func (node *Node) SendNewSessionRequest(mode uint8, sigmaMklRoot []byte, extraInfo []byte) error

SendNewSessionRequest sends a request to create a new session that trades the data of the specified sigma merkle root in the specified mode.

This function is a block operation, which returns when any of following events occurs:

• the request is sent out
• any timeout occurs
• any error occurs

PreState : Connected PostState: SessionAckWait

Parameters:

• mode: the trading mode, refer to Mode... constants.
• sigmaMklRoot: the sigma merkle root of the data

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendSessionAck

func (node *Node) SendSessionAck(
	id uint64, mode uint8, mklroot []byte, extra []byte, needFurtherAck bool,
) error

SendSessionAck sends an acknowledgment for the session request.

This function is a block operation, which returns when any of following events occurs:

• the ack is sent out
• any timeout occurs
• any error occurs

When called by the node that receives the session request:

PreState : SessionReqRecvd
PostState: SessionAckWait

When called by the node that sends the session request:

PreState : SessionAckRecvd
PostState: SessionEstablished

Parameters:

• id: the session ID
• mode: the trading mode
• mklroot: the sigma merkle root of the data
• needFurtherAck: does the caller need to receive a further session ack?

Return:

If no error occurs, return nil. Otherwise, return the error.

func (*Node) SendTxReceipt

func (node *Node) SendTxReceipt(receipt io.Reader, size uint64) error

SendTxReceipt sends the transaction receipt and its signature.

This function is a block operation, which returns when any of following events occurs:

• the receipt is sent out
• any timeout occurs
• any error occurs

PreState : TxResponseRecvd PostState: TxSecretWait

Parameters:

• receipt: the receipt returned from the PoD library
• size: the number of bytes of the receipt

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendTxRequest

func (node *Node) SendTxRequest(req io.Reader, size uint64) error

SendTxRequest sends the transaction request.

This function is a block operation, which returns when any of following events occurs:

• the request is sent out
• any timeout occurs
• any error occurs

In non-OT mode:

PreState : SessionEstablished
PostState: TxResponseWait

In OT mode:

PreState : Negotiated
PostState: TxResponseWait

Parameters:

• req: the request returned from the PoD library
• size: the number of bytes of the request

Return:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (*Node) SendTxResponse

func (node *Node) SendTxResponse(response io.Reader, size uint64) error

SendTxResponse sends a transaction response.

This function is a block operation, which returns when any of following events occurs:

• the response is sent out
• any timeout occurs
• any error occurs

PreState : TxRequestRecvd PostState: TxReceiptWait

Parameters:

• response: the response returned from the PoD library
• size: the number of bytes of the response

Returns:

If no error occurs, return nil. Otherwise, return a non-nil error.

func (Node) String

func (node Node) String() string

type SessionRequest

type SessionRequest struct {
	ID           uint64
	Mode         uint8
	SigmaMklRoot []byte
	ExtraInfo    []byte
}

SessionRequest represents a session request.

If `ID` is 0, request will be interpreted as a request to create a new session.