Limitations of Orbs Contracts

Writing Contracts Building Clients Github

Search…

Orbs contracts are written in the Go programming language.
To enhance security and enable multiple virtual chains in the Orbs blockchain, the smart contracts are limited compared to the Go language. Specifically, Orbs limits the features and packages of the language that are allowed to execute inside the Orbs Virtual Machine.
Package Whitelist
All packages in Go are not allowed except for specific packages listed in the whitelist below:
1
// Orbs Contract SDK
2
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1"
3
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/address"
4
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/env"
5
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/ethereum"
6
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/events"
7
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/safemath"
8
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/safemath/safeuint32"
9
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/safemath/safeuint64"
10
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/safemath/safeuint256"
11
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/service"
12
"github.com/orbs-network/orbs-contract-sdk/go/sdk/v1/state"
13
​
14
// Text
15
"strings"
16
"strconv"
17
"text/template"
18
​
19
// Time
20
"time"
21
​
22
// Binary
23
"bytes"
24
"encoding/binary"
25
"io"
26
​
27
// Encoding
28
"encoding/json"
29
"encoding/hex"
30
"encoding/base32"
31
"encoding/base64"
32
​
33
// Utils
34
"sort"
Copied!
Trying to include any package not in that list results in a failed compilation of the smart contract.
Time functions blacklist
While we enable the use of the time package for time manipulation, it contains several functions which would result in inconsistent and non-deterministic results in contracts, and thus they are blacklisted. These functions are:
1
"After"
2
"AfterFunc"
3
"Sleep"
4
"Tick"
5
"NewTimer"
6
"NewTicker"
7
"Now"
Copied!
Using any of these functions results in a failed compilation of the smart contract.
If you want the current time ('Now'), it is possible to use the contract SDK function env.GetBlockTimestamp()
Blacklisted Features
Aside from a whitelist of the allowed packages, Orbs does not allow the usage of the following Go language features:
Channels
Goroutines (the go statement)
The 'arrow' unary expression (<-)
Using any of the above features results in a failed compilation of the smart contract.

Orbs Contracts - Previous

API Reference

Next - Orbs Contracts

Creating a new contract

Last modified 2yr ago

Copy link

Contents

Package Whitelist

Time functions blacklist

Blacklisted Features