stellar-base 0.22.0 → 0.23.0.pre1

data/xdr/Stellar-ledger-entries.x

@@ -1,295 +0,0 @@
-// Copyright 2015 Stellar Development Foundation and contributors. Licensed
-// under the Apache License, Version 2.0. See the COPYING file at the root
-// of this distribution or at http://www.apache.org/licenses/LICENSE-2.0
-
-%#include "xdr/Stellar-types.h"
-
-namespace stellar
-{
-
-typedef PublicKey AccountID;
-typedef opaque Thresholds[4];
-typedef string string32<32>;
-typedef string string64<64>;
-typedef int64 SequenceNumber;
-typedef uint64 TimePoint;
-typedef opaque DataValue<64>;
-
-// 1-4 alphanumeric characters right-padded with 0 bytes
-typedef opaque AssetCode4[4];
-
-// 5-12 alphanumeric characters right-padded with 0 bytes
-typedef opaque AssetCode12[12];
-
-enum AssetType
-{
-    ASSET_TYPE_NATIVE = 0,
-    ASSET_TYPE_CREDIT_ALPHANUM4 = 1,
-    ASSET_TYPE_CREDIT_ALPHANUM12 = 2
-};
-
-union Asset switch (AssetType type)
-{
-case ASSET_TYPE_NATIVE: // Not credit
-    void;
-
-case ASSET_TYPE_CREDIT_ALPHANUM4:
-    struct
-    {
-        AssetCode4 assetCode;
-        AccountID issuer;
-    } alphaNum4;
-
-case ASSET_TYPE_CREDIT_ALPHANUM12:
-    struct
-    {
-        AssetCode12 assetCode;
-        AccountID issuer;
-    } alphaNum12;
-
-    // add other asset types here in the future
-};
-
-// price in fractional representation
-struct Price
-{
-    int32 n; // numerator
-    int32 d; // denominator
-};
-
-struct Liabilities
-{
-    int64 buying;
-    int64 selling;
-};
-
-// the 'Thresholds' type is packed uint8_t values
-// defined by these indexes
-enum ThresholdIndexes
-{
-    THRESHOLD_MASTER_WEIGHT = 0,
-    THRESHOLD_LOW = 1,
-    THRESHOLD_MED = 2,
-    THRESHOLD_HIGH = 3
-};
-
-enum LedgerEntryType
-{
-    ACCOUNT = 0,
-    TRUSTLINE = 1,
-    OFFER = 2,
-    DATA = 3
-};
-
-struct Signer
-{
-    SignerKey key;
-    uint32 weight; // really only need 1 byte
-};
-
-enum AccountFlags
-{ // masks for each flag
-
-    // Flags set on issuer accounts
-    // TrustLines are created with authorized set to "false" requiring
-    // the issuer to set it for each TrustLine
-    AUTH_REQUIRED_FLAG = 0x1,
-    // If set, the authorized flag in TrustLines can be cleared
-    // otherwise, authorization cannot be revoked
-    AUTH_REVOCABLE_FLAG = 0x2,
-    // Once set, causes all AUTH_* flags to be read-only
-    AUTH_IMMUTABLE_FLAG = 0x4
-};
-
-// mask for all valid flags
-const MASK_ACCOUNT_FLAGS = 0x7;
-
-/* AccountEntry
-
-    Main entry representing a user in Stellar. All transactions are
-    performed using an account.
-
-    Other ledger entries created require an account.
-
-*/
-struct AccountEntry
-{
-    AccountID accountID;      // master public key for this account
-    int64 balance;            // in stroops
-    SequenceNumber seqNum;    // last sequence number used for this account
-    uint32 numSubEntries;     // number of sub-entries this account has
-                              // drives the reserve
-    AccountID* inflationDest; // Account to vote for during inflation
-    uint32 flags;             // see AccountFlags
-
-    string32 homeDomain; // can be used for reverse federation and memo lookup
-
-    // fields used for signatures
-    // thresholds stores unsigned bytes: [weight of master|low|medium|high]
-    Thresholds thresholds;
-
-    Signer signers<20>; // possible signers for this account
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    case 1:
-        struct
-        {
-            Liabilities liabilities;
-
-            union switch (int v)
-            {
-            case 0:
-                void;
-            }
-            ext;
-        } v1;
-    }
-    ext;
-};
-
-/* TrustLineEntry
-    A trust line represents a specific trust relationship with
-    a credit/issuer (limit, authorization)
-    as well as the balance.
-*/
-
-enum TrustLineFlags
-{
-    // issuer has authorized account to perform transactions with its credit
-    AUTHORIZED_FLAG = 1
-};
-
-// mask for all trustline flags
-const MASK_TRUSTLINE_FLAGS = 1;
-
-struct TrustLineEntry
-{
-    AccountID accountID; // account this trustline belongs to
-    Asset asset;         // type of asset (with issuer)
-    int64 balance;       // how much of this asset the user has.
-                         // Asset defines the unit for this;
-
-    int64 limit;  // balance cannot be above this
-    uint32 flags; // see TrustLineFlags
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    case 1:
-        struct
-        {
-            Liabilities liabilities;
-
-            union switch (int v)
-            {
-            case 0:
-                void;
-            }
-            ext;
-        } v1;
-    }
-    ext;
-};
-
-enum OfferEntryFlags
-{
-    // issuer has authorized account to perform transactions with its credit
-    PASSIVE_FLAG = 1
-};
-
-// Mask for OfferEntry flags
-const MASK_OFFERENTRY_FLAGS = 1;
-
-/* OfferEntry
-    An offer is the building block of the offer book, they are automatically
-    claimed by payments when the price set by the owner is met.
-
-    For example an Offer is selling 10A where 1A is priced at 1.5B
-
-*/
-struct OfferEntry
-{
-    AccountID sellerID;
-    int64 offerID;
-    Asset selling; // A
-    Asset buying;  // B
-    int64 amount;  // amount of A
-
-    /* price for this offer:
-        price of A in terms of B
-        price=AmountB/AmountA=priceNumerator/priceDenominator
-        price is after fees
-    */
-    Price price;
-    uint32 flags; // see OfferEntryFlags
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-/* DataEntry
-    Data can be attached to accounts.
-*/
-struct DataEntry
-{
-    AccountID accountID; // account this data belongs to
-    string64 dataName;
-    DataValue dataValue;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-struct LedgerEntry
-{
-    uint32 lastModifiedLedgerSeq; // ledger the LedgerEntry was last changed
-
-    union switch (LedgerEntryType type)
-    {
-    case ACCOUNT:
-        AccountEntry account;
-    case TRUSTLINE:
-        TrustLineEntry trustLine;
-    case OFFER:
-        OfferEntry offer;
-    case DATA:
-        DataEntry data;
-    }
-    data;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-// list of all envelope types used in the application
-// those are prefixes used when building signatures for
-// the respective envelopes
-enum EnvelopeType
-{
-    ENVELOPE_TYPE_SCP = 1,
-    ENVELOPE_TYPE_TX = 2,
-    ENVELOPE_TYPE_AUTH = 3,
-    ENVELOPE_TYPE_SCPVALUE = 4
-};
-}

data/xdr/Stellar-ledger.x

@@ -1,372 +0,0 @@
-// Copyright 2015 Stellar Development Foundation and contributors. Licensed
-// under the Apache License, Version 2.0. See the COPYING file at the root
-// of this distribution or at http://www.apache.org/licenses/LICENSE-2.0
-
-%#include "xdr/Stellar-SCP.h"
-%#include "xdr/Stellar-transaction.h"
-
-namespace stellar
-{
-
-typedef opaque UpgradeType<128>;
-
-enum StellarValueType
-{
-    STELLAR_VALUE_BASIC = 0,
-    STELLAR_VALUE_SIGNED = 1
-};
-
-struct LedgerCloseValueSignature
-{
-    NodeID nodeID;       // which node introduced the value
-    Signature signature; // nodeID's signature
-};
-
-/* StellarValue is the value used by SCP to reach consensus on a given ledger
- */
-struct StellarValue
-{
-    Hash txSetHash;      // transaction set to apply to previous ledger
-    TimePoint closeTime; // network close time
-
-    // upgrades to apply to the previous ledger (usually empty)
-    // this is a vector of encoded 'LedgerUpgrade' so that nodes can drop
-    // unknown steps during consensus if needed.
-    // see notes below on 'LedgerUpgrade' for more detail
-    // max size is dictated by number of upgrade types (+ room for future)
-    UpgradeType upgrades<6>;
-
-    // reserved for future use
-    union switch (StellarValueType v)
-    {
-    case STELLAR_VALUE_BASIC:
-        void;
-    case STELLAR_VALUE_SIGNED:
-        LedgerCloseValueSignature lcValueSignature;
-    }
-    ext;
-};
-
-/* The LedgerHeader is the highest level structure representing the
- * state of a ledger, cryptographically linked to previous ledgers.
- */
-struct LedgerHeader
-{
-    uint32 ledgerVersion;    // the protocol version of the ledger
-    Hash previousLedgerHash; // hash of the previous ledger header
-    StellarValue scpValue;   // what consensus agreed to
-    Hash txSetResultHash;    // the TransactionResultSet that led to this ledger
-    Hash bucketListHash;     // hash of the ledger state
-
-    uint32 ledgerSeq; // sequence number of this ledger
-
-    int64 totalCoins; // total number of stroops in existence.
-                      // 10,000,000 stroops in 1 XLM
-
-    int64 feePool;       // fees burned since last inflation run
-    uint32 inflationSeq; // inflation sequence number
-
-    uint64 idPool; // last used global ID, used for generating objects
-
-    uint32 baseFee;     // base fee per operation in stroops
-    uint32 baseReserve; // account base reserve in stroops
-
-    uint32 maxTxSetSize; // maximum size a transaction set can be
-
-    Hash skipList[4]; // hashes of ledgers in the past. allows you to jump back
-                      // in time without walking the chain back ledger by ledger
-                      // each slot contains the oldest ledger that is mod of
-                      // either 50  5000  50000 or 500000 depending on index
-                      // skipList[0] mod(50), skipList[1] mod(5000), etc
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-/* Ledger upgrades
-note that the `upgrades` field from StellarValue is normalized such that
-it only contains one entry per LedgerUpgradeType, and entries are sorted
-in ascending order
-*/
-enum LedgerUpgradeType
-{
-    LEDGER_UPGRADE_VERSION = 1,
-    LEDGER_UPGRADE_BASE_FEE = 2,
-    LEDGER_UPGRADE_MAX_TX_SET_SIZE = 3,
-    LEDGER_UPGRADE_BASE_RESERVE = 4
-};
-
-union LedgerUpgrade switch (LedgerUpgradeType type)
-{
-case LEDGER_UPGRADE_VERSION:
-    uint32 newLedgerVersion; // update ledgerVersion
-case LEDGER_UPGRADE_BASE_FEE:
-    uint32 newBaseFee; // update baseFee
-case LEDGER_UPGRADE_MAX_TX_SET_SIZE:
-    uint32 newMaxTxSetSize; // update maxTxSetSize
-case LEDGER_UPGRADE_BASE_RESERVE:
-    uint32 newBaseReserve; // update baseReserve
-};
-
-/* Entries used to define the bucket list */
-
-union LedgerKey switch (LedgerEntryType type)
-{
-case ACCOUNT:
-    struct
-    {
-        AccountID accountID;
-    } account;
-
-case TRUSTLINE:
-    struct
-    {
-        AccountID accountID;
-        Asset asset;
-    } trustLine;
-
-case OFFER:
-    struct
-    {
-        AccountID sellerID;
-        int64 offerID;
-    } offer;
-
-case DATA:
-    struct
-    {
-        AccountID accountID;
-        string64 dataName;
-    } data;
-};
-
-enum BucketEntryType
-{
-    METAENTRY =
-        -1, // At-and-after protocol 11: bucket metadata, should come first.
-    LIVEENTRY = 0, // Before protocol 11: created-or-updated;
-                   // At-and-after protocol 11: only updated.
-    DEADENTRY = 1,
-    INITENTRY = 2 // At-and-after protocol 11: only created.
-};
-
-struct BucketMetadata
-{
-    // Indicates the protocol version used to create / merge this bucket.
-    uint32 ledgerVersion;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-union BucketEntry switch (BucketEntryType type)
-{
-case LIVEENTRY:
-case INITENTRY:
-    LedgerEntry liveEntry;
-
-case DEADENTRY:
-    LedgerKey deadEntry;
-case METAENTRY:
-    BucketMetadata metaEntry;
-};
-
-// Transaction sets are the unit used by SCP to decide on transitions
-// between ledgers
-struct TransactionSet
-{
-    Hash previousLedgerHash;
-    TransactionEnvelope txs<>;
-};
-
-struct TransactionResultPair
-{
-    Hash transactionHash;
-    TransactionResult result; // result for the transaction
-};
-
-// TransactionResultSet is used to recover results between ledgers
-struct TransactionResultSet
-{
-    TransactionResultPair results<>;
-};
-
-// Entries below are used in the historical subsystem
-
-struct TransactionHistoryEntry
-{
-    uint32 ledgerSeq;
-    TransactionSet txSet;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-struct TransactionHistoryResultEntry
-{
-    uint32 ledgerSeq;
-    TransactionResultSet txResultSet;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-struct LedgerHeaderHistoryEntry
-{
-    Hash hash;
-    LedgerHeader header;
-
-    // reserved for future use
-    union switch (int v)
-    {
-    case 0:
-        void;
-    }
-    ext;
-};
-
-// historical SCP messages
-
-struct LedgerSCPMessages
-{
-    uint32 ledgerSeq;
-    SCPEnvelope messages<>;
-};
-
-// note: ledgerMessages may refer to any quorumSets encountered
-// in the file so far, not just the one from this entry
-struct SCPHistoryEntryV0
-{
-    SCPQuorumSet quorumSets<>; // additional quorum sets used by ledgerMessages
-    LedgerSCPMessages ledgerMessages;
-};
-
-// SCP history file is an array of these
-union SCPHistoryEntry switch (int v)
-{
-case 0:
-    SCPHistoryEntryV0 v0;
-};
-
-// represents the meta in the transaction table history
-
-// STATE is emitted every time a ledger entry is modified/deleted
-// and the entry was not already modified in the current ledger
-
-enum LedgerEntryChangeType
-{
-    LEDGER_ENTRY_CREATED = 0, // entry was added to the ledger
-    LEDGER_ENTRY_UPDATED = 1, // entry was modified in the ledger
-    LEDGER_ENTRY_REMOVED = 2, // entry was removed from the ledger
-    LEDGER_ENTRY_STATE = 3    // value of the entry
-};
-
-union LedgerEntryChange switch (LedgerEntryChangeType type)
-{
-case LEDGER_ENTRY_CREATED:
-    LedgerEntry created;
-case LEDGER_ENTRY_UPDATED:
-    LedgerEntry updated;
-case LEDGER_ENTRY_REMOVED:
-    LedgerKey removed;
-case LEDGER_ENTRY_STATE:
-    LedgerEntry state;
-};
-
-typedef LedgerEntryChange LedgerEntryChanges<>;
-
-struct OperationMeta
-{
-    LedgerEntryChanges changes;
-};
-
-struct TransactionMetaV1
-{
-    LedgerEntryChanges txChanges; // tx level changes if any
-    OperationMeta operations<>;   // meta for each operation
-};
-
-struct TransactionMetaV2
-{
-    LedgerEntryChanges txChangesBefore; // tx level changes before operations
-                                        // are applied if any
-    OperationMeta operations<>;         // meta for each operation
-    LedgerEntryChanges txChangesAfter;  // tx level changes after operations are
-                                        // applied if any
-};
-
-// this is the meta produced when applying transactions
-// it does not include pre-apply updates such as fees
-union TransactionMeta switch (int v)
-{
-case 0:
-    OperationMeta operations<>;
-case 1:
-    TransactionMetaV1 v1;
-case 2:
-    TransactionMetaV2 v2;
-};
-
-// This struct groups together changes on a per transaction basis
-// note however that fees and transaction application are done in separate
-// phases
-struct TransactionResultMeta
-{
-    TransactionResultPair result;
-    LedgerEntryChanges feeProcessing;
-    TransactionMeta txApplyProcessing;
-};
-
-// this represents a single upgrade that was performed as part of a ledger
-// upgrade
-struct UpgradeEntryMeta
-{
-    LedgerUpgrade upgrade;
-    LedgerEntryChanges changes;
-};
-
-struct LedgerCloseMetaV0
-{
-    LedgerHeaderHistoryEntry ledgerHeader;
-    // NB: txSet is sorted in "Hash order"
-    TransactionSet txSet;
-
-    // NB: transactions are sorted in apply order here
-    // fees for all transactions are processed first
-    // followed by applying transactions
-    TransactionResultMeta txProcessing<>;
-
-    // upgrades are applied last
-    UpgradeEntryMeta upgradesProcessing<>;
-
-    // other misc information attached to the ledger close
-    SCPHistoryEntry scpInfo<>;
-};
-
-union LedgerCloseMeta switch (int v)
-{
-case 0:
-     LedgerCloseMetaV0 v0;
-};
-
-}