Struct OmniLockConfig 

pub struct OmniLockConfig { /* private fields */ }

OmniLock configuration The lock argument has the following data structure:

1. 21 byte auth
2. 1 byte Omnilock flags
3. 32 byte RC cell type ID, optional
4. 2 bytes minimum ckb/udt in ACP, optional
5. 8 bytes since for time lock, optional
6. 32 bytes type script hash for supply, optional

Implementations

impl OmniLockConfig

pub fn new_pubkey_hash(lock_arg: H160) -> Self

Create a pubkey hash algorithm omnilock with proper argument

Arguments

• lock_arg blake160 hash of a public key.

pub fn new_multisig(multisig_config: MultisigConfig) -> Self

pub fn new_ethereum(pubkey_hash: H160) -> Self

Create an ethereum algorithm omnilock with pubkey

Arguments

• pubkey_hash - a ehtereum address of an account.

// pubkey is a public ethereum address
use ckb_sdk::unlock::OmniLockConfig;
use ckb_sdk::util::keccak160;
use ckb_crypto::secp::Pubkey;

let pubkey = Pubkey::from([0u8; 64]);
let pubkey_hash = keccak160(pubkey.as_ref());
let config = OmniLockConfig::new_ethereum(pubkey_hash);

pub fn new_ownerlock(script_hash: H160) -> Self

Create an ownerlock omnilock with according script hash.

Arguments

• script_hash the proper blake160 hash of according ownerlock script.

pub fn new(flag: IdentityFlag, auth_content: H160) -> Self

Create a new OmniLockConfig

pub fn set_admin_config(&mut self, admin_config: AdminConfig)

Set the admin cofiguration, and set the OmniLockFlags::ADMIN flag.

Arguments

• admin_config The new admin config.

pub fn clear_admin_config(&mut self)

Remove the admin configuration, set it to None, and clear the OmniLockFlags::ADMIN flag.

pub fn set_acp_config(&mut self, acp_config: OmniLockAcpConfig)

Set the acp configuration, and set the OmniLockFlags::ACP flag.

pub fn clear_acp_config(&mut self)

Remove the acp config, set it to None, and clear the OmniLockFlags::ACP flag.

pub fn set_time_lock_config(&mut self, since: u64)

Set the time lock config with raw since value, and set the OmniLockFlags::TIME_LOCK flag.

pub fn clear_time_lock_config(&mut self)

Remove the time lock config, set it to None, and clear the OmniLockFlags::TIME_LOCK flag.

pub fn set_info_cell(&mut self, type_script_hash: H256)

Set the info cell to the configuration, and set the OmniLockFlags::SUPPLY to omni_lock_flags.

pub fn clear_info_cell(&mut self)

Clear the info cell to None, and clear OmniLockFlags::SUPPLY from omni_lock_flags.

pub fn id(&self) -> &Identity

pub fn multisig_config(&self) -> Option<&MultisigConfig>

Return the reference content of the multisig config. If the multisig config is None, it will panic.

pub fn omni_lock_flags(&self) -> &OmniLockFlags

pub fn use_rc(&self) -> bool

pub fn build_args(&self) -> Bytes

Build lock script arguments

pub fn get_admin_config(&self) -> Option<&AdminConfig>

return the internal reference of admin_config

pub fn get_info_cell(&self) -> Option<&H256>

pub fn get_args_len(&self) -> usize

Calculate script args length

pub fn get_since_source(&self) -> SinceSource

Get the since source from args.

pub fn is_pubkey_hash(&self) -> bool

Indicate whether is a sighash type.

pub fn is_ethereum(&self) -> bool

Indicate whether is a ethereum type.

pub fn is_multisig(&self) -> bool

Check if it is a mutlisig flag.

pub fn is_ownerlock(&self) -> bool

Check if it is a ownerlock flag.

pub fn placeholder_witness_lock( &self, unlock_mode: OmniUnlockMode, ) -> Result<Bytes, ConfigError>

pub fn zero_lock( &self, unlock_mode: OmniUnlockMode, ) -> Result<Bytes, ConfigError>

Build zero lock content for signature

pub fn placeholder_witness( &self, unlock_mode: OmniUnlockMode, ) -> Result<WitnessArgs, ConfigError>

Create a zero lock witness placeholder

Trait Implementations

impl Clone for OmniLockConfig

fn clone(&self) -> OmniLockConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OmniLockConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OmniLockConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for OmniLockConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OmniLockConfig

fn eq(&self, other: &OmniLockConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OmniLockConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OmniLockConfig

impl StructuralPartialEq for OmniLockConfig