komple-framework-metadata-module 1.0.0-beta

Contract used for keeping metadata information of a collection in Komple Framework.
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
110
111

use crate::state::{Config, MetaInfo, Metadata, Trait};
use cosmwasm_schema::{cw_serde, QueryResponses};
use komple_framework_types::modules::metadata::Metadata as MetadataType;
use komple_framework_types::shared::query::ResponseWrapper;

/// Message to be sent along the `RegisterMsg` for instantiation.
#[cw_serde]
pub struct InstantiateMsg {
    pub metadata_type: MetadataType,
}

#[cw_serde]
pub enum ExecuteMsg {
    /// Admin message.
    ///
    /// Add token metadata information.
    AddMetadata {
        meta_info: MetaInfo,
        attributes: Vec<Trait>,
    },
    /// Admin message.
    ///
    /// Link a token id to a metadata id.
    /// If metadata id is `None`, then the token id will be used as metadata id.
    LinkMetadata {
        token_id: u32,
        metadata_id: Option<u32>,
    },
    /// Admin message.
    ///
    /// Unlink metadata from a token id.
    UnlinkMetadata { token_id: u32 },
    /// Admin message.
    ///
    /// Update the meta info for a metadata.
    /// Can be called for raw metadata id and linked metadata id.
    UpdateMetaInfo {
        raw_metadata: bool,
        id: u32,
        meta_info: MetaInfo,
    },
    /// Admin message.
    ///
    /// Add an attribute for a metadata.
    /// Can be called for raw metadata id and linked metadata id.
    AddAttribute {
        raw_metadata: bool,
        id: u32,
        attribute: Trait,
    },
    /// Admin message.
    ///
    /// Update an attribute for a metadata.
    /// Can be called for raw metadata id and linked metadata id.
    UpdateAttribute {
        raw_metadata: bool,
        id: u32,
        attribute: Trait,
    },
    /// Admin message.
    ///
    /// Remove a trait from a metadata's attributes.
    /// Can be called for raw metadata id and linked metadata id.
    RemoveAttribute {
        raw_metadata: bool,
        id: u32,
        trait_type: String,
    },
    /// Admin message.
    ///
    /// Update the operators of this contract.
    UpdateOperators { addrs: Vec<String> },
}

#[cw_serde]
#[derive(QueryResponses)]
pub enum QueryMsg {
    /// Get the contract's config.
    #[returns(ResponseWrapper<Config>)]
    Config {},
    /// Get a metadata with given raw metadata id.
    #[returns(ResponseWrapper<Metadata>)]
    RawMetadata { metadata_id: u32 },
    /// Get a metadata with given token id.
    #[returns(ResponseWrapper<MetadataResponse>)]
    Metadata { token_id: u32 },
    /// List all the raw metadata with pagination.
    #[returns(ResponseWrapper<Vec<MetadataResponse>>)]
    RawMetadatas {
        start_after: Option<u32>,
        limit: Option<u8>,
    },
    /// List all the linked metadata with pagination.
    #[returns(ResponseWrapper<Vec<MetadataResponse>>)]
    Metadatas {
        start_after: Option<u32>,
        limit: Option<u8>,
    },
    /// Get the operators of this contract.
    #[returns(ResponseWrapper<Vec<String>>)]
    Operators {},
}

#[cw_serde]
pub struct MetadataResponse {
    pub metadata: Metadata,
    pub metadata_id: u32,
}

#[cw_serde]
pub struct MigrateMsg {}