The home for Hyperlane core contracts, sdk packages, and other infrastructure
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
hyperlane-monorepo/solidity/optics-bridge
Anna Carroll 78258419f9
Implement UpgradeBeacon & UpgradeBeaconProxy (#178)
4 years ago
..
contracts refactor: interfaces directories (#157) 4 years ago
interfaces refactor: interfaces directories (#157) 4 years ago
scripts basic token bridge design (#71) 4 years ago
test basic token bridge design (#71) 4 years ago
.eslintrc.json WIP/enhancement: linting and coverage (#106) 4 years ago
.gitignore basic token bridge design (#71) 4 years ago
.prettierrc basic token bridge design (#71) 4 years ago
.solcover.js basic token bridge design (#71) 4 years ago
.solhint.json WIP/enhancement: linting and coverage (#106) 4 years ago
.solhintignore WIP/enhancement: linting and coverage (#106) 4 years ago
README.md docs: add message layout to bridge readme (#127) 4 years ago
hardhat.config.js Implement UpgradeBeacon & UpgradeBeaconProxy (#178) 4 years ago
package-lock.json MVP Governance xApp (#130) 4 years ago
package.json WIP/enhancement: linting and coverage (#106) 4 years ago

README.md

Optics Token Bridge

Message Format

Bridge messages follow the following format:

TokenID (36 bytes)
    -  4 bytes - domain specifier
    - 32 bytes - id (address) on that domain

Actions (variable)
    EITHER
    - Transfer (64 bytes)
        - 32 bytes - to. local recipient
        - 32 bytes - amount. number of tokens to send
    - Details
        - 32 bytes - name. new name of token
        - 32 bytes - symbol. new symbol for token
        -  1 byte  - decimals. new decimal place count

Message (100 or 101 bytes)
    - TokenID (36 bytes)
    - Action  (64 or 65 bytes)

Given a message we know the following:

  • the TokenID is at indices 0-35
    • 0 - 3 Domain
    • 4 - 35 Id
  • the Action is at indices 36 - end.
    • the action type can be determined from the message length alone.
    • for Transfer actions
      • 36 - 67 To
      • 68 - 99 Amount
    • for Details actions
      • 36 - 67 Name
      • 68 - 99 Symbol
      • 100 Decimals