Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transaction changes to support Soroban fee model. #84

Merged
merged 7 commits into from
Apr 26, 2023
85 changes: 62 additions & 23 deletions Stellar-transaction.x
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
namespace stellar
{

// maximum number of operations per transaction
const MAX_OPS_PER_TX = 100;

union LiquidityPoolParameters switch (LiquidityPoolType type)
{
case LIQUIDITY_POOL_CONSTANT_PRODUCT:
Expand All @@ -33,13 +36,6 @@ struct DecoratedSignature
Signature signature; // actual signature
};

// Ledger key sets touched by a smart contract transaction.
struct LedgerFootprint
{
LedgerKey readOnly<>;
LedgerKey readWrite<>;
};

enum OperationType
{
CREATE_ACCOUNT = 0,
Expand Down Expand Up @@ -478,7 +474,7 @@ enum HostFunctionType
{
HOST_FUNCTION_TYPE_INVOKE_CONTRACT = 0,
HOST_FUNCTION_TYPE_CREATE_CONTRACT = 1,
HOST_FUNCTION_TYPE_INSTALL_CONTRACT_CODE = 2
HOST_FUNCTION_TYPE_UPLOAD_CONTRACT_WASM = 2
};

enum ContractIDType
Expand All @@ -494,7 +490,7 @@ enum ContractIDPublicKeyType
CONTRACT_ID_PUBLIC_KEY_ED25519 = 1
};

struct InstallContractCodeArgs
struct UploadContractWasmArgs
{
opaque code<SCVAL_LIMIT>;
};
Expand All @@ -520,14 +516,14 @@ struct CreateContractArgs
SCContractExecutable source;
};

union HostFunction switch (HostFunctionType type)
union HostFunctionArgs switch (HostFunctionType type)
{
case HOST_FUNCTION_TYPE_INVOKE_CONTRACT:
SCVec invokeArgs;
SCVec invokeContract;
case HOST_FUNCTION_TYPE_CREATE_CONTRACT:
CreateContractArgs createContractArgs;
case HOST_FUNCTION_TYPE_INSTALL_CONTRACT_CODE:
InstallContractCodeArgs installContractCodeArgs;
CreateContractArgs createContract;
case HOST_FUNCTION_TYPE_UPLOAD_CONTRACT_WASM:
UploadContractWasmArgs uploadContractWasm;
};

struct AuthorizedInvocation
Expand All @@ -551,17 +547,24 @@ struct ContractAuth
SCVec signatureArgs;
};

struct InvokeHostFunctionOp
{
// The host function to invoke
HostFunction function;
// The footprint for this invocation
LedgerFootprint footprint;
struct HostFunction {
// Arguments of the function to call defined by the function
// type.
HostFunctionArgs args;
// Per-address authorizations for this host fn
// Currently only supported for INVOKE_CONTRACT function
ContractAuth auth<>;
};

struct InvokeHostFunctionOp
{
// The host functions to invoke. The functions will be executed
// in the same fashion as operations: either all functions will
// be successfully applied or all fail if at least one of them
// fails.
HostFunction functions<MAX_OPS_PER_TX>;
sisuresh marked this conversation as resolved.
Show resolved Hide resolved
};

/* An operation is the lowest unit of work that a transaction does */
struct Operation
{
Expand Down Expand Up @@ -772,8 +775,40 @@ case PRECOND_V2:
PreconditionsV2 v2;
};

// maximum number of operations per transaction
const MAX_OPS_PER_TX = 100;
// Ledger key sets touched by a smart contract transaction.
struct LedgerFootprint
{
LedgerKey readOnly<>;
LedgerKey readWrite<>;
};

// Resource limits for a Soroban transaction.
// The transaction will fail if it exceeds any of these limits.
struct SorobanResources
{
// The ledger footprint of the transaction.
LedgerFootprint footprint;
// The maximum number of instructions this transaction can use
uint32 instructions;

// The maximum number of bytes this transaction can read from ledger
uint32 readBytes;
// The maximum number of bytes this transaction can write to ledger
uint32 writeBytes;

// Maximum size of dynamic metadata produced by this contract (
// currently only includes the events).
uint32 extendedMetaDataSizeBytes;
};

// The transaction extension for Soroban.
struct SorobanTransactionData
{
SorobanResources resources;
// Portion of transaction `fee` allocated to refundable fees.
int64 refundableFee;
ExtensionPoint ext;
};

// TransactionV0 is a transaction with the AccountID discriminant stripped off,
// leaving a raw ed25519 public key to identify the source account. This is used
Expand Down Expand Up @@ -835,6 +870,8 @@ struct Transaction
{
case 0:
void;
case 1:
SorobanTransactionData sorobanData;
}
ext;
};
Expand Down Expand Up @@ -1850,7 +1887,9 @@ enum TransactionResultCode
txBAD_SPONSORSHIP = -14, // sponsorship not confirmed
txBAD_MIN_SEQ_AGE_OR_GAP =
-15, // minSeqAge or minSeqLedgerGap conditions not met
txMALFORMED = -16 // precondition is invalid
txMALFORMED = -16, // precondition is invalid
// declared Soroban resource usage exceeds the network limit
txSOROBAN_RESOURCE_LIMIT_EXCEEDED = -17
};

// InnerTransactionResult must be binary compatible with TransactionResult
Expand Down