Solang Solidity Compiler

Welcome to the Solang Solidity Compiler. Using Solang, you can compile smart contracts written in Solidity for Solana and Polkadot. It uses the llvm compiler framework to produce WebAssembly (WASM) or Solana SBF contract code. As result, the output is highly optimized, which saves you in gas costs or compute units.

Solang aims for source file compatibility with the Ethereum EVM Solidity compiler, version 0.8. Where differences exist, this is noted in the language documentation. The source code repository can be found on github and we have solang channels on Hyperledger Discord.

Contents

Using Solang

• Installing Solang
  • Option 1: Download from Brew
  • Option 2: Download binaries
  • Option 3: Use ghcr.io/hyperledger/solang containers
  • Option 4: Build Solang using Dockerfile
  • Option 5: Build Solang from source
    • Step 1: Install the LLVM Libraries
    • Step 2: Build Solang
    • Alternative step 2: Build Solang from crates.io
• Using Solang on the command line
  • Compiler Usage
  • Starting a new project
  • Generating Documentation Usage
  • Generate Solidity interface from IDL
  • Running Solang using a container
• Interacting with smart contracts on the command line
  • Installation
  • Submitting extrinsics to Polkadot on-chain
    • General Options (for all subcommands):
    • Subcommands:
  • Interacting with Solana running programs on-chain
    • General Options (for all subcommands):
    • Subcommands:
• Visual Studio Code Extension
  • Solidity Language flavour
  • Using the extension
  • Development
• Solang Solidity Examples
  • General examples
    • Flipper
    • Example
  • Solana examples
    • NFT example
    • PDA Hash Table

Targets

• Solana
  • Solana Overview
    • Contract upgrades
    • Data types
    • Runtime
    • Compute budget
    • Solidity for Solana incompatibilities with Solidity for Ethereum
  • Getting started on Solana
  • Using the Anchor client library
  • Calling Anchor Programs from Solidity
  • Setting the program_id for a contract
  • Setting the payer, seeds, bump, and space for a contract
  • Transferring native value with a function call
  • Receive function
  • msg.sender not available on Solana
  • Builtin Imports
    • Builtin AccountInfo
    • Builtin AccountMeta
    • Builtin create_program_address
    • Builtin try_find_program_address
  • Solana Library
    • SPL-token
    • System Instructions
    • Minimum balance
  • Solana Account Management
    • Accessing accounts’ data
    • External calls with accounts
• Polkadot
  • Builtin Imports
  • Call Flags
  • Reverts and error data decoding

Solidity language

• Brief Language status
• File Structure
• Imports
• Pragmas
  • About pragma solidity versions
• Types
  • Boolean Type
  • Integer Types
  • Fixed Length byte arrays
  • Address and Address Payable Type
  • Enums
  • Struct Type
  • Fixed Length Arrays
  • Dynamic Length Arrays
  • String
  • Dynamic Length Bytes
  • Mappings
  • Contract Types
  • Function Types
  • Storage References
  • User Defined Types
• Expressions
  • Arithmetic operators
  • Bitwise operators
  • Logical operators
  • Conditional operator
  • Comparison operators
  • Increment and Decrement operators
  • this
  • type(..) operators
  • Ether, Sol, and time units
  • Casting
• Statements
  • If statement
  • While statement
  • Do While statement
  • For statements
  • Destructuring Statement
  • Try Catch Statement
• Constants
• Using directive
  • Binding methods to types with using
    • using with free standing functions
    • User defined Operators
    • using with libraries
    • Scope for using
• Contracts
  • Constructors and contract instantiation
    • Instantiation using new
    • Sending value to the new contract
    • Setting the salt, gas, and address for the new contract
    • Solana constructors
    • Calling a contract on Solana
  • Base contracts, abstract contracts and interfaces
    • Specifying base contracts
    • Virtual Functions
    • Calling function in base contract
    • Specifying constructor arguments
    • Abstract Contracts
• Contract Storage
  • Immutable Variables
  • Accessor Functions
  • How to clear Contract Storage
• Interfaces and libraries
  • Interfaces
  • Libraries
  • Library Using For
• Events
• Functions
  • Function visibility
  • Arguments passing and return values
  • Internal calls and externals calls
  • Passing accounts with external calls on Solana
  • Passing seeds with external calls on Solana
  • Passing value and gas with external calls
  • State mutability
  • Overriding function selector
  • Function overloading
  • Function Modifiers
  • Calling an external function using call()
  • Calling an external function using delegatecall
  • fallback() and receive() function
• Managing values
  • Sending and receiving value
  • Checking your balance
  • Creating contracts with an initial value
  • Sending value with an external call
  • Sending value using send() and transfer()
• Builtin Functions and Variables
  • Block and transaction
    • gasleft() returns (uint64)
    • blockhash(uint64 block) returns (bytes32)
    • msg properties
    • tx properties
    • block properties
  • Error handling
    • assert(bool)
    • revert() or revert(string)
    • require(bool) or require(bool, string)
  • ABI encoding and decoding
    • abi.decode(bytes, (type-list))
    • abi.encode(…)
    • abi.encodeWithSelector(selector, …)
    • abi.encodeWithSignature(string signature, …)
    • abi.encodePacked(…)
    • abi.encodeCall(function, …)
    • Hash
    • chain_extension(uint32 ID, bytes input) returns (uint32, bytes)
    • is_contract(address AccountId) returns (bool)
    • caller_is_root() returns (bool)
    • set_code_hash(uint8[32] hash) returns (uint32)
  • Cryptography
    • keccak256(bytes)
    • ripemd160(bytes)
    • sha256(bytes)
    • blake2_128(bytes)
    • blake2_256(bytes)
    • signatureVerify(address public_key, bytes message, bytes signature)
  • Mathematical
    • addmod(uint x, uint y, uint, k) returns (uint)
    • mulmod(uint x, uint y, uint, k) returns (uint)
  • Encoding and decoding values from bytes buffer
    • readInt8(uint32 offset)
    • readInt16LE(uint32 offset)
    • readInt32LE(uint32 offset)
    • readInt64LE(uint32 offset)
    • readInt128LE(uint32 offset)
    • readInt256LE(uint32 offset)
    • readUint16LE(uint32 offset)
    • readUint32LE(uint32 offset)
    • readUint64LE(uint32 offset)
    • readUint128LE(uint32 offset)
    • readUint256LE(uint32 offset)
    • readAddress(uint32 offset)
    • writeInt8(int8 value, uint32 offset)
    • writeInt16LE(int16 value, uint32 offset)
    • writeInt32LE(int32 value, uint32 offset)
    • writeInt64LE(int64 value, uint32 offset)
    • writeInt128LE(int128 value, uint32 offset)
    • writeInt256LE(int256 value, uint32 offset)
    • writeUint16LE(uint16 value, uint32 offset)
    • writeUint32LE(uint32 value, uint32 offset)
    • writeUint64LE(uint64 value, uint32 offset)
    • writeUint128LE(uint128 value, uint32 offset)
    • writeUint256LE(uint256 value, uint32 offset)
    • writeAddress(address value, uint32 offset)
    • writeString(string value, uint32 offset)
    • writeBytes(bytes value, uint32 offset)
  • Miscellaneous
    • print(string)
    • selfdestruct(address payable recipient)
    • String formatting using "{}".format()
• Tags
• Inline Assembly

Yul language

• Overview of Yul
• Statements
  • For-loop
  • If-block
  • Switch
  • Blocks
  • Variable declaration
  • Assignments
  • Function calls
• Types
• Functions
• Builtins

Extras

• Code Generation Options
  • Optimizer Passes
    • Constant Folding Pass
    • Strength Reduction Pass
    • Dead Storage pass
    • Vector to Slice Pass
    • Unused Variable Elimination
    • Common Subexpression Elimination
    • Array Bound checks optimization
  • wasm-opt optimization passes
  • Debugging Options
    • Print Function
    • Log Runtime Errors
    • Release builds:
• Solang Test Suite
  • Solidity parser and semantics tests
  • Codegen tests
  • Mock contract virtual machine
  • Deploy contract on dev chain
• Contributing
  • How to report issues
  • How to contribute code
  • Target Specific
  • Debugging issues with LLVM
    • Build LLVM with Assertions Enabled
    • Verify the IR with llc
  • Style guide