Solidity API

SpanningAddress

This library adds interpretation of our SpanningAddress as follows:

31    27        19                   0
|-----+---------+--------------------|

+The bottom 0-19 bytes are the local address
+Bytes 20-27 are left empty for future expansion
+Bytes 28 - 31 are the domain ID
+Byte 20 - the number of blocks the protocol
           will wait before settling the transaction

create

function create(address legacyAddress, bytes4 domain) public pure returns (bytes32)

Helper function to pack a Spanning Address.

Name	Type	Description
legacyAddress	address	- Legacy (local) address to pack
domain	bytes4	- Domain identifier to pack

Name	Type	Description
[0]	bytes32	bytes32 - Generated Spanning Address

invalidAddress

function invalidAddress() public pure returns (bytes32)

Sentinel value for an invalid Spanning Address.

Name	Type	Description
[0]	bytes32	bytes32 - An invalid Spanning Address

valid

function valid(bytes32 addr) public pure returns (bool)

getAddress

function getAddress(bytes32 input) public pure returns (address)

Extracts legacy (local) address.

Name	Type	Description
input	bytes32	- Spanning Address to unpack

Name	Type	Description
[0]	address	address - Unpacked legacy (local) address

getDomain

function getDomain(bytes32 input) public pure returns (bytes4)

Extracts domain identifier.

Name	Type	Description
input	bytes32	- Spanning Address to unpack

Name	Type	Description
[0]	bytes4	bytes4 - Unpacked domain identifier

equals

function equals(bytes32 first, bytes32 second) public pure returns (bool)

Determines if two Spanning Addresses are equal. Note: This function only considers LegacyAddress and Domain for equality Note: Thus, equals() can return true even if first != second

Name	Type	Description
first	bytes32	- the first Spanning Address
second	bytes32	- the second Spanning Address

Name	Type	Description
[0]	bool	bool - true if the two Spanning Addresses are equal

packAddressData

function packAddressData(bytes32 existingAddress, uint8 payload, uint8 index) public pure returns (bytes32)

_Packs data into an existing Spanning Address

This can be used to add routing parameters into a Spanning Addresses buffer space.

Example to specify a message waits numFinalityBlocks before settling: newSpanningAddress = packAddressData(prevSpanningAddress, numFinalityBlocks, 20)_

Name	Type	Description
existingAddress	bytes32	- the Spanning Address to modify
payload	uint8	- the data to pack
index	uint8	- the byte location to put the payload into