Initial block of code

Type: object

When you code on GCScript, you always start by calling this function first. This is the initial block of code containing a sequence of GCScript functions or other sub-nested blocks of code.

Go to GCScript DSL and ISL documentation pages for syntax guide and more.

No Additional Properties
Examples:

{
    "type": "script",
    "title": "Your wallet information",
    "description": "Do you want to share wallet information back to the dapp?",
    "exportAs": "myExports",
    "returnURLPattern": "https://yourCustomDappSite.com/dappCallExecutionResults/{result}/view",
    "run": {
        "name": {
            "type": "getName"
        },
        "address": {
            "type": "getCurrentAddress"
        },
        "message": {
            "type": "data",
            "value": "Hello Cardano!"
        }
    }
}
{
    "type": "script",
    "title": "🚀 Pay me 1 ADA",
    "description": "This is a payment request of 1 ADA",
    "returnURLPattern": "https://justAnotherDapp.io/",
    "exportAs": "txHash",
    "return": {
        "mode": "last"
    },
    "run": {
        "stage1_build_transaction": {
            "type": "buildTx",
            "title": "🚀 You paid me 1 ADA",
            "description": "This was a payment request of 1 ADA",
            "tx": {
                "outputs": [
                    {
                        "address": "addr1q98f06pcrsn8x03uw0vlejw684fcu02waffvfscdsz0djgqd6j6v0fc04n5ehg292yxvs292vesrqqmxqfnp7yuwn7yq2vsyn7",
                        "assets": [
                            {
                                "policyId": "ada",
                                "assetName": "ada",
                                "quantity": "1000000"
                            }
                        ]
                    }
                ]
            }
        },
        "stage2_sign_transaction": {
            "type": "signTxs",
            "detailedPermissions": false,
            "txs": [
                "{get('cache.stage1_build_transaction.txHex')}"
            ]
        },
        "stage3_submit_transaction": {
            "type": "submitTxs",
            "txs": "{get('cache.stage2_sign_transaction')}"
        },
        "stage4_export_results": {
            "type": "macro",
            "run": "{get('cache.stage1_build_transaction.txHash')}"
        }
    }
}
{
    "type": "script",
    "title": "My first workspace",
    "description": "Lets create a workspace to store your custom key derivations",
    "run": {
        "myWorkspace": {
            "type": "loadConfig",
            "updateId": "demo",
            "layers": [
                {
                    "type": "Workspace",
                    "items": [
                        {
                            "namePattern": "derivations",
                            "titlePattern": "Derivations",
                            "descriptionPattern": "My custom wallet settings"
                        }
                    ]
                },
                {
                    "type": "Key",
                    "workspaceIds": [
                        "derivations"
                    ],
                    "namePattern": "myKey_{index}_{key}_{kind}_{accountIndex}_{addressIndex}",
                    "items": [
                        {
                            "pathPattern": "m/1852h/1815h/0h/2/{index}"
                        },
                        {
                            "pathPattern": "m/1852h/1815h/1h/1/{index}"
                        },
                        {
                            "pathPattern": "m/1852h/1815h/2h/0/{index}"
                        }
                    ]
                }
            ]
        }
    }
}

Type: const
Specific value: "script"


Type: object

Pass any kind of data as arguments to this script. During runtime, script code will be able to access it using inline macro getter this way {get('args.foo.bar')}


Examples:

{
    "foo": {
        "bar": "Hello World!",
        "baz": 3
    }
}
"Hello World"
5
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.


Reserved language functions

Type: string

function return(result: any ): void ;

The function return allows you to stop execution of inline code block at that position and return a value as result of entire block execution.

Arguments

  • result (any) - value to return [OPTIONAL]

More

The function fail() is similar but halts the execution of entire script with failure instead.

Must match regular expression: (?<![\w_])return\s*\(.*\)(?![\w_])
Examples:

"{ return(5) }"
"{ return('Hello World!') }"
"{ return(get('cache.myAddress')) }"
Type: string

function fail(message: string ): void ;

The function fail allows you to stop execution of inline code block at that position and also entire script execution in error state.
User can provide a message as argument to became the message of the error to be thrown.

Arguments

  • message (string) - error message to throw [OPTIONAL]

More

The function return() is similar but halts the execution of inline code block successfully, returning a value.

Must match regular expression: (?<![\w_])fail\s*\(.*\)(?![\w_])
Examples:

"{ fail('This is an error message') }"
"{ fail() }"

System functions for memory management, logging, etc..

Type: string

function set(path: string, value: any ): any ;

The function set allows you to set arbitrary data on script context for later reuse.

Arguments

  • path (string) - path of the value to set
  • value (any) - variable to store

More

Use get() with path='global.<path>' to access and reuse the value later

Must match regular expression: (?<![\w_])set\s*\(.*\)(?![\w_])
Examples:

"{ set('temp1','Hello World!') }"
"{ set('temp2',get('global.temp1')) }"
Type: string

function get(path: string ): any ;

The function get allows you to get arbitrary data from script context.

Arguments

  • path (string) - path of the value to retrieve

More

Use set() function to declare user variables inside a global object which you can later access using get()

Must match regular expression: (?<![\w_])get\s*\(.*\)(?![\w_])
Examples:

"{ get('cache.myAddress') }"
"{ get('cache.buildTransaction.txHex') }"
"{ set('temp1','Hello World!'); get('global.temp1'); }"
Type: string

function console(type: 'log'|'info'|'warn'|'error', ...values: any ): void ;

Dumps to console one or several values, which can be string messages or of any type

Arguments

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • ...values (any) - value to pretty print in the logs [REST]
Must match regular expression: (?<![\w_])console\s*\(.*\)(?![\w_])
Examples:

"{ console('log','This is a log') }"
"{ console('info','This is an information') }"
"{ console('warn','This is a warning') }"
"{ console('error','This is an error') }"
"{ console('info','Hello web3 user!','Your address is:', get('cache.myAddress')) }"
"{ console('log',get('global.temp1')) }"
Type: string

[DEPRECATED] function delay(timeout: number ): void ;

Pauses the execution for timeout milliseconds.

Arguments

  • timeout (number) - number of milliseconds for the timeout
Must match regular expression: (?<![\w_])delay\s*\(.*\)(?![\w_])

String manipulation functions

Type: string

function truncate(value: string, prefixLength: number, suffixLength: number, separator: string ): string ;

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Useful for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Arguments

  • value (string) - utf-8 string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of characters to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

More

Example:

addr1qzk45...kwg (prefixLength=10 ,suffixLength=3, separator="...")

Must match regular expression: (?<![\w_])truncate\s*\(.*\)(?![\w_])
Type: string

function replaceAll(text: string, match: string, value: string ): string ;

Replaces all match occurrences inside text by value

Arguments

  • text (string) - utf-8 string where to search and replace
  • match (string) - utf-8 exact string that will be searched for and replaced by value
  • value (string) - utf-8 string value to replace with
Must match regular expression: (?<![\w_])replaceAll\s*\(.*\)(?![\w_])

Array manipulation functions

Type: string

function getArray(...values: any ): array ;

Returns an array with each provided argument as an item

Arguments

  • ...values (any) - items of the array of any type [REST]

More

base

Must match regular expression: (?<![\w_])getArray\s*\(.*\)(?![\w_])
Example:

"{ getArray('apple','banana',43, get('cache.address')) }"

Encoding and decoding functions

Type: string

function jsonToObj(value: string ): any ;

Parses a JSON string and returns a value of JSON-supported type

Arguments

  • value (string) - string value to parse, must be a valid JSON string

More

Use objToJson() function to serialize JSON

Must match regular expression: (?<![\w_])jsonToObj\s*\(.*\)(?![\w_])
Type: string

function objToJson(value: any ): string ;

Turns a value of JSON-supported type into a JSON string

Arguments

  • value (any) - value to serialize as JSON string

More

Use jsonToObj() function to parse JSON

Must match regular expression: (?<![\w_])objToJson\s*\(.*\)(?![\w_])
Type: string

function strToHex(value: string ): string ;

Encodes a utf-8 text string into hexadecimal string

Arguments

  • value (string) - utf-8 text string

More

Use hexToStr() function to decode from hexadecimal encoding

Must match regular expression: (?<![\w_])strToHex\s*\(.*\)(?![\w_])
Type: string

function hexToStr(value: string ): string ;

Decodes an hexadecimal string into the former utf-8 text string

Arguments

  • value (string) - hexadecimal encoded string

More

Use strToHex() function to encode using hexadecimal encoding

Must match regular expression: (?<![\w_])hexToStr\s*\(.*\)(?![\w_])
Type: string

function strToBase64(value: string ): string ;

Encodes a utf-8 text string into base64 string

Arguments

  • value (string) - utf-8 text string

More

Use base64ToStr() function to decode from base64 encoding

Must match regular expression: (?<![\w_])strToBase64\s*\(.*\)(?![\w_])
Type: string

function base64ToStr(value: string ): string ;

Decodes a base64 string into a utf-8 text string

Arguments

  • value (string) - base64 encoded string

More

Use strToBase64() function to encode using base64 encoding

Must match regular expression: (?<![\w_])base64ToStr\s*\(.*\)(?![\w_])
Type: string

function strToMetadataStr(value: string ): string|string[] ;

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in Cardano transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.

Arguments

  • value (string) - utf-8 text to be adapted for metadata usage

More

Use metadataStrToStr() function to convert back to string a metadata string

Must match regular expression: (?<![\w_])strToMetadataStr\s*\(.*\)(?![\w_])
Type: string

function metadataStrToStr(value: string|string[] ): string ;

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.

Arguments

  • value (string|string[]) - string or list of strings produced by strToMetadataStr()

More

Use strToMetadataStr() function to convert a string into a metadata string

Must match regular expression: (?<![\w_])metadataStrToStr\s*\(.*\)(?![\w_])

Cryptographic functions

Type: string

function getAddressInfo(address: string ): object ;

Parses a Cardano address and returns information as an object with many useful properties

Arguments

  • address (string) - a valid Cardano address
Must match regular expression: (?<![\w_])getAddressInfo\s*\(.*\)(?![\w_])
Type: string

function sha512(data: string ): string ;

Calculates SHA512 hash of data string

Arguments

  • data (string) - utf-8 string to be hashed
Must match regular expression: (?<![\w_])sha512\s*\(.*\)(?![\w_])
Type: string

function sha256(data: string ): string ;

Calculates SHA256 hash of data string

Arguments

  • data (string) - utf-8 string to be hashed
Must match regular expression: (?<![\w_])sha256\s*\(.*\)(?![\w_])
Type: string

function sha1(data: string ): string ;

Calculates SHA1 hash of data string

Arguments

  • data (string) - utf-8 string to be hashed
Must match regular expression: (?<![\w_])sha1\s*\(.*\)(?![\w_])
Type: string

function md5(data: string ): string ;

Calculates MD5 hash of data string

Arguments

  • data (string) - utf-8 string to be hashed
Must match regular expression: (?<![\w_])md5\s*\(.*\)(?![\w_])
Type: string

function uuid( ): string ;

Generates a random RFC4122 UUID v4

Arguments

none
Must match regular expression: (?<![\w_])uuid\s*\(.*\)(?![\w_])

Arithmetic functions

Type: string

function addBigNum(value: string|number, ...addends: string|number ): string ;

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments

  • value (string|number) - initial value (BigNum)
  • ...addends (string|number) - value or values to be added (BigNum) [REST]
Must match regular expression: (?<![\w_])addBigNum\s*\(.*\)(?![\w_])
Type: string

function subBigNum(value: string|number, ...subtrahends: string|number ): string ;

Subtracts subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the subtraction as a BigNum string.

Arguments

  • value (string|number) - minuend, initial value (BigNum)
  • ...subtrahends (string|number) - value or values to be subtracted (BigNum) [REST]
Must match regular expression: (?<![\w_])subBigNum\s*\(.*\)(?![\w_])
Type: string

function mulBigNum(value: string|number, ...multipliers: string|number ): string ;

Multiplies multipliers numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments

  • value (string|number) - initial value (BigNum)
  • ...multipliers (string|number) - value or values to be multiplied with (BigNum) [REST]
Must match regular expression: (?<![\w_])mulBigNum\s*\(.*\)(?![\w_])
Must match regular expression: ^\{(.|[\r\n])*\}$


List or Key-Value Map of Script Argument List. Each child script will have read access to it's corresponding arguments referenced by with same key. Use inline macro on args parameter like this inside each imported script "args":"{get('args')}". Script args parameter will act as default arguments if key is not present on the list

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Pass any kind of data as arguments to this script. During runtime, script code will be able to access it using inline macro getter this way {get('args.foo.bar')}

Same definition as Script arguments
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Pass any kind of data as arguments to this script. During runtime, script code will be able to access it using inline macro getter this way {get('args.foo.bar')}

Same definition as Script arguments
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Pass any kind of data as arguments to this script. During runtime, script code will be able to access it using inline macro getter this way {get('args.foo.bar')}

Same definition as Script arguments
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)

Type: object Default: {"mode": "all"}

Modes in which a script( a block of code), will return it results

Type: object

Will return undefined, and because is not a valid JSON value it will be purged. Behaves like the result of a function():void; in typescript

No Additional Properties

Type: const
Specific value: "none"
Type: object

Will return all it children code block results. This is the default isomorphic behavior of the scripting language

No Additional Properties

Type: const
Specific value: "all"
Type: object

Will return the result of it's first child code block.

No Additional Properties

Type: const
Specific value: "first"
Type: object

Will return the result of it's last child code block. This is widely used to return data back to dapps or calling agents as it allows you to group and format results at the end of the script execution

No Additional Properties

Type: const
Specific value: "last"
Type: object

Will return the result of one child code block, the one in the key name or position argument.

No Additional Properties

Type: const
Specific value: "one"


Type: string
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Will return the result of some children code blocks, the ones in the keys name or position list argument.

No Additional Properties

Type: const
Specific value: "some"


Type: array of string

Each item of this array must be:

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Will return the result of the execution of an inline scripting language macro. Useful for formatting, debugging results

No Additional Properties

Type: const
Specific value: "macro"

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)

Type: string

When set, it allows you return all the results of this script back to the DAPP under a property with this string as name

Type: boolean Default: false

If true, this block of code isolates it's cache scope as if it where the only one existing on context, making the rest of the code outside of it unreachable from within. Useful to keep variable paths absolute (for get() macro function for ex.), no matter if the block is the root block of an entire script of it is nested inside others.

Type: string

Title of the script


Examples:

"NFT Minting Request"
"Pay 5 ADA to Charles"

Type: string

Description of the script


List of API functions or nested Blocks of Code to execute

Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Stops the execution of the script until a condition is met

No Additional Properties
Examples:

{
    "type": "await",
    "until": {
        "beneficiaryTimeLock": {
            "kind": "timer",
            "unit": "seconds",
            "value": 10
        }
    }
}
{
    "type": "await",
    "until": {
        "A": {
            "kind": "timer",
            "unit": "seconds",
            "value": 15
        },
        "B": {
            "kind": "balance",
            "asset": {
                "policyId": "ada",
                "assetName": "ada",
                "quantity": "5250000"
            }
        },
        "C": {
            "kind": "balance",
            "address": "addr1q98f06pcrsn8x03uw0vlejw684fcu02waffvfscdsz0djgqd6j6v0fc04n5ehg292yxvs292vesrqqmxqfnp7yuwn7yq2vsyn7",
            "is": "equal",
            "asset": {
                "policyId": "d491234d8b40b63aceab0d7329c6db111c3634d9e0d3c6166c66c13b",
                "assetName": "FakeUSD",
                "quantity": "5"
            }
        }
    }
}

Type: const
Specific value: "await"


List or Key-Value Map of Conditions

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Condition methods to be used in functions like await

Type: object

Returns true on timeout

No Additional Properties


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: enum (of string) Default: "seconds"

Must be one of:

  • "year"
  • "years"
  • "y"
  • "month"
  • "months"
  • "M"
  • "week"
  • "weeks"
  • "w"
  • "day"
  • "days"
  • "d"
  • "hour"
  • "hours"
  • "h"
  • "minute"
  • "minutes"
  • "m"
  • "second"
  • "seconds"
  • "s"
  • "millisecond"
  • "milliseconds"
  • "ms"
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Returns true once wallet asset balance meets a condition. If address is not specify, will use current address. If ìs is not specified, will default to greater-or-equal

No Additional Properties


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: enum (of string) Default: "greater-or-equal"

Must be one of:

  • "less"
  • "less-or-equal"
  • "equal"
  • "greater-or-equal"
  • "greater"
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: object

Definition of a Cardano asset.

Type: object

Define a Cardano asset using an ASCII asset name encoding as argument

No Additional Properties


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Define a Cardano asset using an hexadecimal asset name encoding as argument

No Additional Properties


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Get Public Keys from current workspace artifacts stored on wallet local storage, applying a search filter and allowing the customization of the resulting key-value map using keyPattern to name the keyed results, offset and limit numbers to paginate results, and sort to sort the keys of the resulting map

No Additional Properties
Examples:

{
    "type": "getPublicKeys",
    "keyPattern": "{artifactName}",
    "limit": 10,
    "offset": 20
}
{
    "type": "getPublicKeys",
    "keyPattern": "{path}",
    "filter": {
        "isAccount": true,
        "accountIndex": 1
    },
    "sort": "ascending"
}
{
    "type": "getPublicKeys",
    "keyPattern": "account05_{artifactName}_{addressIndex}",
    "filter": {
        "pathPrefix": "m/1852h/1815h/5h/"
    }
}

Type: const
Specific value: "getPublicKeys"

Default: "{kind}-{accountIndex}-{addressIndex}"

Pattern for naming each key of the resulting key-value mapping. You can use variables wrapped between { and }. Available templating variables are limit, offset, index, position, count, maxOffset, sort, artifactKind, artifactRef, artifactKey, artifactName, pubKeyHashHex, kind, accountIndex, addressIndex, path.

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)

Examples:

"Item-{artifactName}"
"{artifactKind} {index}/{maxOffset}"
"{artifactKind} {position}/{count}"


Type: number

Value must be greater or equal to 0

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: number

Value must be greater or equal to 0

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: enum (of string)

Must be one of:

  • "ascending"
  • "descending"
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: object
No Additional Properties


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: enum (of string)

Must be one of:

  • "spend"
  • "stake"
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: number

Value must be greater or equal to 0

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: number

Value must be greater or equal to 0

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)


Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)
Type: object

Get Addresses from current workspace artifacts stored on wallet local storage, applying a search filter and allowing the customization of the resulting key-value map using keyPattern to name the keyed results, offset and limit numbers to paginate results, and sort to sort the keys of the resulting map.

No Additional Properties
Examples:

{
    "type": "getAddresses",
    "keyPattern": "{artifactName}"
}
{
    "type": "getAddresses",
    "keyPattern": "{artifactName}:{address}",
    "sort": "ascending",
    "limit": 10,
    "offset": 20
}
{
    "type": "getAddresses",
    "sort": "descending",
    "filter": {
        "kind": "enterprise",
        "isScript": true
    }
}
{
    "type": "getAddresses",
    "keyPattern": "unique_address_result",
    "filter": {
        "name": "Bob Address"
    }
}

Type: const
Specific value: "getAddresses"

Default: "{kind}-{paymentHashHex}-{stakingHashHex}"

Pattern for naming each key of the resulting key-value mapping. You can use variables wrapped between { and }. Available templating variables are limit, offset, index, position, count, maxOffset, sort, artifactKind, artifactRef, artifactKey, artifactName, address, kind, paymentKeyHashHex, stakingKeyHashHex, paymentScriptHashHex, stakingScriptHashHex, paymentHashHex, stakingHashHex, rewardAddress, identityScriptHashHex, spendPubKeyName, stakePubKeyName, spendNativeScriptName, stakeNativeScriptName, spendPlutusScriptName, stakePlutusScriptName, icarusPubKeyName, spendCredentialName, stakeCredentialName.

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)

Examples:

"Item-{artifactName}"
"{artifactKind} {index}/{maxOffset}"
"{artifactKind} {position}/{count}"


Type: number

Value must be greater or equal to 0

Type: string

Complementary programming language to process, format, reuse, link, or pipe GCScript function results with other function arguments, designed to avoid bad practices such as deep nested code and complex code logic expressed in JSON.

Code functions help you to perform memory, string, arithmetic, cryptographic, encoding, logging, debugging, and other useful secondary operations not supported by primary GCScript API functions.

Usage:

Almost all GCScript function arguments supports ISL.

All arguments passing a string value starting with { and terminating with } and containing calls of one or many ISL functions separated with ; will be interpreted as an ISL code block and will be executed.

The entire ISL code block will be replaced by it's results prior executing the GCScript function, key behavior that makes GCScript more flexible and dynamic.

Otherwise, if syntax rules are not met on GCScript function arguments, interpreter will use these strings as string values instead of ISL executable code.

ISL syntax is a subset of Javascript syntax. It's a deterministic, non-turing complete language, same as GCScript language itself.

Go to ISL documentation page for syntax guide and more.

Same definition as Inline Scripting Language (ISL)