1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
use anchor_lang::{system_program, InstructionData, ToAccountMetas};
use futures::future::join_all;
use reqwest::multipart::{Form, Part};
use serde_json::Value;
use shadow_drive_user_staking::accounts as shdw_drive_accounts;
use shadow_drive_user_staking::instruction as shdw_drive_instructions;
use solana_client::rpc_client::serialize_and_encode;
use solana_sdk::{
    instruction::Instruction, pubkey::Pubkey, signer::Signer, transaction::Transaction,
};
use solana_transaction_status::UiTransactionEncoding;
use std::collections::HashSet;
use std::time::Duration;

use super::ShadowDriveClient;
use crate::{
    constants::{PROGRAM_ADDRESS, SHDW_DRIVE_ENDPOINT, STORAGE_CONFIG_PDA, TOKEN_MINT, UPLOADER},
    derived_addresses,
    error::{Error, FileError},
    models::*,
};

impl<T> ShadowDriveClient<T>
where
    T: Signer + Send + Sync,
{
    /// upload_multiple_files uploads a vector of [`ShadowFile`](crate::models::ShadowFile)s to Shadow Drive.
    /// The multiple upload process is done in 4 steps:
    /// 1. Validate & prepare all files into [`UploadingData`](crate::models::UploadingData). If a file there are validation errors, the process is aborted.
    /// 2. Filter files that have the same name as a previously uploaded file. Uploads are not attempted for duplicates.
    /// 3. Divide files to be uploaded into batches of 5 or less to reduce calls but keep transaction size below the limit.
    /// 4. For each batch:
    ///   a. confirm file account seed
    ///   b. derive file account pubkey for each file
    ///   c. construct & partial sign transaction
    ///   d. submit transaction and files to Shadow Drive as multipart form data
    ///
    /// * `storage_account_key` - The public key of the [`StorageAccount`](crate::models::StorageAccount) that will hold the files.
    /// * `data` - A vector of [`ShadowFile`](crate::models::ShadowFile)s to be uploaded.
    ///
    /// # Example
    ///
    /// ```
    /// # // See the README.md or the example directory for a full example.
    ///
    ///  let upload_results = shdw_drive_client
    ///     .upload_multiple_files(&storage_account_key, files)
    ///     .await
    ///     .expect("failed to upload files");
    /// ````
    pub async fn upload_multiple_files(
        &self,
        storage_account_key: &Pubkey,
        data: Vec<ShadowFile>,
    ) -> ShadowDriveResult<Vec<ShadowBatchUploadResponse>> {
        let wallet_pubkey = self.wallet.pubkey();
        let (user_info, _) = derived_addresses::user_info(&wallet_pubkey);
        let selected_account = self.get_storage_account(storage_account_key).await?;

        //collect upload data for each file
        let upload_data_futures = data
            .into_iter()
            .map(|shdw_file| async move { shdw_file.prepare_upload(storage_account_key).await })
            .collect::<Vec<_>>();

        let file_data = join_all(upload_data_futures).await;

        let (succeeded_files, errored_files): (Vec<_>, Vec<_>) =
            file_data.into_iter().partition(Result::is_ok);
        //it's safe to unwrap after the above partition
        let errored_files: Vec<Vec<FileError>> =
            errored_files.into_iter().map(Result::unwrap_err).collect();
        if errored_files.len() > 0 {
            return Err(Error::FileValidationError(
                errored_files.into_iter().flatten().collect(),
            ));
        }
        let succeeded_files = succeeded_files.into_iter().map(Result::unwrap);

        //filter out any existing files
        let all_objects: HashSet<String> = self
            .list_objects(&storage_account_key)
            .await?
            .into_iter()
            .collect();
        let (to_upload, existing_uploads): (Vec<_>, Vec<_>) = succeeded_files
            .into_iter()
            .partition(|upload_data| !all_objects.contains(&upload_data.file.name));

        //pre-fill results w/ existing files
        let mut upload_results = existing_uploads
            .into_iter()
            .map(|upload_data| ShadowBatchUploadResponse {
                file_name: String::from(upload_data.file.name),
                status: BatchUploadStatus::AlreadyExists,
                location: Some(upload_data.url),
                transaction_signature: None,
            })
            .collect::<Vec<_>>();

        if upload_results.len() > 0 {
            tracing::debug!(existing_uploads = ?upload_results, "found existing files, will not attempt re-upload for existing files");
        }

        let mut batches = Vec::default();
        let mut current_batch: Vec<UploadingData> = Vec::default();
        let mut batch_total_name_length = 0;

        for upload_data in to_upload {
            if current_batch.is_empty() {
                batch_total_name_length += upload_data.file.name.as_bytes().len();
                current_batch.push(upload_data);
                continue;
            }

            //if the current batch has 5 or less
            if current_batch.len() < 5 &&
            //our current name buffer is under the limit 
            batch_total_name_length < 154 &&
            //the name buffer will be under size with the new file
            batch_total_name_length + upload_data.file.name.as_bytes().len() < 154
            {
                //add to current batch
                batch_total_name_length += upload_data.file.name.as_bytes().len();
                current_batch.push(upload_data);
            } else {
                //create new batch and clear name buffer
                batches.push(current_batch);
                current_batch = Vec::default();
                current_batch.push(upload_data);
                batch_total_name_length = 0;
            }
        }
        //if the final batch has something, push it to batches
        if !current_batch.is_empty() {
            batches.push(current_batch);
        }

        let mut new_file_seed = selected_account.init_counter;

        //send each batch to shdw drive
        for batch in batches {
            //confirm file seed before sending
            new_file_seed = self
                .confirm_storage_account_seed(new_file_seed, storage_account_key)
                .await?;

            let mut num_retries = 0;
            loop {
                match self
                    .send_batch(storage_account_key, user_info, &mut new_file_seed, &batch)
                    .await
                {
                    Ok(response) => {
                        upload_results.extend(response.into_iter());
                        //break loop to move to next batch
                        break;
                    }
                    Err(error) => {
                        tracing::error!(
                            retries = num_retries,
                            ?error,
                            "error uploading batch to shdw drive"
                        );
                        num_retries += 1;
                        //after 5 attempts bail on the batch
                        if num_retries == 5 {
                            //reset file seed
                            new_file_seed = self
                                .confirm_storage_account_seed(
                                    selected_account.init_counter,
                                    storage_account_key,
                                )
                                .await?;

                            //save failed entries
                            let failed =
                                batch
                                    .into_iter()
                                    .map(|upload_data| ShadowBatchUploadResponse {
                                        file_name: String::from(upload_data.file.name),
                                        status: BatchUploadStatus::Error(format!("{:?}", error)),
                                        location: None,
                                        transaction_signature: None,
                                    });
                            upload_results.extend(failed);
                            //break batch retry loop to move to next
                            break;
                        }
                    }
                }
            }

            //wait 1/2 second before going to next batch
            //without this the latest blockhash doesn't align with the server's recent blockhash
            tokio::time::sleep(Duration::from_millis(500)).await;
        }

        Ok(upload_results)
    }

    /// confirm_storage_account_seed performs a retry loop to ensure that the file seed
    /// use to derive file account pubkeys is valid before creating a batch upload transaction.
    /// In the event that the chain has a more up to date file seed, the on-chain seed is used for the transaction.
    async fn confirm_storage_account_seed(
        &self,
        expected_seed: u32,
        storage_account_key: &Pubkey,
    ) -> ShadowDriveResult<u32> {
        let mut num_tries = 0;
        loop {
            let storage_account = self.get_storage_account(storage_account_key).await?;
            if expected_seed == storage_account.init_counter {
                tracing::debug!(
                    expected_seed,
                    actual_seed = storage_account.init_counter,
                    "Chain has up to date info. Moving onto the next batch."
                );
                return Ok(expected_seed);
            } else if expected_seed < storage_account.init_counter {
                tracing::debug!(
                    expected_seed,
                    actual_seed = storage_account.init_counter,
                    "Chain has higher seed. Fast forwarding to new start."
                );
                return Ok(storage_account.init_counter);
            } else {
                num_tries += 1;
                if num_tries == 300 {
                    // if we've tried for 5 minutes, give up
                    return Err(Error::InvalidStorage);
                }

                tracing::debug!(
                    expected_seed,
                    actual_seed = storage_account.init_counter,
                    "Chain does not have up to date info. Waiting 1s to check again."
                );
                tokio::time::sleep(Duration::from_secs(1)).await;
            }
        }
    }

    /// send_batch constructs and partially signs a transaction for a given slice of [`UploadingData`].
    /// The transcation is then sent via HTTP POST to Shadow Drive servers as multipart form data alongside file contents.
    async fn send_batch(
        &self,
        storage_account_key: &Pubkey,
        user_info: Pubkey,
        new_file_seed: &mut u32,
        batch: &[UploadingData],
    ) -> ShadowDriveResult<Vec<ShadowBatchUploadResponse>> {
        //derive file account pubkeys using new_file_seed
        let mut files_with_pubkeys: Vec<(Pubkey, &UploadingData)> = Vec::with_capacity(batch.len());
        for file in batch {
            files_with_pubkeys.push((
                derived_addresses::file_account(&storage_account_key, *new_file_seed).0,
                file,
            ));
            *new_file_seed += 1;
        }

        //build txn
        let instructions = files_with_pubkeys
            .iter()
            .map(|(file_account, file)| {
                let accounts = shdw_drive_accounts::StoreFile {
                    storage_config: *STORAGE_CONFIG_PDA,
                    storage_account: *storage_account_key,
                    user_info,
                    owner: self.wallet.pubkey(),
                    uploader: UPLOADER,
                    token_mint: TOKEN_MINT,
                    system_program: system_program::ID,
                    file: *file_account,
                };
                let args = shdw_drive_instructions::StoreFile {
                    filename: file.file.name.clone(),
                    sha256_hash: hex::encode(file.sha256_hash.into_bytes()),
                    size: file.size,
                };
                Instruction {
                    program_id: PROGRAM_ADDRESS,
                    accounts: accounts.to_account_metas(None),
                    data: args.data(),
                }
            })
            .collect::<Vec<_>>();

        let mut txn =
            Transaction::new_with_payer(instructions.as_slice(), Some(&self.wallet.pubkey()));

        txn.try_partial_sign(&[&self.wallet], self.rpc_client.get_latest_blockhash()?)?;
        let txn_encoded = serialize_and_encode(&txn, UiTransactionEncoding::Base64)?;

        //construct HTTP form data
        let mut form = Form::new();
        for (_, file) in files_with_pubkeys {
            form = form.part("file", file.to_form_part().await?);
        }

        let form = form.part("transaction", Part::text(txn_encoded));

        //submit files to Shadow Drive
        let response = self
            .http_client
            .post(format!("{}/upload-batch", SHDW_DRIVE_ENDPOINT))
            .multipart(form)
            .send()
            .await?;

        if !response.status().is_success() {
            return Err(Error::ShadowDriveServerError {
                status: response.status().as_u16(),
                message: response.json::<Value>().await?,
            });
        }

        //deserialize the response from ShadowDrive and return the upload details
        let response = response.json::<ShdwDriveBatchServerResponse>().await?;
        let response = batch
            .iter()
            .map(|file| ShadowBatchUploadResponse {
                file_name: file.file.name.clone(),
                status: BatchUploadStatus::Uploaded,
                location: Some(file.url.clone()),
                transaction_signature: Some(response.transaction_signature.clone()),
            })
            .collect();

        Ok(response)
    }
}