keetanetwork-client-wasm 0.4.0

WebAssembly bindings for the KeetaNet client
//! Serializable views of read results, with amounts rendered as decimal
//! strings and staples as hex so they survive the JS boundary losslessly.

use alloc::string::String;
use alloc::vec::Vec;

use keetanetwork_bindings::permissions::{flag_names, offsets};
use keetanetwork_client::{
	AccountInfo, AccountState, Acl, AclPrincipal, BlockEffects, Certificate, HistoryEntry, LedgerChecksum,
	Representative, TokenBalance,
};
use serde::Serialize;
use tsify::Tsify;

use crate::convert::amount_to_string;

/// A per-token settled balance as a decimal string.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct TokenBalanceView {
	pub token: String,
	pub balance: String,
}

impl From<&TokenBalance> for TokenBalanceView {
	fn from(balance: &TokenBalance) -> Self {
		Self { token: balance.token.to_string(), balance: amount_to_string(balance.balance.clone()) }
	}
}

/// Account metadata as set via `setInfo`.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct AccountInfoView {
	pub name: Option<String>,
	pub description: Option<String>,
	pub metadata: Option<String>,
}

impl From<&AccountInfo> for AccountInfoView {
	fn from(info: &AccountInfo) -> Self {
		let name = info.name.clone();
		let description = info.description.clone();
		let metadata = info.metadata.clone();

		Self { name, description, metadata }
	}
}

/// A snapshot of an account's ledger state.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct AccountStateView {
	pub representative: Option<String>,
	pub head: Option<String>,
	pub height: Option<String>,
	pub info: Option<AccountInfoView>,
	pub supply: Option<String>,
	pub balances: Vec<TokenBalanceView>,
}

impl From<&AccountState> for AccountStateView {
	fn from(state: &AccountState) -> Self {
		Self {
			representative: state
				.representative
				.as_ref()
				.map(|representative| representative.to_string()),
			head: state.head.map(|head| head.to_string()),
			height: state.height.clone().map(amount_to_string),
			info: state.info.as_ref().map(AccountInfoView::from),
			supply: state.supply.clone().map(amount_to_string),
			balances: state.balances.iter().map(TokenBalanceView::from).collect(),
		}
	}
}

/// One staple block (hex) with the indexes of its operations that involve
/// the filtered account, in block order.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct BlockEffectsView {
	pub block: String,
	pub operation_indexes: Vec<usize>,
}

impl From<&BlockEffects> for BlockEffectsView {
	fn from(effects: &BlockEffects) -> Self {
		Self { block: hex::encode(effects.block.to_bytes()), operation_indexes: effects.operation_indexes.clone() }
	}
}

/// The per-staple effects of a filter: the staple id with the matching
/// operations of each of its blocks.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct StapleEffectsView {
	pub id: String,
	pub blocks: Vec<BlockEffectsView>,
}

/// A history entry: the staple as hex plus its id and timestamp.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct HistoryEntryView {
	pub staple: String,
	pub id: Option<String>,
	pub timestamp: Option<String>,
}

impl From<&HistoryEntry> for HistoryEntryView {
	fn from(entry: &HistoryEntry) -> Self {
		Self {
			staple: hex::encode(entry.staple.as_bytes()),
			id: entry.id.map(|id| id.to_string()),
			timestamp: entry.timestamp.map(|moment| moment.to_string()),
		}
	}
}

/// A representative and its voting weight.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct RepresentativeView {
	pub account: String,
	pub weight: String,
	pub api_url: Option<String>,
}

impl From<&Representative> for RepresentativeView {
	fn from(rep: &Representative) -> Self {
		Self {
			account: rep.account.to_string(),
			weight: amount_to_string(rep.weight.clone()),
			api_url: rep.api_url.clone(),
		}
	}
}

/// A point-in-time ledger checksum.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct LedgerChecksumView {
	pub checksum: String,
	pub moment: Option<String>,
	pub moment_range: Option<f64>,
}

impl From<&LedgerChecksum> for LedgerChecksumView {
	fn from(checksum: &LedgerChecksum) -> Self {
		Self {
			checksum: amount_to_string(checksum.checksum.clone()),
			moment: checksum.moment.map(|moment| moment.to_string()),
			moment_range: checksum.moment_range,
		}
	}
}

/// The principal of an access-control entry: `kind` is `"account"` or
/// `"certificate"`; `certificate` carries the issuing certificate hash (hex)
/// for certificate principals.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct AclPrincipalView {
	pub kind: String,
	pub account: String,
	pub certificate: Option<String>,
}

impl From<&AclPrincipal> for AclPrincipalView {
	fn from(principal: &AclPrincipal) -> Self {
		match principal {
			AclPrincipal::Account(account) => {
				Self { kind: String::from("account"), account: account.to_string(), certificate: None }
			}
			AclPrincipal::Certificate { hash, account } => Self {
				kind: String::from("certificate"),
				account: account.to_string(),
				certificate: Some(hex::encode(hash)),
			},
		}
	}
}

/// An access-control entry. `permissions` are the normalized base flag
/// names; `external_permissions` are the external bit offsets.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct AclView {
	pub principal: Option<AclPrincipalView>,
	pub entity: Option<String>,
	pub target: Option<String>,
	pub permissions: Vec<String>,
	pub external_permissions: Vec<u8>,
}

impl From<&Acl> for AclView {
	fn from(acl: &Acl) -> Self {
		Self {
			principal: acl.principal.as_ref().map(AclPrincipalView::from),
			entity: acl.entity.as_ref().map(|entity| entity.to_string()),
			target: acl.target.as_ref().map(|target| target.to_string()),
			permissions: flag_names(&acl.permissions),
			external_permissions: offsets(&acl.permissions),
		}
	}
}

/// A certificate and its intermediate chain.
#[derive(Serialize, Tsify)]
#[tsify(into_wasm_abi)]
pub struct CertificateView {
	pub certificate: String,
	pub intermediates: Vec<String>,
}

impl From<&Certificate> for CertificateView {
	fn from(certificate: &Certificate) -> Self {
		Self { certificate: certificate.certificate.clone(), intermediates: certificate.intermediates.clone() }
	}
}