diff options
Diffstat (limited to 'data/transactions/logic/doc.go')
| -rw-r--r-- | data/transactions/logic/doc.go | 379 |
1 files changed, 192 insertions, 187 deletions
diff --git a/data/transactions/logic/doc.go b/data/transactions/logic/doc.go index 5149f4420..4b6972198 100644 --- a/data/transactions/logic/doc.go +++ b/data/transactions/logic/doc.go @@ -17,21 +17,19 @@ package logic import ( - "fmt" - "github.com/algorand/go-algorand/protocol" ) // short description of every op var opDocByName = map[string]string{ - "err": "Error. Fail immediately. This is primarily a fencepost against accidental zero bytes getting compiled into programs.", - "sha256": "SHA256 hash of value X, yields [32]byte", - "keccak256": "Keccak256 hash of value X, yields [32]byte", - "sha512_256": "SHA512_256 hash of value X, yields [32]byte", + "err": "Fail immediately.", + "sha256": "SHA256 hash of value A, yields [32]byte", + "keccak256": "Keccak256 hash of value A, yields [32]byte", + "sha512_256": "SHA512_256 hash of value A, yields [32]byte", "ed25519verify": "for (data A, signature B, pubkey C) verify the signature of (\"ProgData\" || program_hash || data) against the pubkey => {0 or 1}", "ecdsa_verify": "for (data A, signature B, C and pubkey D, E) verify the signature of the data against the pubkey => {0 or 1}", - "ecdsa_pk_decompress": "decompress pubkey A into components X, Y => [*... stack*, X, Y]", - "ecdsa_pk_recover": "for (data A, recovery id B, signature C, D) recover a public key => [*... stack*, X, Y]", + "ecdsa_pk_decompress": "decompress pubkey A into components X, Y", + "ecdsa_pk_recover": "for (data A, recovery id B, signature C, D) recover a public key", "+": "A plus B. Fail on overflow.", "-": "A minus B. Fail if B > A.", @@ -45,135 +43,141 @@ var opDocByName = map[string]string{ "||": "A is not zero or B is not zero => {0 or 1}", "==": "A is equal to B => {0 or 1}", "!=": "A is not equal to B => {0 or 1}", - "!": "X == 0 yields 1; else 0", - "len": "yields length of byte value X", - "itob": "converts uint64 X to big endian bytes", - "btoi": "converts bytes X as big endian to uint64", + "!": "A == 0 yields 1; else 0", + "len": "yields length of byte value A", + "itob": "converts uint64 A to big endian bytes", + "btoi": "converts bytes A as big endian to uint64", "%": "A modulo B. Fail if B == 0.", "|": "A bitwise-or B", "&": "A bitwise-and B", "^": "A bitwise-xor B", - "~": "bitwise invert value X", + "~": "bitwise invert value A", "shl": "A times 2^B, modulo 2^64", "shr": "A divided by 2^B", - "sqrt": "The largest integer B such that B^2 <= X", - "bitlen": "The highest set bit in X. If X is a byte-array, it is interpreted as a big-endian unsigned integer. bitlen of 0 is 0, bitlen of 8 is 4", + "sqrt": "The largest integer I such that I^2 <= A", + "bitlen": "The highest set bit in A. If A is a byte-array, it is interpreted as a big-endian unsigned integer. bitlen of 0 is 0, bitlen of 8 is 4", "exp": "A raised to the Bth power. Fail if A == B == 0 and on overflow", - "expw": "A raised to the Bth power as a 128-bit long result as low (top) and high uint64 values on the stack. Fail if A == B == 0 or if the results exceeds 2^128-1", - "mulw": "A times B out to 128-bit long result as low (top) and high uint64 values on the stack", - "addw": "A plus B out to 128-bit long result as sum (top) and carry-bit uint64 values on the stack", - "divmodw": "Pop four uint64 values. The deepest two are interpreted as a uint128 dividend (deepest value is high word), the top two are interpreted as a uint128 divisor. Four uint64 values are pushed to the stack. The deepest two are the quotient (deeper value is the high uint64). The top two are the remainder, low bits on top.", + "expw": "A raised to the Bth power as a 128-bit result in two uint64s. X is the high 64 bits, Y is the low. Fail if A == B == 0 or if the results exceeds 2^128-1", + "mulw": "A times B as a 128-bit result in two uint64s. X is the high 64 bits, Y is the low", + "addw": "A plus B as a 128-bit result. X is the carry-bit, Y is the low-order 64 bits.", + "divmodw": "W,X = (A,B / C,D); Y,Z = (A,B modulo C,D)", "intcblock": "prepare block of uint64 constants for use by intc", - "intc": "push Ith constant from intcblock to stack", - "intc_0": "push constant 0 from intcblock to stack", - "intc_1": "push constant 1 from intcblock to stack", - "intc_2": "push constant 2 from intcblock to stack", - "intc_3": "push constant 3 from intcblock to stack", - "pushint": "push immediate UINT to the stack as an integer", + "intc": "Ith constant from intcblock", + "intc_0": "constant 0 from intcblock", + "intc_1": "constant 1 from intcblock", + "intc_2": "constant 2 from intcblock", + "intc_3": "constant 3 from intcblock", + "pushint": "immediate UINT", "bytecblock": "prepare block of byte-array constants for use by bytec", - "bytec": "push Ith constant from bytecblock to stack", - "bytec_0": "push constant 0 from bytecblock to stack", - "bytec_1": "push constant 1 from bytecblock to stack", - "bytec_2": "push constant 2 from bytecblock to stack", - "bytec_3": "push constant 3 from bytecblock to stack", - "pushbytes": "push the following program bytes to the stack", - - "bzero": "push a byte-array of length X, containing all zero bytes", - "arg": "push Nth LogicSig argument to stack", - "arg_0": "push LogicSig argument 0 to stack", - "arg_1": "push LogicSig argument 1 to stack", - "arg_2": "push LogicSig argument 2 to stack", - "arg_3": "push LogicSig argument 3 to stack", - "args": "push Xth LogicSig argument to stack", - "txn": "push field F of current transaction to stack", - "gtxn": "push field F of the Tth transaction in the current group", - "gtxns": "push field F of the Xth transaction in the current group", - "txna": "push Ith value of the array field F of the current transaction", - "gtxna": "push Ith value of the array field F from the Tth transaction in the current group", - "gtxnsa": "push Ith value of the array field F from the Xth transaction in the current group", - "txnas": "push Xth value of the array field F of the current transaction", - "gtxnas": "push Xth value of the array field F from the Tth transaction in the current group", - "gtxnsas": "pop an index A and an index B. push Bth value of the array field F from the Ath transaction in the current group", - "itxn": "push field F of the last inner transaction to stack", - "itxna": "push Ith value of the array field F of the last inner transaction to stack", - - "global": "push value from globals to stack", - "load": "copy a value from scratch space to the stack. All scratch spaces are 0 at program start.", - "store": "pop value X. store X to the Ith scratch space", - "loads": "copy a value from the Xth scratch space to the stack. All scratch spaces are 0 at program start.", - "stores": "pop indexes A and B. store B to the Ath scratch space", - "gload": "push Ith scratch space index of the Tth transaction in the current group", - "gloads": "push Ith scratch space index of the Xth transaction in the current group", - "gaid": "push the ID of the asset or application created in the Tth transaction of the current group", - "gaids": "push the ID of the asset or application created in the Xth transaction of the current group", - - "bnz": "branch to TARGET if value X is not zero", - "bz": "branch to TARGET if value X is zero", + "bytec": "Ith constant from bytecblock", + "bytec_0": "constant 0 from bytecblock", + "bytec_1": "constant 1 from bytecblock", + "bytec_2": "constant 2 from bytecblock", + "bytec_3": "constant 3 from bytecblock", + "pushbytes": "immediate BYTES", + + "bzero": "zero filled byte-array of length A", + "arg": "Nth LogicSig argument", + "arg_0": "LogicSig argument 0", + "arg_1": "LogicSig argument 1", + "arg_2": "LogicSig argument 2", + "arg_3": "LogicSig argument 3", + "args": "Ath LogicSig argument", + "txn": "field F of current transaction", + "gtxn": "field F of the Tth transaction in the current group", + "gtxns": "field F of the Ath transaction in the current group", + "txna": "Ith value of the array field F of the current transaction", + "gtxna": "Ith value of the array field F from the Tth transaction in the current group", + "gtxnsa": "Ith value of the array field F from the Ath transaction in the current group", + "txnas": "Ath value of the array field F of the current transaction", + "gtxnas": "Ath value of the array field F from the Tth transaction in the current group", + "gtxnsas": "Bth value of the array field F from the Ath transaction in the current group", + "itxn": "field F of the last inner transaction", + "itxna": "Ith value of the array field F of the last inner transaction", + "gitxn": "field F of the Tth transaction in the last inner group submitted", + "gitxna": "Ith value of the array field F from the Tth transaction in the last inner group submitted", + + "global": "global field F", + "load": "Ith scratch space value. All scratch spaces are 0 at program start.", + "store": "store A to the Ith scratch space", + "loads": "Ath scratch space value. All scratch spaces are 0 at program start.", + "stores": "store B to the Ath scratch space", + "gload": "Ith scratch space value of the Tth transaction in the current group", + "gloads": "Ith scratch space value of the Ath transaction in the current group", + "gloadss": "Bth scratch space value of the Ath transaction in the current group", + "gaid": "ID of the asset or application created in the Tth transaction of the current group", + "gaids": "ID of the asset or application created in the Ath transaction of the current group", + + "bnz": "branch to TARGET if value A is not zero", + "bz": "branch to TARGET if value A is zero", "b": "branch unconditionally to TARGET", - "return": "use last value on stack as success value; end", - "pop": "discard value X from stack", - "dup": "duplicate last value on stack", - "dup2": "duplicate two last values on stack: A, B -> A, B, A, B", - "dig": "push the Nth value from the top of the stack. dig 0 is equivalent to dup", + "return": "use A as success value; end", + "pop": "discard A", + "dup": "duplicate A", + "dup2": "duplicate A and B", + "dig": "Nth value from the top of the stack. dig 0 is equivalent to dup", "cover": "remove top of stack, and place it deeper in the stack such that N elements are above it. Fails if stack depth <= N.", "uncover": "remove the value at depth N in the stack and shift above items down so the Nth deep value is on top of the stack. Fails if stack depth <= N.", - "swap": "swaps two last values on stack: A, B -> B, A", - "select": "selects one of two values based on top-of-stack: A, B, C -> (if C != 0 then B else A)", - - "concat": "pop two byte-arrays A and B and join them, push the result", - "substring": "pop a byte-array A. For immediate values in 0..255 S and E: extract a range of bytes from A starting at S up to but not including E, push the substring result. If E < S, or either is larger than the array length, the program fails", - "substring3": "pop a byte-array A and two integers B and C. Extract a range of bytes from A starting at B up to but not including C, push the substring result. If C < B, or either is larger than the array length, the program fails", - "getbit": "pop a target A (integer or byte-array), and index B. Push the Bth bit of A.", - "setbit": "pop a target A, index B, and bit C. Set the Bth bit of A to C, and push the result", - "getbyte": "pop a byte-array A and integer B. Extract the Bth byte of A and push it as an integer", - "setbyte": "pop a byte-array A, integer B, and small integer C (between 0..255). Set the Bth byte of A to C, and push the result", - "extract": "pop a byte-array A. For immediate values in 0..255 S and L: extract a range of bytes from A starting at S up to but not including S+L, push the substring result. If L is 0, then extract to the end of the string. If S or S+L is larger than the array length, the program fails", - "extract3": "pop a byte-array A and two integers B and C. Extract a range of bytes from A starting at B up to but not including B+C, push the substring result. If B+C is larger than the array length, the program fails", - "extract_uint16": "pop a byte-array A and integer B. Extract a range of bytes from A starting at B up to but not including B+2, convert bytes as big endian and push the uint64 result. If B+2 is larger than the array length, the program fails", - "extract_uint32": "pop a byte-array A and integer B. Extract a range of bytes from A starting at B up to but not including B+4, convert bytes as big endian and push the uint64 result. If B+4 is larger than the array length, the program fails", - "extract_uint64": "pop a byte-array A and integer B. Extract a range of bytes from A starting at B up to but not including B+8, convert bytes as big endian and push the uint64 result. If B+8 is larger than the array length, the program fails", - "base64_decode": "decode X which was base64-encoded using _encoding_ E. Fail if X is not base64 encoded with encoding E", + "swap": "swaps A and B on stack", + "select": "selects one of two values based on top-of-stack: B if C != 0, else A", + + "concat": "join A and B", + "substring": "A range of bytes from A starting at S up to but not including E. If E < S, or either is larger than the array length, the program fails", + "substring3": "A range of bytes from A starting at B up to but not including C. If C < B, or either is larger than the array length, the program fails", + "getbit": "Bth bit of (byte-array or integer) A.", + "setbit": "Copy of (byte-array or integer) A, with the Bth bit set to (0 or 1) C", + "getbyte": "Bth byte of A, as an integer", + "setbyte": "Copy of A with the Bth byte set to small integer (between 0..255) C", + "extract": "A range of bytes from A starting at S up to but not including S+L. If L is 0, then extract to the end of the string. If S or S+L is larger than the array length, the program fails", + "extract3": "A range of bytes from A starting at B up to but not including B+C. If B+C is larger than the array length, the program fails", + "extract_uint16": "A uint16 formed from a range of big-endian bytes from A starting at B up to but not including B+2. If B+2 is larger than the array length, the program fails", + "extract_uint32": "A uint32 formed from a range of big-endian bytes from A starting at B up to but not including B+4. If B+4 is larger than the array length, the program fails", + "extract_uint64": "A uint64 formed from a range of big-endian bytes from A starting at B up to but not including B+8. If B+8 is larger than the array length, the program fails", + "base64_decode": "decode A which was base64-encoded using _encoding_ E. Fail if A is not base64 encoded with encoding E", "balance": "get balance for account A, in microalgos. The balance is observed after the effects of previous transactions in the group, and after the fee for the current transaction is deducted.", "min_balance": "get minimum required balance for account A, in microalgos. Required balance is affected by [ASA](https://developer.algorand.org/docs/features/asa/#assets-overview) and [App](https://developer.algorand.org/docs/features/asc1/stateful/#minimum-balance-requirement-for-a-smart-contract) usage. When creating or opting into an app, the minimum balance grows before the app code runs, therefore the increase is visible there. When deleting or closing out, the minimum balance decreases after the app executes.", - "app_opted_in": "check if account A opted in for the application B => {0 or 1}", - "app_local_get": "read from account A from local state of the current application key B => value", - "app_local_get_ex": "read from account A from local state of the application B key C => [*... stack*, value, 0 or 1]", - "app_global_get": "read key A from global state of a current application => value", - "app_global_get_ex": "read from application A global state key B => [*... stack*, value, 0 or 1]", - "app_local_put": "write to account specified by A to local state of a current application key B with value C", - "app_global_put": "write key A and value B to global state of the current application", - "app_local_del": "delete from account A local state key B of the current application", - "app_global_del": "delete key A from a global state of the current application", - "asset_holding_get": "read from account A and asset B holding field X (imm arg) => {0 or 1 (top), value}", - "asset_params_get": "read from asset A params field X (imm arg) => {0 or 1 (top), value}", - "app_params_get": "read from app A params field X (imm arg) => {0 or 1 (top), value}", - "assert": "immediately fail unless value X is a non-zero number", + "app_opted_in": "1 if account A is opted in to application B, else 0", + "app_local_get": "local state of the key B in the current application in account A", + "app_local_get_ex": "X is the local state of application B, key C in account A. Y is 1 if key existed, else 0", + "app_global_get": "global state of the key A in the current application", + "app_global_get_ex": "X is the global state of application A, key B. Y is 1 if key existed, else 0", + "app_local_put": "write C to key B in account A's local state of the current application", + "app_global_put": "write B to key A in the global state of the current application", + "app_local_del": "delete key B from account A's local state of the current application", + "app_global_del": "delete key A from the global state of the current application", + "asset_holding_get": "X is field F from account A's holding of asset B. Y is 1 if A is opted into B, else 0", + "asset_params_get": "X is field F from asset A. Y is 1 if A exists, else 0", + "app_params_get": "X is field F from app A. Y is 1 if A exists, else 0", + "acct_params_get": "X is field F from account A. Y is 1 if A owns positive algos, else 0", + "assert": "immediately fail unless X is a non-zero number", "callsub": "branch unconditionally to TARGET, saving the next instruction on the call stack", "retsub": "pop the top instruction from the call stack and branch to it", - "b+": "A plus B, where A and B are byte-arrays interpreted as big-endian unsigned integers", - "b-": "A minus B, where A and B are byte-arrays interpreted as big-endian unsigned integers. Fail on underflow.", - "b/": "A divided by B (truncated division), where A and B are byte-arrays interpreted as big-endian unsigned integers. Fail if B is zero.", - "b*": "A times B, where A and B are byte-arrays interpreted as big-endian unsigned integers.", - "b<": "A is less than B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b>": "A is greater than B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b<=": "A is less than or equal to B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b>=": "A is greater than or equal to B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b==": "A is equals to B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b!=": "A is not equal to B, where A and B are byte-arrays interpreted as big-endian unsigned integers => { 0 or 1}", - "b%": "A modulo B, where A and B are byte-arrays interpreted as big-endian unsigned integers. Fail if B is zero.", - "b|": "A bitwise-or B, where A and B are byte-arrays, zero-left extended to the greater of their lengths", - "b&": "A bitwise-and B, where A and B are byte-arrays, zero-left extended to the greater of their lengths", - "b^": "A bitwise-xor B, where A and B are byte-arrays, zero-left extended to the greater of their lengths", - "b~": "X with all bits inverted", - - "log": "write bytes to log state of the current application", + "b+": "A plus B. A and B are interpreted as big-endian unsigned integers", + "b-": "A minus B. A and B are interpreted as big-endian unsigned integers. Fail on underflow.", + "b/": "A divided by B (truncated division). A and B are interpreted as big-endian unsigned integers. Fail if B is zero.", + "b*": "A times B. A and B are interpreted as big-endian unsigned integers.", + "b<": "1 if A is less than B, else 0. A and B are interpreted as big-endian unsigned integers", + "b>": "1 if A is greater than B, else 0. A and B are interpreted as big-endian unsigned integers", + "b<=": "1 if A is less than or equal to B, else 0. A and B are interpreted as big-endian unsigned integers", + "b>=": "1 if A is greater than or equal to B, else 0. A and B are interpreted as big-endian unsigned integers", + "b==": "1 if A is equal to B, else 0. A and B are interpreted as big-endian unsigned integers", + "b!=": "0 if A is equal to B, else 1. A and B are interpreted as big-endian unsigned integers", + "b%": "A modulo B. A and B are interpreted as big-endian unsigned integers. Fail if B is zero.", + "b|": "A bitwise-or B. A and B are zero-left extended to the greater of their lengths", + "b&": "A bitwise-and B. A and B are zero-left extended to the greater of their lengths", + "b^": "A bitwise-xor B. A and B are zero-left extended to the greater of their lengths", + "b~": "A with all bits inverted", + + "bsqrt": "The largest integer I such that I^2 <= A. A and I are interpreted as big-endian unsigned integers", + + "log": "write A to log state of the current application", "itxn_begin": "begin preparation of a new inner transaction in a new transaction group", "itxn_next": "begin preparation of a new inner transaction in the same transaction group", - "itxn_field": "set field F of the current inner transaction to X", - "itxn_submit": "execute the current inner transaction group. Fail if executing this group would exceed 16 total inner transactions, or if any transaction in the group fails.", + "itxn_field": "set field F of the current inner transaction to A", + "itxn_submit": "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.", } // OpDoc returns a description of the op @@ -222,10 +226,13 @@ var opcodeImmediateNotes = map[string]string{ "asset_holding_get": "{uint8 asset holding field index}", "asset_params_get": "{uint8 asset params field index}", "app_params_get": "{uint8 app params field index}", + "acct_params_get": "{uint8 account params field index}", "itxn_field": "{uint8 transaction field index}", "itxn": "{uint8 transaction field index}", "itxna": "{uint8 transaction field index} {uint8 transaction field array index}", + "gitxn": "{uint8 transaction group index} {uint8 transaction field index}", + "gitxna": "{uint8 transaction group index} {uint8 transaction field index} {uint8 transaction field array index}", "ecdsa_verify": "{uint8 curve index}", "ecdsa_pk_decompress": "{uint8 curve index}", @@ -239,6 +246,21 @@ func OpImmediateNote(opName string) string { return opcodeImmediateNotes[opName] } +var opcodeSpecialStackEffects = map[string]string{ + "dup": "..., A → ..., A, A", + "dup2": "..., A, B → ..., A, B, A, B", + "dig": "..., A, [N items] → ..., A, [N items], A", + "swap": "..., A, B → ..., B, A", + "select": "..., A, B, C → ..., A or B", + "cover": "..., [N items], A → ..., A, [N items]", + "uncover": "..., A, [N items] → ..., [N items], A", +} + +// OpStackEffects returns a "stack pattern" for opcodes that do not have a derivable effect +func OpStackEffects(opName string) string { + return opcodeSpecialStackEffects[opName] +} + // further documentation on the function of the opcode var opDocExtras = map[string]string{ "ed25519verify": "The 32 byte public key is the last element on the stack, preceded by the 64 byte signature at the second-to-last element on the stack, preceded by the data which was signed at the third-to-last element on the stack.", @@ -256,37 +278,39 @@ var opDocExtras = map[string]string{ "+": "Overflow is an error condition which halts execution and fails the transaction. Full precision is available from `addw`.", "/": "`divmodw` is available to divide the two-element values produced by `mulw` and `addw`.", "bitlen": "bitlen interprets arrays as big-endian integers, unlike setbit/getbit", + "divmodw": "The notation J,K indicates that two uint64 values J and K are interpreted as a uint128 value, with J as the high uint64 and K the low.", "txn": "FirstValidTime causes the program to fail. The field is reserved for future use.", "gtxn": "for notes on transaction fields available, see `txn`. If this transaction is _i_ in the group, `gtxn i field` is equivalent to `txn field`.", "gtxns": "for notes on transaction fields available, see `txn`. If top of stack is _i_, `gtxns field` is equivalent to `gtxn _i_ field`. gtxns exists so that _i_ can be calculated, often based on the index of the current transaction.", "gload": "`gload` fails unless the requested transaction is an ApplicationCall and T < GroupIndex.", - "gloads": "`gloads` fails unless the requested transaction is an ApplicationCall and X < GroupIndex.", + "gloads": "`gloads` fails unless the requested transaction is an ApplicationCall and A < GroupIndex.", "gaid": "`gaid` fails unless the requested transaction created an asset or application and T < GroupIndex.", - "gaids": "`gaids` fails unless the requested transaction created an asset or application and X < GroupIndex.", + "gaids": "`gaids` fails unless the requested transaction created an asset or application and A < GroupIndex.", "btoi": "`btoi` fails if the input is longer than 8 bytes.", "concat": "`concat` fails if the result would be greater than 4096 bytes.", "pushbytes": "pushbytes args are not added to the bytecblock during assembly processes", "pushint": "pushint args are not added to the intcblock during assembly processes", "getbit": "see explanation of bit ordering in setbit", "setbit": "When A is a uint64, index 0 is the least significant bit. Setting bit 3 to 1 on the integer 0 yields 8, or 2^3. When A is a byte array, index 0 is the leftmost bit of the leftmost byte. Setting bits 0 through 11 to 1 in a 4-byte-array of 0s yields the byte array 0xfff00000. Setting bit 3 to 1 on the 1-byte-array 0x00 yields the byte array 0x10.", - "balance": "params: Before v4, Txn.Accounts offset. Since v4, Txn.Accounts offset or an account address that appears in Txn.Accounts or is Txn.Sender). Return: value.", - "min_balance": "params: Before v4, Txn.Accounts offset. Since v4, Txn.Accounts offset or an account address that appears in Txn.Accounts or is Txn.Sender). Return: value.", - "app_opted_in": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), application id (or, since v4, a Txn.ForeignApps offset). Return: 1 if opted in and 0 otherwise.", - "app_local_get": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), state key. Return: value. The value is zero (of type uint64) if the key does not exist.", - "app_local_get_ex": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), application id (or, since v4, a Txn.ForeignApps offset), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.", - "app_global_get_ex": "params: Txn.ForeignApps offset (or, since v4, an application id that appears in Txn.ForeignApps or is the CurrentApplicationID), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.", + "balance": "params: Txn.Accounts offset (or, since v4, an _available_ account address), _available_ application id (or, since v4, a Txn.ForeignApps offset). Return: value.", + "min_balance": "params: Txn.Accounts offset (or, since v4, an _available_ account address), _available_ application id (or, since v4, a Txn.ForeignApps offset). Return: value.", + "app_opted_in": "params: Txn.Accounts offset (or, since v4, an _available_ account address), _available_ application id (or, since v4, a Txn.ForeignApps offset). Return: 1 if opted in and 0 otherwise.", + "app_local_get": "params: Txn.Accounts offset (or, since v4, an _available_ account address), state key. Return: value. The value is zero (of type uint64) if the key does not exist.", + "app_local_get_ex": "params: Txn.Accounts offset (or, since v4, an _available_ account address), _available_ application id (or, since v4, a Txn.ForeignApps offset), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.", + "app_global_get_ex": "params: Txn.ForeignApps offset (or, since v4, an _available_ application id), state key. Return: did_exist flag (top of the stack, 1 if the application and key existed and 0 otherwise), value. The value is zero (of type uint64) if the key does not exist.", "app_global_get": "params: state key. Return: value. The value is zero (of type uint64) if the key does not exist.", - "app_local_put": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), state key, value.", - "app_local_del": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), state key.\n\nDeleting a key which is already absent has no effect on the application local state. (In particular, it does _not_ cause the program to fail.)", + "app_local_put": "params: Txn.Accounts offset (or, since v4, an _available_ account address), state key, value.", + "app_local_del": "params: Txn.Accounts offset (or, since v4, an _available_ account address), state key.\n\nDeleting a key which is already absent has no effect on the application local state. (In particular, it does _not_ cause the program to fail.)", "app_global_del": "params: state key.\n\nDeleting a key which is already absent has no effect on the application global state. (In particular, it does _not_ cause the program to fail.)", - "asset_holding_get": "params: Txn.Accounts offset (or, since v4, an account address that appears in Txn.Accounts or is Txn.Sender), asset id (or, since v4, a Txn.ForeignAssets offset). Return: did_exist flag (1 if the asset existed and 0 otherwise), value.", - "asset_params_get": "params: Before v4, Txn.ForeignAssets offset. Since v4, Txn.ForeignAssets offset or an asset id that appears in Txn.ForeignAssets. Return: did_exist flag (1 if the asset existed and 0 otherwise), value.", - "app_params_get": "params: Txn.ForeignApps offset or an app id that appears in Txn.ForeignApps. Return: did_exist flag (1 if the application existed and 0 otherwise), value.", + "asset_holding_get": "params: Txn.Accounts offset (or, since v4, an _available_ address), asset id (or, since v4, a Txn.ForeignAssets offset). Return: did_exist flag (1 if the asset existed and 0 otherwise), value.", + "asset_params_get": "params: Txn.ForeignAssets offset (or, since v4, an _available_ asset id. Return: did_exist flag (1 if the asset existed and 0 otherwise), value.", + "app_params_get": "params: Txn.ForeignApps offset or an _available_ app id. Return: did_exist flag (1 if the application existed and 0 otherwise), value.", "log": "`log` fails if called more than MaxLogCalls times in a program, or if the sum of logged bytes exceeds 1024 bytes.", - "itxn_begin": "`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 top-level transaction, and all other fields to zero values.", - "itxn_field": "`itxn_field` fails if X is of the wrong type for F, including a byte array of the wrong size for use as an address when F is an address field. `itxn_field` also fails if X is an account or asset that does not appear in `txn.Accounts` or `txn.ForeignAssets` of the top-level transaction. (Setting addresses in asset creation are exempted from this requirement.)", + "itxn_begin": "`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.", + "itxn_next": "`itxn_next` initializes the transaction exactly as `itxn_begin` does", + "itxn_field": "`itxn_field` fails if A is of the wrong type for F, including a byte array of the wrong size for use as an address when F is an address field. `itxn_field` also fails if A is an account, asset, or app that is not _available_. (Addresses set into asset params of acfg transactions need not be _available_.)", "itxn_submit": "`itxn_submit` resets the current transaction so that it can not be resubmitted. A new `itxn_begin` is required to prepare another inner transaction.", - "base64_decode": "Decodes X using the base64 encoding E. Specify the encoding with an immediate arg either as URL and Filename Safe (`URLEncoding`) or Standard (`StdEncoding`). See <a href=\"https://rfc-editor.org/rfc/rfc4648.html#section-4\">RFC 4648</a> (sections 4 and 5). It is assumed that the encoding ends with the exact number of `=` padding characters as required by the RFC. When padding occurs, any unused pad bits in the encoding must be set to zero or the decoding will fail. The special cases of `\\n` and `\\r` are allowed but completely ignored. An error will result when attempting to decode a string with a character that is not in the encoding alphabet or not one of `=`, `\\r`, or `\\n`.", + "base64_decode": "Decodes A using the base64 encoding E. Specify the encoding with an immediate arg either as URL and Filename Safe (`URLEncoding`) or Standard (`StdEncoding`). See <a href=\"https://rfc-editor.org/rfc/rfc4648.html#section-4\">RFC 4648</a> (sections 4 and 5). It is assumed that the encoding ends with the exact number of `=` padding characters as required by the RFC. When padding occurs, any unused pad bits in the encoding must be set to zero or the decoding will fail. The special cases of `\\n` and `\\r` are allowed but completely ignored. An error will result when attempting to decode a string with a character that is not in the encoding alphabet or not one of `=`, `\\r`, or `\\n`.", } // OpDocExtra returns extra documentation text about an op @@ -300,12 +324,12 @@ func OpDocExtra(opName string) string { var OpGroups = map[string][]string{ "Arithmetic": {"sha256", "keccak256", "sha512_256", "ed25519verify", "ecdsa_verify", "ecdsa_pk_recover", "ecdsa_pk_decompress", "+", "-", "/", "*", "<", ">", "<=", ">=", "&&", "||", "shl", "shr", "sqrt", "bitlen", "exp", "==", "!=", "!", "len", "itob", "btoi", "%", "|", "&", "^", "~", "mulw", "addw", "divmodw", "expw", "getbit", "setbit", "getbyte", "setbyte", "concat"}, "Byte Array Manipulation": {"substring", "substring3", "extract", "extract3", "extract_uint16", "extract_uint32", "extract_uint64", "base64_decode"}, - "Byte Array Arithmetic": {"b+", "b-", "b/", "b*", "b<", "b>", "b<=", "b>=", "b==", "b!=", "b%"}, + "Byte Array Arithmetic": {"b+", "b-", "b/", "b*", "b<", "b>", "b<=", "b>=", "b==", "b!=", "b%", "bsqrt"}, "Byte Array Logic": {"b|", "b&", "b^", "b~"}, - "Loading Values": {"intcblock", "intc", "intc_0", "intc_1", "intc_2", "intc_3", "pushint", "bytecblock", "bytec", "bytec_0", "bytec_1", "bytec_2", "bytec_3", "pushbytes", "bzero", "arg", "arg_0", "arg_1", "arg_2", "arg_3", "args", "txn", "gtxn", "txna", "txnas", "gtxna", "gtxnas", "gtxns", "gtxnsa", "gtxnsas", "global", "load", "loads", "store", "stores", "gload", "gloads", "gaid", "gaids"}, + "Loading Values": {"intcblock", "intc", "intc_0", "intc_1", "intc_2", "intc_3", "pushint", "bytecblock", "bytec", "bytec_0", "bytec_1", "bytec_2", "bytec_3", "pushbytes", "bzero", "arg", "arg_0", "arg_1", "arg_2", "arg_3", "args", "txn", "gtxn", "txna", "txnas", "gtxna", "gtxnas", "gtxns", "gtxnsa", "gtxnsas", "global", "load", "loads", "store", "stores", "gload", "gloads", "gloadss", "gaid", "gaids"}, "Flow Control": {"err", "bnz", "bz", "b", "return", "pop", "dup", "dup2", "dig", "cover", "uncover", "swap", "select", "assert", "callsub", "retsub"}, - "State Access": {"balance", "min_balance", "app_opted_in", "app_local_get", "app_local_get_ex", "app_global_get", "app_global_get_ex", "app_local_put", "app_global_put", "app_local_del", "app_global_del", "asset_holding_get", "asset_params_get", "app_params_get", "log"}, - "Inner Transactions": {"itxn_begin", "itxn_next", "itxn_field", "itxn_submit", "itxn", "itxna"}, + "State Access": {"balance", "min_balance", "app_opted_in", "app_local_get", "app_local_get_ex", "app_global_get", "app_global_get_ex", "app_local_put", "app_global_put", "app_local_del", "app_global_del", "asset_holding_get", "asset_params_get", "app_params_get", "acct_params_get", "log"}, + "Inner Transactions": {"itxn_begin", "itxn_next", "itxn_field", "itxn_submit", "itxn", "itxna", "gitxn", "gitxna"}, } // OpCost indicates the cost of an operation over the range of @@ -376,7 +400,7 @@ var txnFieldDocs = map[string]string{ "Type": "Transaction type as bytes", "TypeEnum": "See table below", "Sender": "32 byte address", - "Fee": "micro-Algos", + "Fee": "microalgos", "FirstValid": "round number", "FirstValidTime": "Causes program to fail; reserved for future use", "LastValid": "round number", @@ -388,7 +412,7 @@ var txnFieldDocs = map[string]string{ "TxID": "The computed ID for this transaction. 32 bytes.", "Receiver": "32 byte address", - "Amount": "micro-Algos", + "Amount": "microalgos", "CloseRemainderTo": "32 byte address", "VotePK": "32 byte address", @@ -439,62 +463,46 @@ var txnFieldDocs = map[string]string{ "FreezeAssetAccount": "32 byte address of the account whose asset slot is being frozen or un-frozen", "FreezeAssetFrozen": "The new frozen value, 0 or 1", - "Logs": "Log messages emitted by an application call (itxn only)", - "NumLogs": "Number of Logs (itxn only)", - "CreatedAssetID": "Asset ID allocated by the creation of an ASA (itxn only)", - "CreatedApplicationID": "ApplicationID allocated by the creation of an application (itxn only)", -} - -// TxnFieldDocs are notes on fields available by `txn` and `gtxn` with extra versioning info if any -func TxnFieldDocs() map[string]string { - return fieldsDocWithExtra(txnFieldDocs, txnFieldSpecByName) + "Logs": "Log messages emitted by an application call (`itxn` only until v6)", + "NumLogs": "Number of Logs (`itxn` only until v6)", + "CreatedAssetID": "Asset ID allocated by the creation of an ASA (`itxn` only until v6)", + "CreatedApplicationID": "ApplicationID allocated by the creation of an application (`itxn` only until v6)", } var globalFieldDocs = map[string]string{ - "MinTxnFee": "micro Algos", - "MinBalance": "micro Algos", + "MinTxnFee": "microalgos", + "MinBalance": "microalgos", "MaxTxnLife": "rounds", "ZeroAddress": "32 byte address of all zero bytes", "GroupSize": "Number of transactions in this atomic transaction group. At least 1", - "LogicSigVersion": "Maximum supported TEAL version", + "LogicSigVersion": "Maximum supported version", "Round": "Current round number", "LatestTimestamp": "Last confirmed block UNIX timestamp. Fails if negative", - "CurrentApplicationID": "ID of current application executing. Fails in LogicSigs", - "CreatorAddress": "Address of the creator of the current application. Fails if no such application is executing", - "CurrentApplicationAddress": "Address that the current application controls. Fails in LogicSigs", + "CurrentApplicationID": "ID of current application executing", + "CreatorAddress": "Address of the creator of the current application", + "CurrentApplicationAddress": "Address that the current application controls", "GroupID": "ID of the transaction group. 32 zero bytes if the transaction is not part of a group.", + "OpcodeBudget": "The remaining cost that can be spent by opcodes in this program.", + "CallerApplicationID": "The application ID of the application that called this application. 0 if this application is at the top-level.", + "CallerApplicationAddress": "The application address of the application that called this application. ZeroAddress if this application is at the top-level.", } -// GlobalFieldDocs are notes on fields available in `global` with extra versioning info if any -func GlobalFieldDocs() map[string]string { - return fieldsDocWithExtra(globalFieldDocs, globalFieldSpecByName) -} - -type extractor interface { - getExtraFor(string) string -} - -func fieldsDocWithExtra(source map[string]string, ex extractor) map[string]string { - result := make(map[string]string, len(source)) - for name, doc := range source { - if extra := ex.getExtraFor(name); len(extra) > 0 { - if len(doc) == 0 { - doc = extra - } else { - sep := ". " - if doc[len(doc)-1] == '.' { - sep = " " - } - doc = fmt.Sprintf("%s%s%s", doc, sep, extra) - } - } - result[name] = doc +func addExtra(original string, extra string) string { + if len(original) == 0 { + return extra } - return result + if len(extra) == 0 { + return original + } + sep := ". " + if original[len(original)-1] == '.' { + sep = " " + } + return original + sep + extra } // AssetHoldingFieldDocs are notes on fields available in `asset_holding_get` -var AssetHoldingFieldDocs = map[string]string{ +var assetHoldingFieldDocs = map[string]string{ "AssetBalance": "Amount of the asset unit held by this account", "AssetFrozen": "Is the asset frozen or not", } @@ -515,11 +523,6 @@ var assetParamsFieldDocs = map[string]string{ "AssetCreator": "Creator address", } -// AssetParamsFieldDocs are notes on fields available in `asset_params_get` with extra versioning info if any -func AssetParamsFieldDocs() map[string]string { - return fieldsDocWithExtra(assetParamsFieldDocs, assetParamsFieldSpecByName) -} - // appParamsFieldDocs are notes on fields available in `app_params_get` var appParamsFieldDocs = map[string]string{ "AppApprovalProgram": "Bytecode of Approval Program", @@ -533,9 +536,11 @@ var appParamsFieldDocs = map[string]string{ "AppAddress": "Address for which this application has authority", } -// AppParamsFieldDocs are notes on fields available in `app_params_get` with extra versioning info if any -func AppParamsFieldDocs() map[string]string { - return fieldsDocWithExtra(appParamsFieldDocs, appParamsFieldSpecByName) +// acctParamsFieldDocs are notes on fields available in `app_params_get` +var acctParamsFieldDocs = map[string]string{ + "AcctBalance": "Account balance in microalgos", + "AcctMinBalance": "Minimum required blance for account, in microalgos", + "AcctAuthAddr": "Address the account is rekeyed to.", } // EcdsaCurveDocs are notes on curves available in `ecdsa_` opcodes |