Variable BoxConst

Type declaration

• create: function

  • create(a: bytes, b: uint64): boolean

    create a box named A, of length B. Fail if the name A is empty or B exceeds 32,768. Returns 0 if A already existed, else 1 Newly created boxes are filled with 0 bytes. box_create will fail if the referenced box already exists with a different size. Otherwise, existing boxes are unchanged by box_create.

    Parameters

    • a: bytes
    • b: uint64

    Returns boolean

    See

    Native TEAL opcode: box_create Min AVM version: 8

• delete: function

  • delete(a: bytes): boolean

    delete box named A if it exists. Return 1 if A existed, 0 otherwise

    Parameters

    • a: bytes

    Returns boolean

    See

    Native TEAL opcode: box_del Min AVM version: 8

• extract: function

  • extract(a: bytes, b: uint64, c: uint64): bytes

    read C bytes from box A, starting at offset B. Fail if A does not exist, or the byte range is outside A's size.

    Parameters

    • a: bytes
    • b: uint64
    • c: uint64

    Returns bytes

    See

    Native TEAL opcode: box_extract Min AVM version: 8

• get: function

  • get(a: bytes): readonly [bytes, boolean]

    X is the contents of box A if A exists, else ''. Y is 1 if A exists, else 0. For boxes that exceed 4,096 bytes, consider box_create, box_extract, and box_replace

    Parameters

    • a: bytes

    Returns readonly [bytes, boolean]

    See

    Native TEAL opcode: box_get Min AVM version: 8

• length: function

  • length(a: bytes): readonly [uint64, boolean]

    X is the length of box A if A exists, else 0. Y is 1 if A exists, else 0.

    Parameters

    • a: bytes

    Returns readonly [uint64, boolean]

    See

    Native TEAL opcode: box_len Min AVM version: 8

• put: function

  • put(a: bytes, b: bytes): void

    replaces the contents of box A with byte-array B. Fails if A exists and len(B) != len(box A). Creates A if it does not exist For boxes that exceed 4,096 bytes, consider box_create, box_extract, and box_replace

    Parameters

    • a: bytes
    • b: bytes

    Returns void

    See

    Native TEAL opcode: box_put Min AVM version: 8

• replace: function

  • replace(a: bytes, b: uint64, c: bytes): void

    write byte-array C into box A, starting at offset B. Fail if A does not exist, or the byte range is outside A's size.

    Parameters

    • a: bytes
    • b: uint64
    • c: bytes

    Returns void

    See

    Native TEAL opcode: box_replace Min AVM version: 8

• resize: function

  • resize(a: bytes, b: uint64): void

    change the size of box named A to be of length B, adding zero bytes to end or removing bytes from the end, as needed. Fail if the name A is empty, A is not an existing box, or B exceeds 32,768.

    Parameters

    • a: bytes
    • b: uint64

    Returns void

    See

    Native TEAL opcode: box_resize Min AVM version: 10

• splice: function

  • splice(a: bytes, b: uint64, c: uint64, d: bytes): void

    set box A to contain its previous bytes up to index B, followed by D, followed by the original bytes of A that began at index B+C. Boxes are of constant length. If C < len(D), then len(D)-C bytes will be removed from the end. If C > len(D), zero bytes will be appended to the end to reach the box length.

    Parameters

    • a: bytes
    • b: uint64
    • c: uint64
    • d: bytes

    Returns void

    See

    Native TEAL opcode: box_splice Min AVM version: 10