create-dubhe 0.0.13 → 0.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-dubhe",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "type": "module",
   "license": "MIT",
   "author": "team@obelisk.build",

package/template/101/sui-template/contracts/counter/sources/codegen/errors/counter_error_invalid_increment.move

@@ -0,0 +1,30 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: Apache-2.0
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::counter_error_invalid_increment {
+
+  #[error]
+
+  const InvalidIncrement: vector<u8> = b"Number can't be incremented, must be more than 0";
+
+  /// Get the error message.
+
+  public fun message(): vector<u8> {
+    InvalidIncrement
+  }
+
+  /// Abort execution with the given error code.
+
+  public fun emit() {
+    abort InvalidIncrement
+  }
+
+  /// Require that the given condition is true, otherwise abort with the given error code.
+
+  public fun require(condition: bool) {
+    if (!condition) { emit() }
+  }
+}

package/template/101/sui-template/contracts/counter/sources/codegen/events/counter_event_increment.move

@@ -0,0 +1,28 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: Apache-2.0
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::counter_event_increment {
+
+  use sui::event;
+
+  use std::ascii::String;
+
+  public struct IncrementEvent has copy, drop {
+    value: u32,
+  }
+
+  public fun new(value: u32): IncrementEvent {
+    IncrementEvent {
+                                   value
+                               }
+  }
+
+  public fun emit(value: u32) {
+    event::emit(IncrementEvent {
+                                   value
+                               });
+  }
+}

package/template/101/sui-template/contracts/counter/sources/codegen/schemas/counter.move

@@ -1,5 +1,5 @@
   // Copyright (c) Obelisk Labs, Inc.
-  // SPDX-License-Identifier: MIT
+  // SPDX-License-Identifier: Apache-2.0
   #[allow(unused_use)]
   
   /* Autogenerated file. Do not edit manually. */
@@ -14,11 +14,7 @@
 
   use std::type_name;
 
-  use dubhe::dapps_system;
-
-  use dubhe::storage_migrate;
-
-  use dubhe::dapps_schema::Dapps;
+  use dubhe::storage_migration;
 
   use dubhe::storage_value::{Self, StorageValue};
 
@@ -26,25 +22,29 @@
 
   use dubhe::storage_double_map::{Self, StorageDoubleMap};
 
-  use counter::dapp_key::DappKey;
-
   use sui::dynamic_field as df;
 
+  use sui::sui::SUI;
+
+  use sui::coin::Coin;
+
+  use sui::balance::Balance;
+
   public struct Counter has key, store {
     id: UID,
   }
 
   public fun borrow_value(self: &Counter): &StorageValue<u32> {
-    storage_migrate::borrow_field(&self.id, b"value")
+    storage_migration::borrow_field(&self.id, b"value")
   }
 
   public(package) fun borrow_mut_value(self: &mut Counter): &mut StorageValue<u32> {
-    storage_migrate::borrow_mut_field(&mut self.id, b"value")
+    storage_migration::borrow_mut_field(&mut self.id, b"value")
   }
 
   public(package) fun create(ctx: &mut TxContext): Counter {
     let mut id = object::new(ctx);
-    storage_migrate::add_field<StorageValue<u32>>(&mut id, b"value", storage_value::new());
+    storage_migration::add_field<StorageValue<u32>>(&mut id, b"value", storage_value::new());
     Counter { id }
   }
 
@@ -52,8 +52,8 @@
 
   // ======================================== View Functions ========================================
 
-  public fun get_value(self: &Counter): Option<u32> {
-    self.borrow_value().try_get()
+  public fun get_value(self: &Counter): &u32 {
+    self.borrow_value().borrow()
   }
 
   // =========================================================================================================

package/template/101/sui-template/contracts/counter/sources/codegen/schemas/default/dapp/metadata.move

@@ -0,0 +1,102 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: Apache-2.0
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::dapp_metadata {
+
+  use std::ascii::String;
+
+  public struct DappMetadata has drop, copy, store {
+    name: String,
+    description: String,
+    icon_url: String,
+    website_url: String,
+    created_at: u64,
+    partners: vector<String>,
+  }
+
+  public fun new(
+    name: String,
+    description: String,
+    icon_url: String,
+    website_url: String,
+    created_at: u64,
+    partners: vector<String>,
+  ): DappMetadata {
+    DappMetadata {
+            name,
+            description,
+            icon_url,
+            website_url,
+            created_at,
+            partners,
+        }
+  }
+
+  public fun set(
+    self: &mut DappMetadata,
+    name: String,
+    description: String,
+    icon_url: String,
+    website_url: String,
+    created_at: u64,
+    partners: vector<String>,
+  ) {
+    self.name = name;
+    self.description = description;
+    self.icon_url = icon_url;
+    self.website_url = website_url;
+    self.created_at = created_at;
+    self.partners = partners;
+  }
+
+  public fun set_name(self: &mut DappMetadata, name: String) {
+    self.name = name;
+  }
+
+  public fun set_description(self: &mut DappMetadata, description: String) {
+    self.description = description;
+  }
+
+  public fun set_icon_url(self: &mut DappMetadata, icon_url: String) {
+    self.icon_url = icon_url;
+  }
+
+  public fun set_website_url(self: &mut DappMetadata, website_url: String) {
+    self.website_url = website_url;
+  }
+
+  public fun set_created_at(self: &mut DappMetadata, created_at: u64) {
+    self.created_at = created_at;
+  }
+
+  public fun set_partners(self: &mut DappMetadata, partners: vector<String>) {
+    self.partners = partners;
+  }
+
+  public fun get_name(self: DappMetadata): String {
+    self.name
+  }
+
+  public fun get_description(self: DappMetadata): String {
+    self.description
+  }
+
+  public fun get_icon_url(self: DappMetadata): String {
+    self.icon_url
+  }
+
+  public fun get_website_url(self: DappMetadata): String {
+    self.website_url
+  }
+
+  public fun get_created_at(self: DappMetadata): u64 {
+    self.created_at
+  }
+
+  public fun get_partners(self: DappMetadata): vector<String> {
+    self.partners
+  }
+}

package/template/101/sui-template/contracts/counter/sources/codegen/schemas/default/dapp/schema.move

@@ -0,0 +1,114 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: Apache-2.0
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::dapp_schema {
+
+  use counter::dapp_metadata::DappMetadata;
+
+  use dubhe::storage_value;
+
+  use dubhe::storage_value::StorageValue;
+
+  use dubhe::storage_migration;
+
+  use sui::transfer::public_share_object;
+
+  use dubhe::type_info;
+
+  public struct Dapp has key, store {
+    id: UID,
+  }
+
+  public fun borrow_admin(self: &Dapp): &StorageValue<address> {
+    storage_migration::borrow_field(&self.id, b"admin")
+  }
+
+  public(package) fun borrow_mut_admin(self: &mut Dapp): &mut StorageValue<address> {
+    storage_migration::borrow_mut_field(&mut self.id, b"admin")
+  }
+
+  public fun borrow_package_id(self: &Dapp): &StorageValue<address> {
+    storage_migration::borrow_field(&self.id, b"package_id")
+  }
+
+  public(package) fun borrow_mut_package_id(self: &mut Dapp): &mut StorageValue<address> {
+    storage_migration::borrow_mut_field(&mut self.id, b"package_id")
+  }
+
+  public fun borrow_version(self: &Dapp): &StorageValue<u32> {
+    storage_migration::borrow_field(&self.id, b"version")
+  }
+
+  public(package) fun borrow_mut_version(self: &mut Dapp): &mut StorageValue<u32> {
+    storage_migration::borrow_mut_field(&mut self.id, b"version")
+  }
+
+  public fun borrow_metadata(self: &Dapp): &StorageValue<DappMetadata> {
+    storage_migration::borrow_field(&self.id, b"metadata")
+  }
+
+  public(package) fun borrow_mut_metadata(self: &mut Dapp): &mut StorageValue<DappMetadata> {
+    storage_migration::borrow_mut_field(&mut self.id, b"metadata")
+  }
+
+  public fun borrow_schemas(self: &Dapp): &StorageValue<vector<address>> {
+    storage_migration::borrow_field(&self.id, b"schemas")
+  }
+
+  public(package) fun borrow_mut_schemas(self: &mut Dapp): &mut StorageValue<vector<address>> {
+    storage_migration::borrow_mut_field(&mut self.id, b"schemas")
+  }
+
+  public fun borrow_safe_mode(self: &Dapp): &StorageValue<bool> {
+    storage_migration::borrow_field(&self.id, b"safe_mode")
+  }
+
+  public(package) fun borrow_mut_safe_mode(self: &mut Dapp): &mut StorageValue<bool> {
+    storage_migration::borrow_mut_field(&mut self.id, b"safe_mode")
+  }
+
+  public(package) fun create(ctx: &mut TxContext): Dapp {
+    let mut id = object::new(ctx);
+    storage_migration::add_field<StorageValue<address>>(&mut id, b"admin", storage_value::new());
+    storage_migration::add_field<StorageValue<address>>(&mut id, b"package_id", storage_value::new());
+    storage_migration::add_field<StorageValue<u32>>(&mut id, b"version", storage_value::new());
+    storage_migration::add_field<StorageValue<DappMetadata>>(&mut id, b"metadata", storage_value::new());
+    storage_migration::add_field<StorageValue<vector<address>>>(&mut id, b"schemas", storage_value::new());
+    storage_migration::add_field<StorageValue<bool>>(&mut id, b"safe_mode", storage_value::new());
+    Dapp { id }
+  }
+
+  public(package) fun upgrade<DappKey: drop>(dapp: &mut Dapp, ctx: &TxContext) {
+    assert!(dapp.borrow_metadata().contains(), 0);
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+    let new_package_id = type_info::current_package_id<DappKey>();
+    dapp.borrow_mut_package_id().set(new_package_id);
+    dapp.borrow_mut_version().mutate!(|version| {
+        *version = *version + 1;
+        });
+  }
+
+  public(package) fun add_schema<Schema: key + store>(dapp: &mut Dapp, schema: Schema, ctx: &TxContext) {
+    assert!(dapp.borrow_metadata().contains(), 0);
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+    let schema_id = object::id_address(&schema);
+    dapp.borrow_mut_schemas().borrow_mut().push_back(schema_id);
+    public_share_object(schema);
+  }
+
+  #[test_only]
+
+  public fun create_dapp_for_testing(ctx: &mut TxContext): Dapp {
+    create(ctx)
+  }
+
+  #[test_only]
+
+  public fun distroy_dapp_for_testing(dapp: Dapp) {
+    let Dapp { id } = dapp;
+    id.delete();
+  }
+}

package/template/101/sui-template/contracts/counter/sources/codegen/schemas/default/dapp/system.move

@@ -0,0 +1,93 @@
+module counter::dapp_system {
+
+  use std::ascii::String;
+
+  use std::ascii;
+
+  use dubhe::type_info;
+
+  use sui::clock::Clock;
+
+  use counter::dapp_schema;
+
+  use counter::dapp_metadata;
+
+  use counter::dapp_schema::Dapp;
+
+  public struct DappKey has drop {}
+
+  public(package) fun new(): DappKey {
+    DappKey {  }
+  }
+
+  public(package) fun create(name: String, description: String, clock: &Clock, ctx: &mut TxContext): Dapp {
+    let mut dapp = dapp_schema::create(ctx);
+    assert!(!dapp.borrow_metadata().contains(), 0);
+    dapp.borrow_mut_metadata().set(
+            dapp_metadata::new(
+                name,
+                description,
+                ascii::string(b""),
+                ascii::string(b""),
+                clock.timestamp_ms(),
+                vector[]
+            )
+        );
+    let package_id = type_info::current_package_id<DappKey>();
+    dapp.borrow_mut_package_id().set(package_id);
+    dapp.borrow_mut_admin().set(ctx.sender());
+    dapp.borrow_mut_version().set(1);
+    dapp.borrow_mut_safe_mode().set(false);
+    dapp.borrow_mut_schemas().set(vector[]);
+    dapp
+  }
+
+  public entry fun set_metadata(
+    dapp: &mut Dapp,
+    name: String,
+    description: String,
+    icon_url: String,
+    website_url: String,
+    partners: vector<String>,
+    ctx: &TxContext,
+  ) {
+    assert!(dapp.borrow_admin().contains(), 0);
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+    let created_at = dapp.borrow_mut_metadata().take().get_created_at();
+    dapp.borrow_mut_metadata().set(
+            dapp_metadata::new(
+                name,
+                description,
+                icon_url,
+                website_url,
+                created_at,
+                partners
+            )
+        );
+  }
+
+  public entry fun transfer_ownership(dapp: &mut Dapp, new_admin: address, ctx: &mut TxContext) {
+    assert!(dapp.borrow_admin().contains(), 0);
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+    dapp.borrow_mut_admin().set(new_admin);
+  }
+
+  public entry fun set_safe_mode(dapp: &mut Dapp, safe_mode: bool, ctx: &TxContext) {
+    assert!(dapp.borrow_admin().contains(), 0);
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+    dapp.borrow_mut_safe_mode().set(safe_mode);
+  }
+
+  public fun ensure_no_safe_mode(dapp: &Dapp) {
+    assert!(!dapp.borrow_safe_mode().get(), 0);
+  }
+
+  public fun ensure_has_authority(dapp: &Dapp, ctx: &TxContext) {
+    assert!(dapp.borrow_admin().get() == ctx.sender(), 0);
+  }
+
+  public fun ensure_has_schema<Schema: key + store>(dapp: &Dapp, schema: &Schema) {
+    let schema_id = object::id_address(schema);
+    assert!(dapp.borrow_schemas().get().contains(&schema_id), 0);
+  }
+}

package/template/101/sui-template/contracts/counter/sources/scripts/deploy_hook.move

@@ -1,96 +1,24 @@
-#[allow(lint(share_owned))]
-  
-  module counter::deploy_hook {
-
-  use dubhe::dapps_schema::Dapps;
-
-  use dubhe::dapps_system;
-
-  use counter::schema_hub::SchemaHub;
+#[allow(lint(share_owned), unused_let_mut)]module counter::deploy_hook {
 
   use std::ascii::string;
 
   use sui::clock::Clock;
 
-  use sui::sui::SUI;
-
-  use sui::coin::Coin;
-
-  use sui::package::UpgradeCap;
-
-  use sui::transfer::public_share_object;
+  use counter::dapp_system;
 
   use counter::counter_schema::Counter;
 
-  #[test_only]
-
-  use sui::clock;
-
-  #[test_only]
-
-  use sui::coin;
-
-  #[test_only]
-
-  use sui::test_scenario;
-
-  #[test_only]
-
-  use sui::package;
-
-  #[test_only]
-
-  use counter::schema_hub;
-
-  #[test_only]
-
-  use dubhe::dapps_schema;
-
-  #[test_only]
-
-  use sui::test_scenario::Scenario;
-
-  public entry fun run(
-    schema_hub: &mut SchemaHub,
-    dapps: &mut Dapps,
-    cap: &UpgradeCap,
-    clock: &Clock,
-    coin: Coin<SUI>,
-    ctx: &mut TxContext,
-  ) {
-    // Register the dapp to dubhe.
-    dapps_system::register(dapps,cap,string(b"counter"),string(b"counter"),clock,coin,ctx);
+  public entry fun run(clock: &Clock, ctx: &mut TxContext) {
+    // Create a dapp.
+    let mut dapp = dapp_system::create(string(b"counter"),string(b"counter contract"), clock , ctx);
     // Create schemas
     let mut counter = counter::counter_schema::create(ctx);
     // Logic that needs to be automated once the contract is deployed
-
-    counter.borrow_mut_value().set(0);
-
-    // Authorize schemas and public share objects
-    schema_hub.authorize_schema<Counter>();
-    public_share_object(counter);
-  }
-
-  #[test_only]
-
-  public fun deploy_hook_for_testing(): (Scenario, SchemaHub, Dapps) {
-    let mut scenario = test_scenario::begin(@0xA);
     {
-          let ctx = test_scenario::ctx(&mut scenario);
-          dapps_schema::init_dapps_for_testing(ctx);
-          schema_hub::init_schema_hub_for_testing(ctx);
-          test_scenario::next_tx(&mut scenario,@0xA);
-      };
-    let mut dapps = test_scenario::take_shared<Dapps>(&scenario);
-    let mut schema_hub = test_scenario::take_shared<SchemaHub>(&scenario);
-    let ctx = test_scenario::ctx(&mut scenario);
-    let clock = clock::create_for_testing(ctx);
-    let upgrade_cap = package::test_publish(@0x42.to_id(), ctx);
-    let coin  = coin::mint_for_testing<SUI>(1_000_000_000, ctx);
-    run(&mut schema_hub, &mut dapps, &upgrade_cap, &clock, coin, ctx);
-    clock::destroy_for_testing(clock);
-    upgrade_cap.make_immutable();
-    test_scenario::next_tx(&mut scenario,@0xA);
-    (scenario, schema_hub, dapps)
+		counter.borrow_mut_value().set(0);
+    };
+    // Authorize schemas and public share objects
+    dapp.add_schema<Counter>(counter, ctx);
+    sui::transfer::public_share_object(dapp);
   }
 }

package/template/101/sui-template/contracts/counter/sources/scripts/migrate.move

@@ -1,7 +1,6 @@
 module counter::migrate {
 
-  const ON_CHAIN_VERSION: u32 = 0;
-  const ON_CHAIN_VERSION1: u32 = 0;
+  const ON_CHAIN_VERSION: u32 = 1;
 
   public fun on_chain_version(): u32 {
     ON_CHAIN_VERSION

package/template/101/sui-template/contracts/counter/sources/systems/counter.move

@@ -1,11 +1,20 @@
 module counter::counter_system {
     use counter::counter_schema::Counter;
+    use counter::counter_event_increment;
+    use counter::counter_error_invalid_increment;
 
-    public entry fun inc(counter: &mut Counter) {
-        counter.borrow_mut_value().mutate!(|value| *value = *value + 1);
+    public entry fun inc(counter: &mut Counter, number: u32) {
+        // Check if the increment value is valid.
+        counter_error_invalid_increment::require(number > 0 && number < 100);
+        counter.borrow_mut_value().mutate!(|value| {
+        // Increment the counter value.
+        *value =  *value + number;
+        // Emit an event to notify the increment.
+        counter_event_increment::emit(number);
+        });
     }
 
-    public fun get(counter: &Counter): u32 {
+    public fun get(counter: &Counter) : u32 {
         counter.borrow_value().get()
     }
-}
+}

package/template/101/sui-template/contracts/counter/sources/tests/counter.move

@@ -0,0 +1,26 @@
+#[test_only]
+module counter::counter_test {
+    use sui::test_scenario;
+    use counter::counter_system;
+    use counter::counter_schema::Counter;
+    use counter::init_test;
+
+    #[test]
+    public fun inc() {
+        let (scenario, dapp)  = init_test::deploy_dapp_for_testing(@0xA);
+
+        let mut counter = test_scenario::take_shared<Counter>(&scenario);
+
+        assert!(counter.borrow_value().get() == 0);
+
+        counter_system::inc(&mut counter, 10);
+        assert!(counter.borrow_value().get() == 10);
+
+        counter_system::inc(&mut counter, 10);
+        assert!(counter.borrow_value().get() == 20);
+
+        test_scenario::return_shared(counter);
+        dapp.distroy_dapp_for_testing();
+        scenario.end();
+    }
+}

package/template/101/sui-template/contracts/counter/sources/tests/init.move

@@ -0,0 +1,21 @@
+#[test_only]module counter::init_test {
+
+  use counter::dapp_schema::Dapp;
+
+  use sui::clock;
+
+  use sui::test_scenario;
+
+  use sui::test_scenario::Scenario;
+
+  public fun deploy_dapp_for_testing(sender: address): (Scenario, Dapp) {
+    let mut scenario = test_scenario::begin(sender);
+    let ctx = test_scenario::ctx(&mut scenario);
+    let clock = clock::create_for_testing(ctx);
+    counter::deploy_hook::run(&clock, ctx);
+    clock::destroy_for_testing(clock);
+    test_scenario::next_tx(&mut scenario,sender);
+    let dapp = test_scenario::take_shared<Dapp>(&scenario);
+    (scenario, dapp)
+  }
+}

package/template/101/sui-template/contracts/dubhe-framework/sources/frames/utils/type_info.move

@@ -1,6 +1,7 @@
 module dubhe::type_info {
     use std::ascii::String;
     use std::ascii::string;
+    use std::type_name;
     use sui::address;
     use std::type_name::TypeName;
 
@@ -26,4 +27,10 @@ module dubhe::type_info {
 
         (package_id, module_name, struct_name, struct_name_with_type)
     }
+
+    public fun current_package_id<T>(): address {
+        let type_name = type_name::get<T>();
+        let (package_id, _, _, _) = parse_type_name(type_name);
+        package_id
+    }
 }

package/template/{nextjs/sui-template/contracts/dubhe-framework/sources/storages/migrate.move → 101/sui-template/contracts/dubhe-framework/sources/storages/migration.move}

@@ -1,8 +1,8 @@
-module dubhe::storage_migrate {
+module dubhe::storage_migration {
     use sui::dynamic_field as df;
 
-    public fun add_field<StorageType: store>(uid: &mut UID, field_name: vector<u8>, storagr_type: StorageType) {
-        df::add(uid, field_name, storagr_type);
+    public fun add_field<StorageType: store>(uid: &mut UID, field_name: vector<u8>, storagre_type: StorageType) {
+        df::add(uid, field_name, storagre_type);
     }
 
     public fun borrow_field<StorageType: store>(uid: &UID, field_name: vector<u8>): &StorageType {

package/template/101/sui-template/contracts/dubhe-framework/sources/storages/value.move

@@ -51,7 +51,7 @@ module dubhe::storage_value {
         value
     }
 
-    /// Set the `value` of the `StorageValue`.
+    /// Put the `value` of the `StorageValue`.
     public fun put<V: store>(self: &mut StorageValue<V>, value: V) {
         assert!(!self.contains(), EValueAlreadyExist);
         self.contents.push_back(Entry { value });