diff --git a/.gitlab/ci/test-doc-scripts.yml b/.gitlab/ci/test-doc-scripts.yml index 81888bc641e0cca95cd51f971f0af2187dc99acf..c4b9bd1ed4a5948893bc44149d4a4608d474ca4b 100644 --- a/.gitlab/ci/test-doc-scripts.yml +++ b/.gitlab/ci/test-doc-scripts.yml @@ -34,14 +34,14 @@ install_bin_focal: script: - bash ./docs/introduction/install-bin-fedora.sh -install_bin_fedora_32: - image: fedora:32 - extends: .install_bin_fedora_template - install_bin_fedora_33: image: fedora:33 extends: .install_bin_fedora_template +install_bin_fedora_34: + image: fedora:34 + extends: .install_bin_fedora_template + .install_opam_ubuntu_template: extends: - .default_settings_template diff --git a/docs/009/cli-commands.rst b/docs/009/cli-commands.rst deleted file mode 100644 index 3de61b832d5ffc75b0846cad8793950f7ddaded8..0000000000000000000000000000000000000000 --- a/docs/009/cli-commands.rst +++ /dev/null @@ -1,54 +0,0 @@ -********************** -Command Line Interface -********************** - -This document is a prettier output of the documentation produced by -the command ``man`` of the different Tezos binaries. You can obtain similar pages -using shell commands such as (:ref:`indicating the appropriate protocol `): - -:: - - tezos-client -protocol man -verbosity 3 - -The rest of this page documents the protocol-dependent tools. -The protocol-independent tools are documented :doc:`here <../shell/cli-commands>`. - - -.. _client_manual: -.. _client_manual_009: - -Client manual -============= - -.. raw:: html - :file: tezos-client.html - - -.. _baker_manual: -.. _baker_manual_009: - -Baker manual -============ - -.. raw:: html - :file: tezos-baker.html - - -.. _endorser_manual: -.. _endorser_manual_009: - -Endorser manual -=============== - -.. raw:: html - :file: tezos-endorser.html - - -.. _accuser_manual: -.. _accuser_manual_009: - -Accuser manual -============== - -.. raw:: html - :file: tezos-accuser.html diff --git a/docs/009/consensus.rst b/docs/009/consensus.rst deleted file mode 100644 index 8a1f011531eb5800246fb9e603c8254b290f1e93..0000000000000000000000000000000000000000 --- a/docs/009/consensus.rst +++ /dev/null @@ -1,351 +0,0 @@ -The consensus algorithm -======================= - -This document provides a description of Emmy+, the Tezos -proof-of-stake consensus algorithm, as implemented in the current -protocol (namely `PsFLoren` on `mainnet`). - -History -------- - -Before Emmy+, there was Emmy, a Nakamoto-style consensus first described in -2014, in the `Tezos whitepaper -`_: - - our proof-of-stake mechanism is a mix of several ideas, including - Slasher, chain-of-activity, and proof-of-burn. - -The specificity of Emmy with respect to other proof-of-stake consensus -algorithms, including some protocols introduced later such as `Ouroboros -`_ and `Snow White -`_, is the combined use of priorities and -endorsements in the so called minimal delay function. Thanks to these concepts, -Emmy offers a better protection against selfish baking and a shorter time to -finality. The time to finality can be measured in terms of the number of -confirmations a user must have seen for a block to be considered as final. We -recall that, being a Nakamoto-style consensus, Emmy provides *probabilistic* -finality. - - -Emmy+ ------ - -Emmy+ is an improvement of Emmy which still guards against selfish baking but -also achieves greater efficiency and stability. - -.. _terminology: -.. _terminology_009: - -Terminology -~~~~~~~~~~~ - -A *block* in the blockchain consists of a header and a list of operations. The -header has a shell part (common to all protocols) and a -protocol-specific part. In Emmy+, :ref:`the protocol-specific part of the -header` contains, most notably, a timestamp, a -priority (a natural number), and the endorsements for the block at the previous -level. *Endorsements* are operations that can be seen as votes for a given -block. Each block is signed. - -Before being endorsed, blocks are baked. *Baking* is the action of producing and -signing a block. Corresponding to these two actions of baking and endorsing, at -each level, two lists of slots are being created: a (conceptually) infinite list -of baking slots and a list of ``ENDORSERS_PER_BLOCK`` endorsing slots (the value of ``ENDORSERS_PER_BLOCK`` is one of the :ref:`parameters of the consensus protocol `). The index -of a baking slot is called a *priority*. Each slot is associated to a -participant. A participant can appear several times in both lists. The selection -of participants is at :ref:`random`, independently for -each slot, and is stake based. - -An endorsement for a block at level :math:`\ell` is *valid* if it is signed by -a participant that has an endorsing slot at level :math:`\ell`. The *endorsing -power* of an endorsement is the number of slots the endorser owns at level :math:`\ell`. The endorsing -power of a block is the sum of the endorsing powers of the endorsements it -contains. - - -Minimal block delay function -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -At the heart of Emmy+, there is the minimal block delay function. This function -serves to compute the minimal time between blocks depending on the current -block's priority `p`, and its endorsing power `e`. Namely, Emmy+ defines the -minimal block delay function as follows: - -.. _delayplus: -.. _delayplus_009: - -.. math:: - delay+(p, e) = bd + dp \cdot p + de \cdot max(0, ie - e) - -where - -- :math:`bd` stands for the minimal time between the blocks, -- :math:`dp` stands for "delay per priority", -- :math:`de` stands for "delay per (missed) endorsement", and -- :math:`ie` stands for the "initial endorsing power". - -The delay function serves to determine if a produced block can -be considered as valid. - -Block validity condition -~~~~~~~~~~~~~~~~~~~~~~~~ - -A block with timestamp :math:`t'`, priority :math:`p`, and -endorsing power :math:`e` is *valid* at level :math:`\ell` if: - -- the endorsements in the block are valid for level :math:`\ell-1`, -- it is signed by the baker that has baking slot :math:`p`, and -- :math:`t' \geq t + delay(p,e)`, where :math:`t` is the timestamp of the - previous block. - -We note that, by the definition of the delay function, the higher the priority -and the smaller the endorsing power, the longer it takes before the block is -considered as valid. However, if the block has priority 0 and contains endorsements with endorsing -power at least :math:`ie`, then there is no time penalty. - -Emmy+ abstractly -~~~~~~~~~~~~~~~~ - -We refer to someone trying to reach consensus by the generic notion of -participant. Emmy+ can be described in an abstract manner as -follows: - -- A participant continuously observes blocks and endorsements. -- A participant always adopts the :ref:`fittest`, that - is, the longest (valid) chain it observes. -- A participant that has at least an endorsement slot at level :math:`\ell`, - emits an endorsement for the first block it observes at level - :math:`\ell`. -- A participant produces a block as soon as it is allowed to, that is, as soon - as it can produce a valid block (see the validity condition above). - -Emmy+ concretely -~~~~~~~~~~~~~~~~ - -In Tezos, a participant is a :ref:`delegate` that has at least one -:ref:`roll`, and is :ref:`active`. For simplicity we -just refer to participants as delegates (and omit the "active" and "with rolls" -attributes). A delegate plays two roles: - -- that of a **baker**, that is, it creates blocks, or -- that of an **endorser**, that is, it contributes in agreeing on - a block by **endorsing** that block. - - -.. _emmyp_slot_selection: -.. _emmyp_slot_selection_009: - -To these roles correspond the two types of actions mentioned above, baking and -endorsing. As mentioned above, the baking and endorsing rights of a delegate are -given by its baking, respectively endorsing slots, whose selection is described -:ref:`here`. The mechanism behind baking slots is meant to ensure that -if the delegate whose turn is to bake is for some reason unable to bake, the -next delegate in the list can step up and bake the block. - -.. _emmyp_fitness_and_header: -.. _emmyp_fitness_and_header_009: - -There are two more notions which are defined abstractly at the level of the -shell and concretized in Emmy+, the :ref:`fitness`, and the -protocol-specific header: - -- the fitness of a block is 1 plus the fitness of the previous block; -- the protocol-specific header of a block has the following fields: - - - ``signature``: a digital signature of the shell and protocol - headers (excluding the signature itself). - - ``priority``: the position in the priority list of delegates - at which the block was baked. - - ``seed_nonce_hash``: a commitment to :ref:`a random number`, used to - generate entropy on the chain. Present in only one out of - ``BLOCKS_PER_COMMITMENT`` (see :ref:`Constants`). - - ``proof_of_work_nonce``: a nonce used to pass a low-difficulty - proof-of-work for the block, as a spam prevention measure. - - -The consensus algorithm is implemented in Tezos in five components: the shell, -the economic protocol, and the three daemons: the baker, the endorser, and the -accuser. - -There are mainly two rules that the shell uses when receiving a new valid block: - -- The shell changes the head of the chain to this new block only if it has a - higher fitness than the current head. -- The shell does not accept a branch whose fork point is in a cycle more than - ``PRESERVED_CYCLES`` in the past. More precisely, if ``n`` is the current - cycle, the last allowed fork point is the first level of cycle - ``n-PRESERVED_CYCLES``. - -The parameter ``PRESERVED_CYCLES`` therefore plays a central role in Tezos: any -block before the last allowed fork level is immutable. - -Finally, the economic protocol provides the rules for when block and -endorsements are valid, as explained above, and defines the economic incentives -of delegates. Finally, the three daemons are responsible for injecting blocks, -endorsements, and respectively accusations (see below) on behalf of delegates. - - -Economic Incentives -~~~~~~~~~~~~~~~~~~~ - -In Emmy+, participation in consensus is rewarded and bad behavior is punished. - -Rewards -^^^^^^^ - -To incentivize participation in the consensus algorithm, delegates are rewarded -for baking and endorsing. The reward for baking a block with priority :math:`p` -and endorsing power :math:`e` is given by the formula -:math:`baking\_reward(p,e)`. The rewards for endorsing a block with priority -:math:`p` and having the corresponding endorsement included in the block is -given by the formula :math:`endorsing\_reward(p,e)`, where :math:`e` is the -endorsement's endorsing power. These reward formulas are as follows: - -.. math:: - baking\_reward(p,e) = \begin{cases} - \frac{e}{te}\cdot \frac{level\_rewards\_prio\_zero}{2} & \mbox{ if } p = 0\\ - \frac{e}{te} \cdot level\_rewards\_prio\_nonzero & \mbox{ otherwise } - \end{cases} - -.. math:: - endorsing\_reward(p,e) = \begin{cases} - baking\_reward(0, e) & \mbox{ if } p = 0\\ - \frac{2}{3} \cdot baking\_reward(0, e) & \mbox{ otherwise } - \end{cases} - -where - -- :math:`te` (for total endorsing power) stands for ``ENDORSERS_PER_BLOCK``, -- :math:`level\_rewards\_prio\_zero` and :math:`level\_rewards\_prio\_nonzero` are constants. - -The motivation behind this choice of design is given in the `Carthage blog post -`_. - -Besides the reward for baking, the baker receives all the fees paid for the -transactions included in the baked block. - -Rewards and fees are not distributed immediately, instead they are frozen for a -period of ``PRESERVED_CYCLES``. - -Slashing -^^^^^^^^ - -If a delegate deviates from the consensus rules by baking or endorsing two -different blocks at the same level, we say that a delegate double signs. As a -counter-measure against double signing a *security deposit* is frozen from the -delegate's account. Precisely, each delegate key has an associated security -deposit account. When a delegate bakes or endorses a block the security deposit -is automatically moved to the deposit account where it is frozen for -``PRESERVED_CYCLES`` cycles, after which it is automatically moved back to the -baker's main account. - -The values of the security deposits are ``BLOCK_SECURITY_DEPOSIT`` per block -created and ``ENDORSEMENT_SECURITY_DEPOSIT`` per endorsement slot. - -The evidence for double signing at a given level can be collected by any -:ref:`accuser` and included as an *accusation* operation in a block -for a period of ``PRESERVED_CYCLES``. The inclusion of the accusation leads to -forfeiting the entirety of the security deposits and fees obtained during the -cycle when the double signing was made. Half of this amount is burned, and half -goes to the baker who included the accusation. - -In the current protocol, accusations for the *same* incident can be made several -times after the fact. This means that the deposits and fees for the entire -cycle are forfeited, including any deposit made, or fees earned, after the -incident. Pragmatically, any baker who either double bakes or endorses in a -given cycle should immediately stop both baking and endorsing for the rest of -that cycle. - -.. _cs_constants_009: -.. _cs_constants: - -Consensus protocol parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In this section we map the above notation to their corresponding parameter -values. -Note that these parameters are part of the larger set of :ref:`protocol constants `. - -.. list-table:: Mapping - :widths: 55 50 25 - :header-rows: 1 - - * - Notation - - Parameter name - - Parameter value - * - :math:`bd` - - ``TIME_BETWEEN_BLOCKS[0]`` - - 60 seconds - * - :math:`dp` - - ``TIME_BETWEEN_BLOCKS[1]`` - - 40 seconds - * - :math:`de` - - ``DELAY_PER_MISSING_ENDORSEMENT`` - - 8 seconds - * - :math:`ie` - - ``INITIAL_ENDORSERS`` - - 24 - * - :math:`te` - - ``ENDORSERS_PER_BLOCK`` - - 32 - * - :math:`\frac{level\_rewards\_prio\_zero}{te \cdot 2}` - - ``BAKING_REWARD_PER_ENDORSEMENT[0]`` - - 1.250ꜩ - * - :math:`\frac{level\_rewards\_prio\_nonzero}{te}` - - ``BAKING_REWARD_PER_ENDORSEMENT[1]`` - - 0.1875 ꜩ - * - :math:`endorsing\_reward(0,1)` - - ``ENDORSEMENT_REWARD[0]`` - - 1.250 ꜩ - * - :math:`endorsing\_reward(p,1)` for :math:`p \geq 1` - - ``ENDORSEMENT_REWARD[1]`` - - 0.833333 ꜩ - * - - - ``BLOCK_SECURITY_DEPOSIT`` - - 512 ꜩ - * - - - ``ENDORSEMENT_SECURITY_DEPOSIT`` - - 64 ꜩ - -Since blocks are at least ``TIME_BETWEEN_BLOCKS[0]``, that is one minute apart, -and since a cycle has ``BLOCKS_PER_CYCLE``, that is :ref:`4096 -blocks`, a cycle lasts *at least* 2 days, 20 hours, and 16 -minutes, and ``PRESERVED_CYCLES`` cycles, that is 5 cycles, last *at least* 14 -days, 5 hours, and 20 minutes. - -The value for ``BAKING_REWARD_PER_ENDORSEMENT[0]`` is chosen such that the -inflation from block rewards and endorsement rewards, which is given by -``ENDORSERS_PER_BLOCK`` \* (``ENDORSEMENT_REWARD[0]`` + -``BAKING_REWARD_PER_ENDORSEMENT[0]``) is 80 ꜩ which in turn preserves the 5.51% -annual inflation. - -Since deposits are locked for a period of ``PRESERVED_CYCLES``, one can compute -that at any given time, about ((``BLOCK_SECURITY_DEPOSIT`` + -``ENDORSEMENT_SECURITY_DEPOSIT`` \* ``ENDORSERS_PER_BLOCK``) \* -(``PRESERVED_CYCLES`` + 1) \* ``BLOCKS_PER_CYCLE``) tokens of all staked tokens -should be held as security deposits. For instance, if the amount of staked -tokens is 720,000,000 ꜩ, then roughly 8.74% of this amount is stored in security -deposits. This percentage also gives an indication of the minimal amount of -tokens a delegate should own in order to not miss out on creating a block or an -endorsement. Please refer to :ref:`this section ` -of the documentation for a discussion on (over-)delegation. - - -Further External Resources --------------------------- - -The following blog posts present the intuition behind Emmy+: - -- https://blog.nomadic-labs.com/emmy-an-improved-consensus-algorithm.html -- https://blog.nomadic-labs.com/a-new-reward-formula-for-carthage.html. - -Emmy+ was further analyzed in: - -- https://blog.nomadic-labs.com/analysis-of-emmy.html -- https://blog.nomadic-labs.com/on-defending-against-malicious-reorgs-in-tezos-proof-of-stake.html -- https://blog.nomadic-labs.com/emmy-in-the-partial-synchrony-model.html -- https://blog.nomadic-labs.com/the-case-of-mixed-forks-in-emmy.html - -A more high-level presentation of Emmy+ can be found in the -`Tezos agora wiki entry -`_. diff --git a/docs/009/glossary.rst b/docs/009/glossary.rst deleted file mode 100644 index c7588448ee874e0cca34c426f682b687cea02a86..0000000000000000000000000000000000000000 --- a/docs/009/glossary.rst +++ /dev/null @@ -1,179 +0,0 @@ -Glossary -======== - -This glossary is divided in two sections, the first one concerns Tezos, and -the second one concerns the `economic protocol`_. The definitions in the latter -section may be different for other protocol versions. - -Tezos ------ - -.. include:: ../shell/glossary.rst.h - -Protocol --------- - -_`Accuser` - When a node_ attempts to inject several incompatible blocks (or when it tries - to abuse the network in another similar way), another node_ can make an - accusation: show evidence of attempted abuse. The node_ making the accusation - is the accuser. - - The accuser is awarded some funds from the baking_ deposit of the accused. - - Using the tools provided by Nomadic Labs, accusation is handled by a - separate binary. - -_`Account` - An account is a unique identifier within the protocol. There are different - kinds of accounts (see `Originated account`_ and `Implicit account`_). - - In the Context_, each account is associated with a balance (an amount of - tez available). - -_`Baker` - When a node_ creates a new block_, it is the baker of this block_. - Baking_ rights are distributed to different accounts based on their - available balance. Only a node_ that handles an account_ with baking_ rights - is allowed to bake; blocks created by another node_ are invalid. - The baker selects transactions from the mempool_ to be included in the block_ it bakes. - - Using the tools provided by Nomadic Labs, baking_ is handled by a - separate binary. - -_`Baking`/_`Endorsing rights` - A delegate_ is allowed to bake/endorse a block_ if he holds the - baking/endorsing right for that block_. At the start of a Cycle_, - baking and endorsing rights are computed for all the block_ heights in the - cycle_, based on the proportion of Rolls owned by each accounts. - - For each block_ height, there are several accounts that are allowed to bake. - These different accounts are given different Priorities. - - For each block_ height, there are several accounts that are allowed to - endorse. There can be multiple endorsements per block_. - -_`Burn` - To ensure responsible use of the storage space on the public blockchain, - there are some costs charged to users for consuming storage. These - costs are burnt (i.e., the amount of tez is destroyed). For example, - a per-byte storage cost is burnt for increasing the storage space of a - smart contract; a fixed amount is burnt for allocating a new contract - (which consumes space by storing its address on the blockchain). - - See also `Fee`_. - -_`Constants` - Protocols are parameterized by several parameters called protocol constants, which may vary from one protocol to another or from one network to another. - -_`Contract` - See account_. - -_`Cycle` - A cycle is a set of consecutive blocks. E.g., cycle 12 started at block_ - height 49152 and ended at block_ height 53248. - - Cycles are used as a unit of “time” in the block_ chain. For example, the - different phases in the amendment voting procedures are defined based on - cycles. - -_`Delegate` - An `Implicit account`_ to which an account_ has delegated their baking_ and - `endorsing rights`_. The baking_ rights and `endorsing rights`_ are - calculated based on the total balance of tez that an account_ has been - delegated to. - -_`Delegation` - An operation_ in which an account_ balance is lent to a - delegate_. This increases the delegate_'s rolls and consequently - its Baking_ rights. The delegate_ does not control the funds from - the account_. - -_`Double baking` - When a baker_ signs two different blocks at the same height, it is called - double baking. Double baking is detrimental to the network and might be - indicative of an attempt to double spend. As such, it is punished by the - network: an accuser_ can provide proof of the double baking to be awarded - part of the baker_'s deposit. - -_`Endorser` - When a block_ is created and propagated on the network, nodes that have - `endorsing rights`_ for the matching block_ height can emit an endorsement - operation_. The accounts that emit the block_ are the endorsers of the block_. - Endorsement operations_ are included in the next block_. - - Using the tools provided by Nomadic Labs, endorsement is handled by a - separate binary. - -_`Fee` - To ensure responsible use of computation resources of other nodes, and also to encourage active participation in the consensus protocol, there are some - fees that users pay to bakers for including their operations in blocks. - For example, fees are paid to a baker for operations such as a transaction_ or a revelation of a public key. - - See also `Burn`_. - -_`Gas` - A measure of the number of elementary operations_ performed during - the execution of a `smart contract`_. Gas is used to measure how - much computing power is used to execute a `smart contract`_. - -_`Implicit account` - An account_ that is linked to a public key. Contrary to a `smart - contract`_, an `Implicit account`_ cannot include a script and it - cannot reject incoming transactions. - - If registered, an `Implicit account`_ can act as a delegate_. - - The address of an `Implicit account`_ always starts with the - letters `tz` followed by `1`, `2` or `3` (depending on the - signature scheme) and finally the hash of the public key. - -.. _glossary_michelson: -.. _glossary_michelson_009: - -Michelson - The built-in language used by a `smart contract`_. - -_`Operations` - The main operations in the protocol are transactions (to transfer funds - or to execute smart contracts), accusations, activations, delegations, - endorsements and originations. - -_`Originated account` - See `smart contract`_. - -_`Origination` - An operation_ to create a `smart contract`_. - -_`Priority` - A rank of different baking_ rights. Each rank corresponds to a time span. A - baker_ with baking_ rights at a given priority is only allowed to bake during - the priority's corresponding time span. Baking_ outside of one's designated - priority, results in an invalid block_. - -_`Roll` - An amount of tez (e.g., 8000ꜩ) serving as a unit to determine delegates' - baking_ rights in a cycle_. A delegate_ with twice as many rolls as another - will be given twice as many rights to bake. - -_`Smart contract` - Account_ which is associated to a :ref:`Michelson ` script. They are - created with an explicit origination_ operation and are therefore - sometimes called originated accounts. The address of a smart - contract always starts with the letters ``KT1``. - -_`Transaction` - An operation_ to transfer tez between two accounts, or to run the code of a - `smart contract`_. - -_`Voting period` - Any of the ``proposal``, ``exploration``, ``cooldown``, - ``promotion`` or ``adoption`` stages in the voting procedure when - ammending the `economic protocol`_. - -_`Voting listings` - The list calculated at the beginning of each `voting period`_ that contains - the staking balance (in number of rolls) of each delegate_ that owns more - than one roll_ at that moment. For each delegate_, The voting listings - reflects the weight of the vote emitted by the delegate_ when ammending the - `economic protocol`_. diff --git a/docs/009/michelson.rst b/docs/009/michelson.rst deleted file mode 100644 index a92e85e2c1d371b20dbd31f40783f0f9598fc057..0000000000000000000000000000000000000000 --- a/docs/009/michelson.rst +++ /dev/null @@ -1,3692 +0,0 @@ -Michelson: the language of Smart Contracts in Tezos -=================================================== - -This specification gives a detailed formal semantics of the Michelson -language and a short explanation of how smart contracts are executed -and interact in the blockchain. - -The language is stack-based, with high level data types and primitives, -and strict static type checking. Its design cherry picks traits from -several language families. Vigilant readers will notice direct -references to Forth, Scheme, ML and Cat. - -A Michelson program is a series of instructions that are run in -sequence: each instruction receives as input the stack resulting from the -previous instruction, and rewrites it for the next one. The stack -contains both immediate values and heap allocated structures. All values -are immutable and garbage collected. - -The types of the input and output stack are fixed and monomorphic, -and the program is typechecked before being introduced into the system. -No smart contract execution can fail because an instruction has been -executed on a stack of unexpected length or contents. - -This specification gives the complete instruction set, type system and -semantics of the language. It is meant as a precise reference manual, -not an easy introduction. Even though, some examples are provided at -the end of the document and can be read first or at the same time as -the specification. The document also starts with a less formal -explanation of the context: how Michelson code interacts with the -blockchain. - -Semantics of smart contracts and transactions ---------------------------------------------- - -The Tezos ledger currently has two types of accounts that can hold -tokens (and be the destinations of transactions). - - - An implicit account is a non programmable account, whose tokens - are spendable and delegatable by a public key. Its address is - directly the public key hash, and starts with ``tz1``, ``tz2`` or - ``tz3``. - - A smart contract is a programmable account. A transaction to such - an address can provide data, and can fail for reasons decided by - its Michelson code. Its address is a unique hash that depends on - the operation that led to its creation, and starts with ``KT1``. - -From Michelson, they are indistinguishable. A safe way to think about -this is to consider that implicit accounts are smart contracts that -always succeed to receive tokens, and does nothing else. - -Intra-transaction semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Alongside their tokens, smart contracts keep a piece of storage. Both -are ruled by a specific logic specified by a Michelson program. A -transaction to a smart contract will provide an input value and in -option some tokens, and in return, the smart contract can modify its -storage and transfer its tokens. - -The Michelson program receives as input a stack containing a single -pair whose first element is an input value and second element the -content of the storage space. It must return a stack containing a -single pair whose first element is the list of internal operations -that it wants to emit, and second element is the new contents of the -storage space. Alternatively, a Michelson program can fail, explicitly -using a specific opcode, or because something went wrong that could -not be caught by the type system (e.g. gas exhaustion). - -A bit of polymorphism can be used at contract level, with a -lightweight system of named entrypoints: instead of an input value, -the contract can be called with an entrypoint name and an argument, -and these two components are transformed automatically in a simple and -deterministic way to an input value. This feature is available both -for users and from Michelson code. See the dedicated section. - -Inter-transaction semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -An operation included in the blockchain is a sequence of "external -operations" signed as a whole by a source address. These operations -are of three kinds: - - - Transactions to transfer tokens to implicit accounts or tokens and - parameters to a smart contract (or, optionally, to a specified - entrypoint of a smart contract). - - Originations to create new smart contracts from its Michelson - source code, an initial amount of tokens transferred from the - source, and an initial storage contents. - - Delegations to assign the tokens of the source to the stake of - another implicit account (without transferring any tokens). - -Smart contracts can also emit "internal operations". These are run -in sequence after the external transaction completes, as in the -following schema for a sequence of two external operations. - -:: - - +------+----------------+-------+----------------+ - | op 1 | internal ops 1 | op 2 | internal ops 2 | - +------+----------------+-------+----------------+ - -Smart contracts called by internal transactions can in turn also emit -internal operation. The interpretation of the internal operations -of a given external operation uses a stack, as in the following -example, also with two external operations. - -:: - - +-----------+---------------+--------------------------+ - | executing | emissions | resulting stack | - +-----------+---------------+--------------------------+ - | op 1 | 1a, 1b, 1c | 1a, 1b, 1c | - | op 1a | 1ai, 1aj | 1ai, 1aj, 1b, 1c | - | op 1ai | | 1aj, 1b, 1c | - | op 1aj | | 1b, 1c | - | op 1b | 1bi | 1bi, 1c | - | op 1bi | | 1c | - | op 1c | | | - | op 2 | 2a, 2b | 2a, 2b | - | op 2a | 2ai | 2ai, 2b | - | op 2ai | 2ai1 | 2ai1, 2b | - | op 2ai1 | | 2b | - | op 2b | 2bi | 2bi | - | op 2bi | 2bi1 | 2bi1 | - | op 2bi1 | 2bi2 | 2bi2 | - | op 2bi2 | | | - +-----------+---------------+--------------------------+ - -Failures -~~~~~~~~ - -All transactions can fail for a few reasons, mostly: - - - Not enough tokens in the source to spend the specified amount. - - The script took too many execution steps. - - The script failed programmatically using the ``FAILWITH`` instruction. - -External transactions can also fail for these additional reasons: - - - The signature of the external operations was wrong. - - The code or initial storage in an origination did not typecheck. - - The parameter in a transfer did not typecheck. - - The destination did not exist. - - The specified entrypoint did not exist. - -All these errors cannot happen in internal transactions, as the type -system catches them at operation creation time. In particular, -Michelson has two types to talk about other accounts: ``address`` and -``contract t``. The ``address`` type merely gives the guarantee that -the value has the form of a Tezos address. The ``contract t`` type, on -the other hand, guarantees that the value is indeed a valid, existing -account whose parameter type is ``t``. To make a transaction from -Michelson, a value of type ``contract t`` must be provided, and the -type system checks that the argument to the transaction is indeed of -type ``t``. Hence, all transactions made from Michelson are well -formed by construction. - -In any case, when a failure happens, either total success or total -failure is guaranteed. If a transaction (internal or external) fails, -then the whole sequence fails and all the effects up to the failure -are reverted. These transactions can still be included in blocks, and -the transaction fees are given to the implicit account who baked the -block. - -Language semantics ------------------- - -This specification explains in a symbolic way the computation performed by the -Michelson interpreter on a given program and initial stack to produce -the corresponding resulting stack. The Michelson interpreter is a pure -function: it only builds a result stack from the elements of an initial -one, without affecting its environment. This semantics is then naturally -given in what is called a big step form: a symbolic definition of a -recursive reference interpreter. This definition takes the form of a -list of rules that cover all the possible inputs of the interpreter -(program and stack), and describe the computation of the corresponding -resulting stacks. - -Rules form and selection -~~~~~~~~~~~~~~~~~~~~~~~~ - -The rules have the main following form. - -:: - - > (syntax pattern) / (initial stack pattern) => (result stack pattern) - iff (conditions) - where (recursions) - and (more recursions) - -The left hand side of the ``=>`` sign is used for selecting the rule. -Given a program and an initial stack, one (and only one) rule can be -selected using the following process. First, the toplevel structure of -the program must match the syntax pattern. This is quite simple since -there are only a few non-trivial patterns to deal with instruction -sequences, and the rest is made of trivial patterns that match one -specific instruction. Then, the initial stack must match the initial -stack pattern. Finally, some rules add extra conditions over the values -in the stack that follow the ``iff`` keyword. Sometimes, several rules -may apply in a given context. In this case, the one that appears first -in this specification is to be selected. If no rule applies, the result -is equivalent to the one for the explicit ``FAILWITH`` instruction. This -case does not happen on well-typed programs, as explained in the next -section. - -The right hand side describes the result of the interpreter if the rule -applies. It consists in a stack pattern, whose parts are either -constants, or elements of the context (program and initial stack) that -have been named on the left hand side of the ``=>`` sign. - -Recursive rules (big step form) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes, the result of interpreting a program is derived from the -result of interpreting another one (as in conditionals or function -calls). In these cases, the rule contains a clause of the following -form. - -:: - - where (intermediate program) / (intermediate stack) => (partial result) - -This means that this rule applies in case interpreting the intermediate -state on the left gives the pattern on the right. - -The left hand sign of the ``=>`` sign is constructed from elements of -the initial state or other partial results, and the right hand side -identify parts that can be used to build the result stack of the rule. - -If the partial result pattern does not actually match the result of the -interpretation, then the result of the whole rule is equivalent to the -one for the explicit ``FAILWITH`` instruction. Again, this case does not -happen on well-typed programs, as explained in the next section. - -Format of patterns -~~~~~~~~~~~~~~~~~~ - -Code patterns are of one of the following syntactical forms. - -- ``INSTR`` (an uppercase identifier) is a simple instruction (e.g. - ``DROP``). -- ``INSTR (arg) ...`` is a compound instruction, whose arguments can be - code, data or type patterns (e.g. ``PUSH nat 3``). -- ``{ (instr) ; ... }`` is a possibly empty sequence of instructions, - (e.g. ``IF { SWAP ; DROP } { DROP }``), nested sequences can drop the - braces. -- ``name`` is a pattern that matches any program and names a part of - the matched program that can be used to build the result. -- ``_`` is a pattern that matches any instruction. - -Stack patterns are of one of the following syntactical forms. - -- ``[FAILED]`` is the special failed state. -- ``[]`` is the empty stack. -- ``(top) : (rest)`` is a stack whose top element is matched by the - data pattern ``(top)`` on the left, and whose remaining elements are - matched by the stack pattern ``(rest)`` on the right (e.g. - ``x : y : rest``). -- ``name`` is a pattern that matches any stack and names it in order to - use it to build the result. -- ``_`` is a pattern that matches any stack. - -Data patterns are of one of the following syntactical forms. - -- integer/natural number literals, (e.g. ``3``). -- string literals, (e.g. ``"contents"``). -- raw byte sequence literals (e.g. ``0xABCDEF42``). -- ``Tag`` (capitalized) is a symbolic constant, (e.g. ``Unit``, - ``True``, ``False``). -- ``(Tag (arg) ...)`` tagged constructed data, (e.g. ``(Pair 3 4)``). -- a code pattern for first class code values. -- ``name`` to name a value in order to use it to build the result. -- ``_`` to match any value. - -The domain of instruction names, symbolic constants and data -constructors is fixed by this specification. Michelson does not let the -programmer introduce its own types. - -Be aware that the syntax used in the specification may differ from -the :ref:`concrete syntax `. In particular -some instructions are annotated with types that are not present in the -concrete language because they are synthesized by the typechecker. - -Shortcuts -~~~~~~~~~ - -Sometimes, it is easier to think (and shorter to write) in terms of -program rewriting than in terms of big step semantics. When it is the -case, and when both are equivalents, we write rules of the form: - -:: - - p / S => S'' - where p' / S' => S'' - -using the following shortcut: - -:: - - p / S => p' / S' - -The concrete language also has some syntax sugar to group some common -sequences of operations as one. This is described in this specification -using a simple regular expression style recursive instruction rewriting. - -Introduction to the type system and notations ---------------------------------------------- - -This specification describes a type system for Michelson. To make things -clear, in particular to readers that are not accustomed to reading -formal programming language specifications, it does not give a -typechecking or inference algorithm. It only gives an intentional -definition of what we consider to be well-typed programs. For each -syntactical form, it describes the stacks that are considered well-typed -inputs, and the resulting outputs. - -The type system is sound, meaning that if a program can be given a type, -then if run on a well-typed input stack, the interpreter will never -apply an interpretation rule on a stack of unexpected length or -contents. Also, it will never reach a state where it cannot select an -appropriate rule to continue the execution. Well-typed programs do not -block, and do not go wrong. - -Type notations -~~~~~~~~~~~~~~ - -The specification introduces notations for the types of values, terms -and stacks. Apart from a subset of value types that appear in the form -of type annotations in some places throughout the language, it is -important to understand that this type language only exists in the -specification. - -A stack type can be written: - -- ``[]`` for the empty stack. -- ``(top) : (rest)`` for the stack whose first value has type ``(top)`` - and queue has stack type ``(rest)``. - -Instructions, programs and primitives of the language are also typed, -their types are written: - -:: - - (type of stack before) -> (type of stack after) - -The types of values in the stack are written: - -- ``identifier`` for a primitive data-type (e.g. ``bool``). -- ``identifier (arg)`` for a parametric data-type with one parameter - type ``(arg)`` (e.g. ``list nat``). -- ``identifier (arg) ...`` for a parametric data-type with several - parameters (e.g. ``map string int``). -- ``[ (type of stack before) -> (type of stack after) ]`` for a code - quotation, (e.g. ``[ int : int : [] -> int : [] ]``). -- ``lambda (arg) (ret)`` is a shortcut for - ``[ (arg) : [] -> (ret) : [] ]``. - -Meta type variables -~~~~~~~~~~~~~~~~~~~ - -The typing rules introduce meta type variables. To be clear, this has -nothing to do with polymorphism, which Michelson does not have. These -variables only live at the specification level, and are used to express -the consistency between the parts of the program. For instance, the -typing rule for the ``IF`` construct introduces meta variables to -express that both branches must have the same type. - -Here are the notations for meta type variables: - -- ``'a`` for a type variable. -- ``'A`` for a stack type variable. -- ``_`` for an anonymous type or stack type variable. - -Typing rules -~~~~~~~~~~~~ - -The system is syntax directed, meaning that it defines a single -typing rule for each syntax construct. A typing rule restricts the type -of input stacks that are authorized for this syntax construct, links the -output type to the input type, and links both of them to the -subexpressions when needed, using meta type variables. - -Typing rules are of the form: - -:: - - (syntax pattern) - :: (type of stack before) -> (type of stack after) [rule-name] - iff (premises) - -Where premises are typing requirements over subprograms or values in the -stack, both of the form ``(x) :: (type)``, meaning that value ``(x)`` -must have type ``(type)``. - -A program is shown well-typed if one can find an instance of a rule that -applies to the toplevel program expression, with all meta type variables -replaced by non variable type expressions, and of which all type -requirements in the premises can be proven well-typed in the same -manner. For the reader unfamiliar with formal type systems, this is -called building a typing derivation. - -Here is an example typing derivation on a small program that computes -``(x+5)*10`` for a given input ``x``, obtained by instantiating the -typing rules for instructions ``PUSH``, ``ADD`` and for the sequence, as -found in the next sections. When instantiating, we replace the ``iff`` -with ``by``. - -:: - - { PUSH nat 5 ; ADD ; PUSH nat 10 ; MUL } - :: [ nat : [] -> nat : [] ] - by { PUSH nat 5 ; ADD } - :: [ nat : [] -> nat : [] ] - by PUSH nat 5 - :: [ nat : [] -> nat : nat : [] ] - by 5 :: nat - and ADD - :: [ nat : nat : [] -> nat : [] ] - and { PUSH nat 10 ; MUL } - :: [ nat : [] -> nat : [] ] - by PUSH nat 10 - :: [ nat : [] -> nat : nat : [] ] - by 10 :: nat - and MUL - :: [ nat : nat : [] -> nat : [] ] - -Producing such a typing derivation can be done in a number of manners, -such as unification or abstract interpretation. In the implementation of -Michelson, this is done by performing a recursive symbolic evaluation of -the program on an abstract stack representing the input type provided by -the programmer, and checking that the resulting symbolic stack is -consistent with the expected result, also provided by the programmer. - -Side note -~~~~~~~~~ - -As with most type systems, it is incomplete. There are programs that -cannot be given a type in this type system, yet that would not go wrong -if executed. This is a necessary compromise to make the type system -usable. Also, it is important to remember that the implementation of -Michelson does not accept as many programs as the type system describes -as well-typed. This is because the implementation uses a simple single -pass typechecking algorithm, and does not handle any form of -polymorphism. - -Core data types and notations ------------------------------ - -- ``string``, ``nat``, ``int`` and ``bytes``: The core primitive - constant types. - -- ``bool``: The type for booleans whose values are ``True`` and - ``False``. - -- ``unit``: The type whose only value is ``Unit``, to use as a - placeholder when some result or parameter is not necessary. For - instance, when the only goal of a contract is to update its storage. - -- ``never``: The empty type. Since ``never`` has no inhabitant, no value of - this type is allowed to occur in a well-typed program. - -- ``list (t)``: A single, immutable, homogeneous linked list, whose - elements are of type ``(t)``, and that we write ``{}`` for the empty - list or ``{ first ; ... }``. In the semantics, we use chevrons to - denote a subsequence of elements. For instance: ``{ head ; }``. - -- ``pair (l) (r)``: A pair of values ``a`` and ``b`` of types ``(l)`` - and ``(r)``, that we write ``(Pair a b)``. - -- ``pair (t{1}) ... (t{n})`` with ``n > 2``: A shorthand for ``pair (t{1}) (pair (t{2}) ... (pair (t{n-1}) (t{n})) ...)``. - -- ``option (t)``: Optional value of type ``(t)`` that we write ``None`` - or ``(Some v)``. - -- ``or (l) (r)``: A union of two types: a value holding either a value - ``a`` of type ``(l)`` or a value ``b`` of type ``(r)``, that we write - ``(Left a)`` or ``(Right b)``. - -- ``set (t)``: Immutable sets of values of type ``(t)`` that we write as - lists ``{ item ; ... }``, of course with their elements unique, and - sorted. - -- ``map (k) (t)``: Immutable maps from keys of type ``(k)`` of values - of type ``(t)`` that we write ``{ Elt key value ; ... }``, with keys - sorted. - -- ``big_map (k) (t)``: Lazily deserialized maps from keys of type - ``(k)`` of values of type ``(t)``. These maps should be used if one - intends to store large amounts of data in a map. They have higher - gas costs than standard maps as data is lazily deserialized. A - ``big_map`` cannot appear inside another ``big_map``. See the - section on :ref:`operations on big maps ` - for a description of the syntax of values of type ``big_map (k) - (t)`` and available operations. - -Core instructions ------------------ - -Control structures -~~~~~~~~~~~~~~~~~~ - -- ``FAILWITH``: Explicitly abort the current program. - -:: - - :: 'a : \_ -> \_ - -This special instruction aborts the current program exposing the top -element of the stack in its error message (first rule below). It makes -the output useless since all subsequent instructions will simply -ignore their usual semantics to propagate the failure up to the main -result (second rule below). Its type is thus completely generic. - -:: - - > FAILWITH / a : _ => [FAILED] - > _ / [FAILED] => [FAILED] - -- ``{}``: Empty sequence. - -:: - - :: 'A -> 'A - - > {} / SA => SA - -- ``{ I ; C }``: Sequence. - -:: - - :: 'A -> 'C - iff I :: [ 'A -> 'B ] - C :: [ 'B -> 'C ] - - > I ; C / SA => SC - where I / SA => SB - and C / SB => SC - -- ``IF bt bf``: Conditional branching. - -:: - - :: bool : 'A -> 'B - iff bt :: [ 'A -> 'B ] - bf :: [ 'A -> 'B ] - - > IF bt bf / True : S => bt / S - > IF bt bf / False : S => bf / S - -- ``LOOP body``: A generic loop. - -:: - - :: bool : 'A -> 'A - iff body :: [ 'A -> bool : 'A ] - - > LOOP body / True : S => body ; LOOP body / S - > LOOP body / False : S => S - -- ``LOOP_LEFT body``: A loop with an accumulator. - -:: - - :: (or 'a 'b) : 'A -> 'b : 'A - iff body :: [ 'a : 'A -> (or 'a 'b) : 'A ] - - > LOOP_LEFT body / (Left a) : S => body ; LOOP_LEFT body / a : S - > LOOP_LEFT body / (Right b) : S => b : S - -- ``DIP code``: Runs code protecting the top element of the stack. - -:: - - :: 'b : 'A -> 'b : 'C - iff code :: [ 'A -> 'C ] - - > DIP code / x : S => x : S' - where code / S => S' - -- ``DIP n code``: Runs code protecting the ``n`` topmost elements of - the stack. In particular, ``DIP 0 code`` is equivalent to ``code`` - and ``DIP 1 code`` is equivalent to ``DIP code``. - -:: - - :: 'a{1} : ... : 'a{n} : 'A -> 'a{1} : ... : 'a{n} : 'B - iff code :: [ 'A -> 'B ] - - > DIP n code / x{1} : ... : x{n} : S => x{1} : ... : x{n} : S' - where code / S => S' - -- ``EXEC``: Execute a function from the stack. - -:: - - :: 'a : lambda 'a 'b : 'C -> 'b : 'C - - > EXEC / a : f : S => r : S - where f / a : [] => r : [] - -- ``APPLY``: Partially apply a tuplified function from the stack. - Values that are not both pushable and storable - (values of type ``operation``, ``contract _`` and ``big map _ _``) - cannot be captured by ``APPLY`` (cannot appear in ``'a``). - -:: - - :: 'a : lambda (pair 'a 'b) 'c : 'C -> lambda 'b 'c : 'C - - > APPLY / a : f : S => { PUSH 'a a ; PAIR ; f } : S - -Stack operations -~~~~~~~~~~~~~~~~ - -- ``DROP``: Drop the top element of the stack. - -:: - - :: _ : 'A -> 'A - - > DROP / _ : S => S - -- ``DROP n``: Drop the `n` topmost elements of the stack. In - particular, ``DROP 0`` is a noop and ``DROP 1`` is equivalent to - ``DROP``. - -:: - - :: 'a{1} : ... : 'a{n} : 'A -> 'A - - > DROP n / x{1} : ... : x{n} : S => S - -- ``DUP``: Duplicate the top element of the stack. - -:: - - :: 'a : 'A -> 'a : 'a : 'A - - > DUP / x : S => x : x : S - -- ``DUP n``: Duplicate the N-th element of the stack. `DUP 1` is equivalent to `DUP`. `DUP 0` is rejected. - -:: - - DUP 1 :: 'a : 'A -> 'a : 'a : 'A - - DUP (n+1) :: 'a : 'A -> 'b : 'a : 'A - iff DUP n :: 'A -> 'b : 'A - - > DUP 1 / x : S => x : x : S - - > DUP (n+1) / x : S => y : x : S - iff DUP n / S => y : S - - -- ``SWAP``: Exchange the top two elements of the stack. - -:: - - :: 'a : 'b : 'A -> 'b : 'a : 'A - - > SWAP / x : y : S => y : x : S - -- ``DIG n``: Take the element at depth ``n`` of the stack and move it - on top. The element on top of the stack is at depth ``0`` so that - ``DIG 0`` is a no-op and ``DIG 1`` is equivalent to ``SWAP``. - -:: - - :: 'a{1} : ... : 'a{n} : 'b : 'A -> 'b : 'a{1} : ... : 'a{n} : 'A - - > DIG n / x{1} : ... : x{n} : y : S => y : x{1} : ... : x{n} : S - -- ``DUG n``: Place the element on top of the stack at depth ``n``. The - element on top of the stack is at depth ``0`` so that ``DUG 0`` is a - no-op and ``DUG 1`` is equivalent to ``SWAP``. - -:: - - :: 'b : 'a{1} : ... : 'a{n} : 'A -> 'a{1} : ... : 'a{n} : 'b : 'A - - > DUG n / y : x{1} : ... : x{n} : S => x{1} : ... : x{n} : y : S - -- ``PUSH 'a x``: Push a constant value of a given type onto the stack. - -:: - - :: 'A -> 'a : 'A - iff x :: 'a - - > PUSH 'a x / S => x : S - -- ``LAMBDA 'a 'b code``: Push a lambda with the given parameter type `'a` and return - type `'b` onto the stack. - -:: - - :: 'A -> (lambda 'a 'b) : 'A - - > LAMBDA _ _ code / S => code : S - -Generic comparison -~~~~~~~~~~~~~~~~~~ - -Comparison only works on a class of types that we call comparable. A -``COMPARE`` operation is defined in an ad hoc way for each comparable -type, but the result of compare is always an ``int``, which can in turn -be checked in a generic manner using the following combinators. The -result of ``COMPARE`` is ``0`` if the top two elements of the stack are -equal, negative if the first element in the stack is less than the -second, and positive otherwise. - -- ``EQ``: Checks that the top element of the stack is equal to zero. - -:: - - :: int : 'S -> bool : 'S - - > EQ / 0 : S => True : S - > EQ / v : S => False : S - iff v <> 0 - -- ``NEQ``: Checks that the top element of the stack is not equal to zero. - -:: - - :: int : 'S -> bool : 'S - - > NEQ / 0 : S => False : S - > NEQ / v : S => True : S - iff v <> 0 - -- ``LT``: Checks that the top element of the stack is less than zero. - -:: - - :: int : 'S -> bool : 'S - - > LT / v : S => True : S - iff v < 0 - > LT / v : S => False : S - iff v >= 0 - -- ``GT``: Checks that the top element of the stack is greater than zero. - -:: - - :: int : 'S -> bool : 'S - - > GT / v : S => C / True : S - iff v > 0 - > GT / v : S => C / False : S - iff v <= 0 - -- ``LE``: Checks that the top element of the stack is less than or equal to - zero. - -:: - - :: int : 'S -> bool : 'S - - > LE / v : S => True : S - iff v <= 0 - > LE / v : S => False : S - iff v > 0 - -- ``GE``: Checks that the top of the stack is greater than or equal to - zero. - -:: - - :: int : 'S -> bool : 'S - - > GE / v : S => True : S - iff v >= 0 - > GE / v : S => False : S - iff v < 0 - -Operations ----------- - -Operations on unit -~~~~~~~~~~~~~~~~~~ - -- ``UNIT``: Push a unit value onto the stack. - -:: - - :: 'A -> unit : 'A - - > UNIT / S => Unit : S - -- ``COMPARE``: Unit comparison - -:: - - :: unit : unit : 'S -> int : 'S - - > COMPARE / Unit : Unit : S => 0 : S - -Operations on type never -~~~~~~~~~~~~~~~~~~~~~~~~ - -The type ``never`` is the type of forbidden values. The most prominent -scenario in which ``never`` is used is when implementing a contract -template with no additional entrypoint. A contract template defines a set -of basic entrypoints, and its ``parameter`` declaration contains a type -variable for additional entrypoints in some branch of an union type, or -wrapped inside an option type. Letting this type variable be ``never`` in -a particular implementation indicates that the contract template has not -been extended, and turns the branch in the code that processes the -additional entrypoints into a forbidden branch. - -Values of type ``never`` cannot occur in a well-typed program. However, -they can be abstracted in the ``parameter`` declaration of a contract---or -by using the ``LAMBDA`` operation---thus indicating that the corresponding -branches in the code are forbidden. The type ``never`` also plays a role -when introducing values of union or option type with ``LEFT never``, -``RIGHT never``, or ``NONE never``. In such cases, the created values can -be inspected with the operations ``IF_LEFT``, ``IF_RIGHT``, or -``IF_NONE``, and the corresponding branches in the code are forbidden -branches. - -- ``NEVER``: Close a forbidden branch. - -:: - - :: never : 'A -> 'B - -- ``COMPARE``: Trivial comparison on type ``never`` - -:: - - :: never : never : 'S -> int : 'S - - -Operations on booleans -~~~~~~~~~~~~~~~~~~~~~~ - -- ``OR`` - -:: - - :: bool : bool : 'S -> bool : 'S - - > OR / x : y : S => (x | y) : S - -- ``AND`` - -:: - - :: bool : bool : 'S -> bool : 'S - - > AND / x : y : S => (x & y) : S - -- ``XOR`` - -:: - - :: bool : bool : 'S -> bool : 'S - - > XOR / x : y : S => (x ^ y) : S - -- ``NOT`` - -:: - - :: bool : 'S -> bool : 'S - - > NOT / x : S => ~x : S - -- ``COMPARE``: Boolean comparison - -:: - - :: bool : bool : 'S -> int : 'S - - > COMPARE / False : False : S => 0 : S - > COMPARE / False : True : S => -1 : S - > COMPARE / True : False : S => 1 : S - > COMPARE / True : True : S => 0 : S - -Operations on integers and natural numbers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Integers and naturals are arbitrary-precision, meaning that the only size -limit is gas. - -- ``NEG`` - -:: - - :: int : 'S -> int : 'S - :: nat : 'S -> int : 'S - - > NEG / x : S => -x : S - -- ``ABS`` - -:: - - :: int : 'S -> nat : 'S - - > ABS / x : S => abs (x) : S - -- ``ISNAT`` - -:: - - :: int : 'S -> option nat : 'S - - > ISNAT / x : S => Some (x) : S - iff x >= 0 - - > ISNAT / x : S => None : S - iff x < 0 - -- ``INT`` - -:: - - :: nat : 'S -> int : 'S - - > INT / x : S => x : S - -- ``ADD`` - -:: - - :: int : int : 'S -> int : 'S - :: int : nat : 'S -> int : 'S - :: nat : int : 'S -> int : 'S - :: nat : nat : 'S -> nat : 'S - - > ADD / x : y : S => (x + y) : S - -- ``SUB`` - -:: - - :: int : int : 'S -> int : 'S - :: int : nat : 'S -> int : 'S - :: nat : int : 'S -> int : 'S - :: nat : nat : 'S -> int : 'S - - > SUB / x : y : S => (x - y) : S - -- ``MUL`` - -:: - - :: int : int : 'S -> int : 'S - :: int : nat : 'S -> int : 'S - :: nat : int : 'S -> int : 'S - :: nat : nat : 'S -> nat : 'S - - > MUL / x : y : S => (x * y) : S - -- ``EDIV``: Perform Euclidean division - -:: - - :: int : int : 'S -> option (pair int nat) : 'S - :: int : nat : 'S -> option (pair int nat) : 'S - :: nat : int : 'S -> option (pair int nat) : 'S - :: nat : nat : 'S -> option (pair nat nat) : 'S - - > EDIV / x : 0 : S => None : S - > EDIV / x : y : S => Some (Pair (x / y) (x % y)) : S - iff y <> 0 - -Bitwise logical operators are also available on unsigned integers. - -- ``OR`` - -:: - - :: nat : nat : 'S -> nat : 'S - - > OR / x : y : S => (x | y) : S - -- ``AND``: (also available when the top operand is signed) - -:: - - :: nat : nat : 'S -> nat : 'S - :: int : nat : 'S -> nat : 'S - - > AND / x : y : S => (x & y) : S - -- ``XOR`` - -:: - - :: nat : nat : 'S -> nat : 'S - - > XOR / x : y : S => (x ^ y) : S - -- ``NOT``: Two's complement - -:: - - :: nat : 'S -> int : 'S - :: int : 'S -> int : 'S - - > NOT / x : S => ~x : S - - -The return type of ``NOT`` is an ``int`` and not a ``nat``. This is -because the sign is also negated. The resulting integer is computed -using two's complement. For instance, the boolean negation of ``0`` is -``-1``. To get a natural back, a possibility is to use ``AND`` with an -unsigned mask afterwards. - - -- ``LSL`` - -:: - - :: nat : nat : 'S -> nat : 'S - - > LSL / x : s : S => (x << s) : S - iff s <= 256 - > LSL / x : s : S => [FAILED] - iff s > 256 - -- ``LSR`` - -:: - - :: nat : nat : 'S -> nat : 'S - - > LSR / x : s : S => (x >> s) : S - iff s <= 256 - > LSR / x : s : S => [FAILED] - iff s > 256 - -- ``COMPARE``: Integer/natural comparison - -:: - - :: int : int : 'S -> int : 'S - :: nat : nat : 'S -> int : 'S - - > COMPARE / x : y : S => -1 : S - iff x < y - > COMPARE / x : y : S => 0 : S - iff x = y - > COMPARE / x : y : S => 1 : S - iff x > y - -Operations on strings -~~~~~~~~~~~~~~~~~~~~~ - -Strings are mostly used for naming things without having to rely on -external ID databases. They are restricted to the printable subset of -7-bit ASCII, plus some escaped characters (see section on -constants). So what can be done is basically use string constants as -is, concatenate or splice them, and use them as keys. - - -- ``CONCAT``: String concatenation. - -:: - - :: string : string : 'S -> string : 'S - - > CONCAT / s : t : S => (s ^ t) : S - - :: string list : 'S -> string : 'S - - > CONCAT / {} : S => "" : S - > CONCAT / { s ; } : S => (s ^ r) : S - where CONCAT / { } : S => r : S - -- ``SIZE``: number of characters in a string. - -:: - - :: string : 'S -> nat : 'S - -- ``SLICE``: String access. - -:: - - :: nat : nat : string : 'S -> option string : 'S - - > SLICE / offset : length : s : S => Some ss : S - where ss is the substring of s at the given offset and of the given length - iff offset and (offset + length) are in bounds - > SLICE / offset : length : s : S => None : S - iff offset or (offset + length) are out of bounds - -- ``COMPARE``: Lexicographic comparison. - -:: - - :: string : string : 'S -> int : 'S - - > COMPARE / s : t : S => -1 : S - iff s < t - > COMPARE / s : t : S => 0 : S - iff s = t - > COMPARE / s : t : S => 1 : S - iff s > t - -Operations on pairs and right combs -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The type ``pair l r`` is the type of binary pairs composed of a left -element of type ``l`` and a right element of type ``r``. A value of -type ``pair l r`` is written ``Pair x y`` where ``x`` is a value of -type ``l`` and ``y`` is a value of type ``r``. - -To build tuples of length greater than 2, right combs have specific -optimized operations. For any ``n > 2``, the compact notations ``pair -t{0} t{1} ... t{n-2} t{n-1}`` is provided for the type of right combs -``pair t{0} (pair t{1} ... (pair t{n-2} t{n-1}) ...)``. Similarly, the -compact notation ``Pair x{0} x{1} ... x{n-2} x{n-1}`` is provided for -the right-comb value ``Pair x{0} (Pair x{1} ... (Pair x{n-2} x{n-1}) -...)``. Right-comb values can also be written using sequences; ``Pair -x{0} x{1} ... x{n-2} x{n-1}`` can be written ``{x{0}; x{1}; ...; x{n-2}; x{n-1}}``. - -- ``PAIR``: Build a binary pair from the stack's top two elements. - -:: - - :: 'a : 'b : 'S -> pair 'a 'b : 'S - - > PAIR / x : y : S => Pair x y : S - -- ``PAIR n``: Fold ``n`` values on the top of the stack in a right comb. - ``PAIR 0`` and ``PAIR 1`` are rejected. ``PAIR 2`` is equivalent to ``PAIR``. - -:: - - PAIR 2 :: 'a : 'b : 'S -> pair 'a 'b : 'S - PAIR (k+1) :: 'x : 'S -> pair 'x 'y : 'T - iff PAIR k :: 'S -> 'y : 'T - - Or equivalently, for n >= 2, - PAIR n :: 'a{0} : ... : 'a{n-1} : 'A -> pair 'a{0} ... 'a{n-1} : 'A - - > PAIR 2 / x : y : S => Pair x y : S - > PAIR (k+1) / x : S => Pair x y : T - iff PAIR k / S => y : T - - Or equivalently, for n >= 2, - > PAIR n / x{0} : ... : x{n-1} : S => Pair x{0} ... x{n-1} : S - -- ``UNPAIR``: Split a pair into its components. - -:: - - :: pair 'a 'b : 'S -> 'a : 'b : 'S - - > UNPAIR / Pair a b : S => a : b : S - - -- ``UNPAIR n``: Unfold ``n`` values from a right comb on the top of the stack. ``UNPAIR 0`` and ``UNPAIR 1`` are rejected. ``UNPAIR 2`` is equivalent to ``UNPAIR``. - -:: - - UNPAIR 2 :: pair 'a 'b : 'A -> 'a : 'b : 'A - UNPAIR (k+1) :: pair 'a 'b : 'A -> 'a : 'B - iff UNPAIR k :: 'b : 'A -> 'B - - Or equivalently, for n >= 2, - UNPAIR n :: pair 'a{0} ... 'a{n-1} : S -> 'a{0} : ... : 'a{n-1} : S - - > UNPAIR 2 / Pair x y : S => x : y : S - > UNPAIR (k+1) / Pair x y : SA => x : SB - iff UNPAIR k / y : SA => SB - - Or equivalently, for n >= 2, - > UNPAIR n / Pair x{0} ... x{n-1} : S => x{0} : ... : x{n-1} : S - -- ``CAR``: Access the left part of a pair. - -:: - - :: pair 'a _ : 'S -> 'a : 'S - - > CAR / Pair x _ : S => x : S - -- ``CDR``: Access the right part of a pair. - -:: - - :: pair _ 'b : 'S -> 'b : 'S - - > CDR / Pair _ y : S => y : S - -- ``GET k``: Access an element or a sub comb in a right comb. - - The nodes of a right comb of size ``n`` are canonically numbered as follows: - -:: - - 0 - / \ - 1 2 - / \ - 3 4 - / \ - 5 ... - 2n-2 - / \ - 2n-1 2n - - -Or in plain English: - - - The root is numbered with 0, - - The left child of the node numbered by ``k`` is numbered by ``k+1``, and - - The right child of the node numbered by ``k`` is numbered by ``k+2``. - -The ``GET k`` instruction accesses the node numbered by ``k``. In -particular, for a comb of size ``n``, the ``n-1`` first elements are -accessed by ``GET 1``, ``GET 3``, ..., and ``GET (2n-1)`` and the last -element is accessed by ``GET (2n)``. - -:: - - GET 0 :: 'a : 'S -> 'a : 'S - GET 1 :: pair 'x _ : 'S -> 'x : 'S - GET (k+2) :: pair _ 'y : 'S -> 'z : 'S - iff GET k :: 'y : 'S -> 'z : 'S - - Or equivalently, - GET 0 :: 'a : 'S -> 'a : 'S - GET (2k) :: pair 'a{0} ... 'a{k-1} 'a{k} : 'S -> 'a{k} : 'S - GET (2k+1) :: pair 'a{0} ... 'a{k} 'a{k+1} : 'S -> 'a{k} : 'S - - > GET 0 / x : S => x : S - > GET 1 / Pair x _ : S => x : S - > GET (k+2) / Pair _ y : S => GET k / y : S - - Or equivalently, - > GET 0 / x : S => x : S - > GET (2k) / Pair x{0} ... x{k-1} x{k} : 'S -> x{k} : 'S - > GET (2k+1) / Pair x{0} ... x{k} x{k+1} : 'S -> x{k} : 'S - - -- ``UPDATE k``: Update an element or a sub comb in a right comb. The topmost stack element is the new value to insert in the comb, the second stack element is the right comb to update. The meaning of ``k`` is the same as for the ``GET k`` instruction. - -:: - - UPDATE 0 :: 'a : 'b : 'S -> 'a : 'S - UPDATE 1 :: 'a2 : pair 'a1 'b : 'S -> pair 'a2 'b : 'S - UPDATE (k+2) :: 'c : pair 'a 'b1 : 'S -> pair 'a 'b2 : 'S - iff UPDATE k :: 'c : 'b1 : 'S -> 'b2 : 'S - - Or equivalently, - UPDATE 0 :: 'a : 'b : 'S -> 'a : 'S - UPDATE (2k) :: 'c : pair 'a{0} ... 'a{k-1} 'a{k} : 'S -> pair 'a{0} ... 'a{k-1} 'c : 'S - UPDATE (2k+1) :: 'c : pair 'a{0} ... 'a{k} 'a{k+1} : 'S -> pair 'a{0} ... 'a{k-1} 'c 'a{k+1} : 'S - - > UPDATE 0 / x : _ : S => x : S - > UPDATE 1 / x2 : Pair x1 y : S => Pair x2 y : S - > UPDATE (k+2) / z : Pair x y1 : S => Pair x y2 : S - iff UPDATE k / z : y1 : S => y2 : S - - Or equivalently, - > UPDATE 0 / x : _ : S => x : S - > UPDATE (2k) / z : Pair x{0} ... x{k-1} x{k} : 'S => Pair x{0} ... x{k-1} z : 'S - > UPDATE (2k+1) / z : Pair x{0} ... x{k-1} x{k} x{k+1} : 'S => Pair x{0} ... x{k-1} z x{k+1} : 'S - -- ``COMPARE``: Lexicographic comparison. - -:: - - :: pair 'a 'b : pair 'a 'b : 'S -> int : 'S - - > COMPARE / (Pair sa sb) : (Pair ta tb) : S => -1 : S - iff COMPARE / sa : ta : S => -1 : S - > COMPARE / (Pair sa sb) : (Pair ta tb) : S => 1 : S - iff COMPARE / sa : ta : S => 1 : S - > COMPARE / (Pair sa sb) : (Pair ta tb) : S => r : S - iff COMPARE / sa : ta : S => 0 : S - COMPARE / sb : tb : S => r : S - -Operations on sets -~~~~~~~~~~~~~~~~~~ - -- ``EMPTY_SET 'elt``: Build a new, empty set for elements of a given - type. - - The ``'elt`` type must be comparable (the ``COMPARE`` - primitive must be defined over it). - -:: - - :: 'S -> set 'elt : 'S - - > EMPTY_SET _ / S => {} : S - -- ``MEM``: Check for the presence of an element in a set. - -:: - - :: 'elt : set 'elt : 'S -> bool : 'S - - > MEM / x : {} : S => false : S - > MEM / x : { hd ; } : S => r : S - iff COMPARE / x : hd : [] => 1 : [] - where MEM / x : { } : S => r : S - > MEM / x : { hd ; } : S => true : S - iff COMPARE / x : hd : [] => 0 : [] - > MEM / x : { hd ; } : S => false : S - iff COMPARE / x : hd : [] => -1 : [] - -- ``UPDATE``: Inserts or removes an element in a set, replacing a - previous value. - -:: - - :: 'elt : bool : set 'elt : 'S -> set 'elt : 'S - - > UPDATE / x : false : {} : S => {} : S - > UPDATE / x : true : {} : S => { x } : S - > UPDATE / x : v : { hd ; } : S => { hd ; } : S - iff COMPARE / x : hd : [] => 1 : [] - where UPDATE / x : v : { } : S => { } : S - > UPDATE / x : false : { hd ; } : S => { } : S - iff COMPARE / x : hd : [] => 0 : [] - > UPDATE / x : true : { hd ; } : S => { hd ; } : S - iff COMPARE / x : hd : [] => 0 : [] - > UPDATE / x : false : { hd ; } : S => { hd ; } : S - iff COMPARE / x : hd : [] => -1 : [] - > UPDATE / x : true : { hd ; } : S => { x ; hd ; } : S - iff COMPARE / x : hd : [] => -1 : [] - -- ``ITER body``: Apply the body expression to each element of a set. - The body sequence has access to the stack. - -:: - - :: (set 'elt) : 'A -> 'A - iff body :: [ 'elt : 'A -> 'A ] - - > ITER body / {} : S => S - > ITER body / { hd ; } : S => ITER body / { } : S' - iff body / hd : S => S' - - -- ``SIZE``: Get the cardinality of the set. - -:: - - :: set 'elt : 'S -> nat : 'S - - > SIZE / {} : S => 0 : S - > SIZE / { _ ; } : S => 1 + s : S - where SIZE / { } : S => s : S - -Operations on maps -~~~~~~~~~~~~~~~~~~ - -- ``EMPTY_MAP 'key 'val``: Build a new, empty map from keys of a - given type to values of another given type. - - The ``'key`` type must be comparable (the ``COMPARE`` primitive must - be defined over it). - -:: - - :: 'S -> map 'key 'val : 'S - - > EMPTY_MAP _ _ / S => {} : S - - -- ``GET``: Access an element in a map, returns an optional value to be - checked with ``IF_SOME``. - -:: - - :: 'key : map 'key 'val : 'S -> option 'val : 'S - - > GET / x : {} : S => None : S - > GET / x : { Elt k v ; } : S => opt_y : S - iff COMPARE / x : k : [] => 1 : [] - where GET / x : { } : S => opt_y : S - > GET / x : { Elt k v ; } : S => Some v : S - iff COMPARE / x : k : [] => 0 : [] - > GET / x : { Elt k v ; } : S => None : S - iff COMPARE / x : k : [] => -1 : [] - -- ``MEM``: Check for the presence of a binding for a key in a map. - -:: - - :: 'key : map 'key 'val : 'S -> bool : 'S - - > MEM / x : {} : S => false : S - > MEM / x : { Elt k v ; } : S => r : S - iff COMPARE / x : k : [] => 1 : [] - where MEM / x : { } : S => r : S - > MEM / x : { Elt k v ; } : S => true : S - iff COMPARE / x : k : [] => 0 : [] - > MEM / x : { Elt k v ; } : S => false : S - iff COMPARE / x : k : [] => -1 : [] - -- ``UPDATE``: Assign or remove an element in a map. - -:: - - :: 'key : option 'val : map 'key 'val : 'S -> map 'key 'val : 'S - - > UPDATE / x : None : {} : S => {} : S - > UPDATE / x : Some y : {} : S => { Elt x y } : S - > UPDATE / x : opt_y : { Elt k v ; } : S => { Elt k v ; } : S - iff COMPARE / x : k : [] => 1 : [] - where UPDATE / x : opt_y : { } : S => { } : S - > UPDATE / x : None : { Elt k v ; } : S => { } : S - iff COMPARE / x : k : [] => 0 : [] - > UPDATE / x : Some y : { Elt k v ; } : S => { Elt k y ; } : S - iff COMPARE / x : k : [] => 0 : [] - > UPDATE / x : None : { Elt k v ; } : S => { Elt k v ; } : S - iff COMPARE / x : k : [] => -1 : [] - > UPDATE / x : Some y : { Elt k v ; } : S => { Elt x y ; Elt k v ; } : S - iff COMPARE / x : k : [] => -1 : [] - -- ``GET_AND_UPDATE``: A combination of the ``GET`` and ``UPDATE`` instructions. - -:: - - :: 'key : option 'val : map 'key 'val : 'S -> option 'val : map 'key 'val : 'S - -This instruction is similar to ``UPDATE`` but it also returns the -value that was previously stored in the ``map`` at the same key as -``GET`` would. - -:: - - > GET_AND_UPDATE / x : None : {} : S => None : {} : S - > GET_AND_UPDATE / x : Some y : {} : S => None : { Elt x y } : S - > GET_AND_UPDATE / x : opt_y : { Elt k v ; } : S => opt_y' : { Elt k v ; } : S - iff COMPARE / x : k : [] => 1 : [] - where GET_AND_UPDATE / x : opt_y : { } : S => opt_y' : { } : S - > GET_AND_UPDATE / x : None : { Elt k v ; } : S => Some v : { } : S - iff COMPARE / x : k : [] => 0 : [] - > GET_AND_UPDATE / x : Some y : { Elt k v ; } : S => Some v : { Elt k y ; } : S - iff COMPARE / x : k : [] => 0 : [] - > GET_AND_UPDATE / x : None : { Elt k v ; } : S => None : { Elt k v ; } : S - iff COMPARE / x : k : [] => -1 : [] - > GET_AND_UPDATE / x : Some y : { Elt k v ; } : S => None : { Elt x y ; Elt k v ; } : S - iff COMPARE / x : k : [] => -1 : [] - -- ``MAP body``: Apply the body expression to each element of a map. The - body sequence has access to the stack. - -:: - - :: (map 'key 'val) : 'A -> (map 'key 'b) : 'A - iff body :: [ (pair 'key 'val) : 'A -> 'b : 'A ] - - > MAP body / {} : S => {} : S - > MAP body / { Elt k v ; } : S => { Elt k v' ; } : S'' - where body / Pair k v : S => v' : S' - and MAP body / { } : S' => { } : S'' - -- ``ITER body``: Apply the body expression to each element of a map. - The body sequence has access to the stack. - -:: - - :: (map 'elt 'val) : 'A -> 'A - iff body :: [ (pair 'elt 'val : 'A) -> 'A ] - - > ITER body / {} : S => S - > ITER body / { Elt k v ; } : S => ITER body / { } : S' - iff body / (Pair k v) : S => S' - -- ``SIZE``: Get the cardinality of the map. - -:: - - :: map 'key 'val : 'S -> nat : 'S - - > SIZE / {} : S => 0 : S - > SIZE / { _ ; } : S => 1 + s : S - where SIZE / { } : S => s : S - - -Operations on ``big_maps`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. _OperationsOnBigMaps: -.. _OperationsOnBigMaps_009: - -Big maps have three possible representations. A map literal is always -a valid representation for a big map. Big maps can also be represented -by integers called big-map identifiers. Finally, big maps can be -represented as pairs of a big-map identifier (an integer) and a -big-map diff (written in the same syntax as a map whose values are -options). - -So for example, ``{ Elt "bar" True ; Elt "foo" False }``, ``42``, and -``Pair 42 { Elt "foo" (Some False) }`` are all valid representations -of type ``big_map string bool``. - -The behavior of big-map operations is the same as if they were normal -maps, except that under the hood, the elements are loaded and -deserialized on demand. - -- ``EMPTY_BIG_MAP 'key 'val``: Build a new, empty big map from keys of a - given type to values of another given type. - - The ``'key`` type must be comparable (the ``COMPARE`` primitive must - be defined over it). - -:: - - :: 'S -> map 'key 'val : 'S - -- ``GET``: Access an element in a ``big_map``, returns an optional value to be - checked with ``IF_SOME``. - -:: - - :: 'key : big_map 'key 'val : 'S -> option 'val : 'S - -- ``MEM``: Check for the presence of an element in a ``big_map``. - -:: - - :: 'key : big_map 'key 'val : 'S -> bool : 'S - -- ``UPDATE``: Assign or remove an element in a ``big_map``. - -:: - - :: 'key : option 'val : big_map 'key 'val : 'S -> big_map 'key 'val : 'S - - -- ``GET_AND_UPDATE``: A combination of the ``GET`` and ``UPDATE`` instructions. - -:: - - :: 'key : option 'val : big_map 'key 'val : 'S -> option 'val : big_map 'key 'val : 'S - -This instruction is similar to ``UPDATE`` but it also returns the -value that was previously stored in the ``big_map`` at the same key as -``GET`` would. - - -Operations on optional values -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- ``SOME``: Pack a value as an optional value. - -:: - - :: 'a : 'S -> option 'a : 'S - - > SOME / v : S => (Some v) : S - -- ``NONE 'a``: The absent optional value. - -:: - - :: 'S -> option 'a : 'S - - > NONE / S => None : S - -- ``IF_NONE bt bf``: Inspect an optional value. - -:: - - :: option 'a : 'A -> 'B - iff bt :: [ 'A -> 'B] - bf :: [ 'a : 'A -> 'B] - - > IF_NONE bt bf / (None) : S => bt / S - > IF_NONE bt bf / (Some a) : S => bf / a : S - -- ``COMPARE``: Optional values comparison - -:: - - :: option 'a : option 'a : 'S -> int : 'S - - > COMPARE / None : None : S => 0 : S - > COMPARE / None : (Some _) : S => -1 : S - > COMPARE / (Some _) : None : S => 1 : S - > COMPARE / (Some a) : (Some b) : S => COMPARE / a : b : S - -Operations on unions -~~~~~~~~~~~~~~~~~~~~ - -- ``LEFT 'b``: Pack a value in a union (left case). - -:: - - :: 'a : 'S -> or 'a 'b : 'S - - > LEFT / v : S => (Left v) : S - -- ``RIGHT 'a``: Pack a value in a union (right case). - -:: - - :: 'b : 'S -> or 'a 'b : 'S - - > RIGHT / v : S => (Right v) : S - -- ``IF_LEFT bt bf``: Inspect a value of a union. - -:: - - :: or 'a 'b : 'A -> 'B - iff bt :: [ 'a : 'A -> 'B] - bf :: [ 'b : 'A -> 'B] - - > IF_LEFT bt bf / (Left a) : S => bt / a : S - > IF_LEFT bt bf / (Right b) : S => bf / b : S - -- ``COMPARE``: Unions comparison - -:: - - :: or 'a 'b : or 'a 'b : 'S -> int : 'S - - > COMPARE / (Left a) : (Left b) : S => COMPARE / a : b : S - > COMPARE / (Left _) : (Right _) : S => -1 : S - > COMPARE / (Right _) : (Left _) : S => 1 : S - > COMPARE / (Right a) : (Right b) : S => COMPARE / a : b : S - -Operations on lists -~~~~~~~~~~~~~~~~~~~ - -- ``CONS``: Prepend an element to a list. - -:: - - :: 'a : list 'a : 'S -> list 'a : 'S - - > CONS / a : { } : S => { a ; } : S - -- ``NIL 'a``: The empty list. - -:: - - :: 'S -> list 'a : 'S - - > NIL / S => {} : S - -- ``IF_CONS bt bf``: Inspect a list. - -:: - - :: list 'a : 'A -> 'B - iff bt :: [ 'a : list 'a : 'A -> 'B] - bf :: [ 'A -> 'B] - - > IF_CONS bt bf / { a ; } : S => bt / a : { } : S - > IF_CONS bt bf / {} : S => bf / S - -- ``MAP body``: Apply the body expression to each element of the list. - The body sequence has access to the stack. - -:: - - :: (list 'elt) : 'A -> (list 'b) : 'A - iff body :: [ 'elt : 'A -> 'b : 'A ] - - > MAP body / {} : S => {} : S - > MAP body / { a ; } : S => { b ; } : S'' - where body / a : S => b : S' - and MAP body / { } : S' => { } : S'' - -- ``SIZE``: Get the number of elements in the list. - -:: - - :: list 'elt : 'S -> nat : 'S - - > SIZE / { _ ; } : S => 1 + s : S - where SIZE / { } : S => s : S - > SIZE / {} : S => 0 : S - - -- ``ITER body``: Apply the body expression to each element of a list. - The body sequence has access to the stack. - -:: - - :: (list 'elt) : 'A -> 'A - iff body :: [ 'elt : 'A -> 'A ] - > ITER body / {} : S => S - > ITER body / { a ; } : S => ITER body / { } : S' - iff body / a : S => S' - - -Domain specific data types --------------------------- - -- ``timestamp``: Dates in the real world. - -- ``mutez``: A specific type for manipulating tokens. - -- ``address``: An untyped address (implicit account or smart contract). - -- ``contract 'param``: A contract, with the type of its code, - ``contract unit`` for implicit accounts. - -- ``operation``: An internal operation emitted by a contract. - -- ``key``: A public cryptographic key. - -- ``key_hash``: The hash of a public cryptographic key. - -- ``signature``: A cryptographic signature. - -- ``chain_id``: An identifier for a chain, used to distinguish the test and the main chains. - -- ``bls12_381_g1``, ``bls12_381_g2`` : Points on the BLS12-381 curves G\ :sub:`1`\ and G\ :sub:`2`\ , respectively. - -- ``bls12_381_fr`` : An element of the scalar field F\ :sub:`r`\ , used for scalar multiplication on the BLS12-381 curves G\ :sub:`1`\ and G\ :sub:`2`\ . - -- ``sapling_transaction ms``: A :doc:`Sapling ` transaction - -- ``sapling_state ms``: A :doc:`Sapling ` state - -- ``ticket (t)``: A ticket used to authenticate information of type ``(t)`` on-chain. - -Domain specific operations --------------------------- - -Operations on timestamps -~~~~~~~~~~~~~~~~~~~~~~~~ - -Timestamps can be obtained by the ``NOW`` operation, or retrieved from -script parameters or globals. - -- ``ADD`` Increment / decrement a timestamp of the given number of - seconds. - -:: - - :: timestamp : int : 'S -> timestamp : 'S - :: int : timestamp : 'S -> timestamp : 'S - - > ADD / seconds : nat (t) : S => (seconds + t) : S - > ADD / nat (t) : seconds : S => (t + seconds) : S - -- ``SUB`` Subtract a number of seconds from a timestamp. - -:: - - :: timestamp : int : 'S -> timestamp : 'S - - > SUB / seconds : nat (t) : S => (seconds - t) : S - -- ``SUB`` Subtract two timestamps. - -:: - - :: timestamp : timestamp : 'S -> int : 'S - - > SUB / seconds(t1) : seconds(t2) : S => (t1 - t2) : S - -- ``COMPARE``: Timestamp comparison. - -:: - - :: timestamp : timestamp : 'S -> int : 'S - - > COMPARE / seconds(t1) : seconds(t2) : S => -1 : S - iff t1 < t2 - > COMPARE / seconds(t1) : seconds(t2) : S => 0 : S - iff t1 = t2 - > COMPARE / seconds(t1) : seconds(t2) : S => 1 : S - iff t1 > t2 - - -Operations on Mutez -~~~~~~~~~~~~~~~~~~~ - -Mutez (micro-Tez) are internally represented by a 64 bit signed -integers. There are restrictions to prevent creating a negative amount -of mutez. Operations are limited to prevent overflow and mixing them -with other numerical types by mistake. They are also mandatory checked -for under/overflows. - -- ``ADD`` - -:: - - :: mutez : mutez : 'S -> mutez : 'S - - > ADD / x : y : S => [FAILED] on overflow - > ADD / x : y : S => (x + y) : S - -- ``SUB`` - -:: - - :: mutez : mutez : 'S -> mutez : 'S - - > SUB / x : y : S => [FAILED] - iff x < y - > SUB / x : y : S => (x - y) : S - -- ``MUL`` - -:: - - :: mutez : nat : 'S -> mutez : 'S - :: nat : mutez : 'S -> mutez : 'S - - > MUL / x : y : S => [FAILED] on overflow - > MUL / x : y : S => (x * y) : S - -- ``EDIV`` - -:: - - :: mutez : nat : 'S -> option (pair mutez mutez) : 'S - :: mutez : mutez : 'S -> option (pair nat mutez) : 'S - - > EDIV / x : 0 : S => None - > EDIV / x : y : S => Some (Pair (x / y) (x % y)) : S - iff y <> 0 - -- ``COMPARE``: Mutez comparison - -:: - - :: mutez : mutez : 'S -> int : 'S - - > COMPARE / x : y : S => -1 : S - iff x < y - > COMPARE / x : y : S => 0 : S - iff x = y - > COMPARE / x : y : S => 1 : S - iff x > y - -Operations on contracts -~~~~~~~~~~~~~~~~~~~~~~~ - -- ``CREATE_CONTRACT { storage 'g ; parameter 'p ; code ... }``: - Forge a new contract from a literal. - -:: - - :: option key_hash : mutez : 'g : 'S - -> operation : address : 'S - -Originate a contract based on a literal. The parameters are the -optional delegate, the initial amount taken from the current -contract, and the initial storage of the originated contract. -The contract is returned as a first class value (to be dropped, passed -as parameter or stored). The ``CONTRACT 'p`` instruction will fail -until it is actually originated. - -- ``TRANSFER_TOKENS``: Forge a transaction. - -:: - - :: 'p : mutez : contract 'p : 'S -> operation : 'S - -The parameter must be consistent with the one expected by the -contract, unit for an account. - -.. _MichelsonSetDelegate: -.. _MichelsonSetDelegate_009: - -- ``SET_DELEGATE``: Set or withdraw the contract's delegation. - -:: - - :: option key_hash : 'S -> operation : 'S - -Using this instruction is the only way to modify the delegation of a -smart contract. If the parameter is ``None`` then the delegation of the -current contract is withdrawn; if it is ``Some kh`` where ``kh`` is the -key hash of a registered delegate that is not the current delegate of -the contract, then this operation sets the delegate of the contract to -this registered delegate. The operation fails if ``kh`` is the current -delegate of the contract or if ``kh`` is not a registered delegate. - -- ``BALANCE``: Push the current amount of mutez held by the executing - contract, including any mutez added by the calling transaction. - -:: - - :: 'S -> mutez : 'S - -- ``ADDRESS``: Cast the contract to its address. - -:: - - :: contract _ : 'S -> address : 'S - - > ADDRESS / addr : S => addr : S - -- ``CONTRACT 'p``: Cast the address to the given contract type if possible. - -:: - - :: address : 'S -> option (contract 'p) : 'S - - > CONTRACT / addr : S => Some addr : S - iff addr exists and is a contract of parameter type 'p - > CONTRACT / addr : S => Some addr : S - iff 'p = unit and addr is an implicit contract - > CONTRACT / addr : S => None : S - otherwise - -- ``SOURCE``: Push the contract that initiated the current - transaction, i.e. the contract that paid the fees and - storage cost, and whose manager signed the operation - that was sent on the blockchain. Note that since - ``TRANSFER_TOKENS`` instructions can be chained, - ``SOURCE`` and ``SENDER`` are not necessarily the same. - -:: - - :: 'S -> address : 'S - -- ``SENDER``: Push the contract that initiated the current - internal transaction. It may be the ``SOURCE``, but may - also be different if the source sent an order to an intermediate - smart contract, which then called the current contract. - -:: - - :: 'S -> address : 'S - -- ``SELF``: Push the current contract. - -:: - - :: 'S -> contract 'p : 'S - where contract 'p is the type of the current contract - -Note that ``SELF`` is forbidden in lambdas because it cannot be -type-checked; the type of the contract executing the lambda cannot be -known at the point of type-checking the lambda's body. - -- ``SELF_ADDRESS``: Push the address of the current contract. This is - equivalent to ``SELF; ADDRESS`` except that it is allowed in - lambdas. - -:: - - :: 'S -> address : 'S - -Note that ``SELF_ADDRESS`` inside a lambda returns the address of the -contract executing the lambda, which can be different from the address -of the contract in which the ``SELF_ADDRESS`` instruction is written. - -- ``AMOUNT``: Push the amount of the current transaction. - -:: - - :: 'S -> mutez : 'S - -- ``IMPLICIT_ACCOUNT``: Return a default contract with the given - public/private key pair. Any funds deposited in this contract can - immediately be spent by the holder of the private key. This contract - cannot execute Michelson code and will always exist on the - blockchain. - -:: - - :: key_hash : 'S -> contract unit : 'S - -- ``VOTING_POWER``: Return the voting power of a given contract. This voting power - coincides with the weight of the contract in the voting listings (i.e., the rolls - count) which is calculated at the beginning of every voting period. - -:: - - :: key_hash : 'S -> nat : 'S - -Special operations -~~~~~~~~~~~~~~~~~~ - -- ``NOW``: Push the minimal injection time for the current block, - namely the block whose validation triggered this execution. The - minimal injection time is 60 seconds after the timestamp of the - predecessor block. This value does not change during the execution - of the contract. - -:: - - :: 'S -> timestamp : 'S - -- ``CHAIN_ID``: Push the chain identifier. - -:: - - :: 'S -> chain_id : 'S - -- ``COMPARE``: Chain identifier comparison - -:: - - :: chain_id : chain_id : 'S -> int : 'S - - > COMPARE / x : y : S => -1 : S - iff x < y - > COMPARE / x : y : S => 0 : S - iff x = y - > COMPARE / x : y : S => 1 : S - iff x > y - -- ``LEVEL``: Push the level of the current transaction's block. - -:: - - :: 'S -> nat : 'S - -- ``TOTAL_VOTING_POWER``: Return the total voting power of all contracts. The total - voting power coincides with the sum of the rolls count of every contract in the voting - listings. The voting listings is calculated at the beginning of every voting period. - -:: - - :: 'S -> nat : 'S - -Operations on bytes -~~~~~~~~~~~~~~~~~~~ - -Bytes are used for serializing data, in order to check signatures and -compute hashes on them. They can also be used to incorporate data from -the wild and untyped outside world. - -- ``PACK``: Serializes a piece of data to its optimized - binary representation. - -:: - - :: 'a : 'S -> bytes : 'S - -- ``UNPACK 'a``: Deserializes a piece of data, if valid. - -:: - - :: bytes : 'S -> option 'a : 'S - -- ``CONCAT``: Byte sequence concatenation. - -:: - - :: bytes : bytes : 'S -> bytes : 'S - - > CONCAT / s : t : S => (s ^ t) : S - - :: bytes list : 'S -> bytes : 'S - - > CONCAT / {} : S => 0x : S - > CONCAT / { s ; } : S => (s ^ r) : S - where CONCAT / { } : S => r : S - -- ``SIZE``: size of a sequence of bytes. - -:: - - :: bytes : 'S -> nat : 'S - -- ``SLICE``: Bytes access. - -:: - - :: nat : nat : bytes : 'S -> option bytes : 'S - - > SLICE / offset : length : s : S => Some ss : S - where ss is the substring of s at the given offset and of the given length - iff offset and (offset + length) are in bounds - > SLICE / offset : length : s : S => None : S - iff offset or (offset + length) are out of bounds - -- ``COMPARE``: Lexicographic comparison. - -:: - - :: bytes : bytes : 'S -> int : 'S - - > COMPARE / s : t : S => -1 : S - iff s < t - > COMPARE / s : t : S => 0 : S - iff s = t - > COMPARE / s : t : S => 1 : S - iff s > t - - -Cryptographic primitives -~~~~~~~~~~~~~~~~~~~~~~~~ - -- ``HASH_KEY``: Compute the b58check of a public key. - -:: - - :: key : 'S -> key_hash : 'S - -- ``BLAKE2B``: Compute a cryptographic hash of the value contents using the - Blake2b-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - -- ``KECCAK``: Compute a cryptographic hash of the value contents using the - Keccak-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - -- ``SHA256``: Compute a cryptographic hash of the value contents using the - Sha256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - -- ``SHA512``: Compute a cryptographic hash of the value contents using the - Sha512 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - -- ``SHA3``: Compute a cryptographic hash of the value contents using the - SHA3-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - -- ``CHECK_SIGNATURE``: Check that a sequence of bytes has been signed - with a given key. - -:: - - :: key : signature : bytes : 'S -> bool : 'S - -- ``COMPARE``: Key hash, key and signature comparison - -:: - - :: key_hash : key_hash : 'S -> int : 'S - :: key : key : 'S -> int : 'S - :: signature : signature : 'S -> int : 'S - - > COMPARE / x : y : S => -1 : S - iff x < y - > COMPARE / x : y : S => 0 : S - iff x = y - > COMPARE / x : y : S => 1 : S - iff x > y - -BLS12-381 primitives -~~~~~~~~~~~~~~~~~~~~~~~~ - -- ``NEG``: Negate a curve point or field element. - -:: - - :: bls12_381_g1 : 'S -> bls12_381_g1 : 'S - :: bls12_381_g2 : 'S -> bls12_381_g2 : 'S - :: bls12_381_fr : 'S -> bls12_381_fr : 'S - -- ``ADD``: Add two curve points or field elements. - -:: - - :: bls12_381_g1 : bls12_381_g1 : 'S -> bls12_381_g1 : 'S - :: bls12_381_g2 : bls12_381_g2 : 'S -> bls12_381_g2 : 'S - :: bls12_381_fr : bls12_381_fr : 'S -> bls12_381_fr : 'S - -- ``MUL``: Multiply a curve point or field element by a scalar field element. Fr - elements can be built from naturals by multiplying by the unit of Fr using ``PUSH bls12_381_fr 1; MUL``. Note - that the multiplication will be computed using the natural modulo the order - of Fr. - -:: - - :: bls12_381_g1 : bls12_381_fr : 'S -> bls12_381_g1 : 'S - :: bls12_381_g2 : bls12_381_fr : 'S -> bls12_381_g2 : 'S - :: bls12_381_fr : bls12_381_fr : 'S -> bls12_381_fr : 'S - :: nat : bls12_381_fr : 'S -> bls12_381_fr : 'S - :: int : bls12_381_fr : 'S -> bls12_381_fr : 'S - :: bls12_381_fr : nat : 'S -> bls12_381_fr : 'S - :: bls12_381_fr : int : 'S -> bls12_381_fr : 'S - -- ``INT``: Convert a field element to type ``int``. The returned value is always between ``0`` (inclusive) and the order of Fr (exclusive). - -:: - - :: bls12_381_fr : 'S -> int : 'S - -- ``PAIRING_CHECK``: - Verify that the product of pairings of the given list of points is equal to 1 in Fq12. Returns ``true`` if the list is empty. - Can be used to verify if two pairings P1 and P2 are equal by verifying P1 * P2^(-1) = 1. - -:: - - :: list (pair bls12_381_g1 bls12_381_g2) : 'S -> bool : 'S - - -Sapling operations -~~~~~~~~~~~~~~~~~~ - -Please see the :doc:`Sapling integration ` page for a more -comprehensive description of the Sapling protocol. - -- ``SAPLING_VERIFY_UPDATE``: verify and apply a transaction on a Sapling state. - -:: - - :: sapling_transaction ms : sapling_state ms : 'S -> option (pair int (sapling_state ms)): 'S - - > SAPLING_VERIFY_UPDATE / t : s : S => Some (Pair b s') : S - iff the transaction t successfully applied on state s resulting - in balance b and an updated state s' - > SAPLING_VERIFY_UPDATE / t : s : S => None : S - iff the transaction t is invalid with respect to the state - -- ``SAPLING_EMPTY_STATE ms``: Pushes an empty state on the stack. - - :: - - :: 'S -> sapling_state ms: 'S - - > SAPLING_EMPTY_STATE ms / S => sapling_state ms : S - with `sapling_state ms` being the empty state (ie. no one can spend tokens from it) - with memo_size `ms` - - -.. _MichelsonTickets: -.. _MichelsonTickets_009: - -Operations on tickets -~~~~~~~~~~~~~~~~~~~~~ - -The following operations deal with tickets. Tickets are a way for smart-contracts -to authenticate data with respect to a Tezos address. This authentication can -then be used to build composable permission systems. - -A contract can create a ticket from a value and an amount. The ticket, when -inspected reveals the value, the amount, and the address of the ticketer (the contract that created the ticket). It is -impossible for a contract to “forge” a ticket that appears to have been created -by another ticketer. - -The amount is a meta-data that can be used to implement UTXOs. - -Tickets cannot be duplicated using the ``DUP`` instruction. - -For example, a ticket could represent a Non Fungible Token (NFT) or a Unspent -Transaction Output (UTXO) which can then be passed around and behave like a value. -This process can happen without the need to interact with a centralized NFT contract, -simplifying the code. - -- ``TICKET``: Create a ticket with the given content and amount. The ticketer is the address - of `SELF`. - -:: - - :: 'a : nat : 'S -> ticket 'a : 'S - -Type ``'a`` must be comparable (the ``COMPARE`` primitive must be defined over it). - -- ``READ_TICKET``: Retrieve the information stored in a ticket. Also return the ticket. - -:: - - :: ticket 'a : 'S -> pair address 'a nat : ticket 'a : 'S - -- ``SPLIT_TICKET``: Delete the given ticket and create two tickets with the - same content and ticketer as the original, but with the new provided amounts. - (This can be used to easily implement UTXOs.) - Return None iff the ticket's original amount is not equal to the sum of the - provided amounts. - -:: - - :: ticket 'a : (pair nat nat) : 'S -> - option (pair (ticket 'a) (ticket 'a)) : 'S - -- ``JOIN_TICKETS``: The inverse of ``SPLIT_TICKET``. Delete the given tickets and create a ticket with an amount equal to the - sum of the amounts of the input tickets. - (This can be used to consolidate UTXOs.) - Return None iff the input tickets have a different ticketer or content. - -:: - - :: (pair (ticket 'a) (ticket 'a)) : 'S -> - option (ticket 'a) : 'S - - -Removed instructions -~~~~~~~~~~~~~~~~~~~~ - -:doc:`../protocols/005_babylon` deprecated the following instructions. Because no smart -contract used these on Mainnet before they got deprecated, they have been -removed. The Michelson type-checker will reject any contract using them. - -- ``CREATE_CONTRACT { storage 'g ; parameter 'p ; code ... }``: - Forge a new contract from a literal. - -:: - - :: key_hash : option key_hash : bool : bool : mutez : 'g : 'S - -> operation : address : 'S - -See the documentation of the new ``CREATE_CONTRACT`` instruction. The -first, third, and fourth parameters are ignored. - -- ``CREATE_ACCOUNT``: Forge an account creation operation. - -:: - - :: key_hash : option key_hash : bool : mutez : 'S - -> operation : address : 'S - -Takes as argument the manager, optional delegate, the delegatable flag -and finally the initial amount taken from the currently executed -contract. This instruction originates a contract with two entrypoints; -``%default`` of type ``unit`` that does nothing and ``%do`` of type -``lambda unit (list operation)`` that executes and returns the -parameter if the sender is the contract's manager. - -- ``STEPS_TO_QUOTA``: Push the remaining steps before the contract - execution must terminate. - -:: - - :: 'S -> nat : 'S - - -Macros ------- - -In addition to the operations above, several extensions have been added -to the language's concrete syntax. If you are interacting with the node -via RPC, bypassing the client, which expands away these macros, you will -need to desugar them yourself. - -These macros are designed to be unambiguous and reversible, meaning that -errors are reported in terms of desugared syntax. Below you'll see -these macros defined in terms of other syntactic forms. That is how -these macros are seen by the node. - -Compare -~~~~~~~ - -Syntactic sugar exists for merging ``COMPARE`` and comparison -combinators, and also for branching. - -- ``CMP{EQ|NEQ|LT|GT|LE|GE}`` - -:: - - > CMP(\op) / S => COMPARE ; (\op) / S - -- ``IF{EQ|NEQ|LT|GT|LE|GE} bt bf`` - -:: - - > IF(\op) bt bf / S => (\op) ; IF bt bf / S - -- ``IFCMP{EQ|NEQ|LT|GT|LE|GE} bt bf`` - -:: - - > IFCMP(\op) / S => COMPARE ; (\op) ; IF bt bf / S - -Fail -~~~~ - -The ``FAIL`` macros is equivalent to ``UNIT; FAILWITH`` and is callable -in any context since it does not use its input stack. - -- ``FAIL`` - -:: - - > FAIL / S => UNIT; FAILWITH / S - -Assertion macros -~~~~~~~~~~~~~~~~ - -All assertion operations are syntactic sugar for conditionals with a -``FAIL`` instruction in the appropriate branch. When possible, use them -to increase clarity about illegal states. - -- ``ASSERT`` - -:: - - > ASSERT => IF {} {FAIL} - -- ``ASSERT_{EQ|NEQ|LT|LE|GT|GE}`` - -:: - - > ASSERT_(\op) => IF(\op) {} {FAIL} - -- ``ASSERT_CMP{EQ|NEQ|LT|LE|GT|GE}`` - -:: - - > ASSERT_CMP(\op) => IFCMP(\op) {} {FAIL} - -- ``ASSERT_NONE`` - -:: - - > ASSERT_NONE => IF_NONE {} {FAIL} - -- ``ASSERT_SOME`` - -:: - - > ASSERT_SOME @x => IF_NONE {FAIL} {RENAME @x} - -- ``ASSERT_LEFT`` - -:: - - > ASSERT_LEFT @x => IF_LEFT {RENAME @x} {FAIL} - -- ``ASSERT_RIGHT`` - -:: - - > ASSERT_RIGHT @x => IF_LEFT {FAIL} {RENAME @x} - -Syntactic Conveniences -~~~~~~~~~~~~~~~~~~~~~~ - -These macros are simply more convenient syntax for various common -operations. - -- ``P(\left=A|P(\left)(\right))(\right=I|P(\left)(\right))R``: A syntactic sugar - for building nested pairs. In the case of right combs, `PAIR n` is more efficient. - -:: - - > PA(\right)R / S => DIP ((\right)R) ; PAIR / S - > P(\left)IR / S => (\left)R ; PAIR / S - > P(\left)(\right)R => (\left)R ; DIP ((\right)R) ; PAIR / S - -A good way to quickly figure which macro to use is to mentally parse the -macro as ``P`` for pair constructor, ``A`` for left leaf and ``I`` for -right leaf. The macro takes as many elements on the stack as there are -leaves and constructs a nested pair with the shape given by its name. - -Take the macro ``PAPPAIIR`` for instance: - -:: - - P A P P A I I R - ( l, ( ( l, r ), r )) - -A typing rule can be inferred: - -:: - - PAPPAIIR - :: 'a : 'b : 'c : 'd : 'S -> (pair 'a (pair (pair 'b 'c) 'd)) - -- ``UNP(\left=A|P(\left)(\right))(\right=I|P(\left)(\right))R``: A syntactic sugar - for destructing nested pairs. These macros follow the same convention - as the previous one. - -:: - - > UNPA(\right)R / S => UNPAIR ; DIP (UN(\right)R) / S - > UNP(\left)IR / S => UNPAIR ; UN(\left)R / S - > UNP(\left)(\right)R => UNPAIR ; DIP (UN(\right)R) ; UN(\left)R / S - -- ``C[AD]+R``: A syntactic sugar for accessing fields in nested pairs. In the case of right combs, ``CAR k`` and ``CDR k`` are more efficient. - -:: - - > CA(\rest=[AD]+)R / S => CAR ; C(\rest)R / S - > CD(\rest=[AD]+)R / S => CDR ; C(\rest)R / S - -- ``CAR k``: Access the ``k`` -th part of a right comb of size ``n > k + 1``. ``CAR 0`` is equivalent to ``CAR`` and in general ``CAR k`` is equivalent to ``k`` times the ``CDR`` instruction followed by once the ``CAR`` instruction. Note that this instruction cannot access the last element of a right comb; ``CDR k`` should be used for that. - -:: - - > CAR n / S => GET (2n+1) / S - -- ``CDR k``: Access the rightmost element of a right comb of size ``k``. ``CDR 0`` is a no-op, ``CDR 1`` is equivalent to ``CDR`` and in general ``CDR k`` is equivalent to ``k`` times the ``CDR`` instruction. Note that on a right comb of size ``n > k >= 2``, ``CDR k`` will return the right comb composed of the same elements but the ``k`` leftmost ones. - -:: - - > CDR n / S => GET (2n) / S - -- ``IF_SOME bt bf``: Inspect an optional value. - -:: - - > IF_SOME bt bf / S => IF_NONE bf bt / S - -- ``IF_RIGHT bt bf``: Inspect a value of a union. - -:: - - > IF_RIGHT bt bf / S => IF_LEFT bf bt / S - -- ``SET_CAR``: Set the left field of a pair. This is equivalent to ``SWAP; UPDATE 1``. - -:: - - > SET_CAR => CDR ; SWAP ; PAIR - -- ``SET_CDR``: Set the right field of a pair. This is equivalent to ``SWAP; UPDATE 2``. - -:: - - > SET_CDR => CAR ; PAIR - -- ``SET_C[AD]+R``: A syntactic sugar for setting fields in nested - pairs. In the case of right combs, `UPDATE n` is more efficient. - -:: - - > SET_CA(\rest=[AD]+)R / S => - { DUP ; DIP { CAR ; SET_C(\rest)R } ; CDR ; SWAP ; PAIR } / S - > SET_CD(\rest=[AD]+)R / S => - { DUP ; DIP { CDR ; SET_C(\rest)R } ; CAR ; PAIR } / S - -- ``MAP_CAR`` code: Transform the left field of a pair. - -:: - - > MAP_CAR code => DUP ; CDR ; DIP { CAR ; code } ; SWAP ; PAIR - -- ``MAP_CDR`` code: Transform the right field of a pair. - -:: - - > MAP_CDR code => DUP ; CDR ; code ; SWAP ; CAR ; PAIR - -- ``MAP_C[AD]+R`` code: A syntactic sugar for transforming fields in - nested pairs. - -:: - - > MAP_CA(\rest=[AD]+)R code / S => - { DUP ; DIP { CAR ; MAP_C(\rest)R code } ; CDR ; SWAP ; PAIR } / S - > MAP_CD(\rest=[AD]+)R code / S => - { DUP ; DIP { CDR ; MAP_C(\rest)R code } ; CAR ; PAIR } / S - -Concrete syntax ---------------- -.. _ConcreteSyntax: -.. _ConcreteSyntax_009: - -The concrete language is very close to the formal notation of the -specification. Its structure is extremely simple: an expression in the -language can only be one of the five following constructs. - -1. An integer in decimal notation. -2. A character string. -3. A byte sequence in hexadecimal notation prefixed by ``0x``. -4. The application of a primitive to a sequence of expressions. -5. A sequence of expressions. - -This simple five cases notation is called :doc:`../shell/micheline`. - -Constants -~~~~~~~~~ - -There are three kinds of constants: - -1. Integers or naturals in decimal notation. -2. Strings, with some usual escape sequences: ``\n``, ``\\``, - ``\"``. Unescaped line-breaks (both ``\n`` and ``\r``) cannot - appear in a Michelson string. Moreover, the current version of - Michelson restricts strings to be the printable subset of 7-bit - ASCII, namely characters with codes from within `[32, 126]` range, - plus the escaped characters mentioned above. -3. Byte sequences in hexadecimal notation, prefixed with ``0x``. - -Differences with the formal notation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The concrete syntax follows the same lexical conventions as the -specification: instructions are represented by uppercase identifiers, -type constructors by lowercase identifiers, and constant constructors -are capitalized. - -All domain specific constants are Micheline constants with specific -formats. Some have two variants accepted by the data type checker: a -readable one in a string and an optimized. - -- ``mutez`` amounts are written as naturals. -- ``timestamp``\ s are written either using ``RFC3339`` notation - in a string (readable), or as the number of seconds since Epoch - in a natural (optimized). -- ``contract``\ s, ``address``\ es, ``key``\ s and ``signature``\ s - are written as strings, in their usual Base58 encoded versions - (readable), or as their raw bytes (optimized). -- ``bls12_381_g1``\ s and ``bls12_381_g2``\ s are written as their raw bytes, using a big-endian point encoding, `as specified here `__. -- ``bls12_381_fr``\ s are written as their raw bytes, using a little-endian encoding. - -The optimized versions should not reach the RPCs, the protocol code -will convert to optimized by itself when forging operations, storing -to the database, and before hashing to get a canonical representation -of a datum for a given type. - -To prevent errors, control flow primitives that take instructions as -parameters require sequences in the concrete syntax. - -:: - - IF { instr1_true ; instr2_true ; ... } - { instr1_false ; instr2_false ; ... } - -Main program structure -~~~~~~~~~~~~~~~~~~~~~~ - -The toplevel of a smart contract file must be an un-delimited sequence -of three primitive applications (in no particular order) that provide its -``code``, ``parameter`` and ``storage`` fields. - -See the next section for a concrete example. - -Annotations ------------ - -The annotation mechanism of Michelson provides ways to better track -data on the stack and to give additional type constraints. Except for -a single exception specified just after, annotations are only here to -add constraints, *i.e.* they cannot turn an otherwise rejected program -into an accepted one. The notable exception to this rule is for -entrypoints: the semantics of the `CONTRACT` and `SELF` instructions vary depending on -their constructor annotations, and some contract origination may fail due -to invalid entrypoint constructor annotations. - -Stack visualization tools like the Michelson's Emacs mode print -annotations associated with each type in the program, as propagated by -the typechecker as well as variable annotations on the types of elements -in the stack. This is useful as a debugging aid. - -We distinguish three kinds of annotations: - -- type annotations, written ``:type_annot``, -- variable annotations, written ``@var_annot``, -- and field or constructors annotations, written ``%field_annot``. - -Type annotations -~~~~~~~~~~~~~~~~ - -Each type can be annotated with at most one type annotation. They are -used to give names to types. For types to be equal, their unnamed -version must be equal and their names must be the same or at least one -type must be unnamed. - -For instance, the following Michelson program which put its integer -parameter in the storage is not well typed: - -.. code-block:: michelson - - parameter (int :p) ; - storage (int :s) ; - code { UNPAIR ; SWAP ; DROP ; NIL operation ; PAIR } - -Whereas this one is: - -.. code-block:: michelson - - parameter (int :p) ; - storage int ; - code { UNPAIR ; SWAP ; DROP ; NIL operation ; PAIR } - -Inner components of composed typed can also be named. - -:: - - (pair :point (int :x_pos) (int :y_pos)) - -Push-like instructions, that act as constructors, can also be given a -type annotation. The stack type will then have on top a type with a corresponding name. - -:: - - UNIT :t - :: 'A -> (unit :t) : 'A - - PAIR :t - :: 'a : 'b : 'S -> (pair :t 'a 'b) : 'S - - SOME :t - :: 'a : 'S -> (option :t 'a) : 'S - - NONE :t 'a - :: 'S -> (option :t 'a) : 'S - - LEFT :t 'b - :: 'a : 'S -> (or :t 'a 'b) : 'S - - RIGHT :t 'a - :: 'b : 'S -> (or :t 'a 'b) : 'S - - NIL :t 'a - :: 'S -> (list :t 'a) : 'S - - EMPTY_SET :t 'elt - :: 'S -> (set :t 'elt) : 'S - - EMPTY_MAP :t 'key 'val - :: 'S -> (map :t 'key 'val) : 'S - - EMPTY_BIG_MAP :t 'key 'val - :: 'S -> (big_map :t 'key 'val) : 'S - - -A no-op instruction ``CAST`` ensures the top of the stack has the -specified type, and change its type if it is compatible. In particular, -this allows to change or remove type names explicitly. - -:: - - CAST 'b - :: 'a : 'S -> 'b : 'S - iff 'a = 'b - - > CAST t / a : S => a : S - - -Variable annotations -~~~~~~~~~~~~~~~~~~~~ - -Variable annotations can only be used on instructions that produce -elements on the stack. An instruction that produces ``n`` elements on -the stack can be given at most ``n`` variable annotations. - -The stack type contains both the types of each element in the stack, as -well as an optional variable annotation for each element. In this -sub-section we note: - -- ``[]`` for the empty stack, -- ``@annot (top) : (rest)`` for the stack whose first value has type ``(top)`` and is annotated with variable annotation ``@annot`` and whose queue has stack type ``(rest)``. - -The instructions which do not accept any variable annotations are: - -:: - - DROP - SWAP - DIG - DUG - IF_NONE - IF_LEFT - IF_CONS - ITER - IF - LOOP - LOOP_LEFT - DIP - FAILWITH - -The instructions which accept at most one variable annotation are: - -:: - - DUP - PUSH - UNIT - SOME - NONE - PAIR - CAR - CDR - LEFT - RIGHT - NIL - CONS - SIZE - MAP - MEM - EMPTY_SET - EMPTY_MAP - EMPTY_BIG_MAP - UPDATE - GET - LAMBDA - EXEC - ADD - SUB - CONCAT - MUL - OR - AND - XOR - NOT - ABS - ISNAT - INT - NEG - EDIV - LSL - LSR - COMPARE - EQ - NEQ - LT - GT - LE - GE - ADDRESS - CONTRACT - SET_DELEGATE - IMPLICIT_ACCOUNT - NOW - LEVEL - AMOUNT - BALANCE - HASH_KEY - CHECK_SIGNATURE - BLAKE2B - SOURCE - SENDER - SELF - SELF_ADDRESS - CAST - RENAME - CHAIN_ID - -The instructions which accept at most two variable annotations are: - -:: - - UNPAIR - CREATE_CONTRACT - -Annotations on instructions that produce multiple elements on the stack -will be used in order, where the first variable annotation is given to -the top-most element on the resulting stack. Instructions that produce -``n`` elements on the stack but are given less than ``n`` variable -annotations will see only their top-most stack type elements annotated. - -:: - - UNPAIR @fist @second - :: pair 'a 'b : 'S - -> @first 'a : @second 'b : 'S - - UNPAIR @first - :: pair 'a 'b : 'S - -> @first 'a : 'b : 'S - -A no-op instruction ``RENAME`` allows to rename variables in the stack -or to erase variable annotations in the stack. - -:: - - RENAME @new - :: @old 'a ; 'S -> @new 'a : 'S - - RENAME - :: @old 'a ; 'S -> 'a : 'S - - -Field and constructor annotations -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Components of pair types, option types and or types can be annotated -with a field or constructor annotation. This feature is useful to encode -records fields and constructors of sum types. - -:: - - (pair :point - (int %x) - (int %y)) - -The previous Michelson type can be used as visual aid to represent the -record type (given in OCaml-like syntax): - -:: - - type point = { x : int ; y : int } - -Similarly, - -:: - - (or :t - (int %A) - (or - (bool %B) - (pair %C - (nat %n1) - (nat %n2)))) - -can be used to represent the algebraic data type (in OCaml-like syntax): - -:: - - type t = - | A of int - | B of bool - | C of { n1 : nat ; n2 : nat } - - -Field annotations are part of the type (at the same level as type name -annotations), and so types with differing field names (if present) are -not considered equal. - -Instructions that construct elements of composed types can also be -annotated with one or multiple field annotations (in addition to type -and variable annotations). - -:: - - PAIR %fst %snd - :: 'a : 'b : 'S -> (pair ('a %fst) ('b %snd)) : 'S - - LEFT %left %right 'b - :: 'a : 'S -> (or ('a %left) ('b %right)) : 'S - - RIGHT %left %right 'a - :: 'b : 'S -> (or ('a %left) ('b %right)) : 'S - -To improve readability and robustness, instructions ``CAR`` and ``CDR`` -accept one field annotation. For the contract to type check, the name of -the accessed field in the destructed pair must match the one given here. - -:: - - CAR %fst - :: (pair ('a %fst) 'b) : S -> 'a : 'S - - CDR %snd - :: (pair 'a ('b %snd)) : S -> 'b : 'S - - -Syntax -~~~~~~ - -Primitive applications can receive one or many annotations. - -An annotation is a sequence of characters that matches the regular -expression ``@%|@%%|%@|[@:%][_0-9a-zA-Z][_0-9a-zA-Z\.%@]*``. -Note however that ``@%``, ``@%%`` and ``%@`` are -:ref:`special annotations ` and are not allowed everywhere. - -Annotations come after the primitive name and before its potential arguments. - -:: - - (prim @v :t %x arg1 arg2 ...) - - -Ordering between different kinds of annotations is not significant, but -ordering among annotations of the same kind is. Annotations of the same -kind must be grouped together. - -For instance these two annotated instructions are equivalent: - -:: - - PAIR :t @my_pair %x %y - - PAIR %x %y :t @my_pair - -An annotation can be empty, in this case it will mean *no annotation* -and can be used as a wildcard. For instance, it is useful to annotate -only the right field of a pair instruction ``PAIR % %right`` or to -ignore field access constraints, *e.g.* in the macro ``UNPPAIPAIR %x1 % -%x3 %x4``. - -Annotations and macros -~~~~~~~~~~~~~~~~~~~~~~ - -Macros also support annotations, which are propagated on their expanded -forms. As with instructions, macros that produce ``n`` values on the -stack accept ``n`` variable annotations. - -:: - - DUU+P @annot - > DUU(\rest=U*)P @annot / S => DIP (DU(\rest)P @annot) ; SWAP / S - - C[AD]+R @annot %field_name - > CA(\rest=[AD]+)R @annot %field_name / S => CAR ; C(\rest)R @annot %field_name / S - > CD(\rest=[AD]+)R @annot %field_name / S => CDR ; C(\rest)R @annot %field_name / S - - CMP{EQ|NEQ|LT|GT|LE|GE} @annot - > CMP(\op) @annot / S => COMPARE ; (\op) @annot / S - -The variable annotation on ``SET_C[AD]+R`` and ``MAP_C[AD]+R`` annotates -the resulting toplevel pair while its field annotation is used to check -that the modified field is the expected one. - -:: - - SET_C[AD]+R @var %field - > SET_CAR @var %field => CDR %field ; SWAP ; PAIR @var - > SET_CDR @var %field => CAR %field ; PAIR @var - > SET_CA(\rest=[AD]+)R @var %field / S => - { DUP ; DIP { CAR ; SET_C(\rest)R %field } ; CDR ; SWAP ; PAIR @var } / S - > SET_CD(\rest=[AD]+)R @var %field/ S => - { DUP ; DIP { CDR ; SET_C(\rest)R %field } ; CAR ; PAIR @var } / S - - MAP_C[AD]+R @var %field code - > MAP_CAR code => DUP ; CDR ; DIP { CAR %field ; code } ; SWAP ; PAIR @var - > MAP_CDR code => DUP ; CDR %field ; code ; SWAP ; CAR ; PAIR @var - > MAP_CA(\rest=[AD]+)R @var %field code / S => - { DUP ; DIP { CAR ; MAP_C(\rest)R %field code } ; CDR ; SWAP ; PAIR @var} / S - > MAP_CD(\rest=[AD]+)R @var %field code / S => - { DUP ; DIP { CDR ; MAP_C(\rest)R %field code } ; CAR ; PAIR @var} / S - -Macros for nested ``PAIR`` accept multiple annotations. Field -annotations for ``PAIR`` give names to leaves of the constructed -nested pair, in order. This next snippet gives examples instead of -generic rewrite rules for readability purposes. - -:: - - PAPPAIIR @p %x1 %x2 %x3 %x4 - :: 'a : 'b : 'c : 'd : 'S - -> @p (pair ('a %x1) (pair (pair ('b %x) ('c %x3)) ('d %x4))) : 'S - - PAPAIR @p %x1 %x2 %x3 - :: 'a : 'b : 'c : 'S -> @p (pair ('a %x1) (pair ('b %x) ('c %x3))) : 'S - -Annotations for nested ``UNPAIR`` are deprecated. - -Automatic variable and field annotations inferring -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When no annotation is provided by the Michelson programmer, the -typechecker infers some annotations in specific cases. This greatly -helps users track information in the stack for bare contracts. - -For unannotated accesses with ``CAR`` and ``CDR`` to fields that are -named will be appended (with an additional ``.`` character) to the pair -variable annotation. - -:: - - CDAR - :: @p (pair ('a %foo) (pair %bar ('b %x) ('c %y))) : 'S -> @p.bar.x 'b : 'S - -If fields are not named but the pair is still named in the stack then -``.car`` or ``.cdr`` will be appended. - -:: - - CDAR - :: @p (pair 'a (pair 'b 'c)) : 'S -> @p.cdr.car 'b : 'S - -If the original pair is not named in the stack, but a field annotation -is present in the pair type the accessed value will be annotated with a -variable annotation corresponding to the field annotation alone. - -:: - - CDAR - :: (pair ('a %foo) (pair %bar ('b %x) ('c %y))) : 'S -> @bar.x 'b : 'S - -A similar mechanism is used for context dependent instructions: - -:: - - ADDRESS :: @c contract _ : 'S -> @c.address address : 'S - - CONTRACT 'p :: @a address : 'S -> @a.contract contract 'p : 'S - - BALANCE :: 'S -> @balance mutez : 'S - - SOURCE :: 'S -> @source address : 'S - - SENDER :: 'S -> @sender address : 'S - - SELF :: 'S -> @self contract 'p : 'S - - SELF_ADDRESS :: 'S -> @self address : 'S - - AMOUNT :: 'S -> @amount mutez : 'S - - NOW :: 'S -> @now timestamp : 'S - - LEVEL :: 'S -> @level nat : 'S - -Inside nested code blocks, bound items on the stack will be given a -default variable name annotation depending on the instruction and stack -type (which can be changed). For instance the annotated typing rule for -``ITER`` on lists is: - -:: - - ITER body - :: @l (list 'e) : 'A -> 'A - iff body :: [ @l.elt e' : 'A -> 'A ] - -Special annotations -~~~~~~~~~~~~~~~~~~~ -.. _SpecialAnnotations: -.. _SpecialAnnotations_009: - -The special variable annotations ``@%`` and ``@%%`` can be used on instructions -``CAR``, ``CDR``, and ``UNPAIR``. It means to use the accessed field name (if any) as -a name for the value on the stack. The following typing rule -demonstrates their use for instruction ``CAR``. - -:: - - CAR @% - :: @p (pair ('a %fst) ('b %snd)) : 'S -> @fst 'a : 'S - - CAR @%% - :: @p (pair ('a %fst) ('b %snd)) : 'S -> @p.fst 'a : 'S - -The special field annotation ``%@`` can be used on instructions -``PAIR``, ``LEFT`` and ``RIGHT``. It means to use the variable -name annotation in the stack as a field name for the constructed -element. Two examples with ``PAIR`` follows, notice the special -treatment of annotations with ``.``. - -:: - - PAIR %@ %@ - :: @x 'a : @y 'b : 'S -> (pair ('a %x) ('b %y)) : 'S - - PAIR %@ %@ - :: @p.x 'a : @p.y 'b : 'S -> @p (pair ('a %x) ('b %y)) : 'S - :: @p.x 'a : @q.y 'b : 'S -> (pair ('a %x) ('b %y)) : 'S - -Entrypoints ------------ - -The specification up to this point has been mostly ignoring existence -of entrypoints: a mechanism of contract level polymorphism. This -mechanism is optional, non intrusive, and transparent to smart -contracts that don't use them. This section is to be read as a patch -over the rest of the specification, introducing rules that apply only -in presence of contracts that make use of entrypoints. - -Defining and calling entrypoints -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Entrypoints piggyback on the constructor annotations. A contract with -entrypoints is basically a contract that takes a disjunctive type (a -nesting of ``or`` types) as the root of its input parameter, decorated -with constructor annotations. An extra check is performed on these -constructor annotations: a contract cannot define two entrypoints with -the same name. - -An external transaction can include an entrypoint name alongside the -parameter value. In that case, if there is a constructor annotation -with this name at any position in the nesting of ``or`` types, the -value is automatically wrapped into the according constructors. If the -transaction specifies an entrypoint, but there is no such constructor -annotation, the transaction fails. - -For instance, suppose the following input type. - -``parameter (or (or (nat %A) (bool %B)) (or %maybe_C (unit %Z) (string %C)))`` - -The input values will be wrapped as in the following examples. - -:: - - +------------+-----------+---------------------------------+ - | entrypoint | input | wrapped input | - +------------+-----------+---------------------------------+ - | %A | 3 | Left (Left 3) | - | %B | False | Left (Right False) | - | %C | "bob" | Right (Right "bob") | - | %Z | Unit | Right (Left Unit) | - | %maybe_C | Right "x" | Right (Right "x") | - | %maybe_C | Left Unit | Right (Left Unit) | - +------------+-----------+---------------------------------+ - | not given | value | value (untouched) | - | %BAD | _ | failure, contract not called | - +------------+-----------+---------------------------------+ - -The ``default`` entrypoint -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A special semantics is assigned to the ``default`` entrypoint. If the -contract does not explicitly declare a ``default`` entrypoint, then it -is automatically assigned to the root of the parameter -type. Conversely, if the contract is called without specifying an -entrypoint, then it is assumed to be called with the ``default`` -entrypoint. This behaviour makes the entrypoint system completely -transparent to contracts that do not use it. - -This is the case for the previous example, for instance. If a value is -passed to such a contract specifying entrypoint ``default``, then the -value is fed to the contract untouched, exactly as if no entrypoint -was given. - -A non enforced convention is to make the entrypoint ``default`` of -type unit, and to implement the crediting operation (just receive the -transferred tokens). - -A consequence of this semantics is that if the contract uses the -entrypoint system and defines a ``default`` entrypoint somewhere else -than at the root of the parameter type, then it must provide an -entrypoint for all the paths in the toplevel disjunction. Otherwise, -some parts of the contracts would be dead code. - -Another consequence of setting the entrypoint somewhere else than at -the root is that it makes it impossible to send the raw values of the -full parameter type to a contract. A trivial solution for that is to -name the root of the type. The conventional name for that is ``root``. - -Let us recapitulate this by tweaking the names of the previous example. - -``parameter %root (or (or (nat %A) (bool %B)) (or (unit %default) string))`` - -The input values will be wrapped as in the following examples. - -:: - - +------------+---------------------+-----------------------+ - | entrypoint | input | wrapped input | - +------------+---------------------+-----------------------+ - | %A | 3 | Left (Left 3) | - | %B | False | Left (Right False) | - | %default | Unit | Right (Left Unit) | - | %root | Right (Right "bob") | Right (Right "bob") | - +------------+---------------------+-----------------------+ - | not given | Unit | Right (Left Unit) | - | %BAD | _ | failure, contract not | - +------------+---------------------+-----------------------+ - -Calling entrypoints from Michelson -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Michelson code can also produce transactions to a specific entrypoint. - -For this, both types ``address`` and ``contract`` have the ability to -denote not just an address, but a pair of an address and an -entrypoint. The concrete notation is ``"address%entrypoint"``. -Note that ``"address"`` is strictly equivalent to ``"address%default"``, -and for clarity, the second variant is forbidden in the concrete syntax. - -When the ``TRANSFER_TOKENS`` instruction is called, it places the -entrypoint provided in the contract handle in the transaction. - -The ``CONTRACT t`` instruction has a variant ``CONTRACT %entrypoint -t``, that works as follows. Note that ``CONTRACT t`` is strictly -equivalent to ``CONTRACT %default t``, and for clarity, the second -variant is forbidden in the concrete syntax. - -:: - - +---------------+---------------------+------------------------------------------+ - | input address | instruction | output contract | - +---------------+---------------------+------------------------------------------+ - | "addr" | CONTRACT t | (Some "addr") if contract exists, has a | - | | | default entrypoint of type t, or has no | - | | | default entrypoint and parameter type t | - +---------------+---------------------+------------------------------------------+ - | "addr%name" | CONTRACT t | (Some "addr%name") if addr exists and | - +---------------+---------------------+ has an entrypoint %name of type t | - | "addr" | CONTRACT %name t | | - +---------------+---------------------+------------------------------------------+ - | "addr%_" | CONTRACT %_ t | None | - +---------------+---------------------+------------------------------------------+ - -Similarly, the ``SELF`` instruction has a variant ``SELF %entrypoint``, -that is only well-typed if the current contract has an entrypoint named ``%entrypoint``. - -- ``SELF %entrypoint`` - -:: - - :: 'S -> contract 'p : 'S - where contract 'p is the type of the entrypoint %entrypoint of the current contract - -Implicit accounts are considered to have a single ``default`` -entrypoint of type ``Unit``. - -JSON syntax ------------ - -Micheline expressions are encoded in JSON like this: - -- An integer ``N`` is an object with a single field ``"int"`` whose - value is the decimal representation as a string. - - ``{ "int": "N" }`` - -- A string ``"contents"`` is an object with a single field ``"string"`` - whose value is the decimal representation as a string. - - ``{ "string": "contents" }`` - -- A sequence is a JSON array. - - ``[ expr, ... ]`` - -- A primitive application is an object with two fields ``"prim"`` for - the primitive name and ``"args"`` for the arguments (that must - contain an array). A third optional field ``"annots"`` contains a - list of annotations, including their leading ``@``, ``%`` or ``:`` - sign. - - ``{ "prim": "pair", "args": [ { "prim": "nat", "args": [] }, { "prim": "nat", "args": [] } ], "annots": [":t"] }`` - -As in the concrete syntax, all domain specific constants are encoded as -strings. - -Examples ---------- - -Contracts in the system are stored as a piece of code and a global data -storage. The type of the global data of the storage is fixed for each -contract at origination time. This is ensured statically by checking on -origination that the code preserves the type of the global data. For -this, the code of the contract is checked to be of type -``lambda (pair 'arg 'global) -> (pair (list operation) 'global)`` where -``'global`` is the type of the original global store given on origination. -The contract also takes a parameter and returns a list of internal operations, -hence the complete calling convention above. The internal operations are -queued for execution when the contract returns. - -Empty contract -~~~~~~~~~~~~~~ - -The simplest contract is the contract for which the ``parameter`` and -``storage`` are all of type ``unit``. This contract is as follows: - -.. code-block:: michelson - - code { CDR ; # keep the storage - NIL operation ; # return no internal operation - PAIR }; # respect the calling convention - storage unit; - parameter unit; - - -Example contract with entrypoints -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following contract maintains a number in its storage. It has two -entrypoints ``add`` and ``sub`` to modify it, and the default -entrypoint, of type ``unit`` will reset it to ``0``. - -:: - - { parameter (or (or (nat %add) (nat %sub)) (unit %default)) ; - storage int ; - code { AMOUNT ; PUSH mutez 0 ; ASSERT_CMPEQ ; UNPAIR ; - IF_LEFT - { IF_LEFT { ADD } { SWAP ; SUB } } - { DROP ; DROP ; PUSH int 0 } ; - NIL operation ; PAIR } } - -Multisig contract -~~~~~~~~~~~~~~~~~ - -The multisig is a typical access control contract. The ownership of -the multisig contract is shared between ``N`` participants represented -by their public keys in the contract's storage. Any action on the -multisig contract needs to be signed by ``K`` participants where the -threshold ``K`` is also stored in the storage. - -To avoid replay of the signatures sent to the contract, the signed -data include not only a description of the action to perform but also -the address of the multisig contract and a counter that gets -incremented at each successful call to the contract. - -The multisig commands of :ref:`Tezos command line client ` -use this -smart contract. Moreover, `functional correctness of this contract has -been verified -`__ -using the Coq proof assistant. - - -.. code-block:: michelson - - parameter (pair - (pair :payload - (nat %counter) # counter, used to prevent replay attacks - (or :action # payload to sign, represents the requested action - (pair :transfer # transfer tokens - (mutez %amount) # amount to transfer - (contract %dest unit)) # destination to transfer to - (or - (option %delegate key_hash) # change the delegate to this address - (pair %change_keys # change the keys controlling the multisig - (nat %threshold) # new threshold - (list %keys key))))) # new list of keys - (list %sigs (option signature))); # signatures - - storage (pair (nat %stored_counter) (pair (nat %threshold) (list %keys key))) ; - - code - { - UNPAIR ; SWAP ; DUP ; DIP { SWAP } ; - DIP - { - UNPAIR ; - # pair the payload with the current contract address, to ensure signatures - # can't be replayed across different contracts if a key is reused. - DUP ; SELF ; ADDRESS ; CHAIN_ID ; PAIR ; PAIR ; - PACK ; # form the binary payload that we expect to be signed - DIP { UNPAIR @counter ; DIP { SWAP } } ; SWAP - } ; - - # Check that the counters match - UNPAIR @stored_counter; DIP { SWAP }; - ASSERT_CMPEQ ; - - # Compute the number of valid signatures - DIP { SWAP } ; UNPAIR @threshold @keys; - DIP - { - # Running count of valid signatures - PUSH @valid nat 0; SWAP ; - ITER - { - DIP { SWAP } ; SWAP ; - IF_CONS - { - IF_SOME - { SWAP ; - DIP - { - SWAP ; DIIP { DIP { DUP } ; SWAP } ; - # Checks signatures, fails if invalid - CHECK_SIGNATURE ; ASSERT ; - PUSH nat 1 ; ADD @valid } } - { SWAP ; DROP } - } - { - # There were fewer signatures in the list - # than keys. Not all signatures must be present, but - # they should be marked as absent using the option type. - FAIL - } ; - SWAP - } - } ; - # Assert that the threshold is less than or equal to the - # number of valid signatures. - ASSERT_CMPLE ; - DROP ; DROP ; - - # Increment counter and place in storage - DIP { UNPAIR ; PUSH nat 1 ; ADD @new_counter ; PAIR} ; - - # We have now handled the signature verification part, - # produce the operation requested by the signers. - NIL operation ; SWAP ; - IF_LEFT - { # Transfer tokens - UNPAIR ; UNIT ; TRANSFER_TOKENS ; CONS } - { IF_LEFT { - # Change delegate - SET_DELEGATE ; CONS } - { - # Change set of signatures - DIP { SWAP ; CAR } ; SWAP ; PAIR ; SWAP }} ; - PAIR } - - - -Full grammar ------------- - -:: - - ::= - | - | - | - | Unit - | True - | False - | Pair ... - | Left - | Right - | Some - | None - | { ; ... } - | { Elt ; ... } - | instruction - ::= - | [0-9]+ - ::= - | - | - - ::= - | "*" - ::= - | \" - | \r - | \n - | \t - | \b - | \\ - | [^"\] - ::= - | 0x[0-9a-fA-F]+ - ::= - | { ... } - | DROP - | DROP - | DUP - | DUP - | SWAP - | DIG - | DUG - | PUSH - | SOME - | NONE - | UNIT - | NEVER - | IF_NONE { ... } { ... } - | PAIR - | PAIR - | CAR - | CDR - | UNPAIR - | UNPAIR - | LEFT - | RIGHT - | IF_LEFT { ... } { ... } - | NIL - | CONS - | IF_CONS { ... } { ... } - | SIZE - | EMPTY_SET - | EMPTY_MAP - | EMPTY_BIG_MAP - | MAP { ... } - | ITER { ... } - | MEM - | GET - | GET - | UPDATE - | UPDATE - | IF { ... } { ... } - | LOOP { ... } - | LOOP_LEFT { ... } - | LAMBDA { ... } - | EXEC - | APPLY - | DIP { ... } - | DIP { ... } - | FAILWITH - | CAST - | RENAME - | CONCAT - | SLICE - | PACK - | UNPACK - | ADD - | SUB - | MUL - | EDIV - | ABS - | ISNAT - | INT - | NEG - | LSL - | LSR - | OR - | AND - | XOR - | NOT - | COMPARE - | EQ - | NEQ - | LT - | GT - | LE - | GE - | SELF - | SELF_ADDRESS - | CONTRACT - | TRANSFER_TOKENS - | SET_DELEGATE - | CREATE_CONTRACT { ... } - | IMPLICIT_ACCOUNT - | VOTING_POWER - | NOW - | LEVEL - | AMOUNT - | BALANCE - | CHECK_SIGNATURE - | BLAKE2B - | KECCAK - | SHA3 - | SHA256 - | SHA512 - | HASH_KEY - | SOURCE - | SENDER - | ADDRESS - | CHAIN_ID - | TOTAL_VOTING_POWER - | PAIRING_CHECK - | SAPLING_EMPTY_STATE - | SAPLING_VERIFY_UPDATE - | TICKET - | READ_TICKET - | SPLIT_TICKET - | JOIN_TICKETS - ::= - | - | option - | list - | set - | operation - | contract - | ticket - | pair ... - | or - | lambda - | map - | big_map - | bls12_381_g1 - | bls12_381_g2 - | bls12_381_fr - | sapling_transaction - | sapling_state - ::= - | unit - | never - | bool - | int - | nat - | string - | chain_id - | bytes - | mutez - | key_hash - | key - | signature - | timestamp - | address - | option - | or - | pair ... - - -Reference implementation ------------------------- - -The language is implemented in OCaml as follows: - -- The lower internal representation is written as a GADT whose type - parameters encode exactly the typing rules given in this - specification. In other words, if a program written in this - representation is accepted by OCaml's typechecker, it is guaranteed - type-safe. This is of course also valid for programs not - handwritten but generated by OCaml code, so we are sure that any - manipulated code is type-safe. - - In the end, what remains to be checked is the encoding of the typing - rules as OCaml types, which boils down to half a line of code for - each instruction. Everything else is left to the venerable and well - trusted OCaml. - -- The interpreter is basically the direct transcription of the - rewriting rules presented above. It takes an instruction, a stack and - transforms it. OCaml's typechecker ensures that the transformation - respects the pre and post stack types declared by the GADT case for - each instruction. - - The only things that remain to be reviewed are value dependent - choices, such as we did not swap true and false when - interpreting the IF instruction. - -- The input, untyped internal representation is an OCaml ADT with - only 5 grammar constructions: ``String``, ``Int``, ``Bytes``, ``Seq`` and - ``Prim``. It is the target language for the parser, since not all - parsable programs are well typed, and thus could simply not be - constructed using the GADT. - -- The typechecker is a simple function that recognizes the abstract - grammar described in section X by pattern matching, producing the - well-typed, corresponding GADT expressions. It is mostly a checker, - not a full inferrer, and thus takes some annotations (basically the - input and output of the program, of lambdas and of uninitialized maps - and sets). It works by performing a symbolic evaluation of the - program, transforming a symbolic stack. It only needs one pass over - the whole program. - - Here again, OCaml does most of the checking, the structure of the - function is very simple, what we have to check is that we transform a - ``Prim ("If", ...)`` into an ``If``, a ``Prim ("Dup", ...)`` into a - ``Dup``, etc. diff --git a/docs/009/proof_of_stake.rst b/docs/009/proof_of_stake.rst deleted file mode 100644 index dee3dc389a55104db49feeb44e796739ed38c472..0000000000000000000000000000000000000000 --- a/docs/009/proof_of_stake.rst +++ /dev/null @@ -1,210 +0,0 @@ -Proof-of-stake -============== - -Overview --------- - -:doc:`The consensus algorithm ` in Tezos is based on the -*proof-of-stake* mechanism. Proof-of-stake means that participants -in the consensus algorithm are chosen in function of their stake (the -amount of tokens a participant has). The same mechanism is used in the -Tezos :doc:`governance `. - -If one does not have enough stake to participate on its own or does not want to -set up the needed infrastructure, (s)he can use :ref:`delegation -`. Therefore, in Tezos, it is the :ref:`delegates` -that may participate in consensus. Delegates' rights to participate are -determined by a `follow-the-coin strategy -`_. This -procedure is random, in that its result cannot be predicted too much in advance. -The :ref:`randomness` is obtained from information already found on the -blockchain. Thus, the procedure is also deterministic: delegates' rights are -uniquely determined from the random element. - -Delegation ----------- - -A *delegate* is any :ref:`implicit account` registered as -such by emitting a delegate registration operation. - -Any :ref:`accounts ` (implicit or originated) can specify a delegate -through a delegation operation. - - -Any account can change or revoke its delegate at any time. However, the change -only becomes effective after ``PRESERVED_CYCLES + 2`` :ref:`cycles `. -The value ``PRESERVED_CYCLES`` is a -:ref:`protocol constant `. - -A delegate participates in consensus and in governance with a weight -proportional with their delegated stake, which includes the balances of -all the accounts that delegate to it, and also the balance of the -delegate itself. - -Delegates place security deposits that may be forfeited in case they do not -follow (some particular rules of) the protocol. Security deposits are deduced -from the delegates' own balance. Therefore delegates may be subject to -:ref:`over-delegation`. - - -Active and passive delegates -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _active_delegate: -.. _active_delegate_009: - -A delegate can be marked as either active or passive. A passive -delegate cannot participate in the consensus algorithm. - -A delegate is marked as active at its registration. - -A delegate becomes passive for cycle ``n`` when they -fail to participate in the consensus algorithm in -the past ``PRESERVED_CYCLES`` cycles, that is, in cycles ``n-1``, -``n-2``, ..., ``n - PRESERVED_CYCLES``. - -Delegates' rights selection ---------------------------- - -Tezos being proof-of-stake, the delegates' rights are selected at random based on their -stake. In theory, it would be possible to give each token a serial number and -track the specific tokens assigned to specific delegates. However, it would be -too demanding of nodes to track assignments at such a granular level. Instead, -Tezos works with *sets of tokens* which are called *rolls*. - -.. _roll_pos: -.. _roll_pos_009: - -Rolls -^^^^^ - -A roll holds ``TOKENS_PER_ROLL`` tokens. When tokens are moved, or a delegate for an -account is changed, the rolls change delegate according to the following -algorithm. - -Each delegate has a stack of roll identifiers plus some "change" which is always -an amount smaller than ``TOKENS_PER_ROLL``. When tokens are moved from one -delegate to the other, first, the change is used. If it is not enough, rolls -need to be "broken" which means that they move from the delegate stack to a -global, unallocated, roll stack. This is done until the amount is covered, and -some change possibly remains. - -Then, the other delegate is credited. First, the amount is added to the -"change". If it becomes greater than ``TOKENS_PER_ROLL``, then rolls are -unstacked from the global unallocated roll stack onto the delegate stack. If the -global stack is empty, a fresh roll is created. - -This preserves the property that if the delegate is changed through several -transactions, the roll assignment is preserved, even if each operation moves -less than a full roll. - -The advantage of tracking tokens in this way is that a delegate creating a -malicious fork cannot easily change the specific rolls assigned to them, even if -they control the underlying tokens and shuffle them around. - -.. _random_seed: -.. _random_seed_009: - -Random seed -^^^^^^^^^^^ - -Each cycle ``n`` is associated with a random seed. The random seed for cycle -``n`` is a 256-bit number generated at the very end of cycle ``n-1`` from -*nonces* to which delegates commit during cycle ``n-2``. One block out of every -``BLOCKS_PER_COMMITMENT`` can contain a commitment. A commitment is the hash of -a nonce. The commitment is generated by the block proposer and is included in -the block header. - -The committed nonce must be revealed by the original block proposer during cycle -``n-1`` under penalty of forfeiting the rewards and fees of the block that -included the commitment. The associated security deposit is not forfeited. - -A *nonce revelation* is an operation, and multiple nonce revelations can thus be -included in a block. A reward ``SEED_NONCE_REVELATION_TIP`` is given for -including a revelation. Revelations are free operations which do not compete -with transactions for block space. Up to ``MAX_ANON_OPS_PER_BLOCK`` revelations, -wallet activations and denunciations can be contained in any given block. - -The seed for cycle ``n`` is obtained as follows: the seed of cycle ``n-1`` is -hashed with a constant and then with each nonce revealed in cycle ``n-1``. - -.. _rights: -.. _rights_009: - -Slot selection -^^^^^^^^^^^^^^ - -To return to the rights selection mechanism, we first introduce a new -terminology, *roll snapshot*, to denote the stored (in the -:ref:`context `) distribution of rolls for a given block. Roll -snapshots are taken (and stored) every ``BLOCKS_PER_ROLL_SNAPSHOT`` -blocks. - -The delegates' rights at a given level and for a particular role in -the protocol are expressed in terms of *slots* that the delegate -receives for that role. The slot owner is obtained by running a PRNG -(pseudo-random number generator) with the following input: - -- the level -- the role (a string) -- the slot (a non-negative integer) - -Let `n` be the cycle the level belongs to. -The seed of the PRNG is the :ref:`random seed ` associated with cycle ``n-PRESERVED_CYCLES``. -The PRNG first selects a snapshot from cycle ``n-PRESERVED_CYCLES-2`` and then it selects a roll in the selected snapshot. -The slot owner is then the roll owner. - - -.. _protocol_constants: -.. _protocol_constants_009: - -Protocol constants ------------------- - -Protocols are parameterized by several parameters called *protocol constants*, which may vary from one protocol to another or from one network to another (for instance, test networks move faster). -An example of a parameter is the number of tez constituting a roll. This number is given by the constant named ``TOKENS_PER_ROLL``. - -The list of protocol constants can be found in the API of the `Constants module `__. - -The values of protocol constants can be found using a :ref:`specific RPC call `, as shown in :ref:`this example `. - -In particular, the protocol constants related to the proof-of-stake mechanism are detailed below. - -.. _ps_constants: -.. _ps_constants_009: - -Proof-of-stake parameters -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 55 25 - :header-rows: 1 - - * - Parameter name - - Parameter value - * - ``BLOCKS_PER_CYCLE`` - - 4096 blocks - * - ``PRESERVED_CYCLES`` - - 5 cycles - * - ``BLOCKS_PER_COMMITMENT`` - - 32 blocks - * - ``MAX_ANON_OPS_PER_BLOCK`` - - 132 revelations - * - ``SEED_NONCE_REVELATION_TIP`` - - 1/8 ꜩ - * - ``TOKENS_PER_ROLL`` - - 8,000 ꜩ - * - ``BLOCKS_PER_ROLL_SNAPSHOT`` - - 256 blocks - - -Further External Resources --------------------------- - -The original design of the proof-of-stake mechanism in Tezos can be -found in the `whitepaper -`_. - -Another presentation of the Tezos' proof-of-stake mechanism can be -found in the `Tezos agora wiki entry -`_. diff --git a/docs/009/sapling.rst b/docs/009/sapling.rst deleted file mode 100644 index 24e5639d4ea1bd68c5be4672c48e8f4b26bd74a2..0000000000000000000000000000000000000000 --- a/docs/009/sapling.rst +++ /dev/null @@ -1,496 +0,0 @@ -**The features described in this page are experimental and have not undergone any security review.** - -Sapling integration -=================== - -Sapling is a protocol enabling privacy-preserving transactions of fungible -tokens in a decentralised -environment. It was designed and implemented by the Electric Coin -Company as the last iteration over a series of previous protocols and -academic works starting with the `Zerocoin seminal -paper `_. - -The reference implementation of Sapling, -`librustzcash `_, was -integrated in the Tezos codebase during 2019. It will be proposed as -part of a protocol amendment during 2020. - -Librustzcash and the Tezos integration implement the protocol -described in this `specification -`_, version 2020.1.0. - - -Sapling -------- - -Keys -~~~~ - -Sapling offers a rich set of keys, each allowing different operations. -A `spending key` allows to spend tokens so if it is lost or -compromised the tokens could remain locked or be stolen. -From a spending key it is possible to derive a corresponding `viewing -key` which allows to view all incoming and outgoing transactions. -The viewing key allows the owner of the tokens to check their balance -and transaction history so if compromised there is a complete loss of -privacy. -On the other hand a viewing key can willingly be shared with a third -party, for example with an auditor for regulatory compliance purposes. - -A viewing key can also derive several diversified `addresses`. -An address can be used to receive funds, much like the address of an -implicit account. - -Additionally `proving keys` can be used to allow the creation of proofs, -thus revealing private information, without being able to spend funds. -They are useful for example in case the spending key is stored in a -hardware wallet but we'd like to use our laptop to craft the -transaction and produce the zero-knowledge proofs, which are -computationally too intensive for an embedded device. - -More details can be found in the `specification document -`_. - -Shielded transactions -~~~~~~~~~~~~~~~~~~~~~ - -Transactions use Bitcoin's UTXO model with the important difference that each -input and output, instead of containing an amount and an address, -are just cryptographic `commitments`. -In order to avoid double spends, it's important to be able to check -that a commitment has not already been spent. In Bitcoin we just need to -check if an output is also later used as an input to verify if it's -already spent. In Sapling however we can't know because inputs are not -linked to outputs. -For this reason for each input of a transaction, the owner must also -publish a `nullifier`, which invalidates it. The nullifier can only be -produced by the owner of a commitment and it's deterministic so that -everybody can check that it hasn't been already published. -Note however that it is not possible to infer which commitment has -been nullified. -Transactions of this form are privacy preserving and are referred to -as `shielded`, because they reveal neither the amount, the sender nor -the receiver. - -The existing set of transactions is referred to as the `shielded pool`. -Unlike Bitcoin, where everybody can compute the set of unspent -outputs of every user, in Sapling only the owner of a viewing key can -find their outputs and verify that they are not already spent. -For this reason, to an external -observer, the shielded pool is always increasing in size and the more -transactions are added the harder it is to pinpoint the commitments -belonging to a user. - -When we spend a commitment there is some additional information that -we need to transmit to the recipient in order for them to spend the -corresponding output. -This data is encrypted under a symmetric key resulting from a -Diffie-Hellman key exchange using the recipient address and an -ephemeral key. -In principle this `ciphertext` can be transmitted off-chain as it's -not needed to verify the integrity of the pool. For convenience, in -Tezos, it is stored together with the commitment and the nullifier on -chain. - -For reasons of efficiency the commitments are stored in an incremental -`Merkle tree `_ which -allows for compact proofs of membership. The root of the tree is all -that is needed to refer to a certain state of the shielded pool. - -In order to ensure the correctness of a transaction, given that there -is information that we wish to remain secret, the spender must also -generate proofs that various good properties are true. -Thanks to the use of `SNARKs `_ -these proofs are very succinct in size, fast to verify and they don't -reveal any private information. - -This model of transaction adapts elegantly to the case when we need to -mint or burn tokens, which is needed to shield or unshield from a -transparent token. -It suffices to add more values in the outputs than in the inputs -to mint and to have more in inputs than outputs to burn. - -Privacy guarantees -~~~~~~~~~~~~~~~~~~ - -We explained that the shielded pool contains one commitment for each -input (spent or not), and one nullifier for each spent input. -These cryptographic commitments hide the amount and the owner of the -tokens they represent. -Additionally commitments are unlinkable meaning that we can not deduce -which input is spent to create an output. - -It should be noted that the number of inputs and outputs of a -transaction is public, which could help link a class of -transactions. This problem can be mitigated by adding any number of -dummy inputs or outputs at the cost of wasting some space. - -The shielded pool communicates with the public ledger by minting and -burning shielded tokens in exchange for public coins. -Therefore going in and out of the shielded pool is public: we know -which address shielded or unshielded and how much. -We can among other things infer the total number of shielded coins. - -Timing and network information can also help to deduce some private -information. -For example by observing the gossip network we might learn the IP -address of somebody that is submitting a shielded transaction. -This can be mitigated by using `TOR -`_. - -Good practices -~~~~~~~~~~~~~~ - -When blending in a group of people, one should always pay attention to -the size and the variety of the group. - -We recommend two good practices. First, do not originate a second -contract if another one has the same functionalities, it will split -the anonymity set. - -Second, remember that shielding and unshielding are public operations. -A typical anti-pattern is to shield from tz1-alice 15.3 tez, and then -unshield 15.3 tez to tz1-bob. It's fairly clear from timing and -amounts that Alice transferred 15.3 tez to Bob. -To decorrelate the two transfers it is important to change the -amounts, let some time pass between the two and perform the -transactions when there is traffic in the pool. -Similar problems exist in ZCash and they are illustrated in this -introductory `blog post -`_. - -There are a number of more sophisticated techniques to deanonymise -users using timing of operations, network monitoring, side-channels on -clients and analysis of number of inputs/outputs just to mention a few -(`A fistful of Bitcoins -`_ is a good -first read). -We advice users to be familiar with the use of the TOR network and to -use clients developed specifically to protect their privacy. - - -Tezos integration ------------------ - -Michelson: verify update -~~~~~~~~~~~~~~~~~~~~~~~~ - -We introduce two new Michelson types `sapling_state` and -`sapling_transaction`, and two instructions called -`SAPLING_VERIFY_UPDATE` and `SAPLING_EMPTY_STATE` -(see the :doc:`Michelson reference` -for more details). -`SAPLING_EMPTY_STATE` pushes an empty `sapling_state` on the stack. -`SAPLING_VERIFY_UPDATE` takes a transaction and a state and returns an -option type which is Some (updated -state and a balance) if the transaction is correct, None otherwise. -A transaction has a list of inputs, outputs, a signature, a balance, -and the root of the Merkle tree containing its inputs. -The verification part checks the zero-knowledge proofs of all inputs -and outputs of the transaction, which guarantee several properties of -correctness. -It also checks a (randomised) signature associated with each input -(which guarantees that the owner forged the transaction), and the -signature that binds the whole transaction together and guarantees the -correctness of the balance. -All the signatures are over the hash of the data that we wish to sign -and the hash function used is Blake2-b, prefixed with the anti-replay string. -The anti-replay string is the the concatenation of the chain id and -the smart contract address. The same string has to be used by the client for -signing. - -Verify_update also checks that the root of the Merkle tree appears in -one of the past states and that the nullifiers are not already -present (i.e. no double spending is happening). -If one of the checks fails the instruction returns None. - -Otherwise the function adds to the new state the nullifiers given with each inputs -and adds the outputs to the Merkle tree, which will produce a new root. -It should be noted that it is possible to generate transactions -referring to an old root, as long as the inputs used were present in -the Merkle tree with that root and were not spent after. -In particular the protocol keeps 120 previous roots and guarantees -that roots are updated only once per block. -Considering 1 block per minute and that each block contains at least -one call to the same contract, a client has 2 hours to have its -transaction accepted before it is considered invalid. - -The nullifiers are stored in a set. The ciphertexts and other relevant -information linked to the commitment of the Merkle tree are -stored in a map indexed by the position of the commitment in the -Merkle tree. - -Lastly the instruction pushes the updated state and the balance as an option -on the stack. - -Example contracts -~~~~~~~~~~~~~~~~~ - -Shielded tez -^^^^^^^^^^^^ - -An example contract to have a shielded tez with a 1 to 1 conversion to -tez is available in the tests of `lib_sapling`. - -Simple Vote Contract -^^^^^^^^^^^^^^^^^^^^ - -One might think to use Sapling to do private voting. -It is possible to adapt shielded transactions to express preferences. -**Note that this is not what Sapling is designed for and it doesn't provide the same properties as an actual private voting protocol.** -A natural naive idea is the following. -Suppose we want a set of users to express a preference for option A or -B, we can generate two Sapling keys with two addresses that are -published and represent the two options. -The contract lets each user create a token which represents one vote -that can then be transferred to address A or B. -Using the published viewing keys everyone can check the outcome of the -vote. -**However note that a transaction can be replayed and we can see the balance of A or B going up. -This system does not offer ballot privacy. -Therefore one should ensure that the vote he is casting cannot be linked to him. -It is possible that the practical situation makes this usable but we recommend in general not to use -it for any important vote.** -Note that using a random elliptic curve element as incoming viewing key allows to generate a -dummy address that cannot be spent. This eases the counting of the votes. -To ensure that the ivk does not correspond to a normal address with spending key, one -can use the Fiat-Shamir heuristic. - - -Fees issue -~~~~~~~~~~ - -We have an additional privacy issue that Z-cash doesn't have. When -interacting with a shielded pool we interact with a smart contract -with a normal transaction and therefore have to pay fees from an -implicit account. -One could guess that private transactions whose fees are paid by the -same implicit account are from the same user. -This can be mitigated by making a service that act as a proxy by -forwarding the user transactions and paying it fees. The user would -then include in the transaction a shielded output for the service that -covers the fees plus a small bonus to pay the service. -This output can be open by the service before sending the transaction -to check that there is enough money to cover its fees. As for Z-cash, -users interacting with the proxy should use TOR or mitigate network -analysis as they wish. - -Gas, storage and costs -~~~~~~~~~~~~~~~~~~~~~~ - -Gas evaluation is not yet done. - -RPCs -~~~~ - -There are two Sapling RPCs under the prefix `context/sapling`. -`get_size` returns a pair with the size of the set of commitments -and the size of the set of nullifiers. -`get_diff` takes two optional starting offsets `cm_from` and `nf_from` -and returns the sapling state that was added from the offsets to the -current size. In particular it returns three lists, commitments, -ciphertexts from position `cm_from` up to the last one added and -nullifiers, from `nf_from` to the last one added. -Additionally it returns the last computed root of the merkle tree so -that a client updating its tree using the diff can verify the -correctness of the result. - -Client -~~~~~~ - -Wallet -^^^^^^ - -tezos-client supports Sapling keys and can send -shielded transactions to smart contracts. - -The client supports two ways to generate a new Sapling spending key. -It can be generated from a mnemonic using `BIP39 -`_, so -that it can be recovered in case of loss using the mnemonic. -Alternatively it is possible to derive new keys from existing ones -using `ZIP32 -`_, a Sapling -variant of `BIP32 -`_ for -hierarchical deterministic wallets. As usual, in this case it is -important to note the derivation path of the key to be able to recover -it in case of loss. -At the moment there is no hardware wallet support, keys are stored in -`~/.tezos-client/sapling_keys` by default encrypted with a password. -**Users should take care to backup this file.** - -The client can also derive addresses from viewing keys. -By default addresses are generated using an increasing counter called -the address index. Not all indexes corresponds to valid addresses for -each key so it is normal to see an increasing counter that -occasionally skips a few position. - -Because for now the only support for Sapling keys is to interact with -smart contracts, the client binds each newly generated key to a -specific smart contract address. - -Operations -^^^^^^^^^^ - -The client also facilitates the creation of shielded transactions and -their transfer as arguments of smart contracts. -For now there is seamless integration to send transactions to the -reference shielded-tez contract and we are planning to support a -larger class of contracts. - -For the shielded-tez smart contract, the client supports shielding, -unshielding and shielded transactions. -In the case of shielded transactions there are two commands, one to -forge a transaction and save it to file and one to submit it to the -smart contract. -The idea is that a user should not use their own transparent tz{1,2,3} -address to submit a shielded address but rather have a third party -inject it. - -Message argument -^^^^^^^^^^^^^^^^ -Sapling also allows to send an arbitrary encrypted message attached -to an output. -The message size has to be fixed by pool for privacy reasons. -For now it is fixed overall at eight bytes. An incorrect message length -will raise a failure in our client and the protocol will reject the -transaction. Our client adds a default zero's filled message of the -right length. If a message is provided with the --message option, -the client will pad it or truncate it if necessary. A warning message -is printed only if the user's message is truncated. - - -Code base -~~~~~~~~~ - -The current code-base is organized in three main components. -There is a core library called `lib_sapling` which binds `librustzcash`, -adds all the data structures necessary to run the sapling -protocol and includes a simple client and baker. -Under the protocol directory there is a `lib_client_sapling` library -which implements a full client capable of handling Sapling keys and -forging transactions. -Lastly in the protocol there is a efficient implementation of the -Sapling storage, in the spirit of `big_map`s, and the integration of -`SAPLING_VERIFY_UPDATE` in the Michelson interpreter. - -Protocol -^^^^^^^^ - -In order to export the Sapling library to the protocol we first need -to expose it through the environment that sandboxes the protocol. -The changes under `src/lib_protocol_environment` are simple but very -relevant as any change of the environment requires a manual update of the -Tezos node. This changes are part of version V1 of the environment -while protocols 000 to 006 depends on version V0. - -There are two main changes to Tezos' economic protocol, the storage -for Sapling and the addition of `SAPLING_VERIFY_UPDATE` to the Michelson -interpreter. - -Given that the storage of a Sapling contract can be substantially -large, it is important to provide an efficient implementation. -Similarly to what it's done for big_maps, the storage of Sapling can't -be entirely deserialized and modified in memory but only a diff of the -changes is kept by the interpreter and applied at the end of each -smart contract call. - -In the Michelson interpreter two new types are added, `sapling_state` and -`sapling_transaction`, and the instruction `SAPLING_VERIFY_UPDATE`. - -Client -^^^^^^ - -Under `lib_client_sapling` there is the client integration -with the support for Sapling keys and forging of transactions. -The main difference from the existing Tezos client is the need for the -Sapling client to keep an additional state, for each contract. -Because Sapling uses a UTXO model it is necessary for a client to -compute the set of unspent outputs in order to forge new transactions. -Computing this set requires scanning all the state of a contract which -can be expensive. -For this reason the client keeps a local state of the unspent outputs -after the last synchronization and updates it before performing any -Sapling command. -The update is done using the RPCs to recover the new updates since the -last known position. - -The state of all sapling contracts is stored in -`~/.tezos-client/sapling_states`. This file can be regenerated from -the chain in case of loss. However disclosure of this file will reveal -the balance and the unspent outputs of all viewing keys. - -Memo -^^^^^^ - -Sapling offers the possibility to add an arbitrary memo to any -created output. The memo is encrypted and available to anyone -owning the outgoing viewing key or the spending key. -For privacy reasons the size of the memo is fixed per contract -and it is chosen at origination time. -A transaction containing an output with a different memo-size -will be rejected. - -Sandbox tutorial -~~~~~~~~~~~~~~~~ - -As usual it's possible to test the system end-to-end using the -:doc:`../user/sandbox`. -After having set up the sandbox and originated the contract, a good -way to get familiar with the system is to generate keys and then -perform the full cycle of shielding, shielded transfer and -unshielding. - -:: - - # set up the sandbox - ./src/bin_node/tezos-sandboxed-node.sh 1 --connections 0 & - eval `./src/bin_client/tezos-init-sandboxed-client.sh 1` - tezos-activate-alpha - - # originate the contract with its initial empty sapling storage, - # bake a block to include it. - # { } represents an empty Sapling state. - tezos-client originate contract shielded-tez transferring 0 from bootstrap1 \ - running src/proto_009_PsFLoren/lib_protocol/test/contracts/sapling_contract.tz \ - --init '{ }' --burn-cap 3 & - tezos-client bake for bootstrap1 - - # as usual you can check the tezos-client manual - tezos-client sapling man - - # generate two shielded keys for Alice and Bob and use them for the shielded-tez contract - # the memo size has to be indicated - tezos-client sapling gen key alice - tezos-client sapling use key alice for contract shielded-tez --memo-size 8 - tezos-client sapling gen key bob - tezos-client sapling use key bob for contract shielded-tez --memo-size 8 - - # generate an address for Alice to receive shielded tokens. - tezos-client sapling gen address alice - zet1AliceXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX # Alice's address - - - # shield 10 tez from bootstrap1 to alice - tezos-client sapling shield 10 from bootstrap1 to zet1AliceXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX using shielded-tez --burn-cap 2 & - tezos-client bake for bootstrap1 - tezos-client sapling get balance for alice in contract shielded-tez - - # generate an address for Bob to receive shielded tokens. - tezos-client sapling gen address bob - zet1BobXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX # Bob's address - - # forge a shielded transaction from alice to bob that is saved to a file - tezos-client sapling forge transaction 10 from alice to zet1BobXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX using shielded-tez - - # submit the shielded transaction from any transparent account - tezos-client sapling submit sapling_transaction from bootstrap2 using shielded-tez --burn-cap 1 & - tezos-client bake for bootstrap1 - tezos-client sapling get balance for bob in contract shielded-tez - - # unshield from bob to any transparent account - tezos-client sapling unshield 10 from bob to bootstrap1 using shielded-tez --burn-cap 1 - ctrl+z # to put the process in background - tezos-client bake for bootstrap1 - fg # to put resume the transfer diff --git a/docs/009/voting.rst b/docs/009/voting.rst deleted file mode 100644 index 5fbd4b6e407c35c5619ee0cafbf7a630380b0a2a..0000000000000000000000000000000000000000 --- a/docs/009/voting.rst +++ /dev/null @@ -1,218 +0,0 @@ -The Voting Process -================== - -The design of the Tezos Node allows the consensus protocol to be -amended, that is replaced by another set of OCaml files which -implement the API of a valid protocol. - -In the current protocol the amendment procedure is guided by a voting -procedure where delegates can propose, select and test a candidate -protocol before activating it. -Delegates take part in the amendment procedure with an influence -proportional to their stake, one roll one vote. - -The procedure consists of five `voting periods`, each of 20480 blocks -(5 cycles, or ~two weeks), for a total of approximately 2 months and a half. -Voting periods do not align perfectly with cycles, instead start a -level earlier; that is, the first block of a voting period is the last -block of a cycle. - -Other than this page, there is an excellent overview from `Jacob -Arluck on medium. -`_ - -Periods -------- - -The voting procedure works as follows: - -- `Proposal period`: delegates can submit protocol amendment proposals using - the `proposals` operation. At the end of a proposal period, the proposal with - most supporters is selected and we move to a exploration period. - If there are no proposals, or a tie between proposals, a new proposal - period starts. Each delegate can submit a maximum of 20 proposals, - including duplicates. -- `Exploration period`: delegates can cast one vote to pursue the - voting process or not with the winning proposal using the `ballot` - operation. At the end of a exploration period if participation - reaches the quorum and the proposal has a super-majority in favor, - we proceed to a cooldown period. Otherwise we go back to a proposal - period. -- `Cooldown period`: The only purpose of this period is to let some - time elapse before the promotion period. -- `Promotion period`: delegates can cast one vote to promote or not - the proposal using the `ballot` operation. At the end of a - promotion period if participation reaches the quorum and the - proposal has a super-majority in favor, we proceed to adoption - period. Otherwise we go back to a proposal period. -- `Adoption period`: at the end of the period the proposal is activated - as the new protocol and we go back to a proposal period. - -It is important to note -that the stake of each delegate is computed at the beginning of each voting -period, and if the delegate owns one roll or more, its stake in number of rolls is -stored in a list called the `voting listings`. - -Following the adoption period the protocol is activated. After this step the -blocks added to the chain are interpreted in the newly activated protocol. As a -result gas costs (and other such details of operation inclusion) may differ. - - -The Hash and the Protocol -------------------------- - -Note that the voting procedure revolves around the hash of a protocol proposal -whilst the activation revolves around the protocol itself. Consequently, if the -protocol that the hash identifies is invalid, the activation step fails. - -A protocol is invalid if the code cannot be compiled (e.g., if the code is not -valid source code), if the code uses functions not present in the -:ref:`protocol environment `, or if it downgrades the -:ref:`protocol environment ` version. - -If the protocol is invalid and the activation fails, the chain becomes stuck. -Thus, when voting, it is important to vote for hashes that designate a protocol -with sources that are available and valid. - - -Super-majority and Quorum -------------------------- - -Both voting periods work in the same way, only the subject of the -vote differs. -During a vote a delegate can cast a single Yea, Nay or Pass vote. -A vote is successful if it has super-majority and the participation -reaches the current quorum. - -`Super-majority` means the Yeas are more than 8/10 of Yeas+Nays votes. -The `participation` is the ratio of all received votes, including -passes, with respect to the number of possible votes. The `quorum` -starts at 80% and at each vote it is updated using the old quorum and -the current participation with the following coefficients:: - - newQ = oldQ * 8/10 + participation * 2/10 - -More details can be found in the file -:src:`src/proto_009_PsFLoren/lib_protocol/amendment.ml`. - -Operations ----------- - -There are two operations used by the delegates: ``proposals`` and ``ballot``. -A proposal operation can only be submitted during a proposal period. - -:: - - Proposals : { - source: Signature.Public_key_hash.t ; - period: Voting_period_repr.t ; - proposals: Protocol_hash.t list ; } - -Source is the public key hash of the delegate, period is the unique -identifier of each voting period and proposals is a non-empty list of -maximum 20 protocol hashes. -The operation can be submitted more than once but only as long as the -cumulative length of the proposals lists is less than 20. -Duplicate proposals from the same delegate are accounted for in the -maximum number of proposals for that delegate. -However duplicates from the same delegate are not tallied at the end -of the proposal period. - -For example, a delegate submits a ``proposals`` operation for protocols A -and B early in the proposal period, later a new protocol C is revealed -and the delegate submits another ``proposals`` operation for protocols B -and C. -The list of submissions that will be tallied is [A,B,C]. - -A ballot operation can only be submitted during one of the voting -periods, and only once per period. - -:: - - Ballot : { - source: Signature.Public_key_hash.t ; - period: Voting_period_repr.t ; - proposal: Protocol_hash.t ; - ballot: Vote_repr.ballot ; } - -Source and period are the same as above, while proposal is the -currently selected proposal and ballot is one of ``Yea``, ``Nay`` or -``Pass``. -The pass vote allows a delegate to not influence a vote but still -allowing it to reach quorum. - -More details can be found, as for all operations, in -:src:`src/proto_009_PsFLoren/lib_protocol/operation_repr.ml`. -The binary format is described by ``tezos-client describe unsigned -operation``. - -Client Commands ---------------- - -Tezos' client provides a command to show the status of a voting period. -It displays different informations for different kind of periods, as -in the following samples:: - - $ tezos-client show voting period - Current period: "proposal" - Blocks remaining until end of period: 59 - Current proposals: - PsNa6jTtsRfbGaNSoYXNTNM5A7c3Lji22Yf2ZhpFUjQFC17iZVp 400 - - $ tezos-client show voting period - Current period: "exploration" - Blocks remaining until end of period: 63 - Current proposal: PsNa6jTtsRfbGaNSoYXNTNM5A7c3Lji22Yf2ZhpFUjQFC17iZVp - Ballots: { "yay": 400, "nay": 0, "pass": 0 } - Current participation 20.00%, necessary quorum 80.00% - Current in favor 400, needed supermajority 320 - - $ tezos-client show voting period - Current period: "cooldown" - Blocks remaining until end of period: 64 - Current proposal: PsNa6jTtsRfbGaNSoYXNTNM5A7c3Lji22Yf2ZhpFUjQFC17iZVp - -It should be noted that the number 400 above is a number of rolls. -The proposal has a total of 400 rolls, which may come from several -delegates. The same applies for the ballots, there are 400 rolls in -favor of testing protocol PsNa6jTt. - -Submit proposals -~~~~~~~~~~~~~~~~ - -During a proposal period, the list of proposals can be submitted with:: - - tezos-client submit proposals for ... - -Remember that each delegate can submit a maximum of 20 protocol -hashes including duplicates. -Moreover each proposal is accepted only if it meets one of the -following two conditions: - -- the protocol hash was already proposed on the network. In this case - we can submit an additional proposal that "upvotes" an existing one - and our rolls are added to the ones already supporting the proposal. -- the protocol is known by the node. In particular the first proposer - of a protocol should be able to successfully inject the protocol in - its node which performs some checks, compiles and loads the - protocol. - -Submit ballots -~~~~~~~~~~~~~~ - -During a voting period, being it an exploration or a promotion period, -ballots can be submitted once with:: - - tezos-client submit ballot for - -Other resources -~~~~~~~~~~~~~~~ - -For more details on the client commands refer to the manual at -:ref:`client_manual_009`. - -For vote related RPCs check the :doc:`rpc` under the prefix -``votes/``. - -For Ledger support refer to Obsidian Systems' `documentation -`_. diff --git a/docs/010/cli-commands.rst b/docs/010/cli-commands.rst index 132ee0ad7af01462746ff2b6568c1659a0d63ec2..9c475a27d9120ff9213e6d17e943bb9973fe38aa 100644 --- a/docs/010/cli-commands.rst +++ b/docs/010/cli-commands.rst @@ -14,6 +14,7 @@ The rest of this page documents the protocol-dependent tools. The protocol-independent tools are documented :doc:`here <../shell/cli-commands>`. +.. _client_manual: .. _client_manual_010: Client manual @@ -23,6 +24,7 @@ Client manual :file: tezos-client.html +.. _baker_manual: .. _baker_manual_010: Baker manual @@ -32,6 +34,7 @@ Baker manual :file: tezos-baker.html +.. _endorser_manual: .. _endorser_manual_010: Endorser manual @@ -41,6 +44,7 @@ Endorser manual :file: tezos-endorser.html +.. _accuser_manual: .. _accuser_manual_010: Accuser manual diff --git a/docs/010/consensus.rst b/docs/010/consensus.rst index 5126b671401d4b680ef72d5d661ebcac017be581..a04c569af876bfb8ef916d3525b59c9dff7b6790 100644 --- a/docs/010/consensus.rst +++ b/docs/010/consensus.rst @@ -35,6 +35,7 @@ Emmy* improves Emmy+ in that it brings smaller block times and faster times to finality. +.. _terminology: .. _terminology_010: Terminology @@ -72,6 +73,7 @@ serves to compute the minimal time between blocks depending on the current block's priority `p`, and its endorsing power `e`. Namely, Emmy* defines the minimal block delay function as follows: +.. _delaystar: .. _delaystar_010: .. math:: @@ -144,6 +146,7 @@ attributes). A delegate plays two roles: a block by **endorsing** that block. +.. _emmyp_slot_selection: .. _emmyp_slot_selection_010: To these roles correspond the two types of actions mentioned above, baking and @@ -153,6 +156,7 @@ given by its baking, respectively endorsing slots, whose selection is described if the delegate whose turn is to bake is for some reason unable to bake, the next delegate in the list can step up and bake the block. +.. _emmyp_fitness_and_header: .. _emmyp_fitness_and_header_010: There are two more notions which are defined abstractly at the level of the @@ -265,6 +269,7 @@ incident. Pragmatically, any baker who either double bakes or endorses in a given cycle should immediately stop both baking and endorsing for the rest of that cycle. +.. _cs_constants: .. _cs_constants_010: Consensus protocol parameters diff --git a/docs/010/glossary.rst b/docs/010/glossary.rst index 5405ce863276121783b3b3646d8ad93ca82473f8..ba477167dea6510e437886ea6661f05842650ff3 100644 --- a/docs/010/glossary.rst +++ b/docs/010/glossary.rst @@ -128,6 +128,7 @@ _`Implicit account` letters `tz` followed by `1`, `2` or `3` (depending on the signature scheme) and finally the hash of the public key. +.. _glossary_michelson: .. _glossary_michelson_010: Michelson diff --git a/docs/010/michelson.rst b/docs/010/michelson.rst index 62465e054d71ab3e43680c8af18a073a9c930d09..397ebd68c2dabc309211e01b8e29d3b0397205b4 100644 --- a/docs/010/michelson.rst +++ b/docs/010/michelson.rst @@ -303,6 +303,9 @@ The concrete language also has some syntax sugar to group some common sequences of operations as one. This is described in this specification using a simple regular expression style recursive instruction rewriting. +.. _michelson_type_system: +.. _michelson_type_system_010: + Introduction to the type system and notations --------------------------------------------- @@ -1485,6 +1488,7 @@ value that was previously stored in the ``map`` at the same key as Operations on ``big_maps`` ~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. _OperationsOnBigMaps: .. _OperationsOnBigMaps_010: Big maps have three possible representations. A map literal is always @@ -1862,6 +1866,7 @@ until it is actually originated. The parameter must be consistent with the one expected by the contract, unit for an account. +.. _MichelsonSetDelegate: .. _MichelsonSetDelegate_010: - ``SET_DELEGATE``: Set or withdraw the contract's delegation. @@ -2229,6 +2234,7 @@ comprehensive description of the Sapling protocol. with memo_size `ms` +.. _MichelsonTickets: .. _MichelsonTickets_010: Operations on tickets @@ -2548,6 +2554,7 @@ A typing rule can be inferred: Concrete syntax --------------- +.. _ConcreteSyntax: .. _ConcreteSyntax_010: The concrete language is very close to the formal notation of the @@ -3093,6 +3100,7 @@ type (which can be changed). For instance the annotated typing rule for Special annotations ~~~~~~~~~~~~~~~~~~~ +.. _SpecialAnnotations: .. _SpecialAnnotations_010: The special variable annotations ``@%`` and ``@%%`` can be used on instructions diff --git a/docs/010/proof_of_stake.rst b/docs/010/proof_of_stake.rst index 0170ce861dca2359b05cc18cfc962e85fc7cb85a..81986eca28fe696b7de68bd563925e80e989a1b7 100644 --- a/docs/010/proof_of_stake.rst +++ b/docs/010/proof_of_stake.rst @@ -50,6 +50,7 @@ from the delegates' own balance. Therefore delegates may be subject to Active and passive delegates ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. _active_delegate: .. _active_delegate_010: A delegate can be marked as either active or passive. A passive @@ -71,6 +72,7 @@ track the specific tokens assigned to specific delegates. However, it would be too demanding of nodes to track assignments at such a granular level. Instead, Tezos works with *sets of tokens* which are called *rolls*. +.. _roll_pos: .. _roll_pos_010: Rolls @@ -100,6 +102,7 @@ The advantage of tracking tokens in this way is that a delegate creating a malicious fork cannot easily change the specific rolls assigned to them, even if they control the underlying tokens and shuffle them around. +.. _random_seed: .. _random_seed_010: Random seed @@ -125,6 +128,7 @@ wallet activations and denunciations can be contained in any given block. The seed for cycle ``n`` is obtained as follows: the seed of cycle ``n-1`` is hashed with a constant and then with each nonce revealed in cycle ``n-1``. +.. _rights: .. _rights_010: Slot selection @@ -150,6 +154,7 @@ The seed of the PRNG is the :ref:`random seed ` associated with The PRNG first selects a snapshot from cycle ``n-PRESERVED_CYCLES-2`` and then it selects a roll in the selected snapshot. The slot owner is then the roll owner. +.. _protocol_constants: .. _protocol_constants_010: Protocol constants @@ -164,6 +169,7 @@ The values of protocol constants can be found using a :ref:`specific RPC call 010/tezos-baker.html @../tezos-endorser-$(GRANADA_SHORT) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > 010/tezos-endorser.html @../tezos-accuser-$(GRANADA_SHORT) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > 010/tezos-accuser.html - # active (Florence) protocol + # active (granada) protocol @../tezos-client -protocol $(ACTIVE_LONG) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > active/tezos-client.html @../tezos-baker-$(ACTIVE_SHORT) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > active/tezos-baker.html @../tezos-endorser-$(ACTIVE_SHORT) man -verbosity 3 -format html | sed "s#${HOME}#\$$HOME#g" > active/tezos-endorser.html @@ -69,16 +67,18 @@ linkcheck: redirectcheck: @cd $$(pwd)/.. ; ./src/tooling/lint.sh --check-redirects +# xrefs should be checked: +# - on the active protocol using its numeric name (not the "active" symlink) +# - on each other protocol including alpha, also checking label defs (option -l) xrefscheck: - $(CHECKXREFS) active - $(CHECKXREFS) -l 010 + $(CHECKXREFS) 010 $(CHECKXREFS) -l alpha scriptsindoccheck: introduction/test_howtoget.sh install-bin-bionic introduction/test_howtoget.sh install-bin-focal - introduction/test_howtoget.sh install-bin-fedora31 - introduction/test_howtoget.sh install-bin-fedora32 + introduction/test_howtoget.sh install-bin-fedora33 + introduction/test_howtoget.sh install-bin-fedora34 introduction/test_howtoget.sh install-opam-scratch introduction/test_howtoget.sh install-opam-bionic introduction/test_howtoget.sh install-opam-focal @@ -101,7 +101,6 @@ $(DOCGENDIR)/rpc_doc.exe: rpc: $(DOCGENDIR)/rpc_doc.exe @dune exec $(DOCGENDIR)/rpc_doc.exe index "" > active/rpc.rst - @dune exec $(DOCGENDIR)/rpc_doc.exe index 010 > 010/rpc.rst @dune exec $(DOCGENDIR)/rpc_doc.exe index alpha > alpha/rpc.rst @dune exec $(DOCGENDIR)/rpc_doc.exe index shell > shell/rpc.rst @dune exec $(DOCGENDIR)/rpc_doc.exe acl > user/default-acl.json diff --git a/docs/active b/docs/active index ce442a90f937ce6a6795ff0ef0de39ac0e74c0a3..fc06c8b868b8cc0d7990ebd88d527a6c6de87150 120000 --- a/docs/active +++ b/docs/active @@ -1 +1 @@ -009 \ No newline at end of file +010 \ No newline at end of file diff --git a/docs/alpha/michelson.rst b/docs/alpha/michelson.rst index e6a96c8de3fdeb1c48c49f5f8205289c5947a965..9ab1a1d19b91f77b09455265a36c41c49d0a17eb 100644 --- a/docs/alpha/michelson.rst +++ b/docs/alpha/michelson.rst @@ -303,7 +303,7 @@ The concrete language also has some syntax sugar to group some common sequences of operations as one. This is described in this specification using a simple regular expression style recursive instruction rewriting. -.. _michelson_type_system: +.. _michelson_type_system_alpha: Introduction to the type system and notations --------------------------------------------- diff --git a/docs/api/florence-mempool-openapi.json b/docs/api/florence-mempool-openapi.json deleted file mode 100644 index 51302fa34fa6897fef00f392096353c12559be6d..0000000000000000000000000000000000000000 --- a/docs/api/florence-mempool-openapi.json +++ /dev/null @@ -1,256 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Tezos RPC", - "description": "Tezos client RPC API.", - "version": "10.1" - }, - "paths": { - "/pending_operations": { - "get": { - "description": "List the prevalidated operations.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "applied": { - "type": "array", - "items": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - } - }, - "required": [ - "hash", - "branch" - ] - } - }, - "refused": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Operation_hash" - }, - { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i" - ] - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "protocol", - "branch", - "error" - ] - } - ] - } - } - }, - "branch_refused": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Operation_hash" - }, - { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i" - ] - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "protocol", - "branch", - "error" - ] - } - ] - } - } - }, - "branch_delayed": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Operation_hash" - }, - { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i" - ] - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "protocol", - "branch", - "error" - ] - } - ] - } - } - }, - "unprocessed": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Operation_hash" - }, - { - "$ref": "#/components/schemas/next_operation" - } - ] - } - } - } - }, - "required": [ - "applied", - "refused", - "branch_refused", - "branch_delayed", - "unprocessed" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Operation_hash": { - "title": "A Tezos operation ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "block_hash": { - "title": "A block identifier (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "error": { - "description": "The full list of error is available with the global RPC `GET errors`" - }, - "next_operation": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PrihK96nBAFSxVL1GLJTVhu9YnzkMFiBeuJRPA8NwuZVZCE1L6i" - ] - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - } - }, - "required": [ - "protocol", - "branch" - ] - }, - "unistring": { - "title": "Universal string representation", - "description": "Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "invalid_utf8_string": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 255 - } - } - }, - "required": [ - "invalid_utf8_string" - ] - } - ] - } - } - } -} diff --git a/docs/api/florence-openapi.json b/docs/api/florence-openapi.json deleted file mode 100644 index 945de97f44ea99cd3eaff3b594f7b8128b7b383a..0000000000000000000000000000000000000000 --- a/docs/api/florence-openapi.json +++ /dev/null @@ -1,16771 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Tezos RPC", - "description": "Tezos client RPC API.", - "version": "10.1" - }, - "paths": { - "/": { - "get": { - "description": "All the information about a block. The associated metadata may not be present depending on the history mode and block's distance from the head.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "hash": { - "$ref": "#/components/schemas/block_hash" - }, - "header": { - "$ref": "#/components/schemas/raw_block_header" - }, - "metadata": { - "$ref": "#/components/schemas/block_header_metadata" - }, - "operations": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operation" - } - } - } - }, - "required": [ - "protocol", - "chain_id", - "hash", - "header", - "operations" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/big_maps/{big_map_id}/{script_expr}": { - "get": { - "description": "Access the value associated with a key in a big map.", - "parameters": [ - { - "name": "big_map_id", - "in": "path", - "description": "A big map identifier", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "script_expr", - "in": "path", - "description": "script_expr (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/big_maps/{big_map_id}/{script_expr}/normalized": { - "post": { - "description": "Access the value associated with a key in a big map, normalize the output using the requested unparsing mode.", - "parameters": [ - { - "name": "big_map_id", - "in": "path", - "description": "A big map identifier", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "script_expr", - "in": "path", - "description": "script_expr (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/constants": { - "get": { - "description": "All constants", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "proof_of_work_nonce_size": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "nonce_length": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "max_anon_ops_per_block": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "max_operation_data_length": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "max_proposals_per_delegate": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "preserved_cycles": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "blocks_per_cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "blocks_per_commitment": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "blocks_per_roll_snapshot": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "blocks_per_voting_period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "time_between_blocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/int64" - } - }, - "endorsers_per_block": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "hard_gas_limit_per_operation": { - "$ref": "#/components/schemas/bignum" - }, - "hard_gas_limit_per_block": { - "$ref": "#/components/schemas/bignum" - }, - "proof_of_work_threshold": { - "$ref": "#/components/schemas/int64" - }, - "tokens_per_roll": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "michelson_maximum_type_size": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "seed_nonce_revelation_tip": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "origination_size": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "block_security_deposit": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "endorsement_security_deposit": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "baking_reward_per_endorsement": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - }, - "endorsement_reward": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - }, - "cost_per_byte": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "hard_storage_limit_per_operation": { - "$ref": "#/components/schemas/bignum" - }, - "test_chain_duration": { - "$ref": "#/components/schemas/int64" - }, - "quorum_min": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "quorum_max": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "min_proposal_quorum": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "initial_endorsers": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "delay_per_missing_endorsement": { - "$ref": "#/components/schemas/int64" - } - }, - "required": [ - "proof_of_work_nonce_size", - "nonce_length", - "max_anon_ops_per_block", - "max_operation_data_length", - "max_proposals_per_delegate", - "preserved_cycles", - "blocks_per_cycle", - "blocks_per_commitment", - "blocks_per_roll_snapshot", - "blocks_per_voting_period", - "time_between_blocks", - "endorsers_per_block", - "hard_gas_limit_per_operation", - "hard_gas_limit_per_block", - "proof_of_work_threshold", - "tokens_per_roll", - "michelson_maximum_type_size", - "seed_nonce_revelation_tip", - "origination_size", - "block_security_deposit", - "endorsement_security_deposit", - "baking_reward_per_endorsement", - "endorsement_reward", - "cost_per_byte", - "hard_storage_limit_per_operation", - "test_chain_duration", - "quorum_min", - "quorum_max", - "min_proposal_quorum", - "initial_endorsers", - "delay_per_missing_endorsement" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/constants/errors": { - "get": { - "description": "Schema for all the RPC errors from this protocol version", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": {} - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts": { - "get": { - "description": "All existing contracts (including non-empty default contracts).", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}": { - "get": { - "description": "Access the complete status of a contract.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "script": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - } - }, - "required": [ - "balance" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/balance": { - "get": { - "description": "Access the balance of a contract.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/big_map_get": { - "post": { - "description": "Access the value associated with a key in a big map of the contract (deprecated).", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "key", - "type" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/counter": { - "get": { - "description": "Access the counter of a contract, if any.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/bignum" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/delegate": { - "get": { - "description": "Access the delegate of a contract, if any.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/entrypoints": { - "get": { - "description": "Return the list of entrypoints of the contract", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "unreachable": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - } - } - }, - "required": [ - "path" - ] - } - }, - "entrypoints": { - "type": "object", - "properties": {}, - "additionalProperties": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - }, - "required": [ - "entrypoints" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/entrypoints/{string}": { - "get": { - "description": "Return the type of the given entrypoint of the contract", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "string", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/manager_key": { - "get": { - "description": "Access the manager of a contract.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "oneOf": [ - { - "$ref": "#/components/schemas/Signature.Public_key" - } - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/script": { - "get": { - "description": "Access the code and data of the contract.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/script/normalized": { - "post": { - "description": "Access the script of the contract and normalize it using the requested unparsing mode.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "oneOf": [ - { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - } - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/single_sapling_get_diff": { - "get": { - "description": "Returns the root and a diff of a state starting from an optional offset which is zero by default.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "offset_commitment", - "in": "query", - "description": "Commitments and ciphertexts are returned from the specified offset up to the most recent.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "offset_nullifier", - "in": "query", - "description": "Nullifiers are returned from the specified offset up to the most recent.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "root": { - "$ref": "#/components/schemas/sapling.transaction.commitment_hash" - }, - "commitments_and_ciphertexts": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/sapling.transaction.commitment" - }, - { - "$ref": "#/components/schemas/sapling.transaction.ciphertext" - } - ] - } - } - }, - "nullifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/sapling.transaction.nullifier" - } - } - }, - "required": [ - "root", - "commitments_and_ciphertexts", - "nullifiers" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/storage": { - "get": { - "description": "Access the data of the contract.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/contracts/{contract_id}/storage/normalized": { - "post": { - "description": "Access the data of the contract and normalize it using the requested unparsing mode.", - "parameters": [ - { - "name": "contract_id", - "in": "path", - "description": "A contract identifier encoded in b58check.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates": { - "get": { - "description": "Lists all registered delegates.", - "parameters": [ - { - "name": "active", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "inactive", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}": { - "get": { - "description": "Everything about a delegate.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "frozen_balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "frozen_balance_by_cycle": { - "type": "array", - "items": { - "type": "object", - "properties": { - "cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "deposit": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "fees": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "rewards": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - }, - "required": [ - "cycle", - "deposit", - "fees", - "rewards" - ] - } - }, - "staking_balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegated_contracts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - }, - "delegated_balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "deactivated": { - "type": "boolean" - }, - "grace_period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "voting_power": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "balance", - "frozen_balance", - "frozen_balance_by_cycle", - "staking_balance", - "delegated_contracts", - "delegated_balance", - "deactivated", - "grace_period", - "voting_power" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/balance": { - "get": { - "description": "Returns the full balance of a given delegate, including the frozen balances.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/deactivated": { - "get": { - "description": "Tells whether the delegate is currently tagged as deactivated or not.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "boolean" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/delegated_balance": { - "get": { - "description": "Returns the balances of all the contracts that delegate to a given delegate. This excludes the delegate's own balance and its frozen balances.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/delegated_contracts": { - "get": { - "description": "Returns the list of contracts that delegate to a given delegate.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/frozen_balance": { - "get": { - "description": "Returns the total frozen balances of a given delegate, this includes the frozen deposits, rewards and fees.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/frozen_balance_by_cycle": { - "get": { - "description": "Returns the frozen balances of a given delegate, indexed by the cycle by which it will be unfrozen", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "deposit": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "fees": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "rewards": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - }, - "required": [ - "cycle", - "deposit", - "fees", - "rewards" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/grace_period": { - "get": { - "description": "Returns the cycle by the end of which the delegate might be deactivated if she fails to execute any delegate action. A deactivated delegate might be reactivated (without loosing any rolls) by simply re-registering as a delegate. For deactivated delegates, this value contains the cycle by which they were deactivated.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/staking_balance": { - "get": { - "description": "Returns the total amount of tokens delegated to a given delegate. This includes the balances of all the contracts that delegate to it, but also the balance of the delegate itself and its frozen fees and deposits. The rewards do not count in the delegated balance until they are unfrozen.", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/delegates/{pkh}/voting_power": { - "get": { - "description": "The number of rolls in the vote listings for a given delegate", - "parameters": [ - { - "name": "pkh", - "in": "path", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/merkle_tree": { - "get": { - "description": "Returns the merkle tree of a piece of context.", - "parameters": [ - { - "name": "holey", - "in": "query", - "description": "Send only hashes, omit data of key", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - }, - { - "oneOf": [ - { - "title": "Hash", - "type": "array", - "items": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/unistring" - } - ] - } - }, - { - "title": "Data", - "nullable": true, - "oneOf": [ - { - "title": "Key", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - { - "title": "Dir", - "type": "object", - "properties": {}, - "additionalProperties": { - "$ref": "#/components/schemas/raw_context" - } - } - ] - }, - { - "title": "Continue", - "oneOf": [ - { - "$ref": "#/components/schemas/merkle_tree" - } - ] - } - ] - } - ] - } - } - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/nonces/{block_level}": { - "get": { - "description": "Info about the nonce of a previous block.", - "parameters": [ - { - "name": "block_level", - "in": "path", - "description": "A level integer", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Revealed", - "type": "object", - "properties": { - "nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "nonce" - ] - }, - { - "title": "Missing", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/cycle_nonce" - } - }, - "required": [ - "hash" - ] - }, - { - "title": "Forgotten", - "type": "object", - "properties": {} - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/raw/bytes": { - "get": { - "description": "Returns the raw context.", - "parameters": [ - { - "name": "depth", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Key", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - { - "title": "Dir", - "type": "object", - "properties": {}, - "additionalProperties": { - "$ref": "#/components/schemas/raw_context" - } - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/sapling/{sapling_state_id}/get_diff": { - "get": { - "description": "Returns the root and a diff of a state starting from an optional offset which is zero by default.", - "parameters": [ - { - "name": "sapling_state_id", - "in": "path", - "description": "A sapling state identifier", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "offset_commitment", - "in": "query", - "description": "Commitments and ciphertexts are returned from the specified offset up to the most recent.", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "offset_nullifier", - "in": "query", - "description": "Nullifiers are returned from the specified offset up to the most recent.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "root": { - "$ref": "#/components/schemas/sapling.transaction.commitment_hash" - }, - "commitments_and_ciphertexts": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/sapling.transaction.commitment" - }, - { - "$ref": "#/components/schemas/sapling.transaction.ciphertext" - } - ] - } - } - }, - "nullifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/sapling.transaction.nullifier" - } - } - }, - "required": [ - "root", - "commitments_and_ciphertexts", - "nullifiers" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/context/seed": { - "post": { - "description": "Seed of the cycle to which the block belongs.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/endorsing_power": { - "post": { - "description": "Get the endorsing power of an endorsement, that is, the number of slots that the endorser has", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "endorsement_operation": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "branch", - "contents", - "signature" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - } - }, - "required": [ - "endorsement_operation", - "chain_id" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/hash": { - "get": { - "description": "The block's hash, its unique identifier.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/header": { - "get": { - "description": "The whole block header.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_header" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/header/protocol_data": { - "get": { - "description": "The version-specific fragment of the block header.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "content": { - "oneOf": [ - { - "title": "Activate", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters" - ] - }, - { - "title": "Activate_testchain", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate_testchain" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "validity_time": { - "$ref": "#/components/schemas/int64" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters", - "validity_time" - ] - } - ] - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "protocol", - "content", - "signature" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/header/protocol_data/raw": { - "get": { - "description": "The version-specific fragment of the block header (unparsed).", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/header/raw": { - "get": { - "description": "The whole block header (unparsed).", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/header/shell": { - "get": { - "description": "The shell-specific fragment of the block header.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_header.shell" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/baking_rights": { - "get": { - "description": "Retrieves the list of delegates allowed to bake a block.\nBy default, it gives the best baking priorities for bakers that have at least one opportunity below the 64th priority for the next block.\nParameters `level` and `cycle` can be used to specify the (valid) level(s) in the past or future at which the baking rights have to be returned. When asked for (a) whole cycle(s), baking opportunities are given by default up to the priority 8.\nParameter `delegate` can be used to restrict the results to the given delegates. If parameter `all` is set, all the baking opportunities for each baker at each level are returned, instead of just the first one.\nReturns the list of baking slots. Also returns the minimal timestamps that correspond to these slots. The timestamps are omitted for levels in the past, and are only estimates for levels later that the next block, based on the hypothesis that all predecessor blocks were baked at the first priority.", - "parameters": [ - { - "name": "level", - "in": "query", - "description": "A level integer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cycle", - "in": "query", - "description": "A cycle integer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "delegate", - "in": "query", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "max_priority", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "all", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "priority": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "estimated_time": { - "$ref": "#/components/schemas/timestamp.protocol" - } - }, - "required": [ - "level", - "delegate", - "priority" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/complete/{prefix}": { - "get": { - "description": "Try to complete a prefix of a Base58Check-encoded data. This RPC is actually able to complete hashes of block, operations, public_keys and contracts.", - "parameters": [ - { - "name": "prefix", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/unistring" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/current_level": { - "get": { - "description": "Returns the level of the interrogated block, or the one of a block located `offset` blocks after in the chain (or before when negative). For instance, the next block if `offset` is 1.", - "parameters": [ - { - "name": "offset", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "level": { - "description": "The level of the block relative to genesis. This is also the Shell's notion of level", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "level_position": { - "description": "The level of the block relative to the block that starts protocol alpha. This is specific to the protocol alpha. Other protocols might or might not include a similar notion.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "cycle": { - "description": "The current cycle's number. Note that cycles are a protocol-specific notion. As a result, the cycle number starts at 0 with the first block of protocol alpha.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "cycle_position": { - "description": "The current level of the block relative to the first block of the current cycle.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "voting_period": { - "description": "The current voting period's index. Note that cycles are a protocol-specific notion. As a result, the voting period index starts at 0 with the first block of protocol alpha. This field is DEPRECATED: use `../votes/voting_period` RPC instead.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "voting_period_position": { - "description": "The current level of the block relative to the first block of the current voting period. This field is DEPRECATED: use `../votes/voting_period` RPC instead.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "expected_commitment": { - "description": "Tells wether the baker of this block has to commit a seed nonce hash.", - "type": "boolean" - } - }, - "required": [ - "level", - "level_position", - "cycle", - "cycle_position", - "voting_period", - "voting_period_position", - "expected_commitment" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/endorsing_rights": { - "get": { - "description": "Retrieves the delegates allowed to endorse a block.\nBy default, it gives the endorsement slots for delegates that have at least one in the next block.\nParameters `level` and `cycle` can be used to specify the (valid) level(s) in the past or future at which the endorsement rights have to be returned. Parameter `delegate` can be used to restrict the results to the given delegates.\nReturns the list of endorsement slots. Also returns the minimal timestamps that correspond to these slots. The timestamps are omitted for levels in the past, and are only estimates for levels later that the next block, based on the hypothesis that all predecessor blocks were baked at the first priority.", - "parameters": [ - { - "name": "level", - "in": "query", - "description": "A level integer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "cycle", - "in": "query", - "description": "A cycle integer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "delegate", - "in": "query", - "description": "A Secp256k1 of a Ed25519 public key hash (Base58Check-encoded)", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "slots": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - }, - "estimated_time": { - "$ref": "#/components/schemas/timestamp.protocol" - } - }, - "required": [ - "level", - "delegate", - "slots" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/forge/operations": { - "post": { - "description": "Forge an operation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.unsigned_operation" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/forge/protocol_data": { - "post": { - "description": "Forge the protocol-specific part of a block header", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "nonce_hash": { - "$ref": "#/components/schemas/cycle_nonce" - }, - "proof_of_work_nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "priority" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "protocol_data": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "protocol_data" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/forge_block_header": { - "post": { - "description": "Forge a block header", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_header" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "block": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "block" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/levels_in_current_cycle": { - "get": { - "description": "Levels of a cycle", - "parameters": [ - { - "name": "offset", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "first": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "last": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "first", - "last" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/parse/block": { - "post": { - "description": "Parse a block", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_header" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.block_header.alpha.signed_contents" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/parse/operations": { - "post": { - "description": "Parse operations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operation" - } - }, - "check_signature": { - "type": "boolean" - } - }, - "required": [ - "operations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "branch", - "contents", - "signature" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/preapply/block": { - "post": { - "description": "Simulate the validation of a block that would contain the given operations and return the resulting fitness and context hash.", - "parameters": [ - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp", - "in": "query", - "description": "A date in seconds from epoch", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "protocol_data": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PsFLorenaUUuikDWvMDr6fGBRG8kt3e3D3fHoXK1j1BFRxeSH4i" - ] - }, - "priority": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "proof_of_work_nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "seed_nonce_hash": { - "$ref": "#/components/schemas/cycle_nonce" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "protocol", - "priority", - "proof_of_work_nonce", - "signature" - ] - }, - "operations": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/next_operation" - } - } - } - }, - "required": [ - "protocol_data", - "operations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "shell_header": { - "$ref": "#/components/schemas/block_header.shell" - }, - "operations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "applied": { - "type": "array", - "items": { - "description": "An operation. The shell_header part indicates a block an operation is meant to apply on top of. The proto part is protocol-specific and appears as a binary blob.", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "data": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "hash", - "branch", - "data" - ] - } - }, - "refused": { - "type": "array", - "items": { - "description": "An operation. The shell_header part indicates a block an operation is meant to apply on top of. The proto part is protocol-specific and appears as a binary blob.", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "data": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "hash", - "branch", - "data", - "error" - ] - } - }, - "branch_refused": { - "type": "array", - "items": { - "description": "An operation. The shell_header part indicates a block an operation is meant to apply on top of. The proto part is protocol-specific and appears as a binary blob.", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "data": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "hash", - "branch", - "data", - "error" - ] - } - }, - "branch_delayed": { - "type": "array", - "items": { - "description": "An operation. The shell_header part indicates a block an operation is meant to apply on top of. The proto part is protocol-specific and appears as a binary blob.", - "type": "object", - "properties": { - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "data": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "error": { - "$ref": "#/components/schemas/error" - } - }, - "required": [ - "hash", - "branch", - "data", - "error" - ] - } - } - }, - "required": [ - "applied", - "refused", - "branch_refused", - "branch_delayed" - ] - } - } - }, - "required": [ - "shell_header", - "operations" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/preapply/operations": { - "post": { - "description": "Simulate the validation of an operation.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/next_operation" - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_with_metadata" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/entrypoint": { - "post": { - "description": "Return the type of the given entrypoint", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "script" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "entrypoint_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "entrypoint_type" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/entrypoints": { - "post": { - "description": "Return the list of entrypoints of the given script", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "script" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "unreachable": { - "type": "array", - "items": { - "type": "object", - "properties": { - "path": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - } - } - }, - "required": [ - "path" - ] - } - }, - "entrypoints": { - "type": "object", - "properties": {}, - "additionalProperties": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - } - }, - "required": [ - "entrypoints" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/normalize_data": { - "post": { - "description": "Normalizes some data expression using the requested unparsing mode", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - }, - "legacy": { - "type": "boolean" - } - }, - "required": [ - "data", - "type", - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "normalized": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "normalized" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/normalize_script": { - "post": { - "description": "Normalizes a Michelson script using the requested unparsing mode", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "script", - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "normalized": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "normalized" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/normalize_type": { - "post": { - "description": "Normalizes some Michelson type by expanding `pair a b c` as `pair a (pair b c)", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "type" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "normalized": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "normalized" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/pack_data": { - "post": { - "description": "Computes the serialized version of some data expression using the same algorithm as script instruction PACK", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "gas": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "data", - "type" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "packed": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "gas": { - "oneOf": [ - { - "title": "Limited", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - { - "title": "Unaccounted", - "type": "string", - "enum": [ - "unaccounted" - ] - } - ] - } - }, - "required": [ - "packed", - "gas" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/run_code": { - "post": { - "description": "Run a piece of code in the current context", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "input": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "payer": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "script", - "storage", - "input", - "amount", - "balance", - "chain_id" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation" - } - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "storage", - "operations" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/run_code/normalized": { - "post": { - "description": "Run a piece of code in the current context, normalize the output using the requested unparsing mode.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "input": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "payer": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "script", - "storage", - "input", - "amount", - "balance", - "chain_id", - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation" - } - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "storage", - "operations" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/run_operation": { - "post": { - "description": "Run an operation without signature checks", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "operation": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "branch", - "contents", - "signature" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - } - }, - "required": [ - "operation", - "chain_id" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_with_metadata" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/run_view": { - "post": { - "description": "Simulate a call to a view following the TZIP-4 standard. See https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "contract": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - }, - "input": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "payer": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "contract", - "entrypoint", - "input", - "chain_id", - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "data" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/trace_code": { - "post": { - "description": "Run a piece of code in the current context, keeping a trace", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "input": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "payer": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "script", - "storage", - "input", - "amount", - "balance", - "chain_id" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation" - } - }, - "trace": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.trace" - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "storage", - "operations", - "trace" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/trace_code/normalized": { - "post": { - "description": "Run a piece of code in the current context, keeping a trace, normalize the output using the requested unparsing mode.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "script": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "input": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "payer": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "entrypoint": { - "$ref": "#/components/schemas/unistring" - }, - "unparsing_mode": { - "oneOf": [ - { - "title": "Readable", - "type": "string", - "enum": [ - "Readable" - ] - }, - { - "title": "Optimized", - "type": "string", - "enum": [ - "Optimized" - ] - }, - { - "title": "Optimized_legacy", - "type": "string", - "enum": [ - "Optimized_legacy" - ] - } - ] - } - }, - "required": [ - "script", - "storage", - "input", - "amount", - "balance", - "chain_id", - "unparsing_mode" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation" - } - }, - "trace": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.trace" - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "storage", - "operations", - "trace" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/typecheck_code": { - "post": { - "description": "Typecheck a piece of code in the current context", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "program": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "legacy": { - "type": "boolean" - } - }, - "required": [ - "program" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "type_map": { - "type": "array", - "items": { - "type": "object", - "properties": { - "location": { - "$ref": "#/components/schemas/micheline.location" - }, - "stack_before": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/unistring" - } - } - ] - } - } - }, - "stack_after": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/unistring" - } - } - ] - } - } - } - }, - "required": [ - "location", - "stack_before", - "stack_after" - ] - } - }, - "gas": { - "oneOf": [ - { - "title": "Limited", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - { - "title": "Unaccounted", - "type": "string", - "enum": [ - "unaccounted" - ] - } - ] - } - }, - "required": [ - "type_map", - "gas" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/helpers/scripts/typecheck_data": { - "post": { - "description": "Check that some data expression is well formed and of a given type in the current context", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "gas": { - "$ref": "#/components/schemas/bignum" - }, - "legacy": { - "type": "boolean" - } - }, - "required": [ - "data", - "type" - ] - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "gas": { - "oneOf": [ - { - "title": "Limited", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - { - "title": "Unaccounted", - "type": "string", - "enum": [ - "unaccounted" - ] - } - ] - } - }, - "required": [ - "gas" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/live_blocks": { - "get": { - "description": "List the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/block_hash" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/metadata": { - "get": { - "description": "All the metadata associated to the block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/block_header_metadata" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/metadata_hash": { - "get": { - "description": "Hash of the metadata associated to the block. This is only set on blocks starting from environment V1.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Block_metadata_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/minimal_valid_time": { - "get": { - "description": "Minimal valid time for a block given a priority and an endorsing power.", - "parameters": [ - { - "name": "priority", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "endorsing_power", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/timestamp.protocol" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_hashes": { - "get": { - "description": "The hashes of all the operations included in the block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation_hash" - } - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_hashes/{list_offset}": { - "get": { - "description": "All the operations included in `n-th` validation pass of the block.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation_hash" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_hashes/{list_offset}/{operation_offset}": { - "get": { - "description": "The hash of then `m-th` operation in the `n-th` validation pass of the block.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation_offset", - "in": "path", - "description": "Index `m` of the requested operation in its validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Operation_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_metadata_hashes": { - "get": { - "description": "The hashes of all the operation metadata included in the block. This is only set on blocks starting from environment V1.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation_metadata_hash" - } - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_metadata_hashes/{list_offset}": { - "get": { - "description": "All the operation metadata included in `n-th` validation pass of the block. This is only set on blocks starting from environment V1.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Operation_metadata_hash" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operation_metadata_hashes/{list_offset}/{operation_offset}": { - "get": { - "description": "The hash of then `m-th` operation metadata in the `n-th` validation pass of the block. This is only set on blocks starting from environment V1.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation_offset", - "in": "path", - "description": "Index `m` of the requested operation in its validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Operation_metadata_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operations": { - "get": { - "description": "All the operations included in the block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operation" - } - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operations/{list_offset}": { - "get": { - "description": "All the operations included in `n-th` validation pass of the block.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/operation" - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operations/{list_offset}/{operation_offset}": { - "get": { - "description": "The `m-th` operation in the `n-th` validation pass of the block.", - "parameters": [ - { - "name": "list_offset", - "in": "path", - "description": "Index `n` of the requested validation pass.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "operation_offset", - "in": "path", - "description": "Index `m` of the requested operation in its validation pass.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/operation" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/operations_metadata_hash": { - "get": { - "description": "The root hash of the operations metadata from the block. This is only set on blocks starting from environment V1.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Operation_metadata_list_list_hash" - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/protocols": { - "get": { - "description": "Current and next protocol.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "protocol": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "next_protocol": { - "$ref": "#/components/schemas/Protocol_hash" - } - }, - "required": [ - "protocol", - "next_protocol" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/required_endorsements": { - "get": { - "description": "Minimum number of endorsements for a block to be valid, given a delay of the block's timestamp with respect to the minimum time to bake at the block's priority", - "parameters": [ - { - "name": "block_delay", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/ballot_list": { - "get": { - "description": "Ballots casted so far during a voting period.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pkh": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "ballot": { - "type": "string", - "enum": [ - "nay", - "yay", - "pass" - ] - } - }, - "required": [ - "pkh", - "ballot" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/ballots": { - "get": { - "description": "Sum of ballots casted so far during a voting period.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "yay": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "nay": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "pass": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "yay", - "nay", - "pass" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/current_period": { - "get": { - "description": "Returns the voting period (index, kind, starting position) and related information (position, remaining) of the interrogated block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "voting_period": { - "type": "object", - "properties": { - "index": { - "description": "The voting period's index. Starts at 0 with the first block of protocol alpha.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "kind": { - "oneOf": [ - { - "title": "Proposal", - "type": "string", - "enum": [ - "proposal" - ] - }, - { - "title": "exploration", - "type": "string", - "enum": [ - "exploration" - ] - }, - { - "title": "Cooldown", - "type": "string", - "enum": [ - "cooldown" - ] - }, - { - "title": "Promotion", - "type": "string", - "enum": [ - "promotion" - ] - }, - { - "title": "Adoption", - "type": "string", - "enum": [ - "adoption" - ] - } - ] - }, - "start_position": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "index", - "kind", - "start_position" - ] - }, - "position": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "remaining": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "voting_period", - "position", - "remaining" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/current_period_kind": { - "get": { - "description": "Current period kind. This RPC is DEPRECATED: use `../votes/current_period` RPC instead.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Proposal", - "type": "string", - "enum": [ - "proposal" - ] - }, - { - "title": "exploration", - "type": "string", - "enum": [ - "exploration" - ] - }, - { - "title": "Cooldown", - "type": "string", - "enum": [ - "cooldown" - ] - }, - { - "title": "Promotion", - "type": "string", - "enum": [ - "promotion" - ] - }, - { - "title": "Adoption", - "type": "string", - "enum": [ - "adoption" - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/current_proposal": { - "get": { - "description": "Current proposal under evaluation.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "nullable": true, - "oneOf": [ - { - "title": "Some", - "oneOf": [ - { - "$ref": "#/components/schemas/Protocol_hash" - } - ] - } - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/current_quorum": { - "get": { - "description": "Current expected quorum.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/listings": { - "get": { - "description": "List of delegates with their voting weight, in number of rolls.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pkh": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "rolls": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "pkh", - "rolls" - ] - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/proposals": { - "get": { - "description": "List of proposals with number of supporters.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/Protocol_hash" - }, - { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - ] - } - } - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/successor_period": { - "get": { - "description": "Returns the voting period (index, kind, starting position) and related information (position, remaining) of the next block.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "voting_period": { - "type": "object", - "properties": { - "index": { - "description": "The voting period's index. Starts at 0 with the first block of protocol alpha.", - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "kind": { - "oneOf": [ - { - "title": "Proposal", - "type": "string", - "enum": [ - "proposal" - ] - }, - { - "title": "exploration", - "type": "string", - "enum": [ - "exploration" - ] - }, - { - "title": "Cooldown", - "type": "string", - "enum": [ - "cooldown" - ] - }, - { - "title": "Promotion", - "type": "string", - "enum": [ - "promotion" - ] - }, - { - "title": "Adoption", - "type": "string", - "enum": [ - "adoption" - ] - } - ] - }, - "start_position": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "index", - "kind", - "start_position" - ] - }, - "position": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "remaining": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "voting_period", - "position", - "remaining" - ] - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - }, - "/votes/total_voting_power": { - "get": { - "description": "Total number of rolls for the delegates in the voting listings.", - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - } - } - }, - "default": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "009-PsFLoren.big_map_id": { - "title": "Big map identifier", - "description": "A big map identifier", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - "009-PsFLoren.block_header.alpha.full_header": { - "title": "Shell header", - "description": "Block header's shell-related content. It contains information such as the block level, its predecessor and timestamp.", - "type": "object", - "properties": { - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proto": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "predecessor": { - "$ref": "#/components/schemas/block_hash" - }, - "timestamp": { - "$ref": "#/components/schemas/timestamp.protocol" - }, - "validation_pass": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "operations_hash": { - "$ref": "#/components/schemas/Operation_list_list_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "context": { - "$ref": "#/components/schemas/Context_hash" - }, - "priority": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "proof_of_work_nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "seed_nonce_hash": { - "$ref": "#/components/schemas/cycle_nonce" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "level", - "proto", - "predecessor", - "timestamp", - "validation_pass", - "operations_hash", - "fitness", - "context", - "priority", - "proof_of_work_nonce", - "signature" - ] - }, - "009-PsFLoren.block_header.alpha.signed_contents": { - "type": "object", - "properties": { - "priority": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "proof_of_work_nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "seed_nonce_hash": { - "$ref": "#/components/schemas/cycle_nonce" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "priority", - "proof_of_work_nonce", - "signature" - ] - }, - "009-PsFLoren.contract_id": { - "title": "A contract handle", - "description": "A contract notation as given to an RPC or inside scripts. Can be a base58 implicit contract hash or a base58 originated contract hash.", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "009-PsFLoren.entrypoint": { - "title": "entrypoint", - "description": "Named entrypoint to a Michelson smart contract", - "oneOf": [ - { - "title": "default", - "type": "string", - "enum": [ - "default" - ] - }, - { - "title": "root", - "type": "string", - "enum": [ - "root" - ] - }, - { - "title": "do", - "type": "string", - "enum": [ - "do" - ] - }, - { - "title": "set_delegate", - "type": "string", - "enum": [ - "set_delegate" - ] - }, - { - "title": "remove_delegate", - "type": "string", - "enum": [ - "remove_delegate" - ] - }, - { - "title": "named", - "type": "string" - } - ] - }, - "009-PsFLoren.error": { - "description": "The full list of RPC errors would be too long to include.\nIt is available at RPC `/errors` (GET).\nErrors specific to protocol Alpha have an id that starts with `proto.alpha`." - }, - "009-PsFLoren.inlined.endorsement": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "operations": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement.contents" - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "branch", - "operations" - ] - }, - "009-PsFLoren.inlined.endorsement.contents": { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "endorsement" - ] - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "kind", - "level" - ] - }, - "009-PsFLoren.lazy_storage_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "big_map", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "big_map" - ] - }, - "id": { - "$ref": "#/components/schemas/009-PsFLoren.big_map_id" - }, - "diff": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "updates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "key_hash", - "key" - ] - } - } - }, - "required": [ - "action", - "updates" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - } - }, - "required": [ - "action" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.big_map_id" - }, - "updates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "key_hash", - "key" - ] - } - } - }, - "required": [ - "action", - "source", - "updates" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "updates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "key_hash", - "key" - ] - } - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "updates", - "key_type", - "value_type" - ] - } - ] - } - }, - "required": [ - "kind", - "id", - "diff" - ] - }, - { - "title": "sapling_state", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "sapling_state" - ] - }, - "id": { - "$ref": "#/components/schemas/009-PsFLoren.sapling_state_id" - }, - "diff": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "updates": { - "type": "object", - "properties": { - "commitments_and_ciphertexts": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/sapling.transaction.commitment" - }, - { - "$ref": "#/components/schemas/sapling.transaction.ciphertext" - } - ] - } - } - }, - "nullifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/sapling.transaction.nullifier" - } - } - }, - "required": [ - "commitments_and_ciphertexts", - "nullifiers" - ] - } - }, - "required": [ - "action", - "updates" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - } - }, - "required": [ - "action" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.sapling_state_id" - }, - "updates": { - "type": "object", - "properties": { - "commitments_and_ciphertexts": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/sapling.transaction.commitment" - }, - { - "$ref": "#/components/schemas/sapling.transaction.ciphertext" - } - ] - } - } - }, - "nullifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/sapling.transaction.nullifier" - } - } - }, - "required": [ - "commitments_and_ciphertexts", - "nullifiers" - ] - } - }, - "required": [ - "action", - "source", - "updates" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "updates": { - "type": "object", - "properties": { - "commitments_and_ciphertexts": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/sapling.transaction.commitment" - }, - { - "$ref": "#/components/schemas/sapling.transaction.ciphertext" - } - ] - } - } - }, - "nullifiers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/sapling.transaction.nullifier" - } - } - }, - "required": [ - "commitments_and_ciphertexts", - "nullifiers" - ] - }, - "memo_size": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - }, - "required": [ - "action", - "updates", - "memo_size" - ] - } - ] - } - }, - "required": [ - "kind", - "id", - "diff" - ] - } - ] - } - }, - "009-PsFLoren.michelson.v1.primitives": { - "type": "string", - "enum": [ - "ADD", - "IF_LEFT", - "SELF_ADDRESS", - "KECCAK", - "Elt", - "TOTAL_VOTING_POWER", - "VOTING_POWER", - "SHA256", - "option", - "Right", - "LE", - "set", - "ticket", - "storage", - "SOURCE", - "False", - "SHA512", - "BALANCE", - "EMPTY_BIG_MAP", - "operation", - "NOT", - "or", - "TRANSFER_TOKENS", - "DUG", - "COMPARE", - "SHA3", - "chain_id", - "MUL", - "signature", - "AMOUNT", - "DIP", - "ABS", - "list", - "LT", - "bls12_381_g1", - "CONCAT", - "UNIT", - "SWAP", - "DUP", - "bytes", - "CAR", - "CONS", - "NEQ", - "GET", - "Left", - "nat", - "UNPAIR", - "DROP", - "NEG", - "CONTRACT", - "big_map", - "ADDRESS", - "True", - "parameter", - "never", - "EQ", - "Pair", - "UPDATE", - "string", - "AND", - "timestamp", - "READ_TICKET", - "unit", - "CHECK_SIGNATURE", - "IF_CONS", - "INT", - "CREATE_CONTRACT", - "MEM", - "PAIRING_CHECK", - "BLAKE2B", - "bool", - "STEPS_TO_QUOTA", - "sapling_transaction", - "XOR", - "SELF", - "LEVEL", - "IMPLICIT_ACCOUNT", - "PACK", - "NEVER", - "NOW", - "RENAME", - "GET_AND_UPDATE", - "SENDER", - "map", - "mutez", - "SLICE", - "CDR", - "OR", - "sapling_state", - "CHAIN_ID", - "ISNAT", - "SPLIT_TICKET", - "SOME", - "LOOP", - "SAPLING_VERIFY_UPDATE", - "Unit", - "Some", - "UNPACK", - "IF_NONE", - "TICKET", - "ITER", - "EXEC", - "NONE", - "LEFT", - "address", - "JOIN_TICKETS", - "LSR", - "None", - "lambda", - "EMPTY_SET", - "MAP", - "int", - "bls12_381_g2", - "LSL", - "RIGHT", - "contract", - "SIZE", - "pair", - "IF", - "bls12_381_fr", - "PAIR", - "LAMBDA", - "HASH_KEY", - "PUSH", - "LOOP_LEFT", - "SAPLING_EMPTY_STATE", - "key", - "DIG", - "EMPTY_MAP", - "APPLY", - "CAST", - "key_hash", - "FAILWITH", - "GT", - "NIL", - "SUB", - "EDIV", - "CREATE_ACCOUNT", - "GE", - "SET_DELEGATE", - "code" - ] - }, - "009-PsFLoren.mutez": { - "$ref": "#/components/schemas/positive_bignum" - }, - "009-PsFLoren.operation.alpha.contents": { - "oneOf": [ - { - "title": "Endorsement", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "endorsement" - ] - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - } - }, - "required": [ - "kind", - "level" - ] - }, - { - "title": "Seed_nonce_revelation", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "seed_nonce_revelation" - ] - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "kind", - "level", - "nonce" - ] - }, - { - "title": "Endorsement_with_slot", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "endorsement_with_slot" - ] - }, - "endorsement": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "slot": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - }, - "required": [ - "kind", - "endorsement", - "slot" - ] - }, - { - "title": "Double_endorsement_evidence", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "double_endorsement_evidence" - ] - }, - "op1": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "op2": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "slot": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - }, - "required": [ - "kind", - "op1", - "op2", - "slot" - ] - }, - { - "title": "Double_baking_evidence", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "double_baking_evidence" - ] - }, - "bh1": { - "$ref": "#/components/schemas/009-PsFLoren.block_header.alpha.full_header" - }, - "bh2": { - "$ref": "#/components/schemas/009-PsFLoren.block_header.alpha.full_header" - } - }, - "required": [ - "kind", - "bh1", - "bh2" - ] - }, - { - "title": "Activate_account", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "activate_account" - ] - }, - "pkh": { - "$ref": "#/components/schemas/Ed25519.Public_key_hash" - }, - "secret": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "kind", - "pkh", - "secret" - ] - }, - { - "title": "Proposals", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "proposals" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proposals": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Protocol_hash" - } - } - }, - "required": [ - "kind", - "source", - "period", - "proposals" - ] - }, - { - "title": "Ballot", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ballot" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proposal": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "ballot": { - "type": "string", - "enum": [ - "nay", - "yay", - "pass" - ] - } - }, - "required": [ - "kind", - "source", - "period", - "proposal", - "ballot" - ] - }, - { - "title": "Reveal", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "reveal" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "public_key": { - "$ref": "#/components/schemas/Signature.Public_key" - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "public_key" - ] - }, - { - "title": "Transaction", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "transaction" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "destination": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "parameters": { - "type": "object", - "properties": { - "entrypoint": { - "$ref": "#/components/schemas/009-PsFLoren.entrypoint" - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "entrypoint", - "value" - ] - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "amount", - "destination" - ] - }, - { - "title": "Origination", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "origination" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "script": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "balance", - "script" - ] - }, - { - "title": "Delegation", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "delegation" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit" - ] - }, - { - "title": "Failing_noop", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "failing_noop" - ] - }, - "arbitrary": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "kind", - "arbitrary" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.internal_operation": { - "oneOf": [ - { - "title": "Reveal", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "kind": { - "type": "string", - "enum": [ - "reveal" - ] - }, - "public_key": { - "$ref": "#/components/schemas/Signature.Public_key" - } - }, - "required": [ - "source", - "nonce", - "kind", - "public_key" - ] - }, - { - "title": "Transaction", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "kind": { - "type": "string", - "enum": [ - "transaction" - ] - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "destination": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "parameters": { - "type": "object", - "properties": { - "entrypoint": { - "$ref": "#/components/schemas/009-PsFLoren.entrypoint" - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "entrypoint", - "value" - ] - } - }, - "required": [ - "source", - "nonce", - "kind", - "amount", - "destination" - ] - }, - { - "title": "Origination", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "kind": { - "type": "string", - "enum": [ - "origination" - ] - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "script": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - } - }, - "required": [ - "source", - "nonce", - "kind", - "balance", - "script" - ] - }, - { - "title": "Delegation", - "type": "object", - "properties": { - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "kind": { - "type": "string", - "enum": [ - "delegation" - ] - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - } - }, - "required": [ - "source", - "nonce", - "kind" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.internal_operation_result": { - "oneOf": [ - { - "title": "reveal", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "reveal" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "public_key": { - "$ref": "#/components/schemas/Signature.Public_key" - }, - "result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.reveal" - } - }, - "required": [ - "kind", - "source", - "nonce", - "public_key", - "result" - ] - }, - { - "title": "transaction", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "transaction" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "destination": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "parameters": { - "type": "object", - "properties": { - "entrypoint": { - "$ref": "#/components/schemas/009-PsFLoren.entrypoint" - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "entrypoint", - "value" - ] - }, - "result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.transaction" - } - }, - "required": [ - "kind", - "source", - "nonce", - "amount", - "destination", - "result" - ] - }, - { - "title": "origination", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "origination" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "script": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - }, - "result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.origination" - } - }, - "required": [ - "kind", - "source", - "nonce", - "balance", - "script", - "result" - ] - }, - { - "title": "delegation", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "delegation" - ] - }, - "source": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "nonce": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.delegation" - } - }, - "required": [ - "kind", - "source", - "nonce", - "result" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_contents_and_result": { - "oneOf": [ - { - "title": "Endorsement", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "endorsement" - ] - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "slots": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - } - }, - "required": [ - "balance_updates", - "delegate", - "slots" - ] - } - }, - "required": [ - "kind", - "level", - "metadata" - ] - }, - { - "title": "Seed_nonce_revelation", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "seed_nonce_revelation" - ] - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "nonce": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - } - }, - "required": [ - "balance_updates" - ] - } - }, - "required": [ - "kind", - "level", - "nonce", - "metadata" - ] - }, - { - "title": "Endorsement_with_slot", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "endorsement_with_slot" - ] - }, - "endorsement": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "slot": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "slots": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - } - } - }, - "required": [ - "balance_updates", - "delegate", - "slots" - ] - } - }, - "required": [ - "kind", - "endorsement", - "slot", - "metadata" - ] - }, - { - "title": "Double_endorsement_evidence", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "double_endorsement_evidence" - ] - }, - "op1": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "op2": { - "$ref": "#/components/schemas/009-PsFLoren.inlined.endorsement" - }, - "slot": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - } - }, - "required": [ - "balance_updates" - ] - } - }, - "required": [ - "kind", - "op1", - "op2", - "slot", - "metadata" - ] - }, - { - "title": "Double_baking_evidence", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "double_baking_evidence" - ] - }, - "bh1": { - "$ref": "#/components/schemas/009-PsFLoren.block_header.alpha.full_header" - }, - "bh2": { - "$ref": "#/components/schemas/009-PsFLoren.block_header.alpha.full_header" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - } - }, - "required": [ - "balance_updates" - ] - } - }, - "required": [ - "kind", - "bh1", - "bh2", - "metadata" - ] - }, - { - "title": "Activate_account", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "activate_account" - ] - }, - "pkh": { - "$ref": "#/components/schemas/Ed25519.Public_key_hash" - }, - "secret": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - } - }, - "required": [ - "balance_updates" - ] - } - }, - "required": [ - "kind", - "pkh", - "secret", - "metadata" - ] - }, - { - "title": "Proposals", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "proposals" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proposals": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Protocol_hash" - } - }, - "metadata": { - "type": "object", - "properties": {} - } - }, - "required": [ - "kind", - "source", - "period", - "proposals", - "metadata" - ] - }, - { - "title": "Ballot", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "ballot" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "period": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proposal": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "ballot": { - "type": "string", - "enum": [ - "nay", - "yay", - "pass" - ] - }, - "metadata": { - "type": "object", - "properties": {} - } - }, - "required": [ - "kind", - "source", - "period", - "proposal", - "ballot", - "metadata" - ] - }, - { - "title": "Reveal", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "reveal" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "public_key": { - "$ref": "#/components/schemas/Signature.Public_key" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "operation_result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.reveal" - }, - "internal_operation_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation_result" - } - } - }, - "required": [ - "balance_updates", - "operation_result" - ] - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "public_key", - "metadata" - ] - }, - { - "title": "Transaction", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "transaction" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "amount": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "destination": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "parameters": { - "type": "object", - "properties": { - "entrypoint": { - "$ref": "#/components/schemas/009-PsFLoren.entrypoint" - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "entrypoint", - "value" - ] - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "operation_result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.transaction" - }, - "internal_operation_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation_result" - } - } - }, - "required": [ - "balance_updates", - "operation_result" - ] - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "amount", - "destination", - "metadata" - ] - }, - { - "title": "Origination", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "origination" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "balance": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "script": { - "$ref": "#/components/schemas/009-PsFLoren.scripted.contracts" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "operation_result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.origination" - }, - "internal_operation_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation_result" - } - } - }, - "required": [ - "balance_updates", - "operation_result" - ] - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "balance", - "script", - "metadata" - ] - }, - { - "title": "Delegation", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "delegation" - ] - }, - "source": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "fee": { - "$ref": "#/components/schemas/009-PsFLoren.mutez" - }, - "counter": { - "$ref": "#/components/schemas/positive_bignum" - }, - "gas_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_limit": { - "$ref": "#/components/schemas/positive_bignum" - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "metadata": { - "type": "object", - "properties": { - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "operation_result": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_result.delegation" - }, - "internal_operation_results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.internal_operation_result" - } - } - }, - "required": [ - "balance_updates", - "operation_result" - ] - } - }, - "required": [ - "kind", - "source", - "fee", - "counter", - "gas_limit", - "storage_limit", - "metadata" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_result.delegation": { - "oneOf": [ - { - "title": "Applied", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "applied" - ] - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - } - }, - "required": [ - "status" - ] - }, - { - "title": "Failed", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - } - }, - "required": [ - "status", - "errors" - ] - }, - { - "title": "Skipped", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "skipped" - ] - } - }, - "required": [ - "status" - ] - }, - { - "title": "Backtracked", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "backtracked" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - } - }, - "required": [ - "status" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_result.origination": { - "oneOf": [ - { - "title": "Applied", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "applied" - ] - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "originated_contracts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_size": { - "$ref": "#/components/schemas/bignum" - }, - "paid_storage_size_diff": { - "$ref": "#/components/schemas/bignum" - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "status" - ] - }, - { - "title": "Failed", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - } - }, - "required": [ - "status", - "errors" - ] - }, - { - "title": "Skipped", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "skipped" - ] - } - }, - "required": [ - "status" - ] - }, - { - "title": "Backtracked", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "backtracked" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "originated_contracts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_size": { - "$ref": "#/components/schemas/bignum" - }, - "paid_storage_size_diff": { - "$ref": "#/components/schemas/bignum" - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "status" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_result.reveal": { - "oneOf": [ - { - "title": "Applied", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "applied" - ] - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - } - }, - "required": [ - "status" - ] - }, - { - "title": "Failed", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - } - }, - "required": [ - "status", - "errors" - ] - }, - { - "title": "Skipped", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "skipped" - ] - } - }, - "required": [ - "status" - ] - }, - { - "title": "Backtracked", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "backtracked" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - } - }, - "required": [ - "status" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_result.transaction": { - "oneOf": [ - { - "title": "Applied", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "applied" - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "originated_contracts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_size": { - "$ref": "#/components/schemas/bignum" - }, - "paid_storage_size_diff": { - "$ref": "#/components/schemas/bignum" - }, - "allocated_destination_contract": { - "type": "boolean" - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "status" - ] - }, - { - "title": "Failed", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - } - }, - "required": [ - "status", - "errors" - ] - }, - { - "title": "Skipped", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "skipped" - ] - } - }, - "required": [ - "status" - ] - }, - { - "title": "Backtracked", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "backtracked" - ] - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.error" - } - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "big_map_diff": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "update", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "update" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_hash": { - "$ref": "#/components/schemas/script_expr" - }, - "key": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_hash", - "key" - ] - }, - { - "title": "remove", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "remove" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "big_map" - ] - }, - { - "title": "copy", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "copy" - ] - }, - "source_big_map": { - "$ref": "#/components/schemas/bignum" - }, - "destination_big_map": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "action", - "source_big_map", - "destination_big_map" - ] - }, - { - "title": "alloc", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "alloc" - ] - }, - "big_map": { - "$ref": "#/components/schemas/bignum" - }, - "key_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "value_type": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "action", - "big_map", - "key_type", - "value_type" - ] - } - ] - } - }, - "balance_updates": { - "$ref": "#/components/schemas/009-PsFLoren.operation_metadata.alpha.balance_updates" - }, - "originated_contracts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - } - }, - "consumed_gas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "consumed_milligas": { - "$ref": "#/components/schemas/positive_bignum" - }, - "storage_size": { - "$ref": "#/components/schemas/bignum" - }, - "paid_storage_size_diff": { - "$ref": "#/components/schemas/bignum" - }, - "allocated_destination_contract": { - "type": "boolean" - }, - "lazy_storage_diff": { - "$ref": "#/components/schemas/009-PsFLoren.lazy_storage_diff" - } - }, - "required": [ - "status" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.operation_with_metadata": { - "oneOf": [ - { - "title": "Operation_with_metadata", - "type": "object", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.operation_contents_and_result" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "contents" - ] - }, - { - "title": "Operation_without_metadata", - "type": "object", - "properties": { - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "contents" - ] - } - ] - }, - "009-PsFLoren.operation.alpha.unsigned_operation": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - } - }, - "required": [ - "branch", - "contents" - ] - }, - "009-PsFLoren.operation_metadata.alpha.balance_updates": { - "type": "array", - "items": { - "oneOf": [ - { - "title": "Contract", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "contract" - ] - }, - "contract": { - "$ref": "#/components/schemas/009-PsFLoren.contract_id" - }, - "change": { - "$ref": "#/components/schemas/int64" - }, - "origin": { - "oneOf": [ - { - "title": "Block_application", - "type": "string", - "enum": [ - "block" - ] - }, - { - "title": "Protocol_migration", - "type": "string", - "enum": [ - "migration" - ] - } - ] - } - }, - "required": [ - "kind", - "contract", - "change", - "origin" - ] - }, - { - "title": "Rewards", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "freezer" - ] - }, - "category": { - "type": "string", - "enum": [ - "rewards" - ] - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "change": { - "$ref": "#/components/schemas/int64" - }, - "origin": { - "oneOf": [ - { - "title": "Block_application", - "type": "string", - "enum": [ - "block" - ] - }, - { - "title": "Protocol_migration", - "type": "string", - "enum": [ - "migration" - ] - } - ] - } - }, - "required": [ - "kind", - "category", - "delegate", - "cycle", - "change", - "origin" - ] - }, - { - "title": "Fees", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "freezer" - ] - }, - "category": { - "type": "string", - "enum": [ - "fees" - ] - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "change": { - "$ref": "#/components/schemas/int64" - }, - "origin": { - "oneOf": [ - { - "title": "Block_application", - "type": "string", - "enum": [ - "block" - ] - }, - { - "title": "Protocol_migration", - "type": "string", - "enum": [ - "migration" - ] - } - ] - } - }, - "required": [ - "kind", - "category", - "delegate", - "cycle", - "change", - "origin" - ] - }, - { - "title": "Deposits", - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "freezer" - ] - }, - "category": { - "type": "string", - "enum": [ - "deposits" - ] - }, - "delegate": { - "$ref": "#/components/schemas/Signature.Public_key_hash" - }, - "cycle": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "change": { - "$ref": "#/components/schemas/int64" - }, - "origin": { - "oneOf": [ - { - "title": "Block_application", - "type": "string", - "enum": [ - "block" - ] - }, - { - "title": "Protocol_migration", - "type": "string", - "enum": [ - "migration" - ] - } - ] - } - }, - "required": [ - "kind", - "category", - "delegate", - "cycle", - "change", - "origin" - ] - } - ] - } - }, - "009-PsFLoren.sapling_state_id": { - "title": "Sapling state identifier", - "description": "A sapling state identifier", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - "009-PsFLoren.scripted.contracts": { - "type": "object", - "properties": { - "code": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "storage": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - } - }, - "required": [ - "code", - "storage" - ] - }, - "009-PsFLoren.scripted.trace": { - "type": "array", - "items": { - "type": "object", - "properties": { - "location": { - "$ref": "#/components/schemas/micheline.location" - }, - "gas": { - "oneOf": [ - { - "title": "Limited", - "oneOf": [ - { - "$ref": "#/components/schemas/bignum" - } - ] - }, - { - "title": "Unaccounted", - "type": "string", - "enum": [ - "unaccounted" - ] - } - ] - }, - "stack": { - "type": "array", - "items": { - "type": "object", - "properties": { - "item": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "annot": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "item" - ] - } - } - }, - "required": [ - "location", - "gas", - "stack" - ] - } - }, - "Block_metadata_hash": { - "title": "A Tezos block metadata ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Chain_id": { - "title": "Network identifier (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Context_hash": { - "title": "A hash of context (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Ed25519.Public_key_hash": { - "title": "An Ed25519 public key hash (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Operation_hash": { - "title": "A Tezos operation ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Operation_list_list_hash": { - "title": "A list of list of operations (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Operation_metadata_hash": { - "title": "A Tezos operation metadata ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Operation_metadata_list_list_hash": { - "title": "A list of list of operation metadata (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Protocol_hash": { - "title": "A Tezos protocol ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Signature": { - "title": "A Ed25519, Secp256k1 or P256 signature (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Signature.Public_key": { - "title": "A Ed25519, Secp256k1, or P256 public key (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "Signature.Public_key_hash": { - "title": "A Ed25519, Secp256k1, or P256 public key hash (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "bignum": { - "title": "Big number", - "description": "Decimal representation of a big number", - "type": "string" - }, - "block_hash": { - "title": "A block identifier (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "block_header": { - "title": "Shell header", - "description": "Block header's shell-related content. It contains information such as the block level, its predecessor and timestamp.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "hash": { - "$ref": "#/components/schemas/block_hash" - }, - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proto": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "predecessor": { - "$ref": "#/components/schemas/block_hash" - }, - "timestamp": { - "$ref": "#/components/schemas/timestamp.protocol" - }, - "validation_pass": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "operations_hash": { - "$ref": "#/components/schemas/Operation_list_list_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "context": { - "$ref": "#/components/schemas/Context_hash" - }, - "content": { - "oneOf": [ - { - "title": "Activate", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters" - ] - }, - { - "title": "Activate_testchain", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate_testchain" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "validity_time": { - "$ref": "#/components/schemas/int64" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters", - "validity_time" - ] - } - ] - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "protocol", - "chain_id", - "hash", - "level", - "proto", - "predecessor", - "timestamp", - "validation_pass", - "operations_hash", - "fitness", - "context", - "content", - "signature" - ] - }, - "block_header.shell": { - "title": "Shell header", - "description": "Block header's shell-related content. It contains information such as the block level, its predecessor and timestamp.", - "type": "object", - "properties": { - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proto": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "predecessor": { - "$ref": "#/components/schemas/block_hash" - }, - "timestamp": { - "$ref": "#/components/schemas/timestamp.protocol" - }, - "validation_pass": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "operations_hash": { - "$ref": "#/components/schemas/Operation_list_list_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "context": { - "$ref": "#/components/schemas/Context_hash" - } - }, - "required": [ - "level", - "proto", - "predecessor", - "timestamp", - "validation_pass", - "operations_hash", - "fitness", - "context" - ] - }, - "block_header_metadata": { - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "next_protocol": { - "type": "string", - "enum": [ - "PsFLorenaUUuikDWvMDr6fGBRG8kt3e3D3fHoXK1j1BFRxeSH4i" - ] - }, - "test_chain_status": { - "$ref": "#/components/schemas/test_chain_status" - }, - "max_operations_ttl": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "max_operation_data_length": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "max_block_header_length": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "max_operation_list_length": { - "type": "array", - "items": { - "type": "object", - "properties": { - "max_size": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "max_op": { - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - } - }, - "required": [ - "max_size" - ] - } - } - }, - "required": [ - "protocol", - "next_protocol", - "test_chain_status", - "max_operations_ttl", - "max_operation_data_length", - "max_block_header_length", - "max_operation_list_length" - ], - "additionalProperties": {} - }, - "cycle_nonce": { - "title": "A nonce hash (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "error": { - "description": "The full list of error is available with the global RPC `GET errors`" - }, - "fitness": { - "title": "Block fitness", - "description": "The fitness, or score, of a block, that allow the Tezos to decide which chain is the best. A fitness value is a list of byte sequences. They are compared as follows: shortest lists are smaller; lists of the same length are compared according to the lexicographical order.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "int64": { - "title": "64 bit integers", - "description": "Decimal representation of 64 bit integers", - "type": "string" - }, - "merkle_tree": { - "type": "array", - "items": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - }, - { - "oneOf": [ - { - "title": "Hash", - "type": "array", - "items": { - "oneOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/unistring" - } - ] - } - }, - { - "title": "Data", - "nullable": true, - "oneOf": [ - { - "title": "Key", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - { - "title": "Dir", - "type": "object", - "properties": {}, - "additionalProperties": { - "$ref": "#/components/schemas/raw_context" - } - } - ] - }, - { - "title": "Continue", - "oneOf": [ - { - "$ref": "#/components/schemas/merkle_tree" - } - ] - } - ] - } - ] - } - } - }, - "micheline.009-PsFLoren.michelson_v1.expression": { - "oneOf": [ - { - "title": "Int", - "type": "object", - "properties": { - "int": { - "$ref": "#/components/schemas/bignum" - } - }, - "required": [ - "int" - ] - }, - { - "title": "String", - "type": "object", - "properties": { - "string": { - "$ref": "#/components/schemas/unistring" - } - }, - "required": [ - "string" - ] - }, - { - "title": "Bytes", - "type": "object", - "properties": { - "bytes": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "bytes" - ] - }, - { - "title": "Sequence", - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - { - "title": "Generic prim (any number of args with or without annot)", - "type": "object", - "properties": { - "prim": { - "$ref": "#/components/schemas/009-PsFLoren.michelson.v1.primitives" - }, - "args": { - "type": "array", - "items": { - "$ref": "#/components/schemas/micheline.009-PsFLoren.michelson_v1.expression" - } - }, - "annots": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "prim" - ] - } - ] - }, - "micheline.location": { - "title": "Canonical location in a Micheline expression", - "description": "The location of a node in a Micheline expression tree in prefix order, with zero being the root and adding one for every basic node, sequence and primitive application.", - "type": "integer", - "minimum": -1073741824, - "maximum": 1073741823 - }, - "next_operation": { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "PsFLorenaUUuikDWvMDr6fGBRG8kt3e3D3fHoXK1j1BFRxeSH4i" - ] - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - }, - "contents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/009-PsFLoren.operation.alpha.contents" - } - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "protocol", - "branch", - "contents", - "signature" - ] - }, - "operation": { - "oneOf": [ - { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - } - }, - "required": [ - "protocol", - "chain_id", - "hash", - "branch" - ], - "additionalProperties": {} - }, - { - "description": "An operation's shell header.", - "type": "object", - "properties": { - "protocol": { - "type": "string", - "enum": [ - "ProtoGenesisGenesisGenesisGenesisGenesisGenesk612im" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "hash": { - "$ref": "#/components/schemas/Operation_hash" - }, - "branch": { - "$ref": "#/components/schemas/block_hash" - } - }, - "required": [ - "protocol", - "chain_id", - "hash", - "branch" - ], - "additionalProperties": {} - } - ] - }, - "positive_bignum": { - "title": "Positive big number", - "description": "Decimal representation of a positive big number", - "type": "string" - }, - "raw_block_header": { - "title": "Shell header", - "description": "Block header's shell-related content. It contains information such as the block level, its predecessor and timestamp.", - "type": "object", - "properties": { - "level": { - "type": "integer", - "minimum": -2147483648, - "maximum": 2147483647 - }, - "proto": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "predecessor": { - "$ref": "#/components/schemas/block_hash" - }, - "timestamp": { - "$ref": "#/components/schemas/timestamp.protocol" - }, - "validation_pass": { - "type": "integer", - "minimum": 0, - "maximum": 255 - }, - "operations_hash": { - "$ref": "#/components/schemas/Operation_list_list_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "context": { - "$ref": "#/components/schemas/Context_hash" - }, - "content": { - "oneOf": [ - { - "title": "Activate", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters" - ] - }, - { - "title": "Activate_testchain", - "type": "object", - "properties": { - "command": { - "type": "string", - "enum": [ - "activate_testchain" - ] - }, - "hash": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "fitness": { - "$ref": "#/components/schemas/fitness" - }, - "protocol_parameters": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "validity_time": { - "$ref": "#/components/schemas/int64" - } - }, - "required": [ - "command", - "hash", - "fitness", - "protocol_parameters", - "validity_time" - ] - } - ] - }, - "signature": { - "$ref": "#/components/schemas/Signature" - } - }, - "required": [ - "level", - "proto", - "predecessor", - "timestamp", - "validation_pass", - "operations_hash", - "fitness", - "context", - "content", - "signature" - ] - }, - "raw_context": { - "nullable": true, - "oneOf": [ - { - "title": "Key", - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - { - "title": "Dir", - "type": "object", - "properties": {}, - "additionalProperties": { - "$ref": "#/components/schemas/raw_context" - } - } - ] - }, - "sapling.DH.epk": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "sapling.transaction.ciphertext": { - "type": "object", - "properties": { - "cv": { - "$ref": "#/components/schemas/sapling.transaction.commitment_value" - }, - "epk": { - "$ref": "#/components/schemas/sapling.DH.epk" - }, - "payload_enc": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "nonce_enc": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "payload_out": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "nonce_out": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - } - }, - "required": [ - "cv", - "epk", - "payload_enc", - "nonce_enc", - "payload_out", - "nonce_out" - ] - }, - "sapling.transaction.commitment": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "sapling.transaction.commitment_hash": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "sapling.transaction.commitment_value": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "sapling.transaction.nullifier": { - "type": "string", - "pattern": "^[a-zA-Z0-9]+$" - }, - "script_expr": { - "title": "A script expression ID (Base58Check-encoded)", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "test_chain_status": { - "description": "The status of the test chain: not_running (there is no test chain at the moment), forking (the test chain is being setup), running (the test chain is running).", - "oneOf": [ - { - "title": "Not_running", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "not_running" - ] - } - }, - "required": [ - "status" - ] - }, - { - "title": "Forking", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "forking" - ] - }, - "protocol": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "expiration": { - "$ref": "#/components/schemas/timestamp.protocol" - } - }, - "required": [ - "status", - "protocol", - "expiration" - ] - }, - { - "title": "Running", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "running" - ] - }, - "chain_id": { - "$ref": "#/components/schemas/Chain_id" - }, - "genesis": { - "$ref": "#/components/schemas/block_hash" - }, - "protocol": { - "$ref": "#/components/schemas/Protocol_hash" - }, - "expiration": { - "$ref": "#/components/schemas/timestamp.protocol" - } - }, - "required": [ - "status", - "chain_id", - "genesis", - "protocol", - "expiration" - ] - } - ] - }, - "timestamp.protocol": { - "description": "A timestamp as seen by the protocol: second-level precision, epoch based.", - "oneOf": [ - { - "$ref": "#/components/schemas/unistring" - } - ] - }, - "unistring": { - "title": "Universal string representation", - "description": "Either a plain UTF8 string, or a sequence of bytes for strings that contain invalid byte sequences.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "invalid_utf8_string": { - "type": "array", - "items": { - "type": "integer", - "minimum": 0, - "maximum": 255 - } - } - }, - "required": [ - "invalid_utf8_string" - ] - } - ] - } - } - } -} diff --git a/docs/api/openapi.rst b/docs/api/openapi.rst index 02121be289d238c26725f69ad2d373e65332fc72..4791f17341b172796178544d6d0821c2d3825d42 100644 --- a/docs/api/openapi.rst +++ b/docs/api/openapi.rst @@ -27,19 +27,6 @@ Their OpenAPI specification can be found at: .. TODO nomadic-labs/tezos#462: add/remove section(s) -Florence RPCs -------------- - -The OpenAPI specification for RPCs which are specific to the Florence -protocol can be found at: - -- `florence-openapi.json (version 9.2) `_ - -The OpenAPI specification for RPCs which are related to the mempool -and specific to the Florence protocol can be found at: - -- `florence-mempool-openapi.json (version 9.2) `_ - Granada RPCs ------------- diff --git a/docs/conf.py b/docs/conf.py index 139f1c266210a7b80a5adf3835f4608f7b058acd..a6e48a528934bed8cae72f28920a5a0efb2a7a06 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['.venv', '_build', 'Thumbs.db', '.DS_Store', 'doc_gen', '009'] +exclude_patterns = ['.venv', '_build', 'Thumbs.db', '.DS_Store', 'doc_gen', '010'] # TODO nomadic-labs/tezos#462: exclude the active protocol 'NNN' above # The name of the Pygments (syntax highlighting) style to use. diff --git a/docs/doc_gen/dune b/docs/doc_gen/dune index 837d6d7ffb9a76787301d3c0780b7bb1dd010506..99a8f66e30e8e1667ee5880b50722543866bfb43 100644 --- a/docs/doc_gen/dune +++ b/docs/doc_gen/dune @@ -7,7 +7,6 @@ tezos-rpc-http-server tezos-protocol-updater ; TODO nomadic-labs/tezos#462: adapt next line(s) - tezos-embedded-protocol-009-PsFLoren tezos-embedded-protocol-010-PtGRANAD tezos-embedded-protocol-alpha data-encoding diff --git a/docs/doc_gen/rpc_doc.ml b/docs/doc_gen/rpc_doc.ml index 163122c7ba2bf76854f3bdcd77948a6ab0a27f1e..82e8e01d3ccf70ae6f6b472904d993ee71a1537b 100644 --- a/docs/doc_gen/rpc_doc.ml +++ b/docs/doc_gen/rpc_doc.ml @@ -33,14 +33,10 @@ let protocols = Some "/include/rpc_introduction.rst.inc", "ProtoALphaALphaALphaALphaALphaALphaALphaALphaDdp3zK" ); (* TODO nomadic-labs/tezos#462: adapt rest of this list *) - ( "010", + ( "", "010 Granada", Some "/include/rpc_introduction.rst.inc", "PtGRANADsDU8R9daYKAgWnQYAJ64omN1o3KMGVCykShA97vQbvV" ); - ( "", - "009 Florence", - Some "/include/rpc_introduction.rst.inc", - "PsFLorenaUUuikDWvMDr6fGBRG8kt3e3D3fHoXK1j1BFRxeSH4i" ); ] let pp_name ppf = function diff --git a/docs/index.rst b/docs/index.rst index 24dc9d68660cc1b27c366c4a84086ed0c62b2cd1..33b4535decf3948a3284be8e2d7c3adc6711bdfb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -142,7 +142,7 @@ in the :ref:`introduction `. .. toctree:: :maxdepth: 2 - :caption: 009 Florence doc: + :caption: 010 Granada Protocol doc: active/michelson active/proof_of_stake @@ -152,20 +152,7 @@ in the :ref:`introduction `. active/glossary active/cli-commands active/rpc - -.. toctree:: - :maxdepth: 2 - :caption: 010 Granada Protocol doc: - - 010/michelson - 010/proof_of_stake - 010/consensus - 010/sapling - 010/voting - 010/glossary - 010/cli-commands - 010/rpc - 010/liquidity_baking + active/liquidity_baking .. toctree:: :maxdepth: 2 diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index f3cbf5e8504b5d1a198d4d71915086ac73accaf2..de63ddda44f4216e91846508954d2b5eca037912 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -91,7 +91,7 @@ Fedora Copr repository with Tezos packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you're using Fedora, you can install packages with Tezos binaries from the Copr repository. -Currently it supports Fedora 32 and 33. In order to dd the Copr repository to your machine and install the binaries, run the following commands: +Currently it supports Fedora 33 and 34. In order to add the Copr repository to your machine and install the binaries, run the following commands: .. literalinclude:: install-bin-fedora.sh :language: shell @@ -121,27 +121,27 @@ with architecture **x86_64**. Although we only officially support Linux, the script has been tested with success in the past on Windows, OS X, and Linux. -The same script can be used to run Tezos on Mainnet, on Florencenet, or on other network: it +The same script can be used to run Tezos on Mainnet, on Granadanet, or on other network: it suffices to rename it as it downloads a different image based on its name. -For example, to run Tezos on the Florencenet test network with the latest release: +For example, to run Tezos on the Granadanet test network with the latest release: -.. literalinclude:: use-docker-florencenet.sh +.. literalinclude:: use-docker-granadanet.sh :language: shell - :start-after: [get florencenet] - :end-before: [start florencenet] + :start-after: [get granadanet] + :end-before: [start granadanet] Alternatively, to run on Mainnet:: wget -O mainnet.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/tezos-docker-manager.sh chmod +x mainnet.sh -In the following we assume you are running on the florencenet test network. +In the following we assume you are running on the Granadanet test network. You are now one step away from a working node: -.. literalinclude:: use-docker-florencenet.sh +.. literalinclude:: use-docker-granadanet.sh :language: shell - :start-after: [start florencenet] + :start-after: [start granadanet] This will download the right Docker image for your chosen network, launch 3 Docker containers running the node, the baker and the endorser. Keep in mind @@ -150,23 +150,23 @@ synchronize the chain. This can be *lengthy* on the first launch considering that the chain takes up several gigabytes of data. See :ref:`how to use Tezos` for more details. -Every call to ``florencenet.sh`` will check for updates of the node and +Every call to ``granadanet.sh`` will check for updates of the node and will fail if your node is not up-to-date. For updating the node, simply run:: - ./florencenet.sh restart + ./granadanet.sh restart If you prefer to temporarily disable automatic updates, you just have to set an environment variable:: export TEZOS_ALPHANET_DO_NOT_PULL=yes -See ``./florencenet.sh --help`` for more information about the -script. In particular see ``./florencenet.sh client --help`` or the +See ``./granadanet.sh --help`` for more information about the +script. In particular see ``./granadanet.sh client --help`` or the :ref:`online manual` for more information about the client. Every command to the ``tezos-client`` can be equivalently -executed by using ``./florencenet.sh client``, passing the needed arguments. Similarly, ``tezos-admin-client`` -can be executed using ``./florencenet.sh admin-client``. +executed by using ``./granadanet.sh client``, passing the needed arguments. Similarly, ``tezos-admin-client`` +can be executed using ``./granadanet.sh admin-client``. .. _building_with_opam: @@ -258,7 +258,7 @@ Now, install all the binaries by: :start-after: [install tezos] You can be more specific and only ``opam install tezos-node``, ``opam -install tezos-endorser-009-PsFLoren``, ... In that case, it is enough to install the system dependencies of this package only by running ``opam depext tezos-node`` for example instead of ``opam depext tezos``. +install tezos-endorser-010-PtGRANAD``, ... In that case, it is enough to install the system dependencies of this package only by running ``opam depext tezos-node`` for example instead of ``opam depext tezos``. .. warning:: diff --git a/docs/introduction/howtorun.rst b/docs/introduction/howtorun.rst index 9d4692065b06f20e395871a90731aad09eb0a67a..6541ea46bba0a3fa5e84c3ad7a61f330ae29bb4c 100644 --- a/docs/introduction/howtorun.rst +++ b/docs/introduction/howtorun.rst @@ -305,12 +305,12 @@ Docker ~~~~~~ The docker image runs the daemons by default for all your keys. -Assuming you run on Florencenet, to know if you baked, just run:: +Assuming you run on Granadanet, to know if you baked, just run:: - ./florencenet.sh baker log - ./florencenet.sh endorser log + ./granadanet.sh baker log + ./granadanet.sh endorser log -(replace ``florencenet.sh`` with ``mainnet.sh`` for Mainnet). +(replace ``granadanet.sh`` with ``mainnet.sh`` for Mainnet). You should see lines such as:: Injected block BLxzbB7PBW1axq for bootstrap5 after BLSrg4dXzL2aqq (level 1381, slot 0, fitness 00::0000000000005441, operations 21) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 571584fccc3424cbbed3d211a488664df985e0d3..4f60970c042e60d5b38eb1926f7872f44266a13d 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -28,8 +28,8 @@ After a successful compilation, you should have the following binaries: - ``tezos-snoop``: a tool for modeling the performance of any piece of OCaml code, based on benchmarking (see :doc:`../developer/snoop`) The daemons other than the node are suffixed with the name of the protocol they are -bound to. For instance, ``tezos-baker-009-PsFLoren`` is the baker -for the Florence protocol, and ``tezos-baker-alpha`` is the baker +bound to. For instance, ``tezos-baker-010-PtGRANAD`` is the baker +for the Granada protocol, and ``tezos-baker-alpha`` is the baker of the development protocol. The ``tezos-node`` daemon is not suffixed by any protocol name, because it is independent of the economic protocol. See also the `Node Protocol`_ section below. @@ -262,11 +262,11 @@ command:: tezos-client activate account alice with "tz1__xxxxxxxxx__.json" -If you run Tezos using docker images (via the ``tezos-docker-manager.sh`` script, renamed as ``florencenet.sh`` -to run the Florencenet test network for instance), you should prefix the file +If you run Tezos using docker images (via the ``tezos-docker-manager.sh`` script, renamed as ``granadanet.sh`` +to run the Granadanet test network for instance), you should prefix the file with ``container:`` in order to copy it into the docker image:: - ./florencenet.sh client activate account alice with "container:tz1__xxxxxxxxx__.json" + ./granadanet.sh client activate account alice with "container:tz1__xxxxxxxxx__.json" Let's check the balance of the new account with:: diff --git a/docs/introduction/install-bin-fedora.sh b/docs/introduction/install-bin-fedora.sh index 29844651a3ec54b2c6e5303ce530359b053348fd..83c1262b7be63e0c6d9dd111b98e3c8fc48e48af 100644 --- a/docs/introduction/install-bin-fedora.sh +++ b/docs/introduction/install-bin-fedora.sh @@ -7,6 +7,6 @@ dnf install -y dnf-plugins-core dnf copr enable -y @Serokell/Tezos && dnf update -y dnf install -y tezos-client dnf install -y tezos-node -dnf install -y tezos-baker-009-PsFLoren -dnf install -y tezos-endorser-009-PsFLoren -dnf install -y tezos-accuser-009-PsFLoren +dnf install -y tezos-baker-010-PtGRANAD +dnf install -y tezos-endorser-010-PtGRANAD +dnf install -y tezos-accuser-010-PtGRANAD diff --git a/docs/introduction/install-bin-ubuntu.sh b/docs/introduction/install-bin-ubuntu.sh index 16d8dd17b50b9dbd6839d57b4674d14d54e81580..da6e08b29885aa5cb30254023257878d41370935 100644 --- a/docs/introduction/install-bin-ubuntu.sh +++ b/docs/introduction/install-bin-ubuntu.sh @@ -9,6 +9,6 @@ apt-get install -y software-properties-common can be: * use-docker * install-bin-bionic * install-bin-focal -* install-bin-fedora32 * install-bin-fedora33 +* install-bin-fedora34 * install-opam-scratch * install-opam-bionic * install-opam-focal @@ -49,12 +49,12 @@ case "$1" in "install-bin-focal" ) docker run --rm -i $UBUNTU_FOCAL <"$MYDIR"/install-bin-ubuntu.sh ;; - "install-bin-fedora32" ) - docker run --rm -i fedora:32 <"$MYDIR"/install-bin-fedora.sh - ;; "install-bin-fedora33" ) docker run --rm -i fedora:33 <"$MYDIR"/install-bin-fedora.sh ;; + "install-bin-fedora34" ) + docker run --rm -i fedora:34 <"$MYDIR"/install-bin-fedora.sh + ;; "install-opam-scratch" ) docker run --rm -i --privileged $UBUNTU_BIONIC <"$MYDIR"/install-opam-scratch.sh ;; diff --git a/docs/introduction/test_networks.rst b/docs/introduction/test_networks.rst index 2af65f8851e11378c44871ba3e227619c01f52c2..50e65ec75c7a700c09babbd468885a02eb55c44d 100644 --- a/docs/introduction/test_networks.rst +++ b/docs/introduction/test_networks.rst @@ -16,7 +16,7 @@ former is obviously important as users need to test their development with the current protocol. The latter is also needed to test the proposed protocol and its new features, both to decide whether to vote yes and to prepare for its activation. After the intended protocol of a test -network is activated (such as Florence for FLorencenet), the protocol +network is activated (such as Granada for granadanet), the protocol no longer changes because this could break the workflow of some users while they are testing their development, as they may not be ready for the new protocol. So every time a new protocol is proposed on Mainnet, @@ -47,22 +47,6 @@ On Granadanet, some constants differ from Mainnet. This results in a faster chain than Mainnet. See :ref:`protocol constants ` to learn how to find out their values. -Florencenet -=========== - -- Built-in network alias: ``florencenet`` (see :ref:`builtin_networks`) - - * Available in version 9.0 - -- Run Docker image: ``wget -O florencenet.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/tezos-docker-manager.sh`` - -Florencenet is a test network running the ``PsFLoren`` protocol. -Florencenet will run until Florence is replaced by another protocol on Mainnet. - -On Florencenet, some constants differ from Mainnet. -This results in a faster chain than Mainnet. -See :ref:`protocol constants ` to learn how to find out their values. - Future Networks =============== @@ -76,6 +60,13 @@ P is activated, the previous test network will end and P-net will continue on it Old Networks ============ +Florencenet +----------- + +Florencenet was a test network running the Florence protocol. +Following the activation of the Granada protocol replacing Florence on Mainnet, +Florencenet stopped being maintained on August 6, 2021. + Edo2net ------- diff --git a/docs/introduction/use-docker-florencenet.sh b/docs/introduction/use-docker-granadanet.sh similarity index 51% rename from docs/introduction/use-docker-florencenet.sh rename to docs/introduction/use-docker-granadanet.sh index 99a027b21608a034c94ffcfe14a5624b14f2dd56..143b7164195c774a850950dcb08604518bb410e7 100644 --- a/docs/introduction/use-docker-florencenet.sh +++ b/docs/introduction/use-docker-granadanet.sh @@ -6,8 +6,8 @@ cd apt-get update apt-get install -y docker.io docker-compose kmod wget dockerd & -# [get florencenet] -wget -O florencenet.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/tezos-docker-manager.sh -chmod +x florencenet.sh -# [start florencenet] -./florencenet.sh start +# [get granadanet] +wget -O granadanet.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/tezos-docker-manager.sh +chmod +x granadanet.sh +# [start granadanet] +./granadanet.sh start diff --git a/docs/protocols/010_granada.rst b/docs/protocols/010_granada.rst index 03345220580d076a7f3fa030eb04d9be48107c31..0c5de661db9bf70cc2491982bb10b1baf7deda3a 100644 --- a/docs/protocols/010_granada.rst +++ b/docs/protocols/010_granada.rst @@ -67,7 +67,7 @@ At any time bakers can vote to shut off the liquidity baking subsidy by setting - MRs: :gl:`!2765` :gl:`!2897` :gl:`!2920` :gl:`!2929` :gl:`!2946` - Issue: :gl:`#1238` -More detailed docs for liquidity baking can be found :doc:`here<../010/liquidity_baking>`. +More detailed docs for liquidity baking can be found :doc:`here<../active/liquidity_baking>`. Gas improvements ---------------- diff --git a/docs/releases/releases.rst b/docs/releases/releases.rst index 03c6506062ed7cef24f25cf5108c043e714dad0c..813e98d28b0c640fb12365b48dce1ac67eb92941 100644 --- a/docs/releases/releases.rst +++ b/docs/releases/releases.rst @@ -81,8 +81,7 @@ The packaged forms are updated from the source form as follows: - at each stable release - The process is currently performed manually by - `Serokell `_ when the OPAM packages - above are generated. + `Serokell `_. For installing Tezos from these different forms of releases, see :doc:`../introduction/howtoget`. diff --git a/docs/user/fa12.rst b/docs/user/fa12.rst index c496558e1838cec2394036433a632a008f0c2527..6dceb15e9e03716598965b3e8fea714bbee3bd40 100644 --- a/docs/user/fa12.rst +++ b/docs/user/fa12.rst @@ -1,3 +1,5 @@ +.. TODO nomadic-labs/tezos#462: search shifted protocol name/number & adapt + FA1.2 asset smart contracts =========================== @@ -99,7 +101,7 @@ transfers is the following: The complete schema can be inspected via ``tezos-codec describe .fa1.2.token_transfer json schema`` (where ```` -can be replaced with e.g. ``alpha`` or ``009-PsFLoren``). +can be replaced with e.g. ``alpha`` or ``010-PtGRANAD``). View information diff --git a/docs/user/multinetwork.rst b/docs/user/multinetwork.rst index 81fdb0501e0853ab6bbaa89a5b3603919f79553c..77647490489d7f2f958afb7d2963acecdf657bae 100644 --- a/docs/user/multinetwork.rst +++ b/docs/user/multinetwork.rst @@ -34,9 +34,9 @@ Built-In Networks ----------------- The simplest way to select the network to connect to is to use the ``--network`` -option when you initialize your :doc:`node configuration <./node-configuration>`. For instance, to run on Florencenet:: +option when you initialize your :doc:`node configuration <./node-configuration>`. For instance, to run on Granadanet:: - tezos-node config init --data-dir ~/tezos-edonet --network florencenet + tezos-node config init --data-dir ~/tezos-edonet --network granadanet tezos-node identity generate --data-dir ~/tezos-edonet tezos-node run --data-dir ~/tezos-edonet @@ -56,19 +56,17 @@ the following built-in networks: - ``sandbox`` -- ``florencenet`` (available from version 9.0) - - ``granadanet`` (available from version 9.2) If you did not initialize your node configuration, or if your configuration file contains no ``network`` field, the node assumes you want to run Mainnet. You can use the ``--network`` option with ``tezos-node run`` to make sure your node runs on the expected network. For instance, to make sure that -it runs on Florencenet:: +it runs on Granadanet:: - tezos-node run --data-dir ~/tezos-edonet --network florencenet + tezos-node run --data-dir ~/tezos-edonet --network granadanet -This command will fail with an error if the configured network is not Florencenet. +This command will fail with an error if the configured network is not Granadanet. The node also displays the chain name (such as ``TEZOS_MAINNET``) when it starts. Also mind opening the :doc:`RPC interface <../developer/rpc>` as appropriate. @@ -201,11 +199,11 @@ Alias Versus Explicit Configuration If you use one of the `Built-In Networks`_, the configuration file stores the name of the network to connect to. For instance, if you configured it -to connect to Florencenet, it will contain something like:: +to connect to Granadanet, it will contain something like:: { "p2p": {}, - "network": "florencenet" + "network": "granadanet" } For Mainnet, it would contain ``mainnet``, or nothing as this is actually the default. @@ -217,7 +215,7 @@ overrides may be added. Because the configuration file only contains the name of the network and not its parameters, it will automatically use the updated values. However, if you configure `Custom Networks`_, the configuration file will -no longer contain an alias such as ``mainnet`` or ``florencenet``. Instead, +no longer contain an alias such as ``mainnet`` or ``granadanet``. Instead, it will explicitly contain the list of bootstrap peers, user-activated upgrades and user-activated protocol overrides that you specify. This means that when you update your node, updates to built-in network parameters will have no effect. diff --git a/src/tooling/shellcheck_skips b/src/tooling/shellcheck_skips index 568c39ef640e230f3bd7cd24d007de6f64ae3d72..456648a872503b89501d2f5381badf4f37471230 100644 --- a/src/tooling/shellcheck_skips +++ b/src/tooling/shellcheck_skips @@ -3,7 +3,7 @@ docs/introduction/install-bin-fedora.sh docs/introduction/install-bin-ubuntu.sh docs/introduction/install-opam-scratch.sh docs/introduction/install-opam.sh -docs/introduction/use-docker-florencenet.sh +docs/introduction/use-docker-granadanet.sh scripts/baker-version-stats.sh scripts/check_opam_test.sh scripts/ci/create_docker_image.build.sh