algopy.op | Algorand Developer Portal

Initialize self. See help(type(self)) for accurate signature.

add

__add__()

Return self+value.

contains

__contains__()

Return bool(key in self).

delattr

__delattr__()

Implement delattr(self, name).

dir

__dir__()

Default dir() implementation.

eq

__eq__()

Return self==value.

format

__format__()

Return a formatted version of the string as described by format_spec.

ge

__ge__()

Return self>=value.

getattribute

__getattribute__()

Return getattr(self, name).

getitem

__getitem__()

Return self[key].

getstate

__getstate__()

Helper for pickle.

gt

__gt__()

Return self>value.

hash

__hash__()

Return hash(self).

iter

__iter__()

Implement iter(self).

le

__le__()

Return self<=value.

len

__len__()

Return len(self).

lt

__lt__()

Return self<value.

mod

__mod__()

Return self%value.

mul

__mul__()

Return self*value.

ne

__ne__()

Return self!=value.

new

__new__()

Create and return a new object. See help(type) for accurate signature.

reduce

__reduce__()

Helper for pickle.

__reduce ex_

__reduceex_()

Helper for pickle.

repr

__repr__()

Return repr(self).

rmod

__rmod__()

Return value%self.

rmul

__rmul__()

Return value*self.

setattr

__setattr__()

Implement setattr(self, name, value).

sizeof

__sizeof__()

Return the size of the string in memory, in bytes.

str

__str__()

Return str(self).

capitalize

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold

casefold()

Return a version of the string suitable for caseless comparisons.

center

center()

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count

count()

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode

encode()

Encode the string using the codec registered for encoding.

encoding The encoding in which to encode the string. errors The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith

endswith()

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs

expandtabs()

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find

find()

S.find(sub[, start[, end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format

format()

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map

format_map()

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index

index()

S.index(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

isalnum

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join

join()

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust

ljust()

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower

lower()

Return a copy of the string converted to lowercase.

lstrip

lstrip()

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

partition

partition()

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix

removeprefix()

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix

removesuffix()

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace

replace()

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind

rfind()

S.rfind(sub[, start[, end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex

rindex()

S.rindex(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

rjust

rjust()

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition

rpartition()

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit

rsplit()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

rstrip()

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split

split()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines

splitlines()

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith

startswith()

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip

strip()

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate

translate()

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via getitem, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper

upper()

Return a copy of the string converted to uppercase.

zfill

Section titled “class algopy.op.Block”

zfill()

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class algopy.op.Block

field F of block A. Fail unless A falls between txn.LastValid-1002 and txn.FirstValid (exclusive) Native TEAL op: block

static blk_bonus

Section titled “static blk_bonus”

* static blk_bonus(a: algopy.UInt64 | int, /) → algopy.UInt64*

Min AVM version: 11

Native TEAL opcode: block

static blk_branch

Section titled “static blk_branch”

* static blk_branch(a: algopy.UInt64 | int, /) → algopy.Bytes*

Min AVM version: 11

Native TEAL opcode: block

static blk_fee_sink

Section titled “static blk_fee_sink”

* static blk_fee_sink(a: algopy.UInt64 | int, /) → algopy.Account*

Min AVM version: 11

Native TEAL opcode: block

static blk_fees_collected

Section titled “static blk_fees_collected”

* static blk_fees_collected(a: algopy.UInt64 | int, /) → algopy.UInt64*

Min AVM version: 11

Native TEAL opcode: block

static blk_proposer

Section titled “static blk_proposer”

* static blk_proposer(a: algopy.UInt64 | int, /) → algopy.Account*

Min AVM version: 11

Native TEAL opcode: block

static blk_proposer_payout

Section titled “static blk_proposer_payout”

* static blk_proposer_payout(a: algopy.UInt64 | int, /) → algopy.UInt64*

Min AVM version: 11

Native TEAL opcode: block

static blk_protocol

Section titled “static blk_protocol”

* static blk_protocol(a: algopy.UInt64 | int, /) → algopy.Bytes*

Min AVM version: 11

Native TEAL opcode: block

static blk_seed

Section titled “static blk_seed”

* static blk_seed(a: algopy.UInt64 | int, /) → algopy.Bytes*

Native TEAL opcode: block

static blk_timestamp

Section titled “static blk_timestamp”

* static blk_timestamp(a: algopy.UInt64 | int, /) → algopy.UInt64*

Native TEAL opcode: block

static blk_txn_counter

Section titled “static blk_txn_counter”

* static blk_txn_counter(a: algopy.UInt64 | int, /) → algopy.UInt64*

Min AVM version: 11

Native TEAL opcode: block

class algopy.op.Box

Section titled “class algopy.op.Box”

Get or modify box state Native TEAL ops: box_create, box_del, box_extract, box_get, box_len, box_put, box_replace, box_resize, box_splice

static create

Section titled “static create”

* static create(a: algopy.Bytes | bytes, b: algopy.UInt64 | int, /) → bool*

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.

Native TEAL opcode: box_create

static delete

Section titled “static delete”

* static delete(a: algopy.Bytes | bytes, /) → bool*

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

Native TEAL opcode: box_del

static extract

Section titled “static extract”

* static extract(a: algopy.Bytes | bytes, b: algopy.UInt64 | int, c: algopy.UInt64 | int, /) → algopy.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.

Native TEAL opcode: box_extract

static get

Section titled “static get”

* static get(a: algopy.Bytes | bytes, /) → tuple[ algopy.Bytes, bool]*

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

Native TEAL opcode: box_get

static length

Section titled “static length”

* static length(a: algopy.Bytes | bytes, /) → tuple[ algopy.UInt64, bool]*

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

Native TEAL opcode: box_len

static put

Section titled “static put”

* static put(a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → None*

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

Native TEAL opcode: box_put

static replace

Section titled “static replace”

* static replace(a: algopy.Bytes | bytes, b: algopy.UInt64 | int, c: algopy.Bytes | bytes, /) → None*

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.

Native TEAL opcode: box_replace

static resize

Section titled “static resize”

* static resize(a: algopy.Bytes | bytes, b: algopy.UInt64 | int, /) → None*

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.

Native TEAL opcode: box_resize

static splice

Section titled “static splice”

* static splice(a: algopy.Bytes | bytes, b: algopy.UInt64 | int, c: algopy.UInt64 | int, d: algopy.Bytes | bytes, /) → None*

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.

Native TEAL opcode: box_splice

class algopy.op.EC

Section titled “class algopy.op.EC”

Available values for the EC enum

Initialization

Section titled “BLS12_381g1 *: [algopy.op.EC]”

Initialize self. See help(type(self)) for accurate signature.

BLS12_381g1 *: [algopy.op.EC]

_BLS12_381g1 _: algopy.op.EC**

Ellipsis

G1 of the BLS 12-381 curve. Points encoded as 48 byte X following by 48 byte Y

BLS12_381g2 *: [algopy.op.EC]

Section titled “BLS12_381g2 *: [algopy.op.EC]”

_BLS12_381g2 _: algopy.op.EC**

Ellipsis

G2 of the BLS 12-381 curve. Points encoded as 96 byte X following by 96 byte Y

BN254g1 *: [algopy.op.EC]

Section titled “BN254g1 *: [algopy.op.EC]”

_BN254g1 _: algopy.op.EC**

Ellipsis

G1 of the BN254 curve. Points encoded as 32 byte X following by 32 byte Y

BN254g2 *: [algopy.op.EC]

Section titled “BN254g2 *: [algopy.op.EC]”

_BN254g2 _: algopy.op.EC**

Ellipsis

G2 of the BN254 curve. Points encoded as 64 byte X following by 64 byte Y

add

__add__()

Return self+value.

contains

__contains__()

Return bool(key in self).

delattr

__delattr__()

Implement delattr(self, name).

dir

__dir__()

Default dir() implementation.

eq

__eq__()

Return self==value.

format

__format__()

Return a formatted version of the string as described by format_spec.

ge

__ge__()

Return self>=value.

getattribute

__getattribute__()

Return getattr(self, name).

getitem

__getitem__()

Return self[key].

getstate

__getstate__()

Helper for pickle.

gt

__gt__()

Return self>value.

hash

__hash__()

Return hash(self).

iter

__iter__()

Implement iter(self).

le

__le__()

Return self<=value.

len

__len__()

Return len(self).

lt

__lt__()

Return self<value.

mod

__mod__()

Return self%value.

mul

__mul__()

Return self*value.

ne

__ne__()

Return self!=value.

new

__new__()

Create and return a new object. See help(type) for accurate signature.

reduce

__reduce__()

Helper for pickle.

__reduce ex_

__reduceex_()

Helper for pickle.

repr

__repr__()

Return repr(self).

rmod

__rmod__()

Return value%self.

rmul

__rmul__()

Return value*self.

setattr

__setattr__()

Implement setattr(self, name, value).

sizeof

__sizeof__()

Return the size of the string in memory, in bytes.

str

__str__()

Return str(self).

capitalize

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold

casefold()

Return a version of the string suitable for caseless comparisons.

center

center()

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count

count()

S.count(sub[, start[, end]]) -> int

encode

encode()

Encode the string using the codec registered for encoding.

endswith

endswith()

S.endswith(suffix[, start[, end]]) -> bool

expandtabs

expandtabs()

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find

find()

S.find(sub[, start[, end]]) -> int

Return -1 on failure.

format

format()

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map

format_map()

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index

index()

S.index(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

isalnum

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join

join()

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust

ljust()

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower

lower()

Return a copy of the string converted to lowercase.

lstrip

lstrip()

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

partition

partition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix

removeprefix()

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix

removesuffix()

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace

replace()

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind

rfind()

S.rfind(sub[, start[, end]]) -> int

Return -1 on failure.

rindex

rindex()

S.rindex(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

rjust

rjust()

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition

rpartition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit

rsplit()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

rstrip()

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split

split()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

splitlines

splitlines()

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith

startswith()

S.startswith(prefix[, start[, end]]) -> bool

strip

strip()

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate

translate()

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

upper

upper()

Return a copy of the string converted to uppercase.

zfill

Section titled “class algopy.op.ECDSA”

zfill()

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class algopy.op.ECDSA

Available values for the ECDSA enum

Initialization

Section titled “Secp256k1 *: [algopy.op.ECDSA]”

Initialize self. See help(type(self)) for accurate signature.

Secp256k1 *: [algopy.op.ECDSA]

_Secp256k1 _: algopy.op.ECDSA**

Ellipsis

secp256k1 curve, used in Bitcoin

Secp256r1 *: [algopy.op.ECDSA]

Section titled “Secp256r1 *: [algopy.op.ECDSA]”

_Secp256r1 _: algopy.op.ECDSA**

Ellipsis

secp256r1 curve, NIST standard

add

__add__()

Return self+value.

contains

__contains__()

Return bool(key in self).

delattr

__delattr__()

Implement delattr(self, name).

dir

__dir__()

Default dir() implementation.

eq

__eq__()

Return self==value.

format

__format__()

Return a formatted version of the string as described by format_spec.

ge

__ge__()

Return self>=value.

getattribute

__getattribute__()

Return getattr(self, name).

getitem

__getitem__()

Return self[key].

getstate

__getstate__()

Helper for pickle.

gt

__gt__()

Return self>value.

hash

__hash__()

Return hash(self).

iter

__iter__()

Implement iter(self).

le

__le__()

Return self<=value.

len

__len__()

Return len(self).

lt

__lt__()

Return self<value.

mod

__mod__()

Return self%value.

mul

__mul__()

Return self*value.

ne

__ne__()

Return self!=value.

new

__new__()

Create and return a new object. See help(type) for accurate signature.

reduce

__reduce__()

Helper for pickle.

__reduce ex_

__reduceex_()

Helper for pickle.

repr

__repr__()

Return repr(self).

rmod

__rmod__()

Return value%self.

rmul

__rmul__()

Return value*self.

setattr

__setattr__()

Implement setattr(self, name, value).

sizeof

__sizeof__()

Return the size of the string in memory, in bytes.

str

__str__()

Return str(self).

capitalize

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold

casefold()

Return a version of the string suitable for caseless comparisons.

center

center()

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count

count()

S.count(sub[, start[, end]]) -> int

encode

encode()

Encode the string using the codec registered for encoding.

endswith

endswith()

S.endswith(suffix[, start[, end]]) -> bool

expandtabs

expandtabs()

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find

find()

S.find(sub[, start[, end]]) -> int

Return -1 on failure.

format

format()

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map

format_map()

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index

index()

S.index(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

isalnum

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join

join()

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust

ljust()

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower

lower()

Return a copy of the string converted to lowercase.

lstrip

lstrip()

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

partition

partition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix

removeprefix()

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix

removesuffix()

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace

replace()

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind

rfind()

S.rfind(sub[, start[, end]]) -> int

Return -1 on failure.

rindex

rindex()

S.rindex(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

rjust

rjust()

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition

rpartition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit

rsplit()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

rstrip()

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split

split()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

splitlines

splitlines()

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith

startswith()

S.startswith(prefix[, start[, end]]) -> bool

strip

strip()

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate

translate()

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

upper

upper()

Return a copy of the string converted to uppercase.

zfill

Section titled “class algopy.op.EllipticCurve”

zfill()

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class algopy.op.EllipticCurve

Elliptic Curve functions Native TEAL ops: ec_add, ec_map_to, ec_multi_scalar_mul, ec_pairing_check, ec_scalar_mul, ec_subgroup_check

static add

Section titled “static add”

* static add(g: algopy.op.EC, a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.Bytes*

for curve points A and B, return the curve point A + B A and B are curve points in affine representation: field element X concatenated with field element Y. Field element Z is encoded as follows. For the base field elements (Fp), Z is encoded as a big-endian number and must be lower than the field modulus. For the quadratic field extension (Fp2), Z is encoded as the concatenation of the individual encoding of the coefficients. For an Fp2 element of the form Z = Z0 + Z1 i, where i is a formal quadratic non-residue, the encoding of Z is the concatenation of the encoding of Z0 and Z1 in this order. (Z0 and Z1 must be less than the field modulus).

The point at infinity is encoded as (X,Y) = (0,0). Groups G1 and G2 are denoted additively.

Fails if A or B is not in G. A and/or B are allowed to be the point at infinity. Does not check if A and B are in the main prime-order subgroup.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_add

static map_to

Section titled “static map_to”

* static map_to(g: algopy.op.EC, a: algopy.Bytes | bytes, /) → algopy.Bytes*

maps field element A to group G BN254 points are mapped by the SVDW map. BLS12-381 points are mapped by the SSWU map. G1 element inputs are base field elements and G2 element inputs are quadratic field elements, with nearly the same encoding rules (for field elements) as defined in ec_add. There is one difference of encoding rule: G1 element inputs do not need to be 0-padded if they fit in less than 32 bytes for BN254 and less than 48 bytes for BLS12-381. (As usual, the empty byte array represents 0.) G2 elements inputs need to be always have the required size.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_map_to

static pairing_check

Section titled “static pairing_check”

* static pairing_check(g: algopy.op.EC, a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → bool*

1 if the product of the pairing of each point in A with its respective point in B is equal to the identity element of the target group Gt, else 0 A and B are concatenated points, encoded and checked as described in ec_add. A contains points of the group G, B contains points of the associated group (G2 if G is G1, and vice versa). Fails if A and B have a different number of points, or if any point is not in its described group or outside the main prime-order subgroup - a stronger condition than other opcodes. AVM values are limited to 4096 bytes, so ec_pairing_check is limited by the size of the points in the groups being operated upon.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_pairing_check

static scalar_mul

Section titled “static scalar_mul”

* static scalar_mul(g: algopy.op.EC, a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.Bytes*

for curve point A and scalar B, return the curve point BA, the point A multiplied by the scalar B. A is a curve point encoded and checked as described in ec_add. Scalar B is interpreted as a big-endian unsigned integer. Fails if B exceeds 32 bytes.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_scalar_mul

static scalar_mul_multi

Section titled “static scalar_mul_multi”

* static scalar_mul_multi(g: algopy.op.EC, a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.Bytes*

for curve points A and scalars B, return curve point B0A0 + B1A1 + B2A2 + … + BnAn A is a list of concatenated points, encoded and checked as described in ec_add. B is a list of concatenated scalars which, unlike ec_scalar_mul, must all be exactly 32 bytes long. The name ec_multi_scalar_mul was chosen to reflect common usage, but a more consistent name would be ec_multi_scalar_mul. AVM values are limited to 4096 bytes, so ec_multi_scalar_mul is limited by the size of the points in the group being operated upon.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_multi_scalar_mul

static subgroup_check

Section titled “static subgroup_check”

* static subgroup_check(g: algopy.op.EC, a: algopy.Bytes | bytes, /) → bool*

1 if A is in the main prime-order subgroup of G (including the point at infinity) else 0. Program fails if A is not in G at all.

Parameters: g ( EC) – curve index

Native TEAL opcode: ec_subgroup_check

class algopy.op.GITxn

Section titled “class algopy.op.GITxn”

Get values for inner transaction in the last group submitted Native TEAL ops: gitxn, gitxnas

static accounts

Section titled “static amount”

* static accounts(t: int, a: algopy.UInt64 | int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: Accounts listed in the ApplicationCall transaction

Native TEAL opcode: gitxna, gitxnas

static amount

* static amount(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: microalgos

Native TEAL opcode: gitxn

static application_args

Section titled “static application_id”

* static application_args(t: int, a: algopy.UInt64 | int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Arguments passed to the application in the ApplicationCall transaction

static application_id

* static application_id(t: int, /) → algopy.Application*

Parameters: t ( int) – transaction group index
Returns Application: ApplicationID from ApplicationCall transaction

Native TEAL opcode: gitxn

static applications

Section titled “static approval_program”

* static applications(t: int, a: algopy.UInt64 | int, /) → algopy.Application*

Parameters: t ( int) – transaction group index
Returns Application: Foreign Apps listed in the ApplicationCall transaction

static approval_program

* static approval_program(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Approval program

Native TEAL opcode: gitxn

static approval_program_pages

Section titled “static asset_amount”

* static approval_program_pages(t: int, a: algopy.UInt64 | int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Approval Program as an array of pages

static asset_amount

* static asset_amount(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: value in Asset’s units

Native TEAL opcode: gitxn

static asset_close_to

Section titled “static asset_close_to”

* static asset_close_to(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static asset_receiver

Section titled “static asset_receiver”

* static asset_receiver(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static asset_sender

Section titled “static asset_sender”

* static asset_sender(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address. Source of assets if Sender is the Asset’s Clawback address.

Native TEAL opcode: gitxn

static assets

Section titled “static clear_state_program”

* static assets(t: int, a: algopy.UInt64 | int, /) → algopy.Asset*

Parameters: t ( int) – transaction group index
Returns Asset: Foreign Assets listed in the ApplicationCall transaction

static clear_state_program

* static clear_state_program(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Clear state program

Native TEAL opcode: gitxn

static clear_state_program_pages

Section titled “static close_remainder_to”

* static clear_state_program_pages(t: int, a: algopy.UInt64 | int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: ClearState Program as an array of pages

static close_remainder_to

* static close_remainder_to(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static config_asset

Section titled “static config_asset”

* static config_asset(t: int, /) → algopy.Asset*

Parameters: t ( int) – transaction group index
Returns Asset: Asset ID in asset config transaction

Native TEAL opcode: gitxn

static config_asset_clawback

Section titled “static config_asset_clawback”

* static config_asset_clawback(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static config_asset_decimals

Section titled “static config_asset_decimals”

* static config_asset_decimals(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of digits to display after the decimal place when displaying the asset

Native TEAL opcode: gitxn

static config_asset_default_frozen

Section titled “static config_asset_default_frozen”

* static config_asset_default_frozen(t: int, /) → bool*

Parameters: t ( int) – transaction group index
Returns bool: Whether the asset’s slots are frozen by default or not, 0 or 1

Native TEAL opcode: gitxn

static config_asset_freeze

Section titled “static config_asset_freeze”

* static config_asset_freeze(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static config_asset_manager

Section titled “static config_asset_manager”

* static config_asset_manager(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static config_asset_metadata_hash

Section titled “static config_asset_metadata_hash”

* static config_asset_metadata_hash(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: 32 byte commitment to unspecified asset metadata

Native TEAL opcode: gitxn

static config_asset_name

Section titled “static config_asset_name”

* static config_asset_name(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: The asset name

Native TEAL opcode: gitxn

static config_asset_reserve

Section titled “static config_asset_reserve”

* static config_asset_reserve(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static config_asset_total

Section titled “static config_asset_total”

* static config_asset_total(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Total number of units of this asset created

Native TEAL opcode: gitxn

static config_asset_unit_name

Section titled “static config_asset_unit_name”

* static config_asset_unit_name(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Unit name of the asset

Native TEAL opcode: gitxn

static config_asset_url

Section titled “static config_asset_url”

* static config_asset_url(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: URL

Native TEAL opcode: gitxn

static created_application_id

Section titled “static created_application_id”

* static created_application_id(t: int, /) → algopy.Application*

Parameters: t ( int) – transaction group index
Returns Application: ApplicationID allocated by the creation of an application (only with itxn in v5). Application mode only

Native TEAL opcode: gitxn

static created_asset_id

Section titled “static created_asset_id”

* static created_asset_id(t: int, /) → algopy.Asset*

Parameters: t ( int) – transaction group index
Returns Asset: Asset ID allocated by the creation of an ASA (only with itxn in v5). Application mode only

Native TEAL opcode: gitxn

static extra_program_pages

Section titled “static extra_program_pages”

* static extra_program_pages(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

Native TEAL opcode: gitxn

static fee

Section titled “static fee”

* static fee(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: microalgos

Native TEAL opcode: gitxn

static first_valid

Section titled “static first_valid”

* static first_valid(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: round number

Native TEAL opcode: gitxn

static first_valid_time

Section titled “static first_valid_time”

* static first_valid_time(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: UNIX timestamp of block before txn.FirstValid. Fails if negative

Native TEAL opcode: gitxn

static freeze_asset

Section titled “static freeze_asset”

* static freeze_asset(t: int, /) → algopy.Asset*

Parameters: t ( int) – transaction group index
Returns Asset: Asset ID being frozen or un-frozen

Native TEAL opcode: gitxn

static freeze_asset_account

Section titled “static freeze_asset_account”

* static freeze_asset_account(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address of the account whose asset slot is being frozen or un-frozen

Native TEAL opcode: gitxn

static freeze_asset_frozen

Section titled “static freeze_asset_frozen”

* static freeze_asset_frozen(t: int, /) → bool*

Parameters: t ( int) – transaction group index
Returns bool: The new frozen value, 0 or 1

Native TEAL opcode: gitxn

static global_num_byte_slice

Section titled “static global_num_byte_slice”

* static global_num_byte_slice(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of global state byteslices in ApplicationCall

Native TEAL opcode: gitxn

static global_num_uint

Section titled “static global_num_uint”

* static global_num_uint(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of global state integers in ApplicationCall

Native TEAL opcode: gitxn

static group_index

Section titled “static group_index”

* static group_index(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

Native TEAL opcode: gitxn

static last_log

Section titled “static last_log”

* static last_log(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: The last message emitted. Empty bytes if none were emitted. Application mode only

Native TEAL opcode: gitxn

static last_valid

Section titled “static last_valid”

* static last_valid(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: round number

Native TEAL opcode: gitxn

static lease

Section titled “static lease”

* static lease(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: 32 byte lease value

Native TEAL opcode: gitxn

static local_num_byte_slice

Section titled “static local_num_byte_slice”

* static local_num_byte_slice(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of local state byteslices in ApplicationCall

Native TEAL opcode: gitxn

static local_num_uint

Section titled “static local_num_uint”

* static local_num_uint(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of local state integers in ApplicationCall

Native TEAL opcode: gitxn

static logs

Section titled “static nonparticipation”

* static logs(t: int, a: algopy.UInt64 | int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Log messages emitted by an application call (only with itxn in v5). Application mode only

static nonparticipation

* static nonparticipation(t: int, /) → bool*

Parameters: t ( int) – transaction group index
Returns bool: Marks an account nonparticipating for rewards

Native TEAL opcode: gitxn

static note

Section titled “static note”

* static note(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Any data up to 1024 bytes

Native TEAL opcode: gitxn

static num_accounts

Section titled “static num_accounts”

* static num_accounts(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of Accounts

Native TEAL opcode: gitxn

static num_app_args

Section titled “static num_app_args”

* static num_app_args(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of ApplicationArgs

Native TEAL opcode: gitxn

static num_applications

Section titled “static num_applications”

* static num_applications(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of Applications

Native TEAL opcode: gitxn

static num_approval_program_pages

Section titled “static num_approval_program_pages”

* static num_approval_program_pages(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of Approval Program pages

Native TEAL opcode: gitxn

static num_assets

Section titled “static num_assets”

* static num_assets(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of Assets

Native TEAL opcode: gitxn

static num_clear_state_program_pages

Section titled “static num_clear_state_program_pages”

* static num_clear_state_program_pages(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of ClearState Program pages

Native TEAL opcode: gitxn

static num_logs

Section titled “static num_logs”

* static num_logs(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Number of Logs (only with itxn in v5). Application mode only

Native TEAL opcode: gitxn

static on_completion

Section titled “static on_completion”

* static on_completion(t: int, /) → algopy.OnCompleteAction*

Parameters: t ( int) – transaction group index
Returns OnCompleteAction: ApplicationCall transaction on completion action

Native TEAL opcode: gitxn

static receiver

Section titled “static receiver”

* static receiver(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static reject_version

Section titled “static reject_version”

* static reject_version(t: int, /) → algopy.UInt64*

Min AVM version: 12

Parameters: t ( int) – transaction group index
Returns UInt64: Application version for which the txn must reject

Native TEAL opcode: gitxn

static rekey_to

Section titled “static rekey_to”

* static rekey_to(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte Sender’s new AuthAddr

Native TEAL opcode: gitxn

static selection_pk

Section titled “static selection_pk”

* static selection_pk(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: 32 byte address

Native TEAL opcode: gitxn

static sender

Section titled “static sender”

* static sender(t: int, /) → algopy.Account*

Parameters: t ( int) – transaction group index
Returns Account: 32 byte address

Native TEAL opcode: gitxn

static state_proof_pk

Section titled “static state_proof_pk”

* static state_proof_pk(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: State proof public key

Native TEAL opcode: gitxn

static tx_id

Section titled “static tx_id”

* static tx_id(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: The computed ID for this transaction. 32 bytes.

Native TEAL opcode: gitxn

static type

Section titled “static type”

* static type(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: Transaction type as bytes

Native TEAL opcode: gitxn

static type_enum

Section titled “static type_enum”

* static type_enum(t: int, /) → algopy.TransactionType*

Parameters: t ( int) – transaction group index
Returns TransactionType: Transaction type as integer

Native TEAL opcode: gitxn

static vote_first

Section titled “static vote_first”

* static vote_first(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: The first round that the participation key is valid.

Native TEAL opcode: gitxn

static vote_key_dilution

Section titled “static vote_key_dilution”

* static vote_key_dilution(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: Dilution for the 2-level participation key

Native TEAL opcode: gitxn

static vote_last

Section titled “static vote_last”

* static vote_last(t: int, /) → algopy.UInt64*

Parameters: t ( int) – transaction group index
Returns UInt64: The last round that the participation key is valid.

Native TEAL opcode: gitxn

static vote_pk

Section titled “static vote_pk”

* static vote_pk(t: int, /) → algopy.Bytes*

Parameters: t ( int) – transaction group index
Returns Bytes: 32 byte address

Native TEAL opcode: gitxn

static xfer_asset

Section titled “static xfer_asset”

* static xfer_asset(t: int, /) → algopy.Asset*

Parameters: t ( int) – transaction group index
Returns Asset: Asset ID

Native TEAL opcode: gitxn

class algopy.op.GTxn

Section titled “class algopy.op.GTxn”

Get values for transactions in the current group Native TEAL ops: gtxns, gtxnsas

static accounts

Section titled “static amount”

* static accounts(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Account*

Accounts listed in the ApplicationCall transaction

Native TEAL opcode: gtxna, gtxnas, gtxnsa, gtxnsas

static amount

* static amount(a: algopy.UInt64 | int, /) → algopy.UInt64*

microalgos

Native TEAL opcode: gtxn, gtxns

static application_args

Section titled “static application_id”

* static application_args(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Bytes*

Arguments passed to the application in the ApplicationCall transaction

static application_id

* static application_id(a: algopy.UInt64 | int, /) → algopy.Application*

ApplicationID from ApplicationCall transaction

static applications

Section titled “static approval_program”

* static applications(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Application*

Foreign Apps listed in the ApplicationCall transaction

static approval_program

* static approval_program(a: algopy.UInt64 | int, /) → algopy.Bytes*

Approval program

static approval_program_pages

Section titled “static asset_amount”

* static approval_program_pages(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Bytes*

Approval Program as an array of pages

static asset_amount

* static asset_amount(a: algopy.UInt64 | int, /) → algopy.UInt64*

value in Asset’s units

static asset_close_to

Section titled “static asset_close_to”

* static asset_close_to(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static asset_receiver

Section titled “static asset_receiver”

* static asset_receiver(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static asset_sender

Section titled “static asset_sender”

* static asset_sender(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address. Source of assets if Sender is the Asset’s Clawback address.

static assets

Section titled “static clear_state_program”

* static assets(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Asset*

Foreign Assets listed in the ApplicationCall transaction

static clear_state_program

* static clear_state_program(a: algopy.UInt64 | int, /) → algopy.Bytes*

Clear state program

static clear_state_program_pages

Section titled “static close_remainder_to”

* static clear_state_program_pages(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Bytes*

ClearState Program as an array of pages

static close_remainder_to

* static close_remainder_to(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static config_asset

Section titled “static config_asset”

* static config_asset(a: algopy.UInt64 | int, /) → algopy.Asset*

Asset ID in asset config transaction

static config_asset_clawback

Section titled “static config_asset_clawback”

* static config_asset_clawback(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static config_asset_decimals

Section titled “static config_asset_decimals”

* static config_asset_decimals(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of digits to display after the decimal place when displaying the asset

static config_asset_default_frozen

Section titled “static config_asset_default_frozen”

* static config_asset_default_frozen(a: algopy.UInt64 | int, /) → bool*

Whether the asset’s slots are frozen by default or not, 0 or 1

static config_asset_freeze

Section titled “static config_asset_freeze”

* static config_asset_freeze(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static config_asset_manager

Section titled “static config_asset_manager”

* static config_asset_manager(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static config_asset_metadata_hash

Section titled “static config_asset_metadata_hash”

* static config_asset_metadata_hash(a: algopy.UInt64 | int, /) → algopy.Bytes*

32 byte commitment to unspecified asset metadata

static config_asset_name

Section titled “static config_asset_name”

* static config_asset_name(a: algopy.UInt64 | int, /) → algopy.Bytes*

The asset name

static config_asset_reserve

Section titled “static config_asset_reserve”

* static config_asset_reserve(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static config_asset_total

Section titled “static config_asset_total”

* static config_asset_total(a: algopy.UInt64 | int, /) → algopy.UInt64*

Total number of units of this asset created

static config_asset_unit_name

Section titled “static config_asset_unit_name”

* static config_asset_unit_name(a: algopy.UInt64 | int, /) → algopy.Bytes*

Unit name of the asset

static config_asset_url

Section titled “static config_asset_url”

* static config_asset_url(a: algopy.UInt64 | int, /) → algopy.Bytes*

URL

static created_application_id

Section titled “static created_application_id”

* static created_application_id(a: algopy.UInt64 | int, /) → algopy.Application*

ApplicationID allocated by the creation of an application (only with itxn in v5). Application mode only

static created_asset_id

Section titled “static created_asset_id”

* static created_asset_id(a: algopy.UInt64 | int, /) → algopy.Asset*

Asset ID allocated by the creation of an ASA (only with itxn in v5). Application mode only

static extra_program_pages

Section titled “static extra_program_pages”

* static extra_program_pages(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

static fee

Section titled “static fee”

* static fee(a: algopy.UInt64 | int, /) → algopy.UInt64*

microalgos

static first_valid

Section titled “static first_valid”

* static first_valid(a: algopy.UInt64 | int, /) → algopy.UInt64*

round number

static first_valid_time

Section titled “static first_valid_time”

* static first_valid_time(a: algopy.UInt64 | int, /) → algopy.UInt64*

UNIX timestamp of block before txn.FirstValid. Fails if negative

static freeze_asset

Section titled “static freeze_asset”

* static freeze_asset(a: algopy.UInt64 | int, /) → algopy.Asset*

Asset ID being frozen or un-frozen

static freeze_asset_account

Section titled “static freeze_asset_account”

* static freeze_asset_account(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address of the account whose asset slot is being frozen or un-frozen

static freeze_asset_frozen

Section titled “static freeze_asset_frozen”

* static freeze_asset_frozen(a: algopy.UInt64 | int, /) → bool*

The new frozen value, 0 or 1

static global_num_byte_slice

Section titled “static global_num_byte_slice”

* static global_num_byte_slice(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of global state byteslices in ApplicationCall

static global_num_uint

Section titled “static global_num_uint”

* static global_num_uint(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of global state integers in ApplicationCall

static group_index

Section titled “static group_index”

* static group_index(a: algopy.UInt64 | int, /) → algopy.UInt64*

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

static last_log

Section titled “static last_log”

* static last_log(a: algopy.UInt64 | int, /) → algopy.Bytes*

The last message emitted. Empty bytes if none were emitted. Application mode only

static last_valid

Section titled “static last_valid”

* static last_valid(a: algopy.UInt64 | int, /) → algopy.UInt64*

round number

static lease

Section titled “static lease”

* static lease(a: algopy.UInt64 | int, /) → algopy.Bytes*

32 byte lease value

static local_num_byte_slice

Section titled “static local_num_byte_slice”

* static local_num_byte_slice(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of local state byteslices in ApplicationCall

static local_num_uint

Section titled “static local_num_uint”

* static local_num_uint(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of local state integers in ApplicationCall

static logs

Section titled “static nonparticipation”

* static logs(a: algopy.UInt64 | int, b: algopy.UInt64 | int, /) → algopy.Bytes*

Log messages emitted by an application call (only with itxn in v5). Application mode only

static nonparticipation

* static nonparticipation(a: algopy.UInt64 | int, /) → bool*

Marks an account nonparticipating for rewards

static note

Section titled “static note”

* static note(a: algopy.UInt64 | int, /) → algopy.Bytes*

Any data up to 1024 bytes

static num_accounts

Section titled “static num_accounts”

* static num_accounts(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of Accounts

static num_app_args

Section titled “static num_app_args”

* static num_app_args(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of ApplicationArgs

static num_applications

Section titled “static num_applications”

* static num_applications(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of Applications

static num_approval_program_pages

Section titled “static num_approval_program_pages”

* static num_approval_program_pages(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of Approval Program pages

static num_assets

Section titled “static num_assets”

* static num_assets(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of Assets

static num_clear_state_program_pages

Section titled “static num_clear_state_program_pages”

* static num_clear_state_program_pages(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of ClearState Program pages

static num_logs

Section titled “static num_logs”

* static num_logs(a: algopy.UInt64 | int, /) → algopy.UInt64*

Number of Logs (only with itxn in v5). Application mode only

static on_completion

Section titled “static on_completion”

* static on_completion(a: algopy.UInt64 | int, /) → algopy.OnCompleteAction*

ApplicationCall transaction on completion action

static receiver

Section titled “static receiver”

* static receiver(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static reject_version

Section titled “static reject_version”

* static reject_version(a: algopy.UInt64 | int, /) → algopy.UInt64*

Min AVM version: 12

Returns UInt64: Application version for which the txn must reject

static rekey_to

Section titled “static rekey_to”

* static rekey_to(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte Sender’s new AuthAddr

static selection_pk

Section titled “static selection_pk”

* static selection_pk(a: algopy.UInt64 | int, /) → algopy.Bytes*

32 byte address

static sender

Section titled “static sender”

* static sender(a: algopy.UInt64 | int, /) → algopy.Account*

32 byte address

static state_proof_pk

Section titled “static state_proof_pk”

* static state_proof_pk(a: algopy.UInt64 | int, /) → algopy.Bytes*

State proof public key

static tx_id

Section titled “static tx_id”

* static tx_id(a: algopy.UInt64 | int, /) → algopy.Bytes*

The computed ID for this transaction. 32 bytes.

static type

Section titled “static type”

* static type(a: algopy.UInt64 | int, /) → algopy.Bytes*

Transaction type as bytes

static type_enum

Section titled “static type_enum”

* static type_enum(a: algopy.UInt64 | int, /) → algopy.TransactionType*

Transaction type as integer

static vote_first

Section titled “static vote_first”

* static vote_first(a: algopy.UInt64 | int, /) → algopy.UInt64*

The first round that the participation key is valid.

static vote_key_dilution

Section titled “static vote_key_dilution”

* static vote_key_dilution(a: algopy.UInt64 | int, /) → algopy.UInt64*

Dilution for the 2-level participation key

static vote_last

Section titled “static vote_last”

* static vote_last(a: algopy.UInt64 | int, /) → algopy.UInt64*

The last round that the participation key is valid.

static vote_pk

Section titled “static vote_pk”

* static vote_pk(a: algopy.UInt64 | int, /) → algopy.Bytes*

32 byte address

static xfer_asset

Section titled “static xfer_asset”

* static xfer_asset(a: algopy.UInt64 | int, /) → algopy.Asset*

Asset ID

class algopy.op.Global

Section titled “class algopy.op.Global”

Get Global values Native TEAL op: global

asset_create_min_balance *: [Final]

Section titled “asset_create_min_balance *: [Final]”

_asset_create_min_balance _: Final[ algopy.UInt64]**

Ellipsis

The additional minimum balance required to create (and opt-in to) an asset.

asset_opt_in_min_balance *: [Final]

Section titled “asset_opt_in_min_balance *: [Final]”

_asset_opt_in_min_balance _: Final[ algopy.UInt64]**

Ellipsis

The additional minimum balance required to opt-in to an asset.

caller_application_address *: [Final]

Section titled “caller_application_address *: [Final]”

_caller_application_address _: Final[ algopy.Account]**

Ellipsis

The application address of the application that called this application. ZeroAddress if this application is at the top-level. Application mode only.

caller_application_id *: [Final]

Section titled “caller_application_id *: [Final]”

_caller_application_id _: Final[ algopy.UInt64]**

Ellipsis

The application ID of the application that called this application. 0 if this application is at the top-level. Application mode only.

creator_address *: [Final]

Section titled “creator_address *: [Final]”

_creator_address _: Final[ algopy.Account]**

Ellipsis

Address of the creator of the current application. Application mode only.

current_application_address *: [Final]

Section titled “current_application_address *: [Final]”

_current_application_address _: Final[ algopy.Account]**

Ellipsis

Address that the current application controls. Application mode only.

current_application_id *: [Final]

Section titled “current_application_id *: [Final]”

_current_application_id _: Final[ algopy.Application]**

Ellipsis

ID of current application executing. Application mode only.

genesis_hash *: [Final]

Section titled “genesis_hash *: [Final]”

_genesis_hash _: Final[ algopy.Bytes]**

Ellipsis

The Genesis Hash for the network.

group_id *: [Final]

Section titled “group_id *: [Final]”

_group_id _: Final[ algopy.Bytes]**

Ellipsis

ID of the transaction group. 32 zero bytes if the transaction is not part of a group.

group_size *: [Final]

Section titled “group_size *: [Final]”

_group_size _: Final[ algopy.UInt64]**

Ellipsis

Number of transactions in this atomic transaction group. At least 1

latest_timestamp *: [Final]

Section titled “latest_timestamp *: [Final]”

_latest_timestamp _: Final[ algopy.UInt64]**

Ellipsis

Last confirmed block UNIX timestamp. Fails if negative. Application mode only.

logic_sig_version *: [Final]

Section titled “logic_sig_version *: [Final]”

_logic_sig_version _: Final[ algopy.UInt64]**

Ellipsis

Maximum supported version

max_txn_life *: [Final]

Section titled “max_txn_life *: [Final]”

_max_txn_life _: Final[ algopy.UInt64]**

Ellipsis

rounds

min_balance *: [Final]

Section titled “min_balance *: [Final]”

_min_balance _: Final[ algopy.UInt64]**

Ellipsis

microalgos

min_txn_fee *: [Final]

Section titled “min_txn_fee *: [Final]”

_min_txn_fee _: Final[ algopy.UInt64]**

Ellipsis

microalgos

static opcode_budget

Section titled “static opcode_budget”

* static opcode_budget() → algopy.UInt64*

The remaining cost that can be spent by opcodes in this program.

Native TEAL opcode: global

payouts_enabled *: [Final]

Section titled “payouts_enabled *: [Final]”

_payouts_enabled _: Final[ bool]**

Ellipsis

Whether block proposal payouts are enabled. Min AVM version: 11

payouts_go_online_fee *: [Final]

Section titled “payouts_go_online_fee *: [Final]”

_payouts_go_online_fee _: Final[ algopy.UInt64]**

Ellipsis

The fee required in a keyreg transaction to make an account incentive eligible. Min AVM version: 11

payouts_max_balance *: [Final]

Section titled “payouts_max_balance *: [Final]”

_payouts_max_balance _: Final[ algopy.UInt64]**

Ellipsis

The maximum balance an account can have in the agreement round to receive block payouts in the proposal round. Min AVM version: 11

payouts_min_balance *: [Final]

Section titled “payouts_min_balance *: [Final]”

_payouts_min_balance _: Final[ algopy.UInt64]**

Ellipsis

The minimum balance an account must have in the agreement round to receive block payouts in the proposal round. Min AVM version: 11

payouts_percent *: [Final]

Section titled “payouts_percent *: [Final]”

_payouts_percent _: Final[ algopy.UInt64]**

Ellipsis

The percentage of transaction fees in a block that can be paid to the block proposer. Min AVM version: 11

round *: [Final]

Section titled “round *: [Final]”

_round _: Final[ algopy.UInt64]**

Ellipsis

Current round number. Application mode only.

zero_address *: [Final]

Section titled “zero_address *: [Final]”

_zero_address _: Final[ algopy.Account]**

Ellipsis

32 byte address of all zero bytes

class algopy.op.ITxn

Section titled “class algopy.op.ITxn”

Get values for the last inner transaction Native TEAL ops: itxn, itxnas

static accounts

Section titled “static amount”

* static accounts(a: algopy.UInt64 | int, /) → algopy.Account*

Accounts listed in the ApplicationCall transaction

Native TEAL opcode: itxna, itxnas

static amount

* static amount() → algopy.UInt64*

microalgos

Native TEAL opcode: itxn

static application_args

Section titled “static application_id”

* static application_args(a: algopy.UInt64 | int, /) → algopy.Bytes*

Arguments passed to the application in the ApplicationCall transaction

static application_id

* static application_id() → algopy.Application*

ApplicationID from ApplicationCall transaction

Native TEAL opcode: itxn

static applications

Section titled “static approval_program”

* static applications(a: algopy.UInt64 | int, /) → algopy.Application*

Foreign Apps listed in the ApplicationCall transaction

static approval_program

* static approval_program() → algopy.Bytes*

Approval program

Native TEAL opcode: itxn

static approval_program_pages

Section titled “static asset_amount”

* static approval_program_pages(a: algopy.UInt64 | int, /) → algopy.Bytes*

Approval Program as an array of pages

static asset_amount

* static asset_amount() → algopy.UInt64*

value in Asset’s units

Native TEAL opcode: itxn

static asset_close_to

Section titled “static asset_close_to”

* static asset_close_to() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static asset_receiver

Section titled “static asset_receiver”

* static asset_receiver() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static asset_sender

Section titled “static asset_sender”

* static asset_sender() → algopy.Account*

32 byte address. Source of assets if Sender is the Asset’s Clawback address.

Native TEAL opcode: itxn

static assets

Section titled “static clear_state_program”

* static assets(a: algopy.UInt64 | int, /) → algopy.Asset*

Foreign Assets listed in the ApplicationCall transaction

static clear_state_program

* static clear_state_program() → algopy.Bytes*

Clear state program

Native TEAL opcode: itxn

static clear_state_program_pages

Section titled “static close_remainder_to”

* static clear_state_program_pages(a: algopy.UInt64 | int, /) → algopy.Bytes*

ClearState Program as an array of pages

static close_remainder_to

* static close_remainder_to() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static config_asset

Section titled “static config_asset”

* static config_asset() → algopy.Asset*

Asset ID in asset config transaction

Native TEAL opcode: itxn

static config_asset_clawback

Section titled “static config_asset_clawback”

* static config_asset_clawback() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static config_asset_decimals

Section titled “static config_asset_decimals”

* static config_asset_decimals() → algopy.UInt64*

Number of digits to display after the decimal place when displaying the asset

Native TEAL opcode: itxn

static config_asset_default_frozen

Section titled “static config_asset_default_frozen”

* static config_asset_default_frozen() → bool*

Whether the asset’s slots are frozen by default or not, 0 or 1

Native TEAL opcode: itxn

static config_asset_freeze

Section titled “static config_asset_freeze”

* static config_asset_freeze() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static config_asset_manager

Section titled “static config_asset_manager”

* static config_asset_manager() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static config_asset_metadata_hash

Section titled “static config_asset_metadata_hash”

* static config_asset_metadata_hash() → algopy.Bytes*

32 byte commitment to unspecified asset metadata

Native TEAL opcode: itxn

static config_asset_name

Section titled “static config_asset_name”

* static config_asset_name() → algopy.Bytes*

The asset name

Native TEAL opcode: itxn

static config_asset_reserve

Section titled “static config_asset_reserve”

* static config_asset_reserve() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static config_asset_total

Section titled “static config_asset_total”

* static config_asset_total() → algopy.UInt64*

Total number of units of this asset created

Native TEAL opcode: itxn

static config_asset_unit_name

Section titled “static config_asset_unit_name”

* static config_asset_unit_name() → algopy.Bytes*

Unit name of the asset

Native TEAL opcode: itxn

static config_asset_url

Section titled “static config_asset_url”

* static config_asset_url() → algopy.Bytes*

URL

Native TEAL opcode: itxn

static created_application_id

Section titled “static created_application_id”

* static created_application_id() → algopy.Application*

ApplicationID allocated by the creation of an application (only with itxn in v5). Application mode only

Native TEAL opcode: itxn

static created_asset_id

Section titled “static created_asset_id”

* static created_asset_id() → algopy.Asset*

Asset ID allocated by the creation of an ASA (only with itxn in v5). Application mode only

Native TEAL opcode: itxn

static extra_program_pages

Section titled “static extra_program_pages”

* static extra_program_pages() → algopy.UInt64*

Native TEAL opcode: itxn

static fee

Section titled “static fee”

* static fee() → algopy.UInt64*

microalgos

Native TEAL opcode: itxn

static first_valid

Section titled “static first_valid”

* static first_valid() → algopy.UInt64*

round number

Native TEAL opcode: itxn

static first_valid_time

Section titled “static first_valid_time”

* static first_valid_time() → algopy.UInt64*

UNIX timestamp of block before txn.FirstValid. Fails if negative

Native TEAL opcode: itxn

static freeze_asset

Section titled “static freeze_asset”

* static freeze_asset() → algopy.Asset*

Asset ID being frozen or un-frozen

Native TEAL opcode: itxn

static freeze_asset_account

Section titled “static freeze_asset_account”

* static freeze_asset_account() → algopy.Account*

32 byte address of the account whose asset slot is being frozen or un-frozen

Native TEAL opcode: itxn

static freeze_asset_frozen

Section titled “static freeze_asset_frozen”

* static freeze_asset_frozen() → bool*

The new frozen value, 0 or 1

Native TEAL opcode: itxn

static global_num_byte_slice

Section titled “static global_num_byte_slice”

* static global_num_byte_slice() → algopy.UInt64*

Number of global state byteslices in ApplicationCall

Native TEAL opcode: itxn

static global_num_uint

Section titled “static global_num_uint”

* static global_num_uint() → algopy.UInt64*

Number of global state integers in ApplicationCall

Native TEAL opcode: itxn

static group_index

Section titled “static group_index”

* static group_index() → algopy.UInt64*

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

Native TEAL opcode: itxn

static last_log

Section titled “static last_log”

* static last_log() → algopy.Bytes*

The last message emitted. Empty bytes if none were emitted. Application mode only

Native TEAL opcode: itxn

static last_valid

Section titled “static last_valid”

* static last_valid() → algopy.UInt64*

round number

Native TEAL opcode: itxn

static lease

Section titled “static lease”

* static lease() → algopy.Bytes*

32 byte lease value

Native TEAL opcode: itxn

static local_num_byte_slice

Section titled “static local_num_byte_slice”

* static local_num_byte_slice() → algopy.UInt64*

Number of local state byteslices in ApplicationCall

Native TEAL opcode: itxn

static local_num_uint

Section titled “static local_num_uint”

* static local_num_uint() → algopy.UInt64*

Number of local state integers in ApplicationCall

Native TEAL opcode: itxn

static logs

Section titled “static nonparticipation”

* static logs(a: algopy.UInt64 | int, /) → algopy.Bytes*

Log messages emitted by an application call (only with itxn in v5). Application mode only

static nonparticipation

* static nonparticipation() → bool*

Marks an account nonparticipating for rewards

Native TEAL opcode: itxn

static note

Section titled “static note”

* static note() → algopy.Bytes*

Any data up to 1024 bytes

Native TEAL opcode: itxn

static num_accounts

Section titled “static num_accounts”

* static num_accounts() → algopy.UInt64*

Number of Accounts

Native TEAL opcode: itxn

static num_app_args

Section titled “static num_app_args”

* static num_app_args() → algopy.UInt64*

Number of ApplicationArgs

Native TEAL opcode: itxn

static num_applications

Section titled “static num_applications”

* static num_applications() → algopy.UInt64*

Number of Applications

Native TEAL opcode: itxn

static num_approval_program_pages

Section titled “static num_approval_program_pages”

* static num_approval_program_pages() → algopy.UInt64*

Number of Approval Program pages

Native TEAL opcode: itxn

static num_assets

Section titled “static num_assets”

* static num_assets() → algopy.UInt64*

Number of Assets

Native TEAL opcode: itxn

static num_clear_state_program_pages

Section titled “static num_clear_state_program_pages”

* static num_clear_state_program_pages() → algopy.UInt64*

Number of ClearState Program pages

Native TEAL opcode: itxn

static num_logs

Section titled “static num_logs”

* static num_logs() → algopy.UInt64*

Number of Logs (only with itxn in v5). Application mode only

Native TEAL opcode: itxn

static on_completion

Section titled “static on_completion”

* static on_completion() → algopy.OnCompleteAction*

ApplicationCall transaction on completion action

Native TEAL opcode: itxn

static receiver

Section titled “static receiver”

* static receiver() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static reject_version

Section titled “static reject_version”

* static reject_version() → algopy.UInt64*

Min AVM version: 12

Returns UInt64: Application version for which the txn must reject

Native TEAL opcode: itxn

static rekey_to

Section titled “static rekey_to”

* static rekey_to() → algopy.Account*

32 byte Sender’s new AuthAddr

Native TEAL opcode: itxn

static selection_pk

Section titled “static selection_pk”

* static selection_pk() → algopy.Bytes*

32 byte address

Native TEAL opcode: itxn

static sender

Section titled “static sender”

* static sender() → algopy.Account*

32 byte address

Native TEAL opcode: itxn

static state_proof_pk

Section titled “static state_proof_pk”

* static state_proof_pk() → algopy.Bytes*

State proof public key

Native TEAL opcode: itxn

static tx_id

Section titled “static tx_id”

* static tx_id() → algopy.Bytes*

The computed ID for this transaction. 32 bytes.

Native TEAL opcode: itxn

static type

Section titled “static type”

* static type() → algopy.Bytes*

Transaction type as bytes

Native TEAL opcode: itxn

static type_enum

Section titled “static type_enum”

* static type_enum() → algopy.TransactionType*

Transaction type as integer

Native TEAL opcode: itxn

static vote_first

Section titled “static vote_first”

* static vote_first() → algopy.UInt64*

The first round that the participation key is valid.

Native TEAL opcode: itxn

static vote_key_dilution

Section titled “static vote_key_dilution”

* static vote_key_dilution() → algopy.UInt64*

Dilution for the 2-level participation key

Native TEAL opcode: itxn

static vote_last

Section titled “static vote_last”

* static vote_last() → algopy.UInt64*

The last round that the participation key is valid.

Native TEAL opcode: itxn

static vote_pk

Section titled “static vote_pk”

* static vote_pk() → algopy.Bytes*

32 byte address

Native TEAL opcode: itxn

static xfer_asset

Section titled “static xfer_asset”

* static xfer_asset() → algopy.Asset*

Asset ID

Native TEAL opcode: itxn

class algopy.op.ITxnCreate

Section titled “class algopy.op.ITxnCreate”

Create inner transactions Native TEAL ops: itxn_begin, itxn_field, itxn_next, itxn_submit

static begin

Section titled “static begin”

* static begin() → None*

begin preparation of a new inner transaction in a new transaction group itxn_begin initializes Sender to the application address; Fee to the minimum allowable, taking into account MinTxnFee and credit from overpaying in earlier transactions; FirstValid/LastValid to the values in the invoking transaction, and all other fields to zero or empty values.

Native TEAL opcode: itxn_begin

static next

Section titled “static next”

* static next() → None*

begin preparation of a new inner transaction in the same transaction group itxn_next initializes the transaction exactly as itxn_begin does

Native TEAL opcode: itxn_next

static set_accounts

Section titled “static set_accounts”

* static set_accounts(a: algopy.Account, /) → None*

Parameters: a ( Account) – Accounts listed in the ApplicationCall transaction

Native TEAL opcode: itxn_field

static set_amount

Section titled “static set_amount”

* static set_amount(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – microalgos

Native TEAL opcode: itxn_field

static set_application_args

Section titled “static set_application_args”

* static set_application_args(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Arguments passed to the application in the ApplicationCall transaction

Native TEAL opcode: itxn_field

static set_application_id

Section titled “static set_application_id”

* static set_application_id(a: algopy.Application | algopy.UInt64 | int, /) → None*

Parameters: a ( Application | UInt64 | int) – ApplicationID from ApplicationCall transaction

Native TEAL opcode: itxn_field

static set_applications

Section titled “static set_applications”

* static set_applications(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Foreign Apps listed in the ApplicationCall transaction

Native TEAL opcode: itxn_field

static set_approval_program

Section titled “static set_approval_program”

* static set_approval_program(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Approval program

Native TEAL opcode: itxn_field

static set_approval_program_pages

Section titled “static set_approval_program_pages”

* static set_approval_program_pages(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Approval Program as an array of pages

Native TEAL opcode: itxn_field

static set_asset_amount

Section titled “static set_asset_amount”

* static set_asset_amount(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – value in Asset’s units

Native TEAL opcode: itxn_field

static set_asset_close_to

Section titled “static set_asset_close_to”

* static set_asset_close_to(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_asset_receiver

Section titled “static set_asset_receiver”

* static set_asset_receiver(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_asset_sender

Section titled “static set_asset_sender”

* static set_asset_sender(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address. Source of assets if Sender is the Asset’s Clawback address.

Native TEAL opcode: itxn_field

static set_assets

Section titled “static set_assets”

* static set_assets(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Foreign Assets listed in the ApplicationCall transaction

Native TEAL opcode: itxn_field

static set_clear_state_program

Section titled “static set_clear_state_program”

* static set_clear_state_program(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Clear state program

Native TEAL opcode: itxn_field

static set_clear_state_program_pages

Section titled “static set_clear_state_program_pages”

* static set_clear_state_program_pages(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – ClearState Program as an array of pages

Native TEAL opcode: itxn_field

static set_close_remainder_to

Section titled “static set_close_remainder_to”

* static set_close_remainder_to(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_config_asset

Section titled “static set_config_asset”

* static set_config_asset(a: algopy.Asset | algopy.UInt64 | int, /) → None*

Parameters: a ( Asset | UInt64 | int) – Asset ID in asset config transaction

Native TEAL opcode: itxn_field

static set_config_asset_clawback

Section titled “static set_config_asset_clawback”

* static set_config_asset_clawback(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_config_asset_decimals

Section titled “static set_config_asset_decimals”

* static set_config_asset_decimals(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of digits to display after the decimal place when displaying the asset

Native TEAL opcode: itxn_field

static set_config_asset_default_frozen

Section titled “static set_config_asset_default_frozen”

* static set_config_asset_default_frozen(a: bool, /) → None*

Parameters: a ( bool) – Whether the asset’s slots are frozen by default or not, 0 or 1

Native TEAL opcode: itxn_field

static set_config_asset_freeze

Section titled “static set_config_asset_freeze”

* static set_config_asset_freeze(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_config_asset_manager

Section titled “static set_config_asset_manager”

* static set_config_asset_manager(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_config_asset_metadata_hash

Section titled “static set_config_asset_metadata_hash”

* static set_config_asset_metadata_hash(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – 32 byte commitment to unspecified asset metadata

Native TEAL opcode: itxn_field

static set_config_asset_name

Section titled “static set_config_asset_name”

* static set_config_asset_name(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – The asset name

Native TEAL opcode: itxn_field

static set_config_asset_reserve

Section titled “static set_config_asset_reserve”

* static set_config_asset_reserve(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_config_asset_total

Section titled “static set_config_asset_total”

* static set_config_asset_total(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Total number of units of this asset created

Native TEAL opcode: itxn_field

static set_config_asset_unit_name

Section titled “static set_config_asset_unit_name”

* static set_config_asset_unit_name(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Unit name of the asset

Native TEAL opcode: itxn_field

static set_config_asset_url

Section titled “static set_config_asset_url”

* static set_config_asset_url(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – URL

Native TEAL opcode: itxn_field

static set_extra_program_pages

Section titled “static set_extra_program_pages”

* static set_extra_program_pages(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of additional pages for each of the application’s approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program.

Native TEAL opcode: itxn_field

static set_fee

Section titled “static set_fee”

* static set_fee(a: algopy.UInt64 | int, /) → None*

Native TEAL opcode: itxn_field

static set_freeze_asset

Section titled “static set_freeze_asset”

* static set_freeze_asset(a: algopy.Asset | algopy.UInt64 | int, /) → None*

Parameters: a ( Asset | UInt64 | int) – Asset ID being frozen or un-frozen

Native TEAL opcode: itxn_field

static set_freeze_asset_account

Section titled “static set_freeze_asset_account”

* static set_freeze_asset_account(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address of the account whose asset slot is being frozen or un-frozen

Native TEAL opcode: itxn_field

static set_freeze_asset_frozen

Section titled “static set_freeze_asset_frozen”

* static set_freeze_asset_frozen(a: bool, /) → None*

Parameters: a ( bool) – The new frozen value, 0 or 1

Native TEAL opcode: itxn_field

static set_global_num_byte_slice

Section titled “static set_global_num_byte_slice”

* static set_global_num_byte_slice(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of global state byteslices in ApplicationCall

Native TEAL opcode: itxn_field

static set_global_num_uint

Section titled “static set_global_num_uint”

* static set_global_num_uint(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of global state integers in ApplicationCall

Native TEAL opcode: itxn_field

static set_local_num_byte_slice

Section titled “static set_local_num_byte_slice”

* static set_local_num_byte_slice(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of local state byteslices in ApplicationCall

Native TEAL opcode: itxn_field

static set_local_num_uint

Section titled “static set_local_num_uint”

* static set_local_num_uint(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Number of local state integers in ApplicationCall

Native TEAL opcode: itxn_field

static set_nonparticipation

Section titled “static set_nonparticipation”

* static set_nonparticipation(a: bool, /) → None*

Parameters: a ( bool) – Marks an account nonparticipating for rewards

Native TEAL opcode: itxn_field

static set_note

Section titled “static set_note”

* static set_note(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Any data up to 1024 bytes

Native TEAL opcode: itxn_field

static set_on_completion

Section titled “static set_on_completion”

* static set_on_completion(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – ApplicationCall transaction on completion action

Native TEAL opcode: itxn_field

static set_receiver

Section titled “static set_receiver”

* static set_receiver(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_reject_version

Section titled “static set_reject_version”

* static set_reject_version(a: algopy.UInt64 | int, /) → None*

Min AVM version: 12

Parameters: a ( UInt64 | int) – Application version for which the txn must reject

Native TEAL opcode: itxn_field

static set_rekey_to

Section titled “static set_rekey_to”

* static set_rekey_to(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte Sender’s new AuthAddr

Native TEAL opcode: itxn_field

static set_selection_pk

Section titled “static set_selection_pk”

* static set_selection_pk(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – 32 byte address

Native TEAL opcode: itxn_field

static set_sender

Section titled “static set_sender”

* static set_sender(a: algopy.Account, /) → None*

Parameters: a ( Account) – 32 byte address

Native TEAL opcode: itxn_field

static set_state_proof_pk

Section titled “static set_state_proof_pk”

* static set_state_proof_pk(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – State proof public key

Native TEAL opcode: itxn_field

static set_type

Section titled “static set_type”

* static set_type(a: algopy.Bytes | bytes, /) → None*

Parameters: a ( Bytes | bytes) – Transaction type as bytes

Native TEAL opcode: itxn_field

static set_type_enum

Section titled “static set_type_enum”

* static set_type_enum(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Transaction type as integer

Native TEAL opcode: itxn_field

static set_vote_first

Section titled “static set_vote_first”

* static set_vote_first(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – The first round that the participation key is valid.

Native TEAL opcode: itxn_field

static set_vote_key_dilution

Section titled “static set_vote_key_dilution”

* static set_vote_key_dilution(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – Dilution for the 2-level participation key

Native TEAL opcode: itxn_field

static set_vote_last

Section titled “static set_vote_last”

* static set_vote_last(a: algopy.UInt64 | int, /) → None*

Parameters: a ( UInt64 | int) – The last round that the participation key is valid.

Native TEAL opcode: itxn_field

static set_vote_pk

Section titled “static set_vote_pk”

* static set_vote_pk(a: algopy.Bytes | bytes, /) → None*

Native TEAL opcode: itxn_field

static set_xfer_asset

Section titled “static set_xfer_asset”

* static set_xfer_asset(a: algopy.Asset | algopy.UInt64 | int, /) → None*

Parameters: a ( Asset | UInt64 | int) – Asset ID

Native TEAL opcode: itxn_field

static submit

Section titled “static submit”

* static submit() → None*

execute the current inner transaction group. Fail if executing this group would exceed the inner transaction limit, or if any transaction in the group fails. itxn_submit resets the current transaction so that it can not be resubmitted. A new itxn_begin is required to prepare another inner transaction.

Native TEAL opcode: itxn_submit

class algopy.op.JsonRef

Section titled “class algopy.op.JsonRef”

key B’s value, of type R, from a valid utf-8 encoded json object A Warning: Usage should be restricted to very rare use cases, as JSON decoding is expensive and quite limited. In addition, JSON objects are large and not optimized for size. Almost all smart contracts should use simpler and smaller methods (such as the ABI. This opcode should only be used in cases where JSON is only available option, e.g. when a third-party only signs JSON. Native TEAL op: json_ref

static json_object

Section titled “static json_object”

* static json_object(a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.Bytes*

Native TEAL opcode: json_ref

static json_string

Section titled “static json_string”

* static json_string(a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.Bytes*

Native TEAL opcode: json_ref

static json_uint64

Section titled “static json_uint64”

* static json_uint64(a: algopy.Bytes | bytes, b: algopy.Bytes | bytes, /) → algopy.UInt64*

Native TEAL opcode: json_ref

class algopy.op.MiMCConfigurations

Section titled “class algopy.op.MiMCConfigurations”

Available values for the Mimc Configurations enum

Initialization

Section titled “BLS12_381Mp111 *: [algopy.op.MiMCConfigurations]”

Initialize self. See help(type(self)) for accurate signature.

BLS12_381Mp111 *: [algopy.op.MiMCConfigurations]

_BLS12_381Mp111 _: algopy.op.MiMCConfigurations**

Ellipsis

MiMC configuration for the BLS12-381 curve with Miyaguchi-Preneel mode, 111 rounds, exponent 5, seed “seed” Min AVM version: 11

BN254Mp110 *: [algopy.op.MiMCConfigurations]

Section titled “BN254Mp110 *: [algopy.op.MiMCConfigurations]”

_BN254Mp110 _: algopy.op.MiMCConfigurations**

Ellipsis

MiMC configuration for the BN254 curve with Miyaguchi-Preneel mode, 110 rounds, exponent 5, seed “seed” Min AVM version: 11

add

__add__()

Return self+value.

contains

__contains__()

Return bool(key in self).

delattr

__delattr__()

Implement delattr(self, name).

dir

__dir__()

Default dir() implementation.

eq

__eq__()

Return self==value.

format

__format__()

Return a formatted version of the string as described by format_spec.

ge

__ge__()

Return self>=value.

getattribute

__getattribute__()

Return getattr(self, name).

getitem

__getitem__()

Return self[key].

getstate

__getstate__()

Helper for pickle.

gt

__gt__()

Return self>value.

hash

__hash__()

Return hash(self).

iter

__iter__()

Implement iter(self).

le

__le__()

Return self<=value.

len

__len__()

Return len(self).

lt

__lt__()

Return self<value.

mod

__mod__()

Return self%value.

mul

__mul__()

Return self*value.

ne

__ne__()

Return self!=value.

new

__new__()

Create and return a new object. See help(type) for accurate signature.

reduce

__reduce__()

Helper for pickle.

__reduce ex_

__reduceex_()

Helper for pickle.

repr

__repr__()

Return repr(self).

rmod

__rmod__()

Return value%self.

rmul

__rmul__()

Return value*self.

setattr

__setattr__()

Implement setattr(self, name, value).

sizeof

__sizeof__()

Return the size of the string in memory, in bytes.

str

__str__()

Return str(self).

capitalize

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold

casefold()

Return a version of the string suitable for caseless comparisons.

center

center()

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count

count()

S.count(sub[, start[, end]]) -> int

encode

encode()

Encode the string using the codec registered for encoding.

endswith

endswith()

S.endswith(suffix[, start[, end]]) -> bool

expandtabs

expandtabs()

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find

find()

S.find(sub[, start[, end]]) -> int

Return -1 on failure.

format

format()

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map

format_map()

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index

index()

S.index(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

isalnum

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join

join()

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust

ljust()

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower

lower()

Return a copy of the string converted to lowercase.

lstrip

lstrip()

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

partition

partition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix

removeprefix()

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix

removesuffix()

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace

replace()

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind

rfind()

S.rfind(sub[, start[, end]]) -> int

Return -1 on failure.

rindex

rindex()

S.rindex(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

rjust

rjust()

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition

rpartition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit

rsplit()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

rstrip()

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split

split()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

splitlines

splitlines()

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith

startswith()

S.startswith(prefix[, start[, end]]) -> bool

strip

strip()

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate

translate()

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

upper

upper()

Return a copy of the string converted to uppercase.

zfill

Section titled “class algopy.op.Scratch”

zfill()

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

class algopy.op.Scratch

Load or store scratch values Native TEAL ops: loads, stores

static load_bytes

Section titled “static load_bytes”

* static load_bytes(a: algopy.UInt64 | int, /) → algopy.Bytes*

Ath scratch space value. All scratch spaces are 0 at program start.

Native TEAL opcode: loads

static load_uint64

Section titled “static load_uint64”

* static load_uint64(a: algopy.UInt64 | int, /) → algopy.UInt64*

Ath scratch space value. All scratch spaces are 0 at program start.

Native TEAL opcode: loads

static store

Section titled “static store”

* static store(a: algopy.UInt64 | int, b: algopy.Bytes | algopy.UInt64 | bytes | int, /) → None*

store B to the Ath scratch space

Native TEAL opcode: stores

class algopy.op.Txn

Section titled “class algopy.op.Txn”

Get values for the current executing transaction Native TEAL ops: txn, txnas

static accounts

Section titled “amount *: [Final]”

Accounts listed in the ApplicationCall transaction

Native TEAL opcode: txna, txnas

amount *: [Final]

_amount _: Final[ algopy.UInt64]**

Ellipsis

microalgos

static application_args

Section titled “application_id *: [Final]”

Arguments passed to the application in the ApplicationCall transaction

application_id *: [Final]

_application_id _: Final[ algopy.Application]**

Ellipsis

ApplicationID from ApplicationCall transaction

static applications

Section titled “approval_program *: [Final]”

Foreign Apps listed in the ApplicationCall transaction

approval_program *: [Final]

_approval_program _: Final[ algopy.Bytes]**

Ellipsis

Approval program

static approval_program_pages

Section titled “asset_amount *: [Final]”

Approval Program as an array of pages

asset_amount *: [Final]

_asset_amount _: Final[ algopy.UInt64]**

Ellipsis

value in Asset’s units

asset_close_to *: [Final]

Section titled “asset_close_to *: [Final]”

_asset_close_to _: Final[ algopy.Account]**

Ellipsis

32 byte address

asset_receiver *: [Final]

Section titled “asset_receiver *: [Final]”

_asset_receiver _: Final[ algopy.Account]**

Ellipsis

32 byte address

asset_sender *: [Final]

Section titled “asset_sender *: [Final]”

_asset_sender _: Final[ algopy.Account]**

Ellipsis

32 byte address. Source of assets if Sender is the Asset’s Clawback address.

static assets

Section titled “clear_state_program *: [Final]”

Foreign Assets listed in the ApplicationCall transaction

clear_state_program *: [Final]

_clear_state_program _: Final[ algopy.Bytes]**

Ellipsis

Clear state program

static clear_state_program_pages

Section titled “close_remainder_to *: [Final]”

ClearState Program as an array of pages

close_remainder_to *: [Final]

_close_remainder_to _: Final[ algopy.Account]**

Ellipsis

32 byte address

config_asset *: [Final]

Section titled “config_asset *: [Final]”

_config_asset _: Final[ algopy.Asset]**

Ellipsis

Asset ID in asset config transaction

config_asset_clawback *: [Final]

Section titled “config_asset_clawback *: [Final]”

_config_asset_clawback _: Final[ algopy.Account]**

Ellipsis

32 byte address

config_asset_decimals *: [Final]

Section titled “config_asset_decimals *: [Final]”

_config_asset_decimals _: Final[ algopy.UInt64]**

Ellipsis

Number of digits to display after the decimal place when displaying the asset

config_asset_default_frozen *: [Final]

Section titled “config_asset_default_frozen *: [Final]”

_config_asset_default_frozen _: Final[ bool]**

Ellipsis

Whether the asset’s slots are frozen by default or not, 0 or 1

config_asset_freeze *: [Final]

Section titled “config_asset_freeze *: [Final]”

_config_asset_freeze _: Final[ algopy.Account]**

Ellipsis

32 byte address

config_asset_manager *: [Final]

Section titled “config_asset_manager *: [Final]”

_config_asset_manager _: Final[ algopy.Account]**

Ellipsis

32 byte address

config_asset_metadata_hash *: [Final]

Section titled “config_asset_metadata_hash *: [Final]”

_config_asset_metadata_hash _: Final[ algopy.Bytes]**

Ellipsis

32 byte commitment to unspecified asset metadata

config_asset_name *: [Final]

Section titled “config_asset_name *: [Final]”

_config_asset_name _: Final[ algopy.Bytes]**

Ellipsis

The asset name

config_asset_reserve *: [Final]

Section titled “config_asset_reserve *: [Final]”

_config_asset_reserve _: Final[ algopy.Account]**

Ellipsis

32 byte address

config_asset_total *: [Final]

Section titled “config_asset_total *: [Final]”

_config_asset_total _: Final[ algopy.UInt64]**

Ellipsis

Total number of units of this asset created

config_asset_unit_name *: [Final]

Section titled “config_asset_unit_name *: [Final]”

_config_asset_unit_name _: Final[ algopy.Bytes]**

Ellipsis

Unit name of the asset

config_asset_url *: [Final]

Section titled “config_asset_url *: [Final]”

_config_asset_url _: Final[ algopy.Bytes]**

Ellipsis

URL

created_application_id *: [Final]

Section titled “created_application_id *: [Final]”

_created_application_id _: Final[ algopy.Application]**

Ellipsis

ApplicationID allocated by the creation of an application (only with itxn in v5). Application mode only

created_asset_id *: [Final]

Section titled “created_asset_id *: [Final]”

_created_asset_id _: Final[ algopy.Asset]**

Ellipsis

Asset ID allocated by the creation of an ASA (only with itxn in v5). Application mode only

extra_program_pages *: [Final]

Section titled “extra_program_pages *: [Final]”

_extra_program_pages _: Final[ algopy.UInt64]**

Ellipsis

fee *: [Final]

Section titled “fee *: [Final]”

_fee _: Final[ algopy.UInt64]**

Ellipsis

microalgos

first_valid *: [Final]

Section titled “first_valid *: [Final]”

_first_valid _: Final[ algopy.UInt64]**

Ellipsis

round number

first_valid_time *: [Final]

Section titled “first_valid_time *: [Final]”

_first_valid_time _: Final[ algopy.UInt64]**

Ellipsis

UNIX timestamp of block before txn.FirstValid. Fails if negative

freeze_asset *: [Final]

Section titled “freeze_asset *: [Final]”

_freeze_asset _: Final[ algopy.Asset]**

Ellipsis

Asset ID being frozen or un-frozen

freeze_asset_account *: [Final]

Section titled “freeze_asset_account *: [Final]”

_freeze_asset_account _: Final[ algopy.Account]**

Ellipsis

32 byte address of the account whose asset slot is being frozen or un-frozen

freeze_asset_frozen *: [Final]

Section titled “freeze_asset_frozen *: [Final]”

_freeze_asset_frozen _: Final[ bool]**

Ellipsis

The new frozen value, 0 or 1

global_num_byte_slice *: [Final]

Section titled “global_num_byte_slice *: [Final]”

_global_num_byte_slice _: Final[ algopy.UInt64]**

Ellipsis

Number of global state byteslices in ApplicationCall

global_num_uint *: [Final]

Section titled “global_num_uint *: [Final]”

_global_num_uint _: Final[ algopy.UInt64]**

Ellipsis

Number of global state integers in ApplicationCall

group_index *: [Final]

Section titled “group_index *: [Final]”

_group_index _: Final[ algopy.UInt64]**

Ellipsis

Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1

last_log *: [Final]

Section titled “last_log *: [Final]”

_last_log _: Final[ algopy.Bytes]**

Ellipsis

The last message emitted. Empty bytes if none were emitted. Application mode only

last_valid *: [Final]

Section titled “last_valid *: [Final]”

_last_valid _: Final[ algopy.UInt64]**

Ellipsis

round number

lease *: [Final]

Section titled “lease *: [Final]”

_lease _: Final[ algopy.Bytes]**

Ellipsis

32 byte lease value

local_num_byte_slice *: [Final]

Section titled “local_num_byte_slice *: [Final]”

_local_num_byte_slice _: Final[ algopy.UInt64]**

Ellipsis

Number of local state byteslices in ApplicationCall

local_num_uint *: [Final]

Section titled “local_num_uint *: [Final]”

_local_num_uint _: Final[ algopy.UInt64]**

Ellipsis

Number of local state integers in ApplicationCall

static logs

Section titled “nonparticipation *: [Final]”

Log messages emitted by an application call (only with itxn in v5). Application mode only

nonparticipation *: [Final]

_nonparticipation _: Final[ bool]**

Ellipsis

Marks an account nonparticipating for rewards

note *: [Final]

Section titled “note *: [Final]”

_note _: Final[ algopy.Bytes]**

Ellipsis

Any data up to 1024 bytes

num_accounts *: [Final]

Section titled “num_accounts *: [Final]”

_num_accounts _: Final[ algopy.UInt64]**

Ellipsis

Number of Accounts

num_app_args *: [Final]

Section titled “num_app_args *: [Final]”

_num_app_args _: Final[ algopy.UInt64]**

Ellipsis

Number of ApplicationArgs

num_applications *: [Final]

Section titled “num_applications *: [Final]”

_num_applications _: Final[ algopy.UInt64]**

Ellipsis

Number of Applications

num_approval_program_pages *: [Final]

Section titled “num_approval_program_pages *: [Final]”

_num_approval_program_pages _: Final[ algopy.UInt64]**

Ellipsis

Number of Approval Program pages

num_assets *: [Final]

Section titled “num_assets *: [Final]”

_num_assets _: Final[ algopy.UInt64]**

Ellipsis

Number of Assets

num_clear_state_program_pages *: [Final]

Section titled “num_clear_state_program_pages *: [Final]”

_num_clear_state_program_pages _: Final[ algopy.UInt64]**

Ellipsis

Number of ClearState Program pages

num_logs *: [Final]

Section titled “num_logs *: [Final]”

_num_logs _: Final[ algopy.UInt64]**

Ellipsis

Number of Logs (only with itxn in v5). Application mode only

on_completion *: [Final]

Section titled “on_completion *: [Final]”

_on_completion _: Final[ algopy.OnCompleteAction]**

Ellipsis

ApplicationCall transaction on completion action

receiver *: [Final]

Section titled “receiver *: [Final]”

_receiver _: Final[ algopy.Account]**

Ellipsis

32 byte address

reject_version *: [Final]

Section titled “reject_version *: [Final]”

_reject_version _: Final[ algopy.UInt64]**

Ellipsis

Application version for which the txn must reject Min AVM version: 12

rekey_to *: [Final]

Section titled “rekey_to *: [Final]”

_rekey_to _: Final[ algopy.Account]**

Ellipsis

32 byte Sender’s new AuthAddr

selection_pk *: [Final]

Section titled “selection_pk *: [Final]”

_selection_pk _: Final[ algopy.Bytes]**

Ellipsis

32 byte address

sender *: [Final]

Section titled “sender *: [Final]”

_sender _: Final[ algopy.Account]**

Ellipsis

32 byte address

state_proof_pk *: [Final]

Section titled “state_proof_pk *: [Final]”

_state_proof_pk _: Final[ algopy.Bytes]**

Ellipsis

State proof public key

tx_id *: [Final]

Section titled “tx_id *: [Final]”

_tx_id _: Final[ algopy.Bytes]**

Ellipsis

The computed ID for this transaction. 32 bytes.

type *: [Final]

Section titled “type *: [Final]”

_type _: Final[ algopy.Bytes]**

Ellipsis

Transaction type as bytes

type_enum *: [Final]

Section titled “type_enum *: [Final]”

_type_enum _: Final[ algopy.TransactionType]**

Ellipsis

Transaction type as integer

vote_first *: [Final]

Section titled “vote_first *: [Final]”

_vote_first _: Final[ algopy.UInt64]**

Ellipsis

The first round that the participation key is valid.

vote_key_dilution *: [Final]

Section titled “vote_key_dilution *: [Final]”

_vote_key_dilution _: Final[ algopy.UInt64]**

Ellipsis

Dilution for the 2-level participation key

vote_last *: [Final]

Section titled “vote_last *: [Final]”

_vote_last _: Final[ algopy.UInt64]**

Ellipsis

The last round that the participation key is valid.

vote_pk *: [Final]

Section titled “vote_pk *: [Final]”

_vote_pk _: Final[ algopy.Bytes]**

Ellipsis

32 byte address

xfer_asset *: [Final]

Section titled “xfer_asset *: [Final]”

_xfer_asset _: Final[ algopy.Asset]**

Ellipsis

Asset ID

class algopy.op.VoterParamsGet

Section titled “class algopy.op.VoterParamsGet”

X is field F from online account A as of the balance round: 320 rounds before the current round. Y is 1 if A had positive algos online in the agreement round, else Y is 0 and X is a type specific zero-value Native TEAL op: voter_params_get

static voter_balance

Section titled “static voter_balance”

* static voter_balance(a: algopy.Account | algopy.UInt64 | int, /) → tuple[ algopy.UInt64, bool]*

Min AVM version: 11

Returns tuple[UInt64, bool]: Online stake in microalgos

Native TEAL opcode: voter_params_get

static voter_incentive_eligible

Section titled “static voter_incentive_eligible”

* static voter_incentive_eligible(a: algopy.Account | algopy.UInt64 | int, /) → tuple[ bool, bool]*

Min AVM version: 11

Returns tuple[bool, bool]: Had this account opted into block payouts

Native TEAL opcode: voter_params_get

class algopy.op.VrfVerify

Section titled “class algopy.op.VrfVerify”

Available values for the vrf_verify enum

Initialization

Initialize self. See help(type(self)) for accurate signature.

add

__add__()

Return self+value.

contains

__contains__()

Return bool(key in self).

delattr

__delattr__()

Implement delattr(self, name).

dir

__dir__()

Default dir() implementation.

eq

__eq__()

Return self==value.

format

__format__()

Return a formatted version of the string as described by format_spec.

ge

__ge__()

Return self>=value.

getattribute

__getattribute__()

Return getattr(self, name).

getitem

__getitem__()

Return self[key].

getstate

__getstate__()

Helper for pickle.

gt

__gt__()

Return self>value.

hash

__hash__()

Return hash(self).

iter

__iter__()

Implement iter(self).

le

__le__()

Return self<=value.

len

__len__()

Return len(self).

lt

__lt__()

Return self<value.

mod

__mod__()

Return self%value.

mul

__mul__()

Return self*value.

ne

__ne__()

Return self!=value.

new

__new__()

Create and return a new object. See help(type) for accurate signature.

reduce

__reduce__()

Helper for pickle.

__reduce ex_

__reduceex_()

Helper for pickle.

repr

__repr__()

Return repr(self).

rmod

__rmod__()

Return value%self.

rmul

__rmul__()

Return value*self.

setattr

__setattr__()

Implement setattr(self, name, value).

sizeof

__sizeof__()

Return the size of the string in memory, in bytes.

str

__str__()

Return str(self).

capitalize

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold

casefold()

Return a version of the string suitable for caseless comparisons.

center

center()

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count

count()

S.count(sub[, start[, end]]) -> int

encode

encode()

Encode the string using the codec registered for encoding.

endswith

endswith()

S.endswith(suffix[, start[, end]]) -> bool

expandtabs

expandtabs()

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find

find()

S.find(sub[, start[, end]]) -> int

Return -1 on failure.

format

format()

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map

format_map()

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

index

index()

S.index(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

isalnum

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

islower

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable

isprintable()

Return True if the string is printable, False otherwise.

A string is printable if all of its characters are considered printable in repr() or if it is empty.

isspace

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join

join()

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

ljust

ljust()

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower

lower()

Return a copy of the string converted to lowercase.

lstrip

lstrip()

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

partition

partition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix

removeprefix()

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix

removesuffix()

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace

replace()

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind

rfind()

S.rfind(sub[, start[, end]]) -> int

Return -1 on failure.

rindex

rindex()

S.rindex(sub[, start[, end]]) -> int

Raises ValueError when the substring is not found.

rjust

rjust()

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition

rpartition()

Partition the string into three parts using the given separator.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit

rsplit()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

rstrip()

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split

split()

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace

character (including \n \r \t \f and spaces) and will discard

empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

splitlines

splitlines()

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith

startswith()

S.startswith(prefix[, start[, end]]) -> bool

strip

strip()

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate

translate()

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

upper

upper()

Return a copy of the string converted to uppercase.

zfill