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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
use crate::ckb_constants::*; // re-export to maintain compatible with old versions pub use crate::error::SysError; #[link(name = "ckb-syscall")] extern "C" { fn syscall(a0: u64, a1: u64, a2: u64, a3: u64, a4: u64, a5: u64, a6: u64, a7: u64) -> u64; } /// Exit, this script will be terminated after the exit syscall. /// exit code `0` represents verification is success, others represent error code. pub fn exit(code: i8) -> ! { unsafe { syscall(code as u64, 0, 0, 0, 0, 0, 0, SYS_EXIT) }; loop {} } /// Load data /// Return data length or syscall error fn syscall_load( buf_ptr: *mut u8, len: usize, offset: usize, a3: u64, a4: u64, a5: u64, a6: u64, syscall_num: u64, ) -> Result<usize, SysError> { let mut actual_data_len = len; let len_ptr: *mut usize = &mut actual_data_len; let ret = unsafe { syscall( buf_ptr as u64, len_ptr as u64, offset as u64, a3, a4, a5, a6, syscall_num, ) }; SysError::build_syscall_result(ret, len, actual_data_len) } /// Load transaction hash /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// /// # Example /// /// ``` /// let mut tx_hash = [0u8; 32]; /// let len = load_tx_hash(&mut tx_hash, 0).unwrap(); /// assert_eq!(len, tx_hash.len()); /// ``` pub fn load_tx_hash(buf: &mut [u8], offset: usize) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, 0, 0, 0, 0, SYS_LOAD_TX_HASH, ) } /// Load script hash /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// /// # Example /// /// ``` /// let mut script_hash = [0u8; 32]; /// let len = load_script_hash(&mut script_hash, 0).unwrap(); /// assert_eq!(len, script_hash.len()); /// ``` pub fn load_script_hash(buf: &mut [u8], offset: usize) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, 0, 0, 0, 0, SYS_LOAD_SCRIPT_HASH, ) } /// Load cell /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index of cell /// * `source` - source of cell pub fn load_cell( buf: &mut [u8], offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, 0, 0, SYS_LOAD_CELL, ) } /// Load input /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index of cell /// * `source` - source of cell pub fn load_input( buf: &mut [u8], offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, 0, 0, SYS_LOAD_INPUT, ) } /// Load header /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index of cell or header /// * `source` - source pub fn load_header( buf: &mut [u8], offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, 0, 0, SYS_LOAD_HEADER, ) } /// Load witness /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index of cell /// * `source` - source pub fn load_witness( buf: &mut [u8], offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, 0, 0, SYS_LOAD_WITNESS, ) } /// Load transaction /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset pub fn load_transaction(buf: &mut [u8], offset: usize) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, 0, 0, 0, 0, SYS_LOAD_TRANSACTION, ) } /// Load cell by field /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index of cell /// * `source` - source of cell /// * `field` - field of cell /// /// # Example /// /// ``` /// let mut buf = [0u8; size_of::<u64>()]; /// let len = load_cell_by_field(&mut buf, 0, 0, Source::GroupInput, CellField::Capacity).unwrap(); /// assert_eq!(len, buf.len()); /// ``` pub fn load_cell_by_field( buf: &mut [u8], offset: usize, index: usize, source: Source, field: CellField, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, field as u64, 0, SYS_LOAD_CELL_BY_FIELD, ) } /// Load header by field /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index /// * `source` - source /// * `field` - field /// /// # Example /// /// ``` /// let mut buf = [0u8; 8]; /// let len = load_header_by_field(&mut buf, 0, index, source, HeaderField::EpochNumber)?; /// debug_assert_eq!(len, buf.len()); /// ``` pub fn load_header_by_field( buf: &mut [u8], offset: usize, index: usize, source: Source, field: HeaderField, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, field as u64, 0, SYS_LOAD_HEADER_BY_FIELD, ) } /// Load input by field /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index /// * `source` - source /// * `field` - field /// /// # Example /// /// ``` /// let mut buf = [0u8; 8]; /// let len = load_input_by_field(&mut buf, 0, index, source, InputField::Since)?; /// debug_assert_eq!(len, buf.len()); /// ``` pub fn load_input_by_field( buf: &mut [u8], offset: usize, index: usize, source: Source, field: InputField, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, field as u64, 0, SYS_LOAD_INPUT_BY_FIELD, ) } /// Load cell data, read cell data /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset /// * `index` - index /// * `source` - source pub fn load_cell_data( buf: &mut [u8], offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, index as u64, source as u64, 0, 0, SYS_LOAD_CELL_DATA, ) } /// Load script /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf` - a writable buf used to receive the data /// * `offset` - offset pub fn load_script(buf: &mut [u8], offset: usize) -> Result<usize, SysError> { syscall_load( buf.as_mut_ptr(), buf.len(), offset, 0, 0, 0, 0, SYS_LOAD_SCRIPT, ) } /// Output debug message /// /// You should use the macro version syscall: `debug!` /// /// # Arguments /// /// * `s` - string to output pub fn debug(mut s: alloc::string::String) { s.push('\0'); let c_str = s.into_bytes(); unsafe { syscall(c_str.as_ptr() as u64, 0, 0, 0, 0, 0, 0, SYS_DEBUG); } } /// Load cell data, read cell data /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf_ptr` - a writable pointer used to receive the data /// * `len` - length that the `buf_ptr` can receives. /// * `offset` - offset /// * `index` - index /// * `source` - source pub fn load_cell_data_raw( buf_ptr: *mut u8, len: usize, offset: usize, index: usize, source: Source, ) -> Result<usize, SysError> { syscall_load( buf_ptr, len, offset, index as u64, source as u64, 0, 0, SYS_LOAD_CELL_DATA, ) } /// Load cell code, read cell data as executable code /// /// Return the loaded data length or a syscall error /// /// # Arguments /// /// * `buf_ptr` - a writable pointer used to receive the data /// * `len` - length that the `buf_ptr` can receives. /// * `content_offset` - offset /// * `content_size` - read length /// * `index` - index /// * `source` - source pub fn load_cell_code( buf_ptr: *mut u8, len: usize, content_offset: usize, content_size: usize, index: usize, source: Source, ) -> Result<usize, SysError> { let ret = unsafe { syscall( buf_ptr as u64, len as u64, content_offset as u64, content_size as u64, index as u64, source as u64, 0, SYS_LOAD_CELL_DATA_AS_CODE, ) }; SysError::build_syscall_result(ret, len, len) }