Algo Builder Runtime

This package implements a light version of the go-algorand runtime. It allows to executes transactions and processes TEAL in JavaScript environment. The packages provides 4 main object:

• Runtime: handles transaction or txn group processing and state management . User can use a Runtime object to set up accounts, create applications, opt-in to app, update app, etc...
• AccountStore: user can create new accounts using a AccountStore object. All information about an account (apps, assets, localState, globalState etc..) is stored in AccountStore.
• Parser: reads TEAL code and converts it to a list of opcodes which are executable by the interpreter. If a teal code contains an invalid opcode/data, parser will throw an error.
• Interpreter: executes a list of opcodes returned by parser. Interpreter creates teal execution stack and interacts with runtime to perform changes related a TEAL code execution. At the end of execution, if the stack contains a single non-zero uint64 element then the teal code is approved, and transaction can be executed.

Important links

• Home Page
• Runtime API Docs
• User Docs

Usage

@algo-builder/runtime can be included as a library using yarn add @algo-builder/runtime and then import it using import * from '@algo-builder/runtime'.

Please read more about usage of runtime from here.

What we support now

runtime supports:

• Prepare account state for teal execution.

• Stateless TEAL - Approve/Reject logic.

• Stateful TEAL - Update and verify global/local states if teal logic is correct.

• Transactions to

  • create an application
  • opt-in to application
  • call application
  • update application
  • delete application
  • closeout from an application
  • clearState of application
  • create an asset
  • opt-in to asset
  • transfer an asset
  • rekey an account

• Full transaction processing for type payment, application call

• Asset related transactions:

  • Asset Destroy
  • Asset Revoke
  • Asset Freeze
  • Asset Configuration

• Multisignature - Runtime now allows to to withdraw from accounts that has been rekeyed to multisignature account. In order to do it:

  1. Create multisignature address with algosdk.
  2. Rekey account to multisig address.
  3. Sign a transaction using algosdk.
  4. Invoke runtime.executeTx(SignedMultiSigTransaction)

  More details.

STATUS: production ready.

Contributing

Please read the main README.