Skip to content
This repository has been archived by the owner on Aug 14, 2023. It is now read-only.

Moving from App to Account terminology - Part 6 #284

Merged
merged 21 commits into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6adf158
Renaming `App` to `Account`
YaronWittenstein Jul 14, 2021
b2bbef7
Ready for review.
YaronWittenstein Jul 14, 2021
e2bae16
Renamig `SpawnAppReceipt` to `SpawnReceipt`
YaronWittenstein Jul 14, 2021
2bfbc7a
Merge branch 'master' into app-term-deprecation-2
YaronWittenstein Jul 14, 2021
9ec985e
cargo fmt
YaronWittenstein Jul 14, 2021
6d1d378
Merge branch 'master' into app-term-deprecation-3
YaronWittenstein Jul 14, 2021
ae9239a
Renaming `AppAddr` to `AccountAddr`
YaronWittenstein Jul 14, 2021
546ed3a
Merge branch 'master' into app-term-deprecation-3
YaronWittenstein Jul 14, 2021
e2e0166
cargo fmt
YaronWittenstein Jul 14, 2021
e4552a3
Rename `SpawnApp` -> `SpawnAccount`
YaronWittenstein Jul 14, 2021
86e675b
Merge branch 'master' into app-term-deprecation-4
YaronWittenstein Jul 14, 2021
e38e9b6
`RuntimeError` - renaming fields from `app_addr` -> `account_addr`
YaronWittenstein Jul 14, 2021
bcf54a2
code compiles.
YaronWittenstein Jul 14, 2021
2185686
WIP: finishing the migration for the `svm-types` crate.
YaronWittenstein Jul 14, 2021
ebe85ba
tests pass
YaronWittenstein Jul 14, 2021
e168fb4
Merge branch 'app-term-deprecation-4' into app-term-deprecation-5
YaronWittenstein Jul 14, 2021
ebfff86
Merge branch 'master' into app-term-deprecation-5
YaronWittenstein Jul 14, 2021
8e5d279
`Transaction` - rename `app` to `target`
YaronWittenstein Jul 14, 2021
beff562
Renaming Receipts types.
YaronWittenstein Jul 14, 2021
e0e9f6b
cargo fmt
YaronWittenstein Jul 14, 2021
b4056c3
Merge branch 'master' into app-term-deprecation-6
YaronWittenstein Jul 14, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions crates/codec/src/api/json/receipt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ use crate::api::json::{self, JsonError};
use crate::receipt;

use svm_types::RuntimeError;
use svm_types::{CallReceipt, Receipt, ReceiptLog, SpawnReceipt, TemplateReceipt};
use svm_types::{CallReceipt, DeployReceipt, Receipt, ReceiptLog, SpawnReceipt};

/// Given a binary Receipt wrappend inside a JSON,
/// Given a binary Receipt wrapped inside a JSON,
/// decodes it into a user-friendly JSON.
pub fn decode_receipt(json: &Value) -> Result<Value, JsonError> {
let data = json::as_string(json, "data")?;
Expand All @@ -19,9 +19,9 @@ pub fn decode_receipt(json: &Value) -> Result<Value, JsonError> {

let json = if receipt.success() {
match receipt {
Receipt::DeployTemplate(receipt) => decode_deploy_template(&receipt, ty),
Receipt::SpawnApp(receipt) => decode_spawn_app(&receipt, ty),
Receipt::ExecApp(receipt) => decode_exe_app(&receipt, ty),
Receipt::Deploy(receipt) => decode_deploy_template(&receipt, ty),
Receipt::Spawn(receipt) => decode_spawn_app(&receipt, ty),
Receipt::Call(receipt) => decode_exe_app(&receipt, ty),
}
} else {
let ty = receipt_type(&receipt);
Expand All @@ -36,9 +36,9 @@ pub fn decode_receipt(json: &Value) -> Result<Value, JsonError> {

fn receipt_type(receipt: &Receipt) -> &'static str {
match receipt {
Receipt::DeployTemplate(..) => "deploy-template",
Receipt::SpawnApp(..) => "spawn-app",
Receipt::ExecApp(..) => "exec-app",
Receipt::Deploy(..) => "deploy-template",
Receipt::Spawn(..) => "spawn-app",
Receipt::Call(..) => "exec-app",
}
}

Expand Down Expand Up @@ -135,11 +135,11 @@ fn decode_error(ty: &'static str, err: &RuntimeError, logs: &[ReceiptLog]) -> Va
map.into()
}

fn decode_deploy_template(receipt: &TemplateReceipt, ty: &'static str) -> Value {
fn decode_deploy_template(receipt: &DeployReceipt, ty: &'static str) -> Value {
debug_assert!(receipt.success);
debug_assert!(receipt.error.is_none());

let TemplateReceipt {
let DeployReceipt {
addr,
gas_used,
logs,
Expand Down Expand Up @@ -224,7 +224,7 @@ mod tests {
},
];

let receipt = TemplateReceipt {
let receipt = DeployReceipt {
version: 0,
success: true,
error: None,
Expand Down
20 changes: 10 additions & 10 deletions crates/codec/src/receipt/deploy_template.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@

use std::io::Cursor;

use svm_types::TemplateReceipt;
use svm_types::DeployReceipt;

use super::{decode_error, encode_error, gas, logs, types};

use crate::version;
use crate::{ReadExt, WriteExt};

/// Encodes a `deploy-template` into its binary format.
pub fn encode_template_receipt(receipt: &TemplateReceipt) -> Vec<u8> {
pub fn encode_template_receipt(receipt: &DeployReceipt) -> Vec<u8> {
let mut w = Vec::new();

w.write_byte(types::DEPLOY_TEMPLATE);
Expand All @@ -42,7 +42,7 @@ pub fn encode_template_receipt(receipt: &TemplateReceipt) -> Vec<u8> {
}

/// Decodes a binary `deploy-template` transaction into its Rust struct.
pub fn decode_template_receipt(bytes: &[u8]) -> TemplateReceipt {
pub fn decode_template_receipt(bytes: &[u8]) -> DeployReceipt {
let mut cursor = Cursor::new(bytes);

let ty = cursor.read_byte().unwrap();
Expand All @@ -57,14 +57,14 @@ pub fn decode_template_receipt(bytes: &[u8]) -> TemplateReceipt {
false => {
let (err, logs) = decode_error(&mut cursor);

TemplateReceipt::from_err(err, logs)
DeployReceipt::from_err(err, logs)
}
true => {
let addr = cursor.read_address().expect("expected an address");
let gas_used = gas::decode_gas_used(&mut cursor).unwrap();
let logs = logs::decode_logs(&mut cursor).unwrap();

TemplateReceipt {
DeployReceipt {
version,
success: true,
error: None,
Expand All @@ -76,13 +76,13 @@ pub fn decode_template_receipt(bytes: &[u8]) -> TemplateReceipt {
}
}

fn encode_version(receipt: &TemplateReceipt, w: &mut Vec<u8>) {
fn encode_version(receipt: &DeployReceipt, w: &mut Vec<u8>) {
let v = receipt.version;

version::encode_version(v, w);
}

fn encode_template_addr(receipt: &TemplateReceipt, w: &mut Vec<u8>) {
fn encode_template_addr(receipt: &DeployReceipt, w: &mut Vec<u8>) {
debug_assert!(receipt.success);

let addr = receipt.template_addr();
Expand All @@ -94,15 +94,15 @@ fn encode_template_addr(receipt: &TemplateReceipt, w: &mut Vec<u8>) {
mod tests {
use super::*;

use svm_types::{Address, Gas, TemplateReceipt};
use svm_types::{Address, DeployReceipt, Gas};

use crate::receipt::decode_receipt;

#[test]
fn encode_decode_deploy_template_receipt() {
let addr = Address::repeat(0xAB);

let receipt = TemplateReceipt {
let receipt = DeployReceipt {
version: 0,
success: true,
error: None,
Expand All @@ -114,6 +114,6 @@ mod tests {
let bytes = encode_template_receipt(&receipt);
let decoded = decode_receipt(&bytes);

assert_eq!(decoded.into_deploy_template(), receipt);
assert_eq!(decoded.into_deploy(), receipt);
}
}
6 changes: 3 additions & 3 deletions crates/codec/src/receipt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ pub fn decode_receipt(bytes: &[u8]) -> Receipt {
match ty {
types::DEPLOY_TEMPLATE => {
let receipt = decode_template_receipt(bytes);
Receipt::DeployTemplate(receipt)
Receipt::Deploy(receipt)
}
types::SPAWN_APP => {
let receipt = decode_app_receipt(bytes);
Receipt::SpawnApp(receipt)
Receipt::Spawn(receipt)
}
types::EXEC_APP => {
let receipt = decode_exec_receipt(bytes);
Receipt::ExecApp(receipt)
Receipt::Call(receipt)
}
_ => unreachable!(),
}
Expand Down
6 changes: 2 additions & 4 deletions crates/runtime-ffi/tests/api_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,7 @@ fn svm_runtime_failure() {
assert!(res.is_ok());

// extract the `Template Address` out of the `Receipt`
let receipt =
receipt::decode_receipt(template_receipt.clone().into()).into_deploy_template();
let receipt = receipt::decode_receipt(template_receipt.clone().into()).into_deploy();
let template_addr: &Address = receipt.template_addr().inner();
let template_addr: svm_byte_array = (TEMPLATE_ADDR, template_addr).into();

Expand Down Expand Up @@ -304,8 +303,7 @@ fn svm_runtime_success() {
assert!(res.is_ok());

// extract the `template-address` out of the receipt
let receipt =
receipt::decode_receipt(template_receipt.clone().into()).into_deploy_template();
let receipt = receipt::decode_receipt(template_receipt.clone().into()).into_deploy();
let template_addr: &Address = receipt.template_addr().inner();
let template_addr: svm_byte_array = (TEMPLATE_ADDR, template_addr).into();

Expand Down
8 changes: 4 additions & 4 deletions crates/runtime/src/runtime/default.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use svm_storage::app::AppStorage;
use svm_types::GasMode;
use svm_types::SectionKind;
use svm_types::{AccountAddr, DeployerAddr, SpawnerAddr, State, Template};
use svm_types::{CallReceipt, ReceiptLog, SpawnReceipt, TemplateReceipt};
use svm_types::{CallReceipt, DeployReceipt, ReceiptLog, SpawnReceipt};
use svm_types::{Gas, OOGError};
use svm_types::{RuntimeError, Transaction};
use wasmer::{Instance, Module, WasmPtr, WasmTypeList};
Expand Down Expand Up @@ -583,7 +583,7 @@ where
bytes: &[u8],
_deployer: &DeployerAddr,
gas_limit: Gas,
) -> TemplateReceipt {
) -> DeployReceipt {
info!("Deploying a template.");

let template = self.env.parse_deploy_template(bytes, None).unwrap();
Expand All @@ -595,9 +595,9 @@ where
let addr = self.env.compute_template_addr(&template);

self.env.store_template(&template, &addr);
TemplateReceipt::new(addr, gas_used)
DeployReceipt::new(addr, gas_used)
} else {
TemplateReceipt::new_oog()
DeployReceipt::new_oog()
}
}

Expand Down
6 changes: 3 additions & 3 deletions crates/runtime/src/runtime/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ pub use default::DefaultRuntime;
pub use ptr::RuntimePtr;

use svm_types::{
CallReceipt, DeployerAddr, Gas, RuntimeError, SpawnReceipt, SpawnerAddr, State,
TemplateReceipt, Transaction,
CallReceipt, DeployReceipt, DeployerAddr, Gas, RuntimeError, SpawnReceipt, SpawnerAddr, State,
Transaction,
};

use crate::error::ValidateError;
Expand All @@ -51,7 +51,7 @@ pub trait Runtime {
bytes: &[u8],
deployer: &DeployerAddr,
gas_limit: Gas,
) -> TemplateReceipt;
) -> DeployReceipt;

/// Spawns a new app out of an existing app-template.
fn spawn_app(&mut self, bytes: &[u8], spawner: &SpawnerAddr, gas_limit: Gas) -> SpawnReceipt;
Expand Down
4 changes: 2 additions & 2 deletions crates/runtime/tests/runtime_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use svm_layout::FixedLayout;
use svm_runtime::{testing, Runtime, ValidateError};

use svm_types::{Address, Gas, RuntimeError};
use svm_types::{SpawnReceipt, TemplateReceipt};
use svm_types::{DeployReceipt, SpawnReceipt};

fn memory_runtime() -> impl Runtime {
let state_kv = testing::memory_state_kv_init();
Expand Down Expand Up @@ -97,7 +97,7 @@ fn memory_runtime_deploy_template_reaches_oog() {
include_str!("wasm/runtime_app_ctor.wast").into(),
);

let expected = TemplateReceipt::new_oog();
let expected = DeployReceipt::new_oog();
let actual = runtime.deploy_template(&bytes, &deployer, maybe_gas);
assert_eq!(expected, actual);
}
Expand Down
2 changes: 1 addition & 1 deletion crates/types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pub use gas::{Gas, GasMode, OOGError};
mod receipt;

pub use receipt::{
into_spawn_receipt, CallReceipt, Receipt, ReceiptLog, ReceiptRef, SpawnReceipt, TemplateReceipt,
into_spawn_receipt, CallReceipt, DeployReceipt, Receipt, ReceiptLog, ReceiptRef, SpawnReceipt,
};

/// Address-related types
Expand Down
4 changes: 2 additions & 2 deletions crates/types/src/receipt/deploy_template.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::{Gas, TemplateAddr};
/// [`TemplateReceipt`] should *not* be wrapped in a [`Result`] for failure
/// detection; error detection is built-in the type itself.
#[derive(Debug, PartialEq, Clone)]
pub struct TemplateReceipt {
pub struct DeployReceipt {
/// Transaction format version
pub version: u16,

Expand All @@ -27,7 +27,7 @@ pub struct TemplateReceipt {
pub logs: Vec<ReceiptLog>,
}

impl TemplateReceipt {
impl DeployReceipt {
/// Creates a [`TemplateReceipt`] which indicates a successful deployment of
/// the template located at `addr` which cost `gas_used`.
pub fn new(addr: TemplateAddr, gas_used: Gas) -> Self {
Expand Down
Loading