Nifty Pony Merchandise

    teal-interpreter
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.39 • Public • Published

    teal-interpreter

    An interpreter for the TEAL assembly language that simulates the Algorand virtual machine.

    Supports up to and including TEAL 5. Support for TEAL 6 is coming in the future.

    See opcodes doc to check the details of supported opcodes.

    Use the CLI

    Install it globally:

    npm install -g teal-interpreter

    Run it from the terminal:

    teal

    Or install in your Node.js project:

    npm install teal-interpreter

    Run it:

    npx teal

    Execute a TEAL file:

    npx teal my-code-file.teal

    Execute and print code coverage:

    npx teal my-code-file.teal --code-coverage

    Use the API

    Install it in your Node.js project:

    npm install teal-interpreter

    Execute TEAL code and print the result:

    import { execute } from "teal-interpreter";
    
    const teal = `
        int 1
        int 2
        +
    `;
    
    const result = execute(teal);
    
    console.log("== STACK ==");
    console.log(result.stack);

    You can configure the state of the interpreter by passing in a config object like this:

    import { execute, ITealInterpreterConfig } from "teal-interpreter";
    
    const config: ITealInterpreterConfig = {
        /* Configuration goes here */
    };
    
    const teal = `/* your TEAL code */`;
    const result = execute(teal, config);

    The configuration allows you to provide values for global and local state and details for transactions, accounts, assets and applications.

    Please see the Configuration documentation to learn more about configuring the TEAL interpreter.

    Development

    See the development guide for instructions on development of the TEAL interpreter.

    Keywords

    none

    Install

    npm i teal-interpreter

    DownloadsWeekly Downloads

    45

    Version

    0.0.39

    License

    MIT

    Unpacked Size

    366 kB

    Total Files

    463

    Last publish

    Collaborators

    • ashleydavis
    • dao-architect