Struct AccountAllowlist 

pub struct AccountAllowlist { /* private fields */ }

Persistent account registry in a separate SQLite database.

The registry has separate reader and writer pools. Its writes do not wait for block database writes. Each entry records when it was added to the allowlist in UTC Unix seconds. Registration and retries preserve this time. Write transactions acquire the write lock before they read registrations. Each write operation commits all its changes together. Failed operations leave no changes.

Implementations

impl AccountAllowlist

pub fn bootstrap( database_filepath: impl AsRef<Path>, ) -> Result<(), DatabaseError>

Creates the registry database and applies all migrations.

The database file must not exist.

pub fn load(database_filepath: impl AsRef<Path>) -> Result<Self, DatabaseError>

Opens the registry database after verifying its schema.

The database must exist and have the latest schema. This method does not apply migrations.

pub fn migrate(database_filepath: impl AsRef<Path>) -> Result<(), DatabaseError>

Applies pending migrations to an existing registry database.

pub fn reader(&self) -> AccountAllowlistReader

Returns a read-only handle that shares the reader pool.

pub async fn import_invitation( &self, entry: InvitationEntry, ) -> Result<InvitationImportOutcome, AllowlistError>

Imports an invitation code with an optional account registration. Returns whether the invitation is new and which account the import registered.

An entry without an account preserves any existing registration for its invitation code. An entry with an account can register an unused invitation code. An identical registration has no effect. A conflicting registration leaves the registry unchanged.

pub async fn add_account( &self, account_id: AccountId, ) -> Result<bool, DatabaseError>

Adds an account without an invitation code. Returns true if the registration is new.

An existing account keeps its invitation code registration, if any.

pub async fn register_account( &self, invitation_code: InvitationCode, account_id: AccountId, ) -> Result<RegistrationOutcome, AllowlistError>

Registers an unused invitation code to an account in one transaction.

A retry with the same invitation code and account succeeds without changes. An account already registered by another method cannot consume an unused invitation code.

Methods from Deref<Target = AccountAllowlistReader>

pub async fn allowlisted_at( &self, account_id: AccountId, ) -> Result<Option<i64>, DatabaseError>

Returns when the account’s allowlist entry was added, if it exists.

pub async fn invitation_info( &self, invitation_code: InvitationCode, ) -> Result<Option<InvitationInfo>, DatabaseError>

Returns the invitation’s registration and allowlist entry timestamp, if it exists.

pub async fn contains_account( &self, account_id: AccountId, ) -> Result<bool, DatabaseError>

Returns whether the registry contains the account.

pub async fn invitation_status( &self, invitation_code: InvitationCode, ) -> Result<InvitationStatus, DatabaseError>

Returns the registration state of the invitation code.

Trait Implementations

impl Deref for AccountAllowlist

type Target = AccountAllowlistReader

The resulting type after dereferencing.

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

Dereferences the value.