sns-wasm 0.1.1

Client-side SDK for interacting with Solana Name Service Program.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! SNS record types: TLD, domain and subdomain.

use derive_more::{Constructor, Deref, Into};
use serde::{Deserialize, Serialize};
use solana_pubkey::Pubkey;

use crate::{
    SNSNode, SOL_TLD_ADDRESS, SOL_TLD_OWNER_ADDRESS_MAINNET, derive_domain, derive_subdomain,
    derive_tld,
    instruction_builder::{CreateDomainInstBuilder, CreateSubdomainInstBuilder},
};

/// SNS record address and its owner.
#[derive(Debug, Clone, Copy, Default, Constructor, Serialize, Deserialize)]
pub struct SNSNodeWithOwner {
    /// Programmatically Derived Address (PDA) of this account.
    pub pda: Pubkey,
    /// Owner of account.
    pub owner: Pubkey,
}

/// Top Level Domain (TLD) SNS record.
///
/// Specs: <https://sns.guide/domain-name/domain-tld.html>
#[derive(Debug, Clone, Copy, Default, Deref, Into)]
pub struct TLDomain(SNSNodeWithOwner);

impl TLDomain {
    /// Returns new instance with given Programmatically Derived Address (PDA) and its owner.
    pub fn new(pda: Pubkey, owner: Pubkey) -> Self {
        Self(SNSNodeWithOwner::new(pda, owner))
    }

    /// Returns new instance with given owner and deriving PDA from given class + name +
    /// [`ROOT_TLD_ADDRESS`].
    pub fn derive_new(owner: Pubkey, class: Option<&Pubkey>, name: &str) -> Self {
        let SNSNode { pda, .. } = derive_tld(class, name);
        Self(SNSNodeWithOwner::new(pda, owner))
    }

    /// Returns new instance with Mainnet owner of PDA of `.sol`.
    pub fn sol_mainnet() -> Self {
        Self(SNSNodeWithOwner::new(SOL_TLD_ADDRESS, SOL_TLD_OWNER_ADDRESS_MAINNET))
    }

    /// Returns new instance with System Program as owner of PDA of `.sol`.
    pub fn sol_devnet() -> Self {
        let owner = Pubkey::default();
        Self(SNSNodeWithOwner::new(SOL_TLD_ADDRESS, owner))
    }
}

/// Domain SNS record.
///
/// Specs: <https://sns.guide/domain-name/domain-tld.html>
#[derive(Debug, Clone, Copy, Deref, Into)]
pub struct Domain(SNSNodeWithOwner);

impl Domain {
    /// Returns new instance with given Programmatically Derived Address (PDA) and its owner.
    pub fn new(pda: Pubkey, owner: Pubkey) -> Self {
        Self(SNSNodeWithOwner::new(pda, owner))
    }

    /// Returns new instance with given owner and deriving PDA from given class + name +
    /// TLD.
    pub fn derive_new(parent: &Pubkey, owner: Pubkey, class: Option<&Pubkey>, name: &str) -> Self {
        let SNSNode { pda, .. } = derive_domain(parent, class, name);
        Self::new(pda, owner)
    }

    /// Returns builder for create domain instruction.
    pub fn create_instruction_builder(
        payer: Pubkey,
        tld: TLDomain,
        name: &str,
    ) -> CreateDomainInstBuilder {
        CreateDomainInstBuilder::new(payer, tld, String::from(name))
    }
}

/// Subdomain SNS record.
///
/// Specs: <https://sns.guide/domain-name/domain-tld.html>
#[derive(Debug, Clone, Copy, Deref, Into)]
pub struct Subdomain(SNSNodeWithOwner);

impl Subdomain {
    /// Returns new instance with given Programmatically Derived Address (PDA) and its owner.
    pub fn new(pda: Pubkey, owner: Pubkey) -> Self {
        Self(SNSNodeWithOwner::new(pda, owner))
    }

    /// Returns new instance with given owner and deriving PDA from given class + name +
    /// parent [sub]domain.
    pub fn derive_new(parent: &Pubkey, owner: Pubkey, class: Option<&Pubkey>, name: &str) -> Self {
        let SNSNode { pda, .. } = derive_subdomain(parent, class, name);
        Self::new(pda, owner)
    }

    /// Returns builder for create subdomain instruction.
    pub fn create_instruction_builder(
        payer: Pubkey,
        domain: Domain,
        name: &str,
    ) -> CreateSubdomainInstBuilder {
        CreateSubdomainInstBuilder::new(payer, domain, String::from(name))
    }
}