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 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
use crate::ckb_constants::*;
use crate::debug;
use crate::error::SysError;
use crate::syscalls;
use alloc::{ffi::CString, string::String, vec, vec::Vec};
use ckb_types::{core::ScriptHashType, packed::*, prelude::*};
use core::convert::Infallible;
use core::ffi::CStr;
use core::fmt::Write;
/// Default buffer size, it is used to load data from syscall.
/// The default value is set to 256, which will be enough for most cases:
/// * load a `Script`, the typical size is 73 ~ 86
/// * load a `CellOutput`, the typical size is 97 ~ 195
pub const BUF_SIZE: usize = 256;
/// Load tx hash
///
/// Return the tx hash or a syscall error
///
/// # Example
///
/// ```
/// let tx_hash = load_tx_hash().unwrap();
/// ```
pub fn load_tx_hash() -> Result<[u8; 32], SysError> {
let mut hash = [0u8; 32];
let len = syscalls::load_tx_hash(&mut hash, 0)?;
debug_assert_eq!(hash.len(), len);
Ok(hash)
}
/// Load script hash
///
/// Return the script hash or a syscall error
///
/// # Example
///
/// ```
/// let script_hash = load_script_hash().unwrap();
/// ```
pub fn load_script_hash() -> Result<[u8; 32], SysError> {
let mut hash = [0u8; 32];
let len = syscalls::load_script_hash(&mut hash, 0)?;
debug_assert_eq!(hash.len(), len);
Ok(hash)
}
/// Common method to fully load data from syscall
fn load_data<F: Fn(&mut [u8], usize) -> Result<usize, SysError>>(
syscall: F,
) -> Result<Vec<u8>, SysError> {
let mut buf = [0u8; BUF_SIZE];
match syscall(&mut buf, 0) {
Ok(len) => Ok(buf[..len].to_vec()),
Err(SysError::LengthNotEnough(actual_size)) => {
let mut data = vec![0; actual_size];
let loaded_len = buf.len();
data[..loaded_len].copy_from_slice(&buf);
let len = syscall(&mut data[loaded_len..], loaded_len)?;
debug_assert_eq!(len + loaded_len, actual_size);
Ok(data)
}
Err(err) => Err(err),
}
}
/// Load cell
///
/// Return the cell or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let cell_output = load_cell(0, Source::Input).unwrap();
/// ```
pub fn load_cell(index: usize, source: Source) -> Result<CellOutput, SysError> {
let data = load_data(|buf, offset| syscalls::load_cell(buf, offset, index, source))?;
match CellOutputReader::verify(&data, false) {
Ok(()) => Ok(CellOutput::new_unchecked(data.into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load input
///
/// Return the input or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let input = load_input(0, Source::Input).unwrap();
/// ```
pub fn load_input(index: usize, source: Source) -> Result<CellInput, SysError> {
let mut data = [0u8; CellInput::TOTAL_SIZE];
syscalls::load_input(&mut data, 0, index, source)?;
match CellInputReader::verify(&data, false) {
Ok(()) => Ok(CellInput::new_unchecked(data.to_vec().into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load header
///
/// Return the header or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let header = load_header(0, Source::HeaderDep).unwrap();
/// ```
pub fn load_header(index: usize, source: Source) -> Result<Header, SysError> {
let mut data = [0u8; Header::TOTAL_SIZE];
syscalls::load_header(&mut data, 0, index, source)?;
match HeaderReader::verify(&data, false) {
Ok(()) => Ok(Header::new_unchecked(data.to_vec().into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load witness
///
/// Return the witness or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let witness = load_witness(0, Source::Input).unwrap();
/// ```
pub fn load_witness(index: usize, source: Source) -> Result<Vec<u8>, SysError> {
load_data(|buf, offset| syscalls::load_witness(buf, offset, index, source))
}
/// Load witness args
///
/// Return the witness args or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let witness_args = load_witness_args(0, Source::Input).unwrap();
/// ```
pub fn load_witness_args(index: usize, source: Source) -> Result<WitnessArgs, SysError> {
let data = load_data(|buf, offset| syscalls::load_witness(buf, offset, index, source))?;
match WitnessArgsReader::verify(&data, false) {
Ok(()) => Ok(WitnessArgs::new_unchecked(data.into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load transaction
///
/// Return the transaction or a syscall error
///
/// # Example
///
/// ```
/// let tx = load_transaction().unwrap();
/// ```
pub fn load_transaction() -> Result<Transaction, SysError> {
let data = load_data(|buf, offset| syscalls::load_transaction(buf, offset))?;
match TransactionReader::verify(&data, false) {
Ok(()) => Ok(Transaction::new_unchecked(data.into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load cell capacity
///
/// Return the loaded data length or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let capacity = syscalls::load_cell_capacity(index, source).unwrap();
/// ```
pub fn load_cell_capacity(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len = syscalls::load_cell_by_field(&mut buf, 0, index, source, CellField::Capacity)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load cell occupied capacity
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let occupied_capacity = load_cell_occupied_capacity(index, source).unwrap();
/// ```
pub fn load_cell_occupied_capacity(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len =
syscalls::load_cell_by_field(&mut buf, 0, index, source, CellField::OccupiedCapacity)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load cell data hash
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let data_hash = load_cell_data_hash(index, source).unwrap();
/// ```
pub fn load_cell_data_hash(index: usize, source: Source) -> Result<[u8; 32], SysError> {
let mut buf = [0u8; 32];
let len = syscalls::load_cell_by_field(&mut buf, 0, index, source, CellField::DataHash)?;
debug_assert_eq!(len, buf.len());
Ok(buf)
}
/// Load cell lock hash
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let lock_hash = load_cell_lock_hash(index, source).unwrap();
/// ```
pub fn load_cell_lock_hash(index: usize, source: Source) -> Result<[u8; 32], SysError> {
let mut buf = [0u8; 32];
let len = syscalls::load_cell_by_field(&mut buf, 0, index, source, CellField::LockHash)?;
debug_assert_eq!(len, buf.len());
Ok(buf)
}
/// Load cell type hash
///
/// return None if the cell has no type
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let type_hash = load_cell_type_hash(index, source).unwrap().unwrap();
/// ```
pub fn load_cell_type_hash(index: usize, source: Source) -> Result<Option<[u8; 32]>, SysError> {
let mut buf = [0u8; 32];
match syscalls::load_cell_by_field(&mut buf, 0, index, source, CellField::TypeHash) {
Ok(len) => {
debug_assert_eq!(len, buf.len());
Ok(Some(buf))
}
Err(SysError::ItemMissing) => Ok(None),
Err(err) => Err(err),
}
}
/// Load cell lock
///
/// Return the lock script or a syscall error
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let lock = load_cell_lock(index, source).unwrap();
/// ```
pub fn load_cell_lock(index: usize, source: Source) -> Result<Script, SysError> {
let data = load_data(|buf, offset| {
syscalls::load_cell_by_field(buf, offset, index, source, CellField::Lock)
})?;
match ScriptReader::verify(&data, false) {
Ok(()) => Ok(Script::new_unchecked(data.into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load cell type
///
/// Return the type script or a syscall error, return None if the cell has no type
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let type_script = load_cell_type(index, source).unwrap().unwrap();
/// ```
pub fn load_cell_type(index: usize, source: Source) -> Result<Option<Script>, SysError> {
let data = match load_data(|buf, offset| {
syscalls::load_cell_by_field(buf, offset, index, source, CellField::Type)
}) {
Ok(data) => data,
Err(SysError::ItemMissing) => return Ok(None),
Err(err) => return Err(err),
};
match ScriptReader::verify(&data, false) {
Ok(()) => Ok(Some(Script::new_unchecked(data.into()))),
Err(_err) => Err(SysError::Encoding),
}
}
// Load header epoch number
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let epoch_number = load_header_epoch_number(index, source).unwrap();
/// ```
pub fn load_header_epoch_number(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len = syscalls::load_header_by_field(&mut buf, 0, index, source, HeaderField::EpochNumber)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load header epoch start block number
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let epoch_start_block_number = load_header_epoch_start_block_number(index, source).unwrap();
/// ```
pub fn load_header_epoch_start_block_number(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len = syscalls::load_header_by_field(
&mut buf,
0,
index,
source,
HeaderField::EpochStartBlockNumber,
)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load header epoch length
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let epoch_length = load_header_epoch_length(index, source).unwrap();
/// ```
pub fn load_header_epoch_length(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len = syscalls::load_header_by_field(&mut buf, 0, index, source, HeaderField::EpochLength)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load input since
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let since = load_input_since(index, source).unwrap();
/// ```
pub fn load_input_since(index: usize, source: Source) -> Result<u64, SysError> {
let mut buf = [0u8; 8];
let len = syscalls::load_input_by_field(&mut buf, 0, index, source, InputField::Since)?;
debug_assert_eq!(len, buf.len());
Ok(u64::from_le_bytes(buf))
}
/// Load input out point
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let out_point = load_input_out_point(index, source).unwrap();
/// ```
pub fn load_input_out_point(index: usize, source: Source) -> Result<OutPoint, SysError> {
let mut data = [0u8; OutPoint::TOTAL_SIZE];
syscalls::load_input_by_field(&mut data, 0, index, source, InputField::OutPoint)?;
match OutPointReader::verify(&data, false) {
Ok(()) => Ok(OutPoint::new_unchecked(data.to_vec().into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// Load cell data
///
/// # Arguments
///
/// * `index` - index
/// * `source` - source
///
/// # Example
///
/// ```
/// let data = load_cell_data(index, source).unwrap();
/// ```
pub fn load_cell_data(index: usize, source: Source) -> Result<Vec<u8>, SysError> {
load_data(|buf, offset| syscalls::load_cell_data(buf, offset, index, source))
}
/// Load script
///
/// # Example
///
/// ```
/// let script = load_script().unwrap();
/// ```
pub fn load_script() -> Result<Script, SysError> {
let data = load_data(|buf, offset| syscalls::load_script(buf, offset))?;
match ScriptReader::verify(&data, false) {
Ok(()) => Ok(Script::new_unchecked(data.into())),
Err(_err) => Err(SysError::Encoding),
}
}
/// QueryIter
///
/// A advanced iterator to manipulate cells/inputs/headers/witnesses
///
/// # Example
///
/// ```
/// use high_level::load_cell_capacity;
/// // calculate all inputs capacity
/// let inputs_capacity = QueryIter::new(load_cell_capacity, Source::Input)
/// .map(|capacity| capacity.unwrap_or(0))
/// .sum::<u64>();
///
/// // calculate all outputs capacity
/// let outputs_capacity = QueryIter::new(load_cell_capacity, Source::Output)
/// .map(|capacity| capacity.unwrap_or(0))
/// .sum::<u64>();
///
/// assert_eq!(inputs_capacity, outputs_capacity);
/// ```
pub struct QueryIter<F> {
query_fn: F,
index: usize,
source: Source,
}
impl<F> QueryIter<F> {
/// new
///
/// # Arguments
///
/// * `query_fn` - A high level query function, which accept `(index, source)` as args and
/// returns Result<T, SysError>. Examples: `load_cell`, `load_cell_data`,`load_witness_args`, `load_input`, `load_header`, ...
/// * `source` - source
///
/// # Example
///
/// ```
/// use high_level::load_cell;
/// // iterate all inputs cells
/// let iter = QueryIter::new(load_cell, Source::Input)
/// ```
pub fn new(query_fn: F, source: Source) -> Self {
QueryIter {
query_fn,
index: 0,
source,
}
}
}
impl<T, F: Fn(usize, Source) -> Result<T, SysError>> Iterator for QueryIter<F> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
match (self.query_fn)(self.index, self.source) {
Ok(item) => {
self.index += 1;
Some(item)
}
Err(SysError::IndexOutOfBound) => None,
Err(err) => {
debug!("QueryIter error {:?}", err);
panic!("QueryIter query_fn return an error")
}
}
}
}
/// Find cell by data_hash
///
/// Iterate and find the cell which data hash equals `data_hash`,
/// return the index of the first cell we found, otherwise return None.
///
pub fn find_cell_by_data_hash(data_hash: &[u8], source: Source) -> Result<Option<usize>, SysError> {
let mut buf = [0u8; 32];
for i in 0.. {
let len = match syscalls::load_cell_by_field(&mut buf, 0, i, source, CellField::DataHash) {
Ok(len) => len,
Err(SysError::IndexOutOfBound) => break,
Err(err) => return Err(err),
};
debug_assert_eq!(len, buf.len());
if data_hash == &buf[..] {
return Ok(Some(i));
}
}
Ok(None)
}
/// Look for a dep cell with specific code hash, code_hash should be a buffer
/// with 32 bytes.
///
pub fn look_for_dep_with_hash2(
code_hash: &[u8],
hash_type: ScriptHashType,
) -> Result<usize, SysError> {
let field = match hash_type {
ScriptHashType::Type => CellField::TypeHash,
_ => CellField::DataHash,
};
let mut current: usize = 0;
loop {
let mut buf = [0u8; 32];
match syscalls::load_cell_by_field(&mut buf, 0, current, Source::CellDep, field) {
Ok(len) => {
debug_assert_eq!(len, buf.len());
if buf == code_hash {
return Ok(current);
}
}
Err(SysError::ItemMissing) => {}
Err(SysError::IndexOutOfBound) => {
return Err(SysError::IndexOutOfBound);
}
Err(err) => {
return Err(err);
}
}
current += 1;
}
}
pub fn look_for_dep_with_data_hash(data_hash: &[u8]) -> Result<usize, SysError> {
look_for_dep_with_hash2(data_hash, ScriptHashType::Data)
}
pub fn encode_hex(data: &[u8]) -> CString {
let mut s = String::with_capacity(data.len() * 2);
for &b in data {
write!(&mut s, "{:02x}", b).unwrap();
}
CString::new(s).unwrap()
}
pub fn decode_hex(data: &CStr) -> Result<Vec<u8>, SysError> {
let data = data.to_str().unwrap();
if data.len() & 1 != 0 {
return Err(SysError::Encoding);
}
(0..data.len())
.step_by(2)
.map(|i| u8::from_str_radix(&data[i..i + 2], 16).map_err(|_| SysError::Encoding))
.collect()
}
/// Exec a cell in cell dep.
///
/// # Arguments
///
/// * `code_hash` - the code hash to search cell in cell deps.
/// * `hash_type` - the hash type to search cell in cell deps.
/// * `argv` - subprocess arguments. In most cases two types of parameters can be accepted:
/// - if the parameter you want to pass can be represented by a string:
/// - CStr::from_bytes_with_nul(b"arg0\0").unwrap();
/// - CString::new("arg0").unwrap().as_c_str();
/// - if you want to pass a piece of bytes data, you may encode it to hexadecimal string or other format:
/// - high_level::encode_hex(&vec![0xff, 0xfe, 0xfd]);
pub fn exec_cell(
code_hash: &[u8],
hash_type: ScriptHashType,
argv: &[&CStr],
) -> Result<Infallible, SysError> {
#[cfg(not(feature = "simulator"))]
{
let index = look_for_dep_with_hash2(code_hash, hash_type)?;
let ret = syscalls::exec(index, Source::CellDep, 0, 0, argv);
let err = match ret {
1 => SysError::IndexOutOfBound,
2 => SysError::ItemMissing,
r => SysError::Unknown(r),
};
Err(err)
}
#[cfg(feature = "simulator")]
syscalls::exec_cell(code_hash, hash_type, argv)
}
/// Spawn a cell in cell dep.
///
/// # Arguments
///
/// * `code_hash` - the code hash to search cell in cell deps.
/// * `hash_type` - the hash type to search cell in cell deps.
/// * `argv` - subprocess arguments. In most cases two types of parameters can be accepted:
/// - if the parameter you want to pass can be represented by a string:
/// - CStr::from_bytes_with_nul(b"arg0\0").unwrap();
/// - CString::new("arg0").unwrap().as_c_str();
/// - if you want to pass a piece of bytes data, you may encode it to hexadecimal string or other format:
/// - high_level::encode_hex(&vec![0xff, 0xfe, 0xfd]);
/// * `memory_limit` - a number between 1 and 8.
/// - note each tick represents an additional 0.5M of memory.
/// * `content` - a buffer to saving the output by sub script.
/// - note the size of content will be shrinked after call.
#[cfg(feature = "ckb2023")]
pub fn spawn_cell(
code_hash: &[u8],
hash_type: ScriptHashType,
argv: &[&CStr],
memory_limit: u64,
content: &mut Vec<u8>,
) -> Result<i8, SysError> {
let index = look_for_dep_with_hash2(code_hash, hash_type)?;
let mut content_length = content.len() as u64;
let mut exit_code = 0i8;
let spgs = syscalls::SpawnArgs {
memory_limit,
exit_code: &mut exit_code as *mut i8,
content: content.as_mut_ptr(),
content_length: &mut content_length as *mut u64,
};
let ret = syscalls::spawn(index, Source::CellDep, 0, argv, &spgs);
match ret {
0 => {
content.truncate(content_length as usize);
Ok(exit_code)
}
1 => Err(SysError::IndexOutOfBound),
2 => Err(SysError::ItemMissing),
3 => Err(SysError::LengthNotEnough(content.len())),
4 => Err(SysError::Encoding),
5 => Err(SysError::SpawnExceededMaxContentLength),
6 => Err(SysError::SpawnWrongMemoryLimit),
7 => Err(SysError::SpawnExceededMaxPeakMemory),
r => Err(SysError::Unknown(r)),
}
}