Structures

All structures in Ride are built-in — you cannot create your own structures. All structures have constructors.

Let's see an example of a code that creates an instance of the IntegerEntry structure and reads its key and value:

let data = IntegerEntry("Age", 33)
let key  = data.key
let val = data.value

Script Actions

Script actions are executed, that is, they make changes on the blockchain only if they are included in the resulting expression of the callable function. See more details in the callable function article.

Available script actions depend on the standard library version used.

BinaryEntry

BinaryEntry is a structure that sets key and value of binary entry account data storage. Adding or changing an entry is performed only if the structure is included in the callable function result>`.

Constructor

BinaryEntry(key: String, value: ByteVector)

Fields

BooleanEntry

BooleanEntry is a structure that sets the key and value of the account data storage boolean entry. Adding or changing an entry is performed only if the structure is included in the callable function result>`.

Constructor

BooleanEntry(key: String, value: Boolean)

Fields

Burn

Burn is a structure that sets the parameters of the token burning. The token burning is performed only if the structure is included in the callable function result>`. If the token is a smart asset, the asset script verifies the Burn action as if it were BurnTransaction with the fee of 0 and the version of 0. If the asset script denies the action, then the transaction that invoked the dApp script is either denied or saved on the blockchain as failed, see the transaction validation.

Constructor

Burn(assetId: ByteVector, quantity: Int)

Fields

DeleteEntry

DeleteEntry is a structure that sets the parameters of deletion of entry from the account data storage. Deleting an entry is performed only if the structure is included in the callable function result>`.

Constructor

DeleteEntry(key: String)

Fields

Example

{-# STDLIB_VERSION 5 #-}
{-# SCRIPT_TYPE ACCOUNT #-}
   
@Callable(inv)
func default() = {
 (
   [
     DeleteEntry(inv.caller.toString())
   ],
   unit
 )
}

IntegerEntry

IntegerEntry is a structure that sets the key and value of account data storage integer entry. Adding or changing an entry is performed only if the structure is included in the callable function result>`.

Constructor

IntegerEntry(key: String, value: Int)

Fields

Issue

Issue is a structure that sets the parameters of the token issue. The token issue is performed only if the structure is included in the callable function result>`. The minimum fee for an invoke script transaction is increased by 1 DecentralCoin for each issued asset that is not NFT. You can get the ID of the issued token using the calculateAssetId function.

Constructor

Issue(name: String, description: String, quantity: Int, decimals: Int, isReissuable: Boolean, compiledScript: Script|Unit, nonce: Int)

or

Issue(name: String, description: String, quantity: Int, decimals: Int, isReissuable: Boolean) 

In the second case, compiledScript = unit and nonce = 0 values are inserted automatically.

Fields

Example

Regular Token Issue

Issue("RegularToken", "This is an ordinary token", 10000, 2, true)

The structure sets the following parameters of token:

• Name: RegularToken
• Description: This is an ordinary token
• Amount of tokens to issue: 100 (value of 10 000 is specified in the minimum fraction — “cents”)
• Amount of decimals: 2
• Reissue ability: yes

Multiple Token Issue

(
 [
   Issue("RegularToken", "This is an ordinary token", 10000, 2, true, unit, 0),
   Issue("RegularToken", "This is an ordinary token", 10000, 2, true, unit, 1)
 ],
 unit
)

NFT Issue

Issue("UberToken", "The ultimate token.", 1, 0, false)

The structure sets the following parameters of token:

• Name: UberToken
• Description: The ultimate token.
• Amount of tokens to issue: 1
• Amount of decimals: 0
• Reissue ability: no

Lease

Lease is a structure that sets the lease parameters. The lease is performed only if the structure is included in the callable function result>`. More about lease. You can get the lease ID using the calculateLeaseId function.

Constructor

Lease(recipient: Address|Alias, amount: Int, nonce: Int)

or

Lease(recipient: Address|Alias, amount: Int) 

In the second case, nonce = 0 is inserted automatically.

Fields

Example

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE DAPP #-}
{-# SCRIPT_TYPE ACCOUNT #-}
 
@Callable(i)
func foo() = {
 let lease = Lease(Alias("merry"),100000000)
 let id = calculateLeaseId(lease)
 (
   [
     lease,
     BinaryEntry("lease", id)
   ],
   unit
 )
}

LeaseCancel

LeaseCancel is a structure that sets the lease cancellation parameters. The lease cancellation is performed only if the structure is included in the callable function result>`.

Constructor

LeaseCancel(leaseId: ByteVector)

Fields

Reissue

Reissue is a structure that sets the parameters of the token reissue. The token reissue is performed only if the structure is included in the callable function result>`. The token reissue is only available for an asset that is issued by a dApp account. If the token is a smart asset, the asset script verifies the Reissue action as if it were ReissueTransaction with the fee of 0 and the version of 0. If the asset script denies the action, then the transaction that invoked the dApp script is either denied or saved on the blockchain as failed, see the transaction validation.

Constructor

Reissue(assetId: ByteVector, quantity: Int, isReissuable: Boolean)

Fields

ScriptTransfer

ScriptTransfer is a structure that sets the parameters of the token transfer. The token transfer is performed only if the structure is included in the callable function result>`. If the token is a smart asset, the asset script verifies the ScriptTransfer action as if it were TransferTransaction with the fee of 0 and the version of 0. If the asset script denies the action, then the transaction that invoked the dApp script is either denied or saved on the blockchain as failed, see the transaction validation.

Constructor

ScriptTransfer(recipient: Address|Alias, amount: Int, asset: ByteVector|Unit)

Fields

SponsorFee

SponsorFee is a structure that sets up sponsorship. For information about sponsorship, see the sponsored fee article. The sponsorship setup is performed only if the structure is included in the resulting expression of the callable function. See details in the callable function article. The sponsorship setup is only available if the asset is issued by a dApp account (by the same script invocation as well) and is not a smart asset.

Constructor

SponsorFee(assetId: ByteVector, minSponsoredAssetFee: Int|Unit)

Fields

Example

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE DAPP #-}
{-# SCRIPT_TYPE ACCOUNT #-}
 
@Callable(i)
func issueAndSponsor() = {
 let issue = Issue("Spring", "", 100000, 2, true, unit, 0)
 let id = calculateAssetId(issue)
 (
   [
     issue,
     SponsorFee(id, 300)
   ],
   unit
 )
}

The issueAndSponsor callable function issues an asset and enables sponsorship. The minimum fee in sponsored assets is 3 Spring.

StringEntry

StringEntry is a structure that sets key and value of account data storage string entry. Adding or changing an entry is performed only if the structure is included in the callable function result>`.

Constructor

BinaryEntry(key: String, value: String)

Fields

Common Structures

Address

Structure of an address.

Constructor

Address(bytes: ByteVector)

Fields

Example

Get all types of balance in DecentralCoins for the current account (in a dApp script or an account script):

decentralchainBalance(this)

For any account:

let address=base58'3N4iKL6ikwxiL7yNvWQmw7rg3wGna8uL6LU'
decentralchainBalance(Address(address))

Get an entry value by key from the account data storage:

let address2=base58'3N6dFJ6XBQsWz1VV1i5aW4CyYpVKc39MUGZ'
getBoolean(Address(address2),"allow_orders")

Convert the address that invoked the function to a base58 string:

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE DAPP #-}
{-# SCRIPT_TYPE ACCOUNT #-}

@Callable(i)
func foo(question: String) = {
 let callerAddress = toBase58String(i.caller.bytes)
 ...
}

Check the recipient's address in the transfer transaction:

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE EXPRESSION #-}
{-# SCRIPT_TYPE ACCOUNT #-}

# Bank dApp address
let BANK = base58'3MpFRn3X9ZqcLimFoqNeZwPBnwP7Br5Fmgs'

match (tx) {
 case t: TransferTransaction => addressFromRecipient(t.recipient).bytes == BANK
 case _ => false
}

Alias

Structure of an alias.

Constructor

Alias(alias: String)

Fields

Example

let alias = Alias("merry")
addressFromRecipient(alias)

Asset

Structure of a token. The structure is returned by the assetInfo built-in function.

Constructor

Asset(id: ByteVector, quantity: Int, decimals: Int, issuer: Address, issuerPublicKey: ByteVector, reissuable: Boolean, scripted: Boolean, minSponsoredFee: Int|Unit, name: String, description: String)

Fields

Example

Get the account balance in a given asset:

let address=base58'3Mw48B85LvkBUhhDDmUvLhF9koAzfsPekDb'
let assetId=base58'GpxmxorKXLz1V7xootrvGyFgqP2tTTBib5HEm8QGZTHX'
assetBalance(Address(address), assetId)

AssetPair

Structure of a pair of tokens of an order within the Order structure.

Constructor

AssetPair(amountAsset: ByteVector|Unit, priceAsset: ByteVector|Unit)

Fields

Example

Get the account balance in a given asset:

let address=base58'3Mw48B85LvkBUhhDDmUvLhF9koAzfsPekDb'
let assetId=base58'GpxmxorKXLz1V7xootrvGyFgqP2tTTBib5HEm8QGZTHX'
assetBalance(Address(address), assetId)

AttachedPayment

Structure of a payment attached to the script invocation and available to the callable function. The structure is used in:

• Invocation structure.
• InvokeScriptTransaction structure.
• Invoke and reentrantInvoke functions.

Constructor

AttachedPayment(assetId: ByteVector|Unit, amount: Int)

Fields

BalanceDetails

Structure that contains DecentralCoins balances of account. The structure is returned by the decentralchainBalance built-in function. For description of balance types, see the account balance article.

Constructor

BalanceDetails(available: Int, regular: Int, generating: Int, effective: Int)

Fields

All balances are given in Decentralites.

BlockInfo

Structure containing block headers. The structure is returned by the blockInfoByHeight built-in function.

Constructor

BlockInfo(timestamp: Int, height: Int, baseTarget: Int, generationSignature: ByteVector, generator: Address, generatorPublicKey: ByteVector, vrf: ByteVector|Unit)

Fields

Invocation

Structure that contains the fields of the script invocation that the callable function can use.

Constructor

Invocation(caller: Address, callerPublicKey: ByteVector, originCaller: Address, originCallerPublicKey: ByteVector, payments: List[AttachedPayment], transactionId: ByteVector, fee: Int, feeAssetId: ByteVector|Unit)

Fields

The field values depend on how the callable function is invoked. If the callable function is invoked by an invoke script transaction:

If the callable function is invoked by the invoke or reentrantInvoke function (see the dApp-to-dApp invocation article):

The originCaller, originCallerPublicKey, transactionId, fee, and feeAssetId values are the same for all dApp-to-dApp invocations within a single Invoke Script transaction.

Example

The following function checks that the first payment in the Invoke Script transaction is at least 1 DecentralCoin or 5 in the specified asset.

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE DAPP #-}
{-# SCRIPT_TYPE ACCOUNT #-}

func isPaymentOk(i: Invocation) = {
 let acceptableAssetId = base58'3JmaWyFqWo8YSA8x3DXCBUW7veesxacvKx19dMv7wTMg'
 if (size(i.payments) == 0) then {
   throw("Payment not attached")
 } else {
   let p = i.payments[0]
   match p.assetId {
     case assetId: ByteVector => assetId == acceptableAssetId && p.amount >= 500000000
     case _ => p.amount >= 100000000
   }
 }
}

@Callable(i)
func foo() = {
 if isPaymentOk(i) then ([],unit) else throw("Wrong payment amount or asset")
}

Order

Structure of an order dApp-to-dApp invocation. The structure is used:

• When checking an outgoing order by the account script or the verifier function of the dApp script.
• In the InvokeScriptTransaction structure.

Constructor

Order(id: ByteVector, matcherPublicKey: ByteVector, assetPair: AssetPair, orderType: Buy|Sell, price: Int, amount: Int, timestamp: Int, expiration: Int, matcherFee: Int, matcherFeeAssetId: ByteVector|Unit, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

Example

The script below enables buying from a sender's account:

• Only the specified asset.
• Only at a given price.
• Only for DecentralCoins.

{-# STDLIB_VERSION 5 #-}
{-# CONTENT_TYPE EXPRESSION #-}
{-# SCRIPT_TYPE ACCOUNT #-}

let myAssetId = base58'8LLpj6yQLUu37KUt3rVo1S69j2gWMbgbM6qqgt2ac1Vb'

match tx {
  case o: Order =>
   let isDecentralChainPriceAsset = !isDefined(o.assetPair.priceAsset)
   let rightPair = (o.assetPair.amountAsset == myAssetId) && isDecentralChainPriceAsset
   sigVerify(o.bodyBytes, o.proofs[0], o.senderPublicKey)
   && rightPair
   && o.price == 500000
   && o.orderType == Buy
  case _ => false
}

Transfer

Structure of a single transfer within the MassTransferTransaction structure.

Constructor

Transfer(recipient: Address|Alias, amount: Int)

Fields

Transaction Structures

Tokenization

IssueTransaction

Structure of an issue transaction.

Constructor

IssueTransaction(quantity: Int, name: String, description: String, reissuable: Boolean, decimals: Int, script: ByteVector|Unit, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

ReissueTransaction

Structure of a reissue transaction.

Constructor

ReissueTransaction(quantity: Int, assetId: ByteVector, reissuable: Boolean, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

BurnTransaction

Structure of an burn transaction.

Constructor

BurnTransaction(quantity: Int, assetId: ByteVector, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

SetAssetScriptTransaction

Structure of an set asset script transaction.

Constructor

SetAssetScriptTransaction(script: ByteVector|Unit, assetId: ByteVector, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

UpdateAssetInfoTransaction

Structure of an update asset info transaction.

Constructor

UpdateAssetInfoTransaction(name: String, assetId: ByteVector, description: String, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

Usage

TransferTransaction

Structure of an transfer transaction.

Constructor

TransferTransaction(feeAssetId: ByteVector|Unit, amount: Int, assetId: ByteVector|Unit, recipient: Address|Alias, attachment: ByteVector, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

ExchangeTransaction

Structure of an exchange transaction.

Constructor

ExchangeTransaction(buyOrder: Order, sellOrder: Order, price: Int, amount: Int, buyMatcherFee: Int, sellMatcherFee: Int, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

CreateAliasTransaction

Structure of a create alias transaction.

Constructor

CreateAliasTransaction(alias: String, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

MassTransferTransaction

Structure of a mass transfer transaction.

Constructor

MassTransferTransaction(assetId: ByteVector|Unit, totalAmount: Int, transfers: List[Transfer], transferCount: Int, attachment: ByteVector, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

DataTransaction

Structure of a data transaction.

Constructor

DataTransaction(data: List[BinaryEntry|BooleanEntry|DeleteEntry|IntegerEntry|StringEntry], id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

SetScriptTransaction

Structure of a set script transaction.

Constructor

SetScriptTransaction(script: ByteVector|Unit, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

InvokeScriptTransaction

Structure of an invoke script transaction.

Constructor

InvokeScriptTransaction(dApp: Address|Alias, payments: List[AttachedPayments], feeAssetId: ByteVector|Unit, function: String, args: List[Boolean|ByteVector|Int|String|List[Boolean|ByteVector|Int|String]], id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

Network

LeaseTransaction

Structure of a lease transaction.

Constructor

LeaseTransaction(amount: Int, recipient: Address|Alias, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

LeaseCancelTransaction

Structure of a lease cancel transaction.

Constructor

LeaseCancelTransaction(leaseId: ByteVector, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

SponsorFeeTransaction

Structure of a sponsor fee transaction.

Constructor

SponsorFeeTransaction(assetId: ByteVector, minSponsoredAssetFee: Int|Unit, id: ByteVector, fee: Int, timestamp: Int, version: Int, sender: Address, senderPublicKey: ByteVector, bodyBytes: ByteVector, proofs: List[ByteVector])

Fields

Genesis

GenesisTransaction

Structure of a genesis transaction.

Constructor

GenesisTransaction(amount: Int, recipient: Address|Alias, id: ByteVector, fee: Int, timestamp: Int, version: Int)

Fields