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.

Sign up for GitHub

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

Jump to bottom

[cli] Make large packages module address configurable #15118

Merged
merged 3 commits into from
Oct 30, 2024
Merged

[cli] Make large packages module address configurable #15118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fd92a6
[cli] Make large packages module address configurable
0xjunha Oct 30, 2024
39c1371
Fix cli test case
0xjunha Oct 30, 2024
7237d82
Fix to use clap default_value
0xjunha Oct 30, 2024
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
1 change: 1 addition & 0 deletions aptos-move/e2e-move-tests/src/tests/large_package_publishing.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ impl LargePackageTestContext {
package_code,
publish_type,
Some(self.object_address),
LARGE_PACKAGES_MODULE_ADDRESS,
)
}
}
Expand Down
31 changes: 23 additions & 8 deletions aptos-move/framework/src/chunked_publish.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
use aptos_types::transaction::{EntryFunction, TransactionPayload};
use move_core_types::{account_address::AccountAddress, ident_str, language_storage::ModuleId};

/// The default address where the `large_packages.move` module is deployed.
/// This address is used on both mainnet and testnet.
pub const LARGE_PACKAGES_MODULE_ADDRESS: &str =
"0x0e1ca3011bdd07246d4d16d909dbb2d6953a86c4735d5acf5865d962c630cce7"; // mainnet and testnet
"0x0e1ca3011bdd07246d4d16d909dbb2d6953a86c4735d5acf5865d962c630cce7";

/// Maximum code & metadata chunk size to be included in a transaction
pub const MAX_CHUNK_SIZE_IN_BYTES: usize = 60_000;
Expand All @@ -21,6 +23,7 @@ pub fn chunk_package_and_create_payloads(
package_code: Vec<Vec<u8>>,
publish_type: PublishType,
object_address: Option<AccountAddress>,
large_packages_module_address: &str,
) -> Vec<TransactionPayload> {
// Chunk the metadata
let mut metadata_chunks = create_chunks(metadata);
Expand All @@ -30,7 +33,9 @@ pub fn chunk_package_and_create_payloads(
let mut taken_size = metadata_chunk.len();
let mut payloads = metadata_chunks
.into_iter()
.map(|chunk| large_packages_stage_code_chunk(chunk, vec![], vec![]))
.map(|chunk| {
large_packages_stage_code_chunk(chunk, vec![], vec![], large_packages_module_address)
})
.collect::<Vec<_>>();

let mut code_indices: Vec<u16> = vec![];
Expand All @@ -45,6 +50,7 @@ pub fn chunk_package_and_create_payloads(
metadata_chunk,
code_indices.clone(),
code_chunks.clone(),
large_packages_module_address,
);
payloads.push(payload);

Expand All @@ -66,17 +72,20 @@ pub fn chunk_package_and_create_payloads(
metadata_chunk,
code_indices,
code_chunks,
large_packages_module_address,
),
PublishType::ObjectDeploy => large_packages_stage_code_chunk_and_publish_to_object(
metadata_chunk,
code_indices,
code_chunks,
large_packages_module_address,
),
PublishType::ObjectUpgrade => large_packages_stage_code_chunk_and_upgrade_object_code(
metadata_chunk,
code_indices,
code_chunks,
object_address.expect("ObjectAddress is missing"),
large_packages_module_address,
),
};
payloads.push(payload);
Expand All @@ -96,10 +105,11 @@ fn large_packages_stage_code_chunk(
metadata_chunk: Vec<u8>,
code_indices: Vec<u16>,
code_chunks: Vec<Vec<u8>>,
large_packages_module_address: &str,
) -> TransactionPayload {
TransactionPayload::EntryFunction(EntryFunction::new(
ModuleId::new(
AccountAddress::from_hex_literal(LARGE_PACKAGES_MODULE_ADDRESS).unwrap(),
AccountAddress::from_hex_literal(large_packages_module_address).unwrap(),
ident_str!("large_packages").to_owned(),
),
ident_str!("stage_code_chunk").to_owned(),
Expand All @@ -117,10 +127,11 @@ fn large_packages_stage_code_chunk_and_publish_to_account(
metadata_chunk: Vec<u8>,
code_indices: Vec<u16>,
code_chunks: Vec<Vec<u8>>,
large_packages_module_address: &str,
) -> TransactionPayload {
TransactionPayload::EntryFunction(EntryFunction::new(
ModuleId::new(
AccountAddress::from_hex_literal(LARGE_PACKAGES_MODULE_ADDRESS).unwrap(),
AccountAddress::from_hex_literal(large_packages_module_address).unwrap(),
ident_str!("large_packages").to_owned(),
),
ident_str!("stage_code_chunk_and_publish_to_account").to_owned(),
Expand All @@ -138,10 +149,11 @@ fn large_packages_stage_code_chunk_and_publish_to_object(
metadata_chunk: Vec<u8>,
code_indices: Vec<u16>,
code_chunks: Vec<Vec<u8>>,
large_packages_module_address: &str,
) -> TransactionPayload {
TransactionPayload::EntryFunction(EntryFunction::new(
ModuleId::new(
AccountAddress::from_hex_literal(LARGE_PACKAGES_MODULE_ADDRESS).unwrap(),
AccountAddress::from_hex_literal(large_packages_module_address).unwrap(),
ident_str!("large_packages").to_owned(),
),
ident_str!("stage_code_chunk_and_publish_to_object").to_owned(),
Expand All @@ -160,10 +172,11 @@ fn large_packages_stage_code_chunk_and_upgrade_object_code(
code_indices: Vec<u16>,
code_chunks: Vec<Vec<u8>>,
code_object: AccountAddress,
large_packages_module_address: &str,
) -> TransactionPayload {
TransactionPayload::EntryFunction(EntryFunction::new(
ModuleId::new(
AccountAddress::from_hex_literal(LARGE_PACKAGES_MODULE_ADDRESS).unwrap(),
AccountAddress::from_hex_literal(large_packages_module_address).unwrap(),
ident_str!("large_packages").to_owned(),
),
ident_str!("stage_code_chunk_and_upgrade_object_code").to_owned(),
Expand All @@ -178,10 +191,12 @@ fn large_packages_stage_code_chunk_and_upgrade_object_code(
}

// Cleanup account's `StagingArea` resource.
pub fn large_packages_cleanup_staging_area() -> TransactionPayload {
pub fn large_packages_cleanup_staging_area(
large_packages_module_address: &str,
) -> TransactionPayload {
TransactionPayload::EntryFunction(EntryFunction::new(
ModuleId::new(
AccountAddress::from_hex_literal(LARGE_PACKAGES_MODULE_ADDRESS).unwrap(),
AccountAddress::from_hex_literal(large_packages_module_address).unwrap(),
ident_str!("large_packages").to_owned(),
),
ident_str!("cleanup_staging_area").to_owned(),
Expand Down
5 changes: 5 additions & 0 deletions crates/aptos/src/common/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ use aptos_crypto::{
encoding_type::{EncodingError, EncodingType},
x25519, PrivateKey, ValidCryptoMaterialStringExt,
};
use aptos_framework::chunked_publish::LARGE_PACKAGES_MODULE_ADDRESS;
use aptos_global_constants::adjust_gas_headroom;
use aptos_keygen::KeyGen;
use aptos_logger::Level;
Expand Down Expand Up @@ -2350,4 +2351,8 @@ pub struct ChunkedPublishOption {
/// Use this option for publishing large packages exceeding `MAX_PUBLISH_PACKAGE_SIZE`.
#[clap(long)]
pub(crate) chunked_publish: bool,

/// Address of the `large_packages` move module for chunked publishing
#[clap(long, default_value = LARGE_PACKAGES_MODULE_ADDRESS)]
pub(crate) large_packages_module_address: String,
}
99 changes: 77 additions & 22 deletions crates/aptos/src/move_tool/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -816,8 +816,12 @@ impl AsyncTryInto<ChunkedPublishPayloads> for &PublishPackage {
async fn async_try_into(self) -> Result<ChunkedPublishPayloads, Self::Error> {
let package = build_package_options(&self.move_options, &self.included_artifacts_args)?;

let chunked_publish_payloads =
create_chunked_publish_payloads(package, PublishType::AccountDeploy, None)?;
let chunked_publish_payloads = create_chunked_publish_payloads(
package,
PublishType::AccountDeploy,
None,
&self.chunked_publish_option.large_packages_module_address,
)?;

let size = &chunked_publish_payloads
.payloads
Expand Down Expand Up @@ -1008,6 +1012,7 @@ fn create_chunked_publish_payloads(
package: BuiltPackage,
publish_type: PublishType,
object_address: Option<AccountAddress>,
large_packages_module_address: &str,
) -> CliTypedResult<ChunkedPublishPayloads> {
let compiled_units = package.extract_code();
let metadata = package.extract_metadata()?;
Expand All @@ -1024,6 +1029,7 @@ fn create_chunked_publish_payloads(
compiled_units,
publish_type,
maybe_object_address,
large_packages_module_address,
);

Ok(ChunkedPublishPayloads { payloads })
Expand All @@ -1044,6 +1050,7 @@ impl CliCommand<TransactionSummary> for PublishPackage {
submit_chunked_publish_transactions(
chunked_package_payloads.payloads,
&self.txn_options,
&self.chunked_publish_option.large_packages_module_address,
)
.await
} else {
Expand Down Expand Up @@ -1145,9 +1152,13 @@ impl CliCommand<TransactionSummary> for CreateObjectAndPublishPackage {
self.move_options
.add_named_address(self.address_name.clone(), mock_object_address.to_string());
let package = build_package_options(&self.move_options, &self.included_artifacts_args)?;
let mock_payloads =
create_chunked_publish_payloads(package, PublishType::AccountDeploy, None)?
.payloads;
let mock_payloads = create_chunked_publish_payloads(
package,
PublishType::AccountDeploy,
None,
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;
let staging_tx_count = (mock_payloads.len() - 1) as u64;
self.txn_options.sequence_number(sender_address).await? + staging_tx_count + 1
} else {
Expand All @@ -1167,8 +1178,13 @@ impl CliCommand<TransactionSummary> for CreateObjectAndPublishPackage {
prompt_yes_with_override(&message, self.txn_options.prompt_options)?;

let result = if self.chunked_publish_option.chunked_publish {
let payloads =
create_chunked_publish_payloads(package, PublishType::ObjectDeploy, None)?.payloads;
let payloads = create_chunked_publish_payloads(
package,
PublishType::ObjectDeploy,
None,
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;

let size = &payloads
.iter()
Expand All @@ -1178,7 +1194,12 @@ impl CliCommand<TransactionSummary> for CreateObjectAndPublishPackage {
let message = format!("Publishing package in chunked mode will submit {} transactions for staging and publishing code.\n", &payloads.len());
println!("{}", message.bold());

submit_chunked_publish_transactions(payloads, &self.txn_options).await
submit_chunked_publish_transactions(
payloads,
&self.txn_options,
&self.chunked_publish_option.large_packages_module_address,
)
.await
} else {
let payload = create_package_publication_data(
package,
Expand Down Expand Up @@ -1273,6 +1294,7 @@ impl CliCommand<TransactionSummary> for UpgradeObjectPackage {
built_package,
PublishType::ObjectUpgrade,
Some(self.object_address),
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;

Expand All @@ -1283,7 +1305,12 @@ impl CliCommand<TransactionSummary> for UpgradeObjectPackage {
println!("package size {} bytes", size);
let message = format!("Upgrading package in chunked mode will submit {} transactions for staging and upgrading code.\n", &payloads.len());
println!("{}", message.bold());
submit_chunked_publish_transactions(payloads, &self.txn_options).await
submit_chunked_publish_transactions(
payloads,
&self.txn_options,
&self.chunked_publish_option.large_packages_module_address,
)
.await
} else {
let payload = create_package_publication_data(
built_package,
Expand Down Expand Up @@ -1354,9 +1381,13 @@ impl CliCommand<TransactionSummary> for DeployObjectCode {
self.move_options
.add_named_address(self.address_name.clone(), mock_object_address.to_string());
let package = build_package_options(&self.move_options, &self.included_artifacts_args)?;
let mock_payloads =
create_chunked_publish_payloads(package, PublishType::AccountDeploy, None)?
.payloads;
let mock_payloads = create_chunked_publish_payloads(
package,
PublishType::AccountDeploy,
None,
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;
let staging_tx_count = (mock_payloads.len() - 1) as u64;
self.txn_options.sequence_number(sender_address).await? + staging_tx_count + 1
} else {
Expand All @@ -1376,8 +1407,13 @@ impl CliCommand<TransactionSummary> for DeployObjectCode {
prompt_yes_with_override(&message, self.txn_options.prompt_options)?;

let result = if self.chunked_publish_option.chunked_publish {
let payloads =
create_chunked_publish_payloads(package, PublishType::ObjectDeploy, None)?.payloads;
let payloads = create_chunked_publish_payloads(
package,
PublishType::ObjectDeploy,
None,
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;

let size = &payloads
.iter()
Expand All @@ -1387,7 +1423,12 @@ impl CliCommand<TransactionSummary> for DeployObjectCode {
let message = format!("Publishing package in chunked mode will submit {} transactions for staging and publishing code.\n", &payloads.len());
println!("{}", message.bold());

submit_chunked_publish_transactions(payloads, &self.txn_options).await
submit_chunked_publish_transactions(
payloads,
&self.txn_options,
&self.chunked_publish_option.large_packages_module_address,
)
.await
} else {
let payload = create_package_publication_data(
package,
Expand Down Expand Up @@ -1488,6 +1529,7 @@ impl CliCommand<TransactionSummary> for UpgradeCodeObject {
package,
PublishType::ObjectUpgrade,
Some(self.object_address),
&self.chunked_publish_option.large_packages_module_address,
)?
.payloads;

Expand All @@ -1498,7 +1540,12 @@ impl CliCommand<TransactionSummary> for UpgradeCodeObject {
println!("package size {} bytes", size);
let message = format!("Upgrading package in chunked mode will submit {} transactions for staging and upgrading code.\n", &payloads.len());
println!("{}", message.bold());
submit_chunked_publish_transactions(payloads, &self.txn_options).await
submit_chunked_publish_transactions(
payloads,
&self.txn_options,
&self.chunked_publish_option.large_packages_module_address,
)
.await
} else {
let payload = create_package_publication_data(
package,
Expand Down Expand Up @@ -1547,6 +1594,7 @@ fn build_package_options(
async fn submit_chunked_publish_transactions(
payloads: Vec<TransactionPayload>,
txn_options: &TransactionOptions,
large_packages_module_address: &str,
) -> CliTypedResult<TransactionSummary> {
let mut publishing_result = Err(CliError::UnexpectedError(
"No payload provided for batch transaction run".to_string(),
Expand All @@ -1556,12 +1604,12 @@ async fn submit_chunked_publish_transactions(

let account_address = txn_options.profile_options.account_address()?;

if !is_staging_area_empty(txn_options).await? {
if !is_staging_area_empty(txn_options, large_packages_module_address).await? {
let message = format!(
"The resource {}::large_packages::StagingArea under account {} is not empty.\
\nThis may cause package publishing to fail if the data is unexpected. \
\nUse the `aptos move clear-staging-area` command to clean up the `StagingArea` resource under the account.",
LARGE_PACKAGES_MODULE_ADDRESS, account_address,
large_packages_module_address, account_address,
)
.bold();
println!("{}", message);
Expand Down Expand Up @@ -1616,7 +1664,10 @@ async fn submit_chunked_publish_transactions(
publishing_result
}

async fn is_staging_area_empty(txn_options: &TransactionOptions) -> CliTypedResult<bool> {
async fn is_staging_area_empty(
txn_options: &TransactionOptions,
large_packages_module_address: &str,
) -> CliTypedResult<bool> {
let url = txn_options.rest_options.url(&txn_options.profile_options)?;
let client = Client::new(url);

Expand All @@ -1625,7 +1676,7 @@ async fn is_staging_area_empty(txn_options: &TransactionOptions) -> CliTypedResu
txn_options.profile_options.account_address()?,
&format!(
"{}::large_packages::StagingArea",
LARGE_PACKAGES_MODULE_ADDRESS
large_packages_module_address
),
)
.await;
Expand All @@ -1649,6 +1700,10 @@ async fn is_staging_area_empty(txn_options: &TransactionOptions) -> CliTypedResu
pub struct ClearStagingArea {
#[clap(flatten)]
pub(crate) txn_options: TransactionOptions,

/// Address of the `large_packages` move module for chunked publishing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add another line that you only have to override when not on testnet or mainnet

#[clap(long, default_value = LARGE_PACKAGES_MODULE_ADDRESS)]
pub(crate) large_packages_module_address: String,
}

#[async_trait]
Expand All @@ -1660,10 +1715,10 @@ impl CliCommand<TransactionSummary> for ClearStagingArea {
async fn execute(self) -> CliTypedResult<TransactionSummary> {
println!(
"Cleaning up resource {}::large_packages::StagingArea under account {}.",
LARGE_PACKAGES_MODULE_ADDRESS,
&self.large_packages_module_address,
self.txn_options.profile_options.account_address()?
);
let payload = large_packages_cleanup_staging_area();
let payload = large_packages_cleanup_staging_area(&self.large_packages_module_address);
self.txn_options
.submit_transaction(payload)
.await
Expand Down
Loading
Loading