Script Builder

To execute operations on-chain you must build a script using ScriptBuilder.

import { Address, ScriptBuilder } from "phantasma-sdk-ts";

const sb = new ScriptBuilder();

AllowGas

Allocates KCAL for a transaction. Every state-changing script must call AllowGas and SpendGas.

import { Address, DomainSettings, ScriptBuilder } from "phantasma-sdk-ts";

const from = Address.FromText("P2K...");
const gasPrice = DomainSettings.DefaultMinimumGasFee;
const gasLimit = 21000;

const script = new ScriptBuilder()
  .BeginScript()
  .AllowGas(from, Address.Null, gasPrice, gasLimit)
  .CallInterop("Runtime.TransferTokens", [from, "P2K...", "KCAL", "1000000000"])
  .SpendGas(from)
  .EndScript();

SpendGas

Finalizes gas usage for the transaction.

const script = new ScriptBuilder()
  .BeginScript()
  .AllowGas(from, Address.Null, gasPrice, gasLimit)
  .CallContract("stake", "Claim", [from, from])
  .SpendGas(from)
  .EndScript();

CallInterop

Use internal operations such as Runtime.TransferTokens or Runtime.TransferToken.

const script = new ScriptBuilder()
  .BeginScript()
  .AllowGas(from, Address.Null, gasPrice, gasLimit)
  .CallInterop("Runtime.TransferTokens", [from, "P2K...", "SOUL", "100000000"])
  .SpendGas(from)
  .EndScript();

CallContract

Call a smart contract method by name.

const script = new ScriptBuilder()
  .BeginScript()
  .AllowGas(from, Address.Null, gasPrice, gasLimit)
  .CallContract("stake", "Stake", [from, "100000000"])
  .SpendGas(from)
  .EndScript();

Contract names are usually lowercase (for example stake). Token symbols are uppercase (for example SOUL).