Sigil documentation
ReferenceRust referencesigil-core

sigil-core · sns

Source declarations, signatures and documentation for sns.

Source: sigil/node/sigil-core/src/sns.rs. SHA-256: 27792c4c3d4f633ff4e07ce7482cab6f432fda7b657499c8bfe51a7dcf959f2f.

This reference follows declared source modules, retains conditional attributes, and includes public declarations and implementation methods. Private-module re-exports and trait resolution require the compiler; this is a source reference, not a claim that every listed item is a root import. Function bodies and constant values are omitted.

sns::SNS_NAMEHASH_DOMAIN

pub const SNS_NAMEHASH_DOMAIN: &str;

Source line: 7.

sns::SNS_TX_DOMAIN

pub const SNS_TX_DOMAIN: &str;

Source line: 8.

sns::SNS_EVENT_DOMAIN

pub const SNS_EVENT_DOMAIN: &str;

Source line: 9.

sns::SNS_REGISTRATION_COMMITMENT_DOMAIN

pub const SNS_REGISTRATION_COMMITMENT_DOMAIN: &str;

Source line: 10.

sns::SNS_SEALED_BID_COMMITMENT_DOMAIN

pub const SNS_SEALED_BID_COMMITMENT_DOMAIN: &str;

Source line: 11.

sns::SNS_AUCTION_ID_DOMAIN

pub const SNS_AUCTION_ID_DOMAIN: &str;

Source line: 12.

sns::SNS_REGISTRATION_PRICE_PER_YEAR

pub const SNS_REGISTRATION_PRICE_PER_YEAR: u128;

Source line: 13.

sns::normalize_sigil_name

pub fn normalize_sigil_name(input: &str) -> Result<String, CoreError>;

Source line: 56.

sns::namehash

pub fn namehash(name: &str) -> Result<String, CoreError>;

Source line: 86.

sns::auction_id

pub fn auction_id(name: &str) -> Result<String, CoreError>;

Source line: 91.

sns::name_registration_commitment

pub fn name_registration_commitment(
    chain_id: &str,
    name: &str,
    owner_did: &str,
    salt: &str,
    reveal_nonce: &str,
) -> Result<String, CoreError>;

Source line: 96.

sns::sealed_name_bid_commitment

pub fn sealed_name_bid_commitment(
    chain_id: &str,
    auction_id: &str,
    name: &str,
    bidder_did: &str,
    bid_amount: u128,
    salt: &str,
) -> Result<String, CoreError>;

Source line: 124.

sns::NameStatus

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NameStatus {
    Active,
    ExpiredGrace,
    Reclaimable,
    Revoked,
    Disputed,
}

Source line: 156.

sns::SnsNameRecord

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SnsNameRecord {
pub name_hash: String,
pub canonical_name: String,
pub parent_hash: Option<String>,
pub label: String,
pub owner_did: String,
pub admin_did: Option<String>,
pub registered_at_height: u64,
pub expires_at_height: Option<u64>,
pub status: NameStatus,
pub username_compat: Option<String>,
pub resolver_revision: u64,
pub transfer_nonce: u64,
pub is_reserved: bool,
pub is_disputed: bool
}

Source line: 165.

sns::NameRecordKind

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NameRecordKind {
    WalletAddress,
    Did,
    PublicKey,
    Mailbox,
    MailService,
    WeaveMailboxRef,
    Website,
    WeaveDrive,
    ServiceEndpoint,
    Avatar,
    Text,
    SubdomainDelegation,
}

Source line: 184.

sns::SnsResolverRecord

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SnsResolverRecord {
pub name_hash: String,
pub kind: NameRecordKind,
pub value: String,
pub ttl_hint_blocks: Option<u64>,
pub revision: u64,
pub controller_did: String
}

Source line: 200.

sns::SnsResolverRecord::validate_public_shape

pub fn validate_public_shape(&self) -> Result<(), CoreError>;

Source line: 210.

sns::NamePermissionScope

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NamePermissionScope {
    ManageRecords,
    ManageMailRecords,
    ManageWebsiteRecords,
    DelegateSubdomains,
    RenewName,
    TransferName,
}

Source line: 247.

sns::NameDelegation

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct NameDelegation {
pub grant_id: String,
pub name_hash: String,
pub delegate_did: String,
pub scopes: Vec<NamePermissionScope>,
pub valid_until_height: Option<u64>,
pub revoked_at_height: Option<u64>,
pub revision: u64
}

Source line: 257.

sns::RegisterNameData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RegisterNameData {
pub name: String,
pub owner_did: String,
pub years: u8,
pub salt: String,
pub reveal_nonce: String,
pub client_nonce: String
}

Source line: 268.

sns::RenewNameData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RenewNameData {
pub name: String,
pub years: u8,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 278.

sns::SetNameRecordsData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetNameRecordsData {
pub name: String,
pub records: Vec<SnsResolverRecord>,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 286.

sns::DeleteNameRecordsData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DeleteNameRecordsData {
pub name: String,
pub kinds: Vec<NameRecordKind>,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 294.

sns::DelegateSubdomainData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DelegateSubdomainData {
pub name: String,
pub subdomain: String,
pub delegate_did: String,
pub scopes: Vec<NamePermissionScope>,
pub valid_until_height: Option<u64>,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 302.

sns::RevokeDelegationData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RevokeDelegationData {
pub name: String,
pub grant_id: String,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 313.

sns::SetPrimaryNameData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetPrimaryNameData {
pub subject_did: String,
pub name: String,
pub expected_revision: u64,
pub client_nonce: String
}

Source line: 321.

sns::SnsCommitmentStatus

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SnsCommitmentStatus {
    Committed,
    Revealed,
    Expired,
    Forfeited,
}

Source line: 330.

sns::SnsNameRegistrationCommitment

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SnsNameRegistrationCommitment {
pub commitment: String,
pub bidder_did: String,
pub deposit: u128,
pub reveal_after_height: u64,
pub expires_at_height: u64,
pub committed_at_height: u64,
pub status: SnsCommitmentStatus,
pub revealed_name_hash: Option<String>
}

Source line: 338.

sns::SnsSealedBidStatus

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SnsSealedBidStatus {
    Committed,
    Revealed,
    Refunded,
    Settled,
    Forfeited,
}

Source line: 351.

sns::SnsSealedBidCommitment

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SnsSealedBidCommitment {
pub auction_id: String,
pub commitment: String,
pub bidder_did: String,
pub deposit: u128,
pub committed_at_height: u64,
pub status: SnsSealedBidStatus,
pub revealed_name_hash: Option<String>,
pub revealed_bid_amount: Option<u128>
}

Source line: 360.

sns::SnsAuctionStatus

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SnsAuctionStatus {
    Open,
    Finalized,
}

Source line: 373.

sns::SnsAuctionRecord

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SnsAuctionRecord {
pub auction_id: String,
pub name_hash: String,
pub canonical_name: String,
pub highest_bid: Option<u128>,
pub highest_bidder: Option<String>,
pub highest_commitment: Option<String>,
pub revealed_count: u64,
pub finalized_at_height: Option<u64>,
pub status: SnsAuctionStatus
}

Source line: 379.

sns::CommitNameRegistrationData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CommitNameRegistrationData {
pub commitment: String,
pub bidder_did: String,
pub deposit: u128,
pub reveal_after_height: u64,
pub expires_at_height: u64,
pub client_nonce: String
}

Source line: 392.

sns::CommitSealedNameBidData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CommitSealedNameBidData {
pub auction_id: String,
pub commitment: String,
pub bidder_did: String,
pub deposit: u128,
pub client_nonce: String
}

Source line: 402.

sns::RevealSealedNameBidData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RevealSealedNameBidData {
pub auction_id: String,
pub name: String,
pub bid_amount: u128,
pub salt: String,
pub bidder_did: String,
pub client_nonce: String
}

Source line: 411.

sns::FinalizeSealedNameAuctionData

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct FinalizeSealedNameAuctionData {
pub auction_id: String,
pub name: String,
pub winner_did: String,
pub expected_bid: u128,
pub years: u8,
pub client_nonce: String
}

Source line: 421.

On this page