convex.cell — world.convex/cvm.clj 0.0.0-alpha4

Constructors for CVM cells and related type predicate functions.

* clj macro

(* x)

Macro for translating Clojure types to Convex types.

Convex types can be inserted using ~, especially useful for inserting values dynamically or inserting types that have no equivalent in Clojure (eg. address).

Also understands ~@ (aka unquote splicing).

;; Cell for `(transfer #42 500000)`
;;
(* (transfer ~(address 42)
             500000))

address clj

(address long)

Creates an address from a long.

blob clj

(blob byte-array)

Creates a blob from a byte array.

blob-map clj

(blob-map)

(blob-map kvs)

Creates a blob map from a collection of [blob value].

blob<-hex clj

(blob<-hex hex-string)

Creates a blob from a hex string.

boolean clj

(boolean x)

Creates a boolean cell given a falsy or truthy value.

byte clj

(byte b)

Creates a byte cell from a value between 0 and 255 inclusive.

call clj

(call address sequence address-callable function-name args)

(call address sequence address-callable offer function-name args)

Creates a transaction for invoking a callable function.

char clj

(char ch)

Creates a character cell from a regular character.

code-std* clj macro

(code-std* kw)

Given a Clojure keyword, returns the corresponding standard error code (any of the Convex keyword the CVM itself uses):

• :ARGUMENT
• :ARITY
• :ASSERT
• :BOUNDS
• :CAST
• :COMPILE
• :DEPTH
• :EXCEPTION
• :EXPAND
• :FATAL
• :FUNDS
• :HALT
• :JUICE
• :MEMORY
• :NOBODY
• :RECUR
• :REDUCED
• :RETURN
• :ROLLBACK
• :SEQUENCE
• :SIGNATURE
• :STATE
• :TAILCALL
• :TODO
• :TRUST
• :UNDECLARED
• :UNEXPECTED

Throws if keyword does not match any of those.

Note that in user functions, codes can be anything, any type, using those codes is not at all mandatory.

double clj

(double x)

Creates a double cell.

encoding clj

(encoding cell)

Returns a blob representing the encoding of the given cell.

This encoding is meant for incremental updates.

error clj

(error message)

(error code message)

(error code message trace)

An error value as Convex data.

code is often a keyword cell (:ASSERT by default), message could be any cell (albeit often a human-readable string), and trace is an optional stacktrace (vector cell of string cells).

hash clj

(hash cell)

Returns the hash of the given cell.

A hash is a specialized 32-byte blob.

hash<-blob clj

(hash<-blob blob)

Converts a 32-byte blob to a hash.

hash<-hex clj

(hash<-hex hex-string)

Creates a hash from a hex string.

Returns nil if hex string is of wrong format.

invoke clj

(invoke address sequence-id cell)

Creates a transaction for invoking code (a cell).

key clj

(key blob)

Creates an account key from a 32-byte blob.

Returns nil if the given blob is of wrong size.

key-fake clj

Zeroed key that can be used during dev and testing so that an account is considered as a user, not an actor.

keyword clj

(keyword string)

Creates a keyword cell from a string.

list clj

(list)

(list x)

Creates a list cell from a collection of cells.

long clj

(long x)

Creates a long cell.

map clj

(map)

(map kvs)

Creates a map cell from a collection of [key value].

quoted clj

(quoted x)

Wraps x in quote.

set clj

(set)

(set x)

Creates a set cell from a collection of items cell.

string clj

(string string)

Creates a string cell from a regular string.

symbol clj

(symbol string)

Creates a symbol cell from a string.

syntax clj

(syntax cell)

(syntax cell metadata)

Creates a syntax cell.

It wraps the given cell and allow attaching a metadata map.

transfer clj

(transfer address sequence address-receiver amount)

Creates a transaction for transferring Convex Coins.

vector clj

(vector)

(vector x)

Creates a vector cell from a collection of items cell.