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
112
113
114

// Copyright (C) 2021 Subspace Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Pallet object store, used for simple object storage on the network.

#![cfg_attr(not(feature = "std"), no_std)]
#![forbid(unsafe_code)]
#![warn(rust_2018_idioms, missing_debug_implementations)]

#[cfg(all(feature = "std", test))]
mod mock;
#[cfg(all(feature = "std", test))]
mod tests;

pub use pallet::*;
use subspace_core_primitives::{crypto, Blake3Hash};

#[frame_support::pallet]
mod pallet {
    use frame_support::pallet_prelude::*;
    use frame_system::pallet_prelude::*;
    use log::debug;
    use subspace_core_primitives::{crypto, Blake3Hash};

    #[pallet::config]
    pub trait Config: frame_system::Config {
        /// `pallet-object-store` events
        type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;
    }

    /// Pallet object-store, used for storing arbitrary user-provided data combined into object-store.
    #[pallet::pallet]
    pub struct Pallet<T>(_);

    /// `pallet-object-store` events
    #[pallet::event]
    #[pallet::generate_deposit(pub (super) fn deposit_event)]
    pub enum Event<T: Config> {
        /// New object was added.
        ObjectSubmitted {
            who: T::AccountId,
            object_id: Blake3Hash,
            object_size: u32,
        },
    }

    #[pallet::call]
    impl<T: Config> Pallet<T> {
        // TODO: add proper weights
        // TODO: For now we don't have fees, but we will have them in the future
        /// Put a new object into a feed
        #[pallet::call_index(0)]
        #[pallet::weight((10_000, Pays::No))]
        pub fn put(origin: OriginFor<T>, object: Vec<u8>) -> DispatchResult {
            let who = ensure_signed(origin)?;

            let object_size = object.len() as u32;

            let object_id = crypto::blake3_hash(&object);

            debug!(
                target: "runtime:object-store",
                "New object {}, size {} bytes",
                hex::encode(object_id),
                object_size
            );

            Self::deposit_event(Event::ObjectSubmitted {
                who,
                object_id,
                object_size,
            });

            Ok(())
        }
    }
}

/// Mapping to the object offset and size within an extrinsic
#[derive(Debug)]
pub struct CallObject {
    /// Object hash
    pub hash: Blake3Hash,
    /// Offset of object in the encoded call.
    pub offset: u32,
}

impl<T: Config> Call<T> {
    /// Extract object location if an extrinsic corresponds to `put` call
    pub fn extract_call_object(&self) -> Option<CallObject> {
        match self {
            Self::put { object } => {
                // `1` corresponds to `Call::put {}` enum variant encoding.
                Some(CallObject {
                    hash: crypto::blake3_hash(object),
                    offset: 1,
                })
            }
            _ => None,
        }
    }
}