Merge branch 'master' into anchor-387-withdrawal

contents/cap-0046/Stellar-contract-config-setting.x

@@ -0,0 +1,247 @@
+%#include "xdr/Stellar-types.h"
+
+namespace stellar {
+// General “Soroban execution lane” settings
+struct ConfigSettingContractExecutionLanesV0
+{
+    // maximum number of Soroban transactions per ledger
+    uint32 ledgerMaxTxCount;
+};
+
+// "Compute" settings for contracts (instructions and memory).
+struct ConfigSettingContractComputeV0
+{
+    // Maximum instructions per ledger
+    int64 ledgerMaxInstructions;
+    // Maximum instructions per transaction
+    int64 txMaxInstructions;
+    // Cost of 10000 instructions
+    int64 feeRatePerInstructionsIncrement;
+
+    // Memory limit per transaction. Unlike instructions, there is no fee
+    // for memory, just the limit.
+    uint32 txMemoryLimit;
+};
+
+// Ledger access settings for contracts.
+struct ConfigSettingContractLedgerCostV0
+{
+    // Maximum number of ledger entry read operations per ledger
+    uint32 ledgerMaxReadLedgerEntries;
+    // Maximum number of bytes that can be read per ledger
+    uint32 ledgerMaxReadBytes;
+    // Maximum number of ledger entry write operations per ledger
+    uint32 ledgerMaxWriteLedgerEntries;
+    // Maximum number of bytes that can be written per ledger
+    uint32 ledgerMaxWriteBytes;
+
+    // Maximum number of ledger entry read operations per transaction
+    uint32 txMaxReadLedgerEntries;
+    // Maximum number of bytes that can be read per transaction
+    uint32 txMaxReadBytes;
+    // Maximum number of ledger entry write operations per transaction
+    uint32 txMaxWriteLedgerEntries;
+    // Maximum number of bytes that can be written per transaction
+    uint32 txMaxWriteBytes;
+
+    int64 feeReadLedgerEntry;  // Fee per ledger entry read
+    int64 feeWriteLedgerEntry; // Fee per ledger entry write
+
+    int64 feeRead1KB;  // Fee for reading 1KB
+
+    // The following parameters determine the write fee per 1KB.
+    // Write fee grows linearly until bucket list reaches this size
+    int64 bucketListTargetSizeBytes;
+    // Fee per 1KB write when the bucket list is empty
+    int64 writeFee1KBBucketListLow;
+    // Fee per 1KB write when the bucket list has reached `bucketListTargetSizeBytes` 
+    int64 writeFee1KBBucketListHigh;
+    // Write fee multiplier for any additional data past the first `bucketListTargetSizeBytes`
+    uint32 bucketListWriteFeeGrowthFactor;
+};
+
+// Historical data (pushed to core archives) settings for contracts.
+struct ConfigSettingContractHistoricalDataV0
+{
+    int64 feeHistorical1KB; // Fee for storing 1KB in archives
+};
+
+// Contract event-related settings.
+struct ConfigSettingContractEventsV0
+{
+    // Maximum size of events that a contract call can emit.
+    uint32 txMaxContractEventsSizeBytes;
+    // Fee for generating 1KB of contract events.
+    int64 feeContractEvents1KB;
+};
+
+// Bandwidth related data settings for contracts.
+// We consider bandwidth to only be consumed by the transaction envelopes, hence
+// this concerns only transaction sizes.
+struct ConfigSettingContractBandwidthV0
+{
+    // Maximum sum of all transaction sizes in the ledger in bytes
+    uint32 ledgerMaxTxsSizeBytes;
+    // Maximum size in bytes for a transaction
+    uint32 txMaxSizeBytes;
+
+    // Fee for 1 KB of transaction size
+    int64 feeTxSize1KB;
+};
+
+enum ContractCostType {
+    // Cost of running 1 wasm instruction
+    WasmInsnExec = 0,
+    // Cost of growing wasm linear memory by 1 page
+    WasmMemAlloc = 1,
+    // Cost of allocating a chuck of host memory (in bytes)
+    HostMemAlloc = 2,
+    // Cost of copying a chuck of bytes into a pre-allocated host memory
+    HostMemCpy = 3,
+    // Cost of comparing two slices of host memory
+    HostMemCmp = 4,
+    // Cost of a host function dispatch, not including the actual work done by
+    // the function nor the cost of VM invocation machinary
+    DispatchHostFunction = 5,
+    // Cost of visiting a host object from the host object storage. Exists to 
+    // make sure some baseline cost coverage, i.e. repeatly visiting objects
+    // by the guest will always incur some charges.
+    VisitObject = 6,
+    // Cost of serializing an xdr object to bytes
+    ValSer = 7,
+    // Cost of deserializing an xdr object from bytes
+    ValDeser = 8,
+    // Cost of computing the sha256 hash from bytes
+    ComputeSha256Hash = 9,
+    // Cost of computing the ed25519 pubkey from bytes
+    ComputeEd25519PubKey = 10,
+    // Cost of accessing an entry in a Map.
+    MapEntry = 11,
+    // Cost of accessing an entry in a Vec
+    VecEntry = 12,
+    // Cost of verifying ed25519 signature of a payload.
+    VerifyEd25519Sig = 13,
+    // Cost of reading a slice of vm linear memory
+    VmMemRead = 14,
+    // Cost of writing to a slice of vm linear memory
+    VmMemWrite = 15,
+    // Cost of instantiation a VM from wasm bytes code.
+    VmInstantiation = 16,
+    // Cost of instantiation a VM from a cached state.
+    VmCachedInstantiation = 17,
+    // Cost of invoking a function on the VM. If the function is a host function,
+    // additional cost will be covered by `DispatchHostFunction`.
+    InvokeVmFunction = 18,
+    // Cost of computing a keccak256 hash from bytes.
+    ComputeKeccak256Hash = 19,
+    // Cost of computing an ECDSA secp256k1 pubkey from bytes.
+    ComputeEcdsaSecp256k1Key = 20,
+    // Cost of computing an ECDSA secp256k1 signature from bytes.
+    ComputeEcdsaSecp256k1Sig = 21,
+    // Cost of recovering an ECDSA secp256k1 key from a signature.
+    RecoverEcdsaSecp256k1Key = 22,
+    // Cost of int256 addition (`+`) and subtraction (`-`) operations
+    Int256AddSub = 23,
+    // Cost of int256 multiplication (`*`) operation
+    Int256Mul = 24,
+    // Cost of int256 division (`/`) operation
+    Int256Div = 25,
+    // Cost of int256 power (`exp`) operation
+    Int256Pow = 26,
+    // Cost of int256 shift (`shl`, `shr`) operation
+    Int256Shift = 27
+};
+
+struct ContractCostParamEntry {
+    // use `ext` to add more terms (e.g. higher order polynomials) in the future
+    ExtensionPoint ext;
+
+    int64 constTerm;
+    int64 linearTerm;
+};
+
+struct StateExpirationSettings {
+    uint32 maxEntryExpiration;
+    uint32 minTempEntryExpiration;
+    uint32 minPersistentEntryExpiration;
+    uint32 autoBumpLedgers;
+
+    // rent_fee = wfee_rate_average / rent_rate_denominator_for_type
+    int64 persistentRentRateDenominator;
+    int64 tempRentRateDenominator;
+
+    // max number of entries that emit expiration meta in a single ledger
+    uint32 maxEntriesToExpire;
+
+    // Number of snapshots to use when calculating average BucketList size
+    uint32 bucketListSizeWindowSampleSize;
+
+    // Maximum number of bytes that we scan for eviction per ledger
+    uint64 evictionScanSize;
+
+    // Lowest BucketList level to be scanned to evict entries
+    uint32 startingEvictionScanLevel;
+};
+
+struct EvictionIterator {
+    uint32 bucketListLevel;
+    bool isCurrBucket;
+    uint64 bucketFileOffset;
+};
+
+// limits the ContractCostParams size to 20kB
+const CONTRACT_COST_COUNT_LIMIT = 1024;
+
+typedef ContractCostParamEntry ContractCostParams<CONTRACT_COST_COUNT_LIMIT>;
+
+// Identifiers of all the network settings.
+enum ConfigSettingID
+{
+    CONFIG_SETTING_CONTRACT_MAX_SIZE_BYTES = 0,
+    CONFIG_SETTING_CONTRACT_COMPUTE_V0 = 1,
+    CONFIG_SETTING_CONTRACT_LEDGER_COST_V0 = 2,
+    CONFIG_SETTING_CONTRACT_HISTORICAL_DATA_V0 = 3,
+    CONFIG_SETTING_CONTRACT_EVENTS_V0 = 4,
+    CONFIG_SETTING_CONTRACT_BANDWIDTH_V0 = 5,
+    CONFIG_SETTING_CONTRACT_COST_PARAMS_CPU_INSTRUCTIONS = 6,
+    CONFIG_SETTING_CONTRACT_COST_PARAMS_MEMORY_BYTES = 7,
+    CONFIG_SETTING_CONTRACT_DATA_KEY_SIZE_BYTES = 8,
+    CONFIG_SETTING_CONTRACT_DATA_ENTRY_SIZE_BYTES = 9,
+    CONFIG_SETTING_STATE_EXPIRATION = 10,
+    CONFIG_SETTING_CONTRACT_EXECUTION_LANES = 11,
+    CONFIG_SETTING_BUCKETLIST_SIZE_WINDOW = 12,
+    CONFIG_SETTING_EVICTION_ITERATOR = 13
+};
+
+union ConfigSettingEntry switch (ConfigSettingID configSettingID)
+{
+case CONFIG_SETTING_CONTRACT_MAX_SIZE_BYTES:
+    uint32 contractMaxSizeBytes;
+case CONFIG_SETTING_CONTRACT_COMPUTE_V0:
+    ConfigSettingContractComputeV0 contractCompute;
+case CONFIG_SETTING_CONTRACT_LEDGER_COST_V0:
+    ConfigSettingContractLedgerCostV0 contractLedgerCost;
+case CONFIG_SETTING_CONTRACT_HISTORICAL_DATA_V0:
+    ConfigSettingContractHistoricalDataV0 contractHistoricalData;
+case CONFIG_SETTING_CONTRACT_EVENTS_V0:
+    ConfigSettingContractEventsV0 contractEvents;
+case CONFIG_SETTING_CONTRACT_BANDWIDTH_V0:
+    ConfigSettingContractBandwidthV0 contractBandwidth;
+case CONFIG_SETTING_CONTRACT_COST_PARAMS_CPU_INSTRUCTIONS:
+    ContractCostParams contractCostParamsCpuInsns;
+case CONFIG_SETTING_CONTRACT_COST_PARAMS_MEMORY_BYTES:
+    ContractCostParams contractCostParamsMemBytes;
+case CONFIG_SETTING_CONTRACT_DATA_KEY_SIZE_BYTES:
+    uint32 contractDataKeySizeBytes;
+case CONFIG_SETTING_CONTRACT_DATA_ENTRY_SIZE_BYTES:
+    uint32 contractDataEntrySizeBytes;
+case CONFIG_SETTING_STATE_EXPIRATION:
+    StateExpirationSettings stateExpirationSettings;
+case CONFIG_SETTING_CONTRACT_EXECUTION_LANES:
+    ConfigSettingContractExecutionLanesV0 contractExecutionLanes;
+case CONFIG_SETTING_BUCKETLIST_SIZE_WINDOW:
+    uint64 bucketListSizeWindow<>;
+case CONFIG_SETTING_EVICTION_ITERATOR:
+    EvictionIterator evictionIterator;
+};
+}