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

//! Build instruction to create new SNS subdomain.

use solana_instruction::Instruction;
use solana_program_error::ProgramError;
use solana_pubkey::Pubkey;

use super::CreateInstBuilder;
use crate::{Domain, derive_subdomain, name_record::SNSNodeWithOwner};

/// Builds instruction to register subdomain.
#[derive(Debug)]
pub struct CreateSubdomainInstBuilder {
    payer: Pubkey,
    domain: SNSNodeWithOwner,
    owner: Option<Pubkey>,
    class: Option<Pubkey>,
    name: String,
    space: Option<u32>,
}

impl CreateSubdomainInstBuilder {
    /// Returns new builder for given payer, parent SNS record and user defined name.
    ///
    /// - Reserves no extra space for user data, like URLs and social media handles. See
    ///   [`space`](Self::space)
    /// - Unless [`owner`](Self::owner) explicitly set defaults to payer
    /// - Unless [`class``](Self::class) explicitly set defaults to System Program (null address),
    pub fn new(payer: Pubkey, domain: Domain, name: String) -> Self {
        Self { domain: domain.into(), payer, owner: None, class: None, name, space: None }
    }

    /// Sets owner to register for SNS record.
    pub fn owner(mut self, owner: Option<Pubkey>) -> Self {
        self.owner = owner;
        self
    }

    /// Sets class to derive SNS record address from.
    pub fn class(mut self, class: Option<Pubkey>) -> Self {
        self.class = class;
        self
    }

    /// Sets additional blockchain space to allocate for SNS record other than minimum reserved for
    /// [`SNS_RECORD_HEADER_BYTE_LEN`].
    ///
    /// Registering domains at <https://v1.sns.id> allocates 10 KB extra.
    pub fn space(mut self, space: Option<u32>) -> Self {
        self.space = space;
        self
    }

    /// Builds instruction to input into transaction to create new SNS domain.
    pub fn build(self) -> Result<Instruction, ProgramError> {
        let Self { domain: parent, payer, owner, class, name, space } = self;

        // derive subdomain PDA
        let account = derive_subdomain(&parent.pda, class.as_ref(), &name);

        let builder = CreateInstBuilder { payer, account, parent, owner, class, space };
        builder.build()
    }
}