List of external script JSON files to load into the workflow
No Additional Properties{
"type": "importAsScript",
"from": [
"gcfs://88e0e51d4522c8d9c10e061dca6eb928c1df2a5d10efdcae9059bc85.test@latest://src/script.gcscript"
]
}
{
"type": "importAsScript",
"decryptWith": {
"kind": "system"
},
"from": [
"gcfs://1170d12887c70593e40938a5ff1832f9eb2b8e4a328a982621b36a57.gc_settings@latest://scripts/config.gcscript.sys"
]
}
"importAsScript"
When set, it allows you return all the results of this script back to the DAPP under a property with this string as name
Title of the container script
"NFT Minting Request"
"Pay 5 ADA to Charles"
Description of the container script
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')}
{
"foo": {
"bar": "Hello World!",
"baz": 3
}
}
"Hello World"
5
Inline Scripting Language (ISL) is a 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.
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.
Reserved language functions
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.
any
) - value to return [OPTIONAL]The function fail() is similar but halts the execution of entire script with failure instead.
(?<![\w_])return\s*\(.*\)(?![\w_])
"{ return(5) }"
"{ return('Hello World!') }"
"{ return(get('cache.myAddress')) }"
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.
string
) - error message to throw [OPTIONAL]The function return() is similar but halts the execution of inline code block successfully, returning a value.
(?<![\w_])fail\s*\(.*\)(?![\w_])
"{ fail('This is an error message') }"
"{ fail() }"
System functions for memory management, logging, etc..
string
, value: any
): any
;The function set allows you to set arbitrary data on script context for later reuse.
string
) - path of the value to set any
) - variable to store Use get() with path='global.<path>'
to access and reuse the value later
(?<![\w_])set\s*\(.*\)(?![\w_])
"{ set('temp1','Hello World!') }"
"{ set('temp2',get('global.temp1')) }"
string
): any
;The function get allows you to get arbitrary data from script context.
string
) - path of the value to retrieve Use set() function to declare user variables inside a global
object which you can later access using get()
(?<![\w_])get\s*\(.*\)(?![\w_])
"{ get('cache.myAddress') }"
"{ get('cache.buildTransaction.txHex') }"
"{ set('temp1','Hello World!'); get('global.temp1'); }"
'log'|'info'|'warn'|'error'
, ...values: any
): void
;Dumps to console one or several values
, which can be string messages or of any type
'log'|'info'|'warn'|'error'
) - value to pretty print in the logs any
) - value to pretty print in the logs [REST](?<![\w_])console\s*\(.*\)(?![\w_])
"{ 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')) }"
String manipulation functions
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.
string
) - utf-8 string to be truncated number
) - initial number of characters to be included in resulting string number
) - final number of characters to be included in resulting string string
) - string to be included between prefix and suffix parts of the string addr1qzk45...kwg (prefixLength
=10 ,suffixLength
=3, separator
="...")
(?<![\w_])truncate\s*\(.*\)(?![\w_])
string
, match: string
, value: string
): string
;Replaces all match
occurrences inside text
by value
string
) - utf-8 string where to search and replace string
) - utf-8 exact string that will be searched for and replaced by value
string
) - utf-8 string value to replace with (?<![\w_])replaceAll\s*\(.*\)(?![\w_])
Array manipulation functions
Type: stringany
): array
;Returns an array with each provided argument as an item
any
) - items of the array of any type [REST]base
(?<![\w_])getArray\s*\(.*\)(?![\w_])
"{ getArray('apple','banana',43, get('cache.address')) }"
Encoding and decoding functions
string
): any
;Parses a JSON string and returns a value of JSON-supported type
string
) - string value to parse, must be a valid JSON string Use objToJson() function to serialize JSON
(?<![\w_])jsonToObj\s*\(.*\)(?![\w_])
any
): string
;Turns a value of JSON-supported type into a JSON string
any
) - value to serialize as JSON string Use jsonToObj() function to parse JSON
(?<![\w_])objToJson\s*\(.*\)(?![\w_])
string
): string
;Encodes a utf-8 text string into hexadecimal string
string
) - utf-8 text string Use hexToStr() function to decode from hexadecimal encoding
(?<![\w_])strToHex\s*\(.*\)(?![\w_])
string
): string
;Decodes an hexadecimal string into the former utf-8 text string
string
) - hexadecimal encoded string Use strToHex() function to encode using hexadecimal encoding
(?<![\w_])hexToStr\s*\(.*\)(?![\w_])
string
): string
;Encodes a utf-8 text string into base64 string
string
) - utf-8 text string Use base64ToStr() function to decode from base64 encoding
(?<![\w_])strToBase64\s*\(.*\)(?![\w_])
string
): string
;Decodes a base64 string into a utf-8 text string
string
) - base64 encoded string Use strToBase64() function to encode using base64 encoding
(?<![\w_])base64ToStr\s*\(.*\)(?![\w_])
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.
string
) - utf-8 text to be adapted for metadata usage Use metadataStrToStr() function to convert back to string a metadata string
(?<![\w_])strToMetadataStr\s*\(.*\)(?![\w_])
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.
string|string[]
) - string or list of strings produced by strToMetadataStr() Use strToMetadataStr() function to convert a string into a metadata string
(?<![\w_])metadataStrToStr\s*\(.*\)(?![\w_])
Cryptographic functions
string
): object
;Parses a Cardano address
and returns information as an object with many useful properties
string
) - a valid Cardano address (?<![\w_])getAddressInfo\s*\(.*\)(?![\w_])
string
): string
;Calculates SHA512 hash of data
string
string
) - utf-8 string to be hashed (?<![\w_])sha512\s*\(.*\)(?![\w_])
string
): string
;Calculates SHA256 hash of data
string
string
) - utf-8 string to be hashed (?<![\w_])sha256\s*\(.*\)(?![\w_])
string
): string
;Calculates SHA1 hash of data
string
string
) - utf-8 string to be hashed (?<![\w_])sha1\s*\(.*\)(?![\w_])
string
): string
;Calculates MD5 hash of data
string
string
) - utf-8 string to be hashed (?<![\w_])md5\s*\(.*\)(?![\w_])
Arithmetic functions
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.
string|number
) - initial value (BigNum) string|number
) - value or values to be added (BigNum) [REST](?<![\w_])addBigNum\s*\(.*\)(?![\w_])
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.
string|number
) - minuend, initial value (BigNum) string|number
) - value or values to be subtracted (BigNum) [REST](?<![\w_])subBigNum\s*\(.*\)(?![\w_])
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.
string|number
) - initial value (BigNum) string|number
) - value or values to be multiplied with (BigNum) [REST](?<![\w_])mulBigNum\s*\(.*\)(?![\w_])
^\{(.|[\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
Inline Scripting Language (ISL) is a 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.
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.
Must contain a minimum of 1
items
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')}
Inline Scripting Language (ISL) is a 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.
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.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:
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')}
Inline Scripting Language (ISL) is a 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.
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.
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:
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')}
Inline Scripting Language (ISL) is a 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.
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.
List of external JSON files to inline into the script
Must contain a minimum of 1
items
URI of an GCFS (gcfs://...
) or hexadecimal (0x...
) JSON resource to inline into the script
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:
URI of an GCFS (gcfs://...
) or hexadecimal (0x...
) JSON resource to inline into the script
All properties whose name matches the following regular expression must respect the following conditions
Property name regular expression:
URI of an GCFS (gcfs://...
) or hexadecimal (0x...
) JSON resource to inline into the script
Password modal for manual user input
No Additional Properties"modal"
Special password modal for manual user input, to decrypt only wallet configuration scripts generated by the wallet or by the saveConfig
function
"system"