Module: file_manager
File Manager: Utility functions to download and upload files to Arweave, as well as check if a file exists on Arweave.
FileManager
A class to manage file operations with Arweave, including downloading, uploading, and checking file existence.
Source code in src/ritual_arweave/file_manager.py
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 |
|
wallet: Wallet
property
Load and return the wallet from the wallet path.
Returns:
Name | Type | Description |
---|---|---|
Wallet |
Wallet
|
The loaded wallet. |
__init__(api_url=DEFAULT_API_URL, wallet_path='./wallet.json', logger=default_logger.info)
Initialize the FileManager with the given API URL, wallet path, and logger.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_url |
str
|
The URL of the Arweave API. |
DEFAULT_API_URL
|
wallet_path |
str
|
The path to the wallet file. |
'./wallet.json'
|
logger |
Callable[[str], None]
|
A logging function. |
info
|
Source code in src/ritual_arweave/file_manager.py
download(pathname, txid)
Download an Arweave data transaction to a given path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pathname |
str
|
The path to download to. |
required |
txid |
str
|
The transaction ID of the data transaction. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The absolute path of the downloaded file. |
Raises:
Type | Description |
---|---|
FileNotReadyException
|
If the file is pending and not ready for download. |
Source code in src/ritual_arweave/file_manager.py
file_exists(file_path, txid)
Given a local file path and a transaction ID, check if the file exists on Arweave. Checks for the following: - Local file exists - Local file's size matches transaction data size - Local file's sha256 digest matches transaction digest
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path |
str
|
The path to the local file. |
required |
txid |
str
|
The transaction ID to check against. |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if the file exists and matches the transaction, False otherwise. |
Source code in src/ritual_arweave/file_manager.py
upload(file_path, tags_dict)
Upload a file to Arweave with the given tags.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path |
Path
|
The path to the file to be uploaded. |
required |
tags_dict |
dict[str, str]
|
A dictionary of tags to be added to the |
required |
Returns:
Name | Type | Description |
---|---|---|
Transaction |
Transaction
|
The created and signed transaction. |