pub struct RecordCiphertext(/* private fields */);
Expand description

Encrypted Aleo record

Implementations§

source§

impl RecordCiphertext

source

pub fn from_string(record: &str) -> Result<RecordCiphertext, String>

Create a record ciphertext from a string

@param {string} record String representation of a record ciphertext @returns {RecordCiphertext | Error} Record ciphertext

source

pub fn to_string(&self) -> String

Return the string reprensentation of the record ciphertext

@returns {string} String representation of the record ciphertext

source

pub fn decrypt(&self, view_key: &ViewKey) -> Result<RecordPlaintext, String>

Decrypt the record ciphertext into plaintext using the view key. The record will only decrypt if the record was encrypted by the account corresponding to the view key

@param {ViewKey} view_key View key used to decrypt the ciphertext @returns {RecordPlaintext | Error} Record plaintext object

source

pub fn is_owner(&self, view_key: &ViewKey) -> bool

Determines if the account corresponding to the view key is the owner of the record

@param {ViewKey} view_key View key used to decrypt the ciphertext @returns {boolean}

Methods from Deref<Target = Record<Testnet3, Ciphertext<Testnet3>>>§

pub fn decrypt( &self, view_key: &ViewKey<N> ) -> Result<Record<N, Plaintext<N>>, Error>

Decrypts self into plaintext using the given view key and checks that the owner matches the view key.

pub fn decrypt_symmetric_unchecked( &self, record_view_key: &Field<N> ) -> Result<Record<N, Plaintext<N>>, Error>

Decrypts self into plaintext using the given record view key. Note: This method does not check that the record view key corresponds to the record owner. Use Self::decrypt for the checked variant.

pub fn encrypt( &self, randomizer: Scalar<N> ) -> Result<Record<N, Ciphertext<N>>, Error>

Encrypts self for the record owner under the given randomizer.

pub fn encrypt_symmetric_unchecked( &self, record_view_key: &Field<N> ) -> Result<Record<N, Ciphertext<N>>, Error>

Encrypts self under the given record view key. Note: This method does not check that the record view key corresponds to the record owner. Use Self::encrypt for the checked variant.

pub fn find<A>(&self, path: &[A]) -> Result<Entry<N, Plaintext<N>>, Error>where A: Into<Access<N>> + Copy + Debug,

Returns the entry from the given path.

pub fn is_owner(&self, view_key: &ViewKey<N>) -> bool

Decrypts self into plaintext using the given view key.

pub fn is_owner_with_address_x_coordinate( &self, view_key: &ViewKey<N>, address_x_coordinate: &Field<N> ) -> bool

Decrypts self into plaintext using the x-coordinate of the address corresponding to the given view key.

pub fn to_commitment( &self, program_id: &ProgramID<N>, record_name: &Identifier<N> ) -> Result<Field<N>, Error>

Returns the record commitment.

pub fn to_commitment( &self, _program_id: &ProgramID<N>, _record_name: &Identifier<N> ) -> Result<Field<N>, Error>

Returns the record commitment.

pub fn owner(&self) -> &Owner<N, Private>

Returns the owner of the program record.

pub fn data(&self) -> &IndexMap<Identifier<N>, Entry<N, Private>>

Returns the program data.

pub fn nonce(&self) -> &Group<N>

Returns the nonce of the program record.

Trait Implementations§

source§

impl Clone for RecordCiphertext

source§

fn clone(&self) -> RecordCiphertext

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Deref for RecordCiphertext

§

type Target = Record<Testnet3, Ciphertext<Testnet3>>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl From<RecordCiphertext> for JsValue

source§

fn from(value: RecordCiphertext) -> Self

Converts to this type from the input type.
source§

impl FromStr for RecordCiphertext

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(ciphertext: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl FromWasmAbi for RecordCiphertext

§

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.
source§

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
source§

impl IntoWasmAbi for RecordCiphertext

§

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
source§

impl LongRefFromWasmAbi for RecordCiphertext

§

type Abi = u32

Same as RefFromWasmAbi::Abi
§

type Anchor = Ref<'static, RecordCiphertext>

Same as RefFromWasmAbi::Anchor
source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl OptionFromWasmAbi for RecordCiphertext

source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
source§

impl OptionIntoWasmAbi for RecordCiphertext

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl RefFromWasmAbi for RecordCiphertext

§

type Abi = u32

The wasm ABI type references to Self are recovered from.
§

type Anchor = Ref<'static, RecordCiphertext>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
source§

impl RefMutFromWasmAbi for RecordCiphertext

§

type Abi = u32

Same as RefFromWasmAbi::Abi
§

type Anchor = RefMut<'static, RecordCiphertext>

Same as RefFromWasmAbi::Anchor
source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl TryFromJsValue for RecordCiphertext

§

type Error = JsValue

The type returned in the event of a conversion error.
source§

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl VectorFromWasmAbi for RecordCiphertext

§

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[RecordCiphertext]>

source§

impl VectorIntoWasmAbi for RecordCiphertext

source§

impl WasmDescribe for RecordCiphertext

source§

impl WasmDescribeVector for RecordCiphertext

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ReturnWasmAbi for Twhere T: IntoWasmAbi,

§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more