Struct aleo_wasm::record::record_plaintext::RecordPlaintext

impl RecordPlaintext

pub fn commitment( &self, program_id: &str, record_name: &str ) -> Result<Field, String>

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

Return a record plaintext from a string.

@param {string} record String representation of a plaintext representation of an Aleo record @returns {RecordPlaintext | Error} Record plaintext

pub fn to_string(&self) -> String

Returns the record plaintext string

@returns {string} String representation of the record plaintext

pub fn microcredits(&self) -> u64

Returns the amount of microcredits in the record

@returns {u64} Amount of microcredits in the record

pub fn nonce(&self) -> String

Returns the nonce of the record. This can be used to uniquely identify a record.

@returns {string} Nonce of the record

pub fn serial_number_string( &self, private_key: &PrivateKey, program_id: &str, record_name: &str ) -> Result<String, String>

Attempt to get the serial number of a record to determine whether or not is has been spent

@param {PrivateKey} private_key Private key of the account that owns the record @param {string} program_id Program ID of the program that the record is associated with @param {string} record_name Name of the record @returns {string | Error} Serial number of the record

Methods from Deref<Target = Record<Testnet3, Plaintext<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§

impl Clone for RecordPlaintext

fn clone(&self) -> RecordPlaintext

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

impl Deref for RecordPlaintext

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

The resulting type after dereferencing.

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

Dereferences the value.

impl From<Record<Testnet3, Plaintext<Testnet3>>> for RecordPlaintext

fn from(record: Record<Testnet3, Plaintext<Testnet3>>) -> Self

Converts to this type from the input type.

impl From<RecordPlaintext> for JsValue

fn from(value: RecordPlaintext) -> Self

Converts to this type from the input type.

impl FromStr for RecordPlaintext

type Err = Error

The associated error which can be returned from parsing.

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

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

impl FromWasmAbi for RecordPlaintext

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more

impl IntoWasmAbi for RecordPlaintext

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for RecordPlaintext

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, RecordPlaintext>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for RecordPlaintext

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.

impl OptionIntoWasmAbi for RecordPlaintext

fn none() -> Self::Abi

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

impl RefFromWasmAbi for RecordPlaintext

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, RecordPlaintext>

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.