create-dubhe 0.0.1

package/template/nextjs/sui-template/README.md

@@ -0,0 +1,13 @@
+## How to use
+```bash
+1 install sui <https://docs.sui.io/build/install>
+2 cd dubhe-nextjs-template folder 
+3 pnpm install
+4 open new window && npm run localnode
+4 open new window && npm run start-template
+5 set WorldId:<value> to src/chain/config.ts
+6 set PackageId:<value> to src/chain/config.ts
+7 npm run dev
+```
+
+Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

package/template/nextjs/sui-template/contracts/counter/Move.toml

@@ -0,0 +1,13 @@
+[package]
+name = "counter"
+version = "0.0.1"
+edition = "2024.beta"
+
+[dependencies]
+Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "mainnet-v1.36.2" }
+Dubhe = { git = "https://github.com/0xobelisk/dubhe.git", subdir = "packages/dubhe-framework", rev = "main" }
+
+[addresses]
+sui = "0x2"
+dubhe = "0x1736475f476c5dec96f33c03c778843f572239d3a887d795eef66d2836484c28"
+counter = "0x0"

package/template/nextjs/sui-template/contracts/counter/sources/codegen/dapp_key.move

@@ -0,0 +1,16 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: MIT
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::dapp_key {
+
+  /// Authorization token for the app.
+
+  public struct DappKey has drop {}
+
+  public(package) fun new(): DappKey {
+    DappKey {  }
+  }
+}

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

@@ -0,0 +1,50 @@
+  // Copyright (c) Obelisk Labs, Inc.
+  // SPDX-License-Identifier: MIT
+  #[allow(unused_use)]
+  
+  /* Autogenerated file. Do not edit manually. */
+  
+  module counter::counter_schema {
+
+  use std::ascii::String;
+
+  use std::type_name;
+
+  use dubhe::dapps_system;
+
+  use dubhe::dapps_schema::Dapps;
+
+  use dubhe::storage_value::{Self, StorageValue};
+
+  use dubhe::storage_map::{Self, StorageMap};
+
+  use dubhe::storage_double_map::{Self, StorageDoubleMap};
+
+  use counter::dapp_key::DappKey;
+
+  public struct Counter has key, store {
+    id: UID,
+    value: StorageValue<u32>,
+  }
+
+  public fun borrow_value(self: &Counter): &StorageValue<u32> {
+    &self.value
+  }
+
+  public(package) fun borrow_mut_value(self: &mut Counter): &mut StorageValue<u32> {
+    &mut self.value
+  }
+
+  public fun register(dapps: &mut Dapps, ctx: &mut TxContext): Counter {
+    let package_id = dapps_system::current_package_id<DappKey>();
+    assert!(dapps.borrow_metadata().contains_key(package_id), 0);
+    assert!(dapps.borrow_admin().get(package_id) == ctx.sender(), 0);
+    let schema = type_name::get<Counter>().into_string();
+    assert!(!dapps.borrow_schemas().get(package_id).contains(&schema), 0);
+    dapps_system::add_schema<Counter>(dapps, package_id, ctx);
+    Counter {
+                          id: object::new(ctx),
+                          value: storage_value::new(),
+                        }
+  }
+}

package/template/nextjs/sui-template/contracts/counter/sources/script/deploy_hook.move

@@ -0,0 +1,67 @@
+#[allow(lint(share_owned))]
+  
+  module counter::deploy_hook {
+
+  use dubhe::dapps_schema::Dapps;
+
+  use dubhe::dapps_system;
+
+  use counter::dapp_key::DappKey;
+
+  use std::ascii;
+
+  use sui::clock::Clock;
+
+  use sui::transfer::public_share_object;
+
+  #[test_only]
+
+  use dubhe::dapps_schema;
+
+  #[test_only]
+
+  use sui::clock;
+
+  #[test_only]
+
+  use sui::test_scenario;
+
+  #[test_only]
+
+  use sui::test_scenario::Scenario;
+
+  public entry fun run(dapps: &mut Dapps, clock: &Clock, ctx: &mut TxContext) {
+    // Register the dapp to dubhe.
+    dapps_system::register<DappKey>(
+            dapps,
+            ascii::string(b"counter"),
+            ascii::string(b"counter"),
+            clock,
+            ctx
+        );
+    let mut counter = counter::counter_schema::register(dapps, ctx);
+    // Logic that needs to be automated once the contract is deployed
+      counter.borrow_mut_value().set(0);
+
+    // Share the dapp object with the public
+    public_share_object(counter);
+  }
+
+  #[test_only]
+
+  public fun deploy_hook_for_testing(): (Scenario, Dapps) {
+    let mut scenario = test_scenario::begin(@0xA);
+    {
+          let ctx = test_scenario::ctx(&mut scenario);
+          dapps_schema::init_dapps_for_testing(ctx);
+          test_scenario::next_tx(&mut scenario,@0xA);
+      };
+    let mut dapps = test_scenario::take_shared<Dapps>(&scenario);
+    let ctx = test_scenario::ctx(&mut scenario);
+    let clock = clock::create_for_testing(ctx);
+    run(&mut dapps, &clock, ctx);
+    clock::destroy_for_testing(clock);
+    test_scenario::next_tx(&mut scenario,@0xA);
+    (scenario, dapps)
+  }
+}

package/template/nextjs/sui-template/contracts/counter/sources/system/counter.move

@@ -0,0 +1,11 @@
+module counter::counter_system {
+    use counter::counter_schema::Counter;
+
+    public entry fun inc(counter: &mut Counter) {
+        counter.borrow_mut_value().mutate!(|value| *value = *value + 1);
+    }
+
+    public fun get(counter: &Counter): u32 {
+        counter.borrow_value().get()
+    }
+}

package/template/nextjs/sui-template/docker-compose.yaml

@@ -0,0 +1,29 @@
+
+version: "3"
+
+services:
+  sui-test-validator-node:
+    image: vladilenaksana/sui-test-validator:v0.0.3
+    restart: always
+    volumes:
+      - ./:/app
+    ports:
+      - 9000:9000
+      - 9123:9123
+    command: ["/opt/sui/bin/sui-test-validator", "--fullnode-rpc-addr", "0.0.0.0:9000", "--faucet-addr", "0.0.0.0:9123"]
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://sui-test-validator-node:9123"]
+      interval: 3s
+      timeout: 5s
+      retries: 10
+
+  # webapp:
+  #   build:
+  #     context: .
+  #     dockerfile: ./Dockerfile
+  #   ports:
+  #     - 3000:3000
+  #   depends_on:
+  #     "sui-test-validator-node":
+  #       condition: service_healthy
+  #   restart: always

package/template/nextjs/sui-template/dubhe.config.ts

@@ -0,0 +1,14 @@
+import { DubheConfig } from '@0xobelisk/sui-common';
+
+export const dubheConfig = {
+  name: 'counter',
+  description: 'counter',
+  systems: ['counter'],
+  schemas: {
+    counter: {
+      structure: {
+        value: "StorageValue<u32>"
+      }
+    },
+  },
+} as DubheConfig;

package/template/nextjs/sui-template/jest.config.ts

@@ -0,0 +1,17 @@
+import type { InitialOptionsTsJest } from 'ts-jest/dist/types'
+
+const config: InitialOptionsTsJest = {
+  preset: 'ts-jest',
+  setupFilesAfterEnv: ['<rootDir>/setupTests.ts'],
+  transform: {
+    '.+\\.(css|styl|less|sass|scss)$': 'jest-css-modules-transform',
+  },
+  testEnvironment: 'jsdom',
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.test.json',
+    },
+  },
+}
+
+export default config

package/template/nextjs/sui-template/localnet/dubhe-framework/Move.toml

@@ -0,0 +1,39 @@
+[package]
+name = "Dubhe"
+edition = "2024.alpha" # edition = "legacy" to use legacy (pre-2024) Move
+published-at = "0x1736475f476c5dec96f33c03c778843f572239d3a887d795eef66d2836484c28"
+# license = ""           # e.g., "MIT", "GPL", "Apache 2.0"
+# authors = ["..."]      # e.g., ["Joe Smith (joesmith@noemail.com)", "John Snow (johnsnow@noemail.com)"]
+
+[dependencies]
+Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "mainnet-v1.36.2" }
+
+# For remote import, use the `{ git = "...", subdir = "...", rev = "..." }`.
+# Revision can be a branch, a tag, and a commit hash.
+# MyRemotePackage = { git = "https://some.remote/host.git", subdir = "remote/path", rev = "main" }
+
+# For local dependencies use `local = path`. Path is relative to the package root
+# Local = { local = "../path/to" }
+
+# To resolve a version conflict and force a specific version for dependency
+# override use `override = true`
+# Override = { local = "../conflicting/version", override = true }
+
+[addresses]
+dubhe = "0x1736475f476c5dec96f33c03c778843f572239d3a887d795eef66d2836484c28"
+#dubhe = "0x0"
+
+# Named addresses will be accessible in Move as `@name`. They're also exported:
+# for example, `std = "0x1"` is exported by the Standard Library.
+# alice = "0xA11CE"
+
+[dev-dependencies]
+# The dev-dependencies section allows overriding dependencies for `--test` and
+# `--dev` modes. You can introduce test-only dependencies here.
+# Local = { local = "../path/to/dev-build" }
+
+[dev-addresses]
+# The dev-addresses section allows overwriting named addresses for the `--test`
+# and `--dev` modes.
+# alice = "0xB0B"
+

package/template/nextjs/sui-template/localnet/dubhe-framework/README.md

@@ -0,0 +1,18 @@
+## Dubhe Framework
+
+### Testnet
+```txt
+PackageID: 0xf68ab6ceb5cfce6a73d76e5ef64f28d3cbe684413c80232871b31a9df0e09496                 
+Version: 1                                                                                    
+Digest: HwpoK2ZUoxsDzFyeszWzdcAm4aLi5g2CxBq3JBodxA16                                        
+Modules: access_control, events, resource_id, resource_tyeps, schema, world
+
+ObjectID: 0x9f4cd3e0aa5587b2d9191fa20ea877a0d66c6eb6a4f49ec34328122b29d1d9c6
+ObjectType: 0x2::package::UpgradeCap
+```
+
+```shell
+# upgrade
+sui client upgrade --gas-budget 1000000000 --upgrade-capability 0x9f4cd3e0aa5587b2d9191fa20ea877a0d66c6eb6a4f49ec34328122b29d1d9c6
+```
+

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/access_control.move

@@ -0,0 +1,35 @@
+module dubhe::access_control {
+    use dubhe::world::{AdminCap, World};
+    use sui::dynamic_field as df;
+
+    const ENotAdmin: u64 = 4;
+    const EAppNotAuthorized: u64 = 5;
+
+    public struct AppKey<phantom App: drop> has copy, store, drop {}
+    
+    /// Authorize an application to access protected features of the World.
+    public fun authorize_app<App: drop>(admin_cap: &AdminCap, world: &mut World) {
+        assert!(world.admin() == object::id(admin_cap), ENotAdmin);
+        df::add(world.mut_uid(), AppKey<App>{}, true);
+    }
+
+    /// Deauthorize an application by removing its authorization key.
+    public fun deauthorize_app<App: drop>(admin_cap: &AdminCap, world: &mut World): bool {
+        assert!(world.admin() == object::id(admin_cap), ENotAdmin);
+        df::remove(world.mut_uid(), AppKey<App>{})
+    }
+
+    // Check if an application is authorized to access protected features of
+    /// the World.
+    public fun is_app_authorized<App: drop>(world: &World): bool {
+        df::exists_(world.uid(), AppKey<App>{})
+    }
+
+    /// Assert that an application is authorized to access protected features of
+    /// the World. Aborts with `EAppNotAuthorized` if not.
+    public fun assert_app_is_authorized<App: drop>(world: &World) {
+        assert!(is_app_authorized<App>(world), EAppNotAuthorized);
+    }
+
+
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/events.move

@@ -0,0 +1,23 @@
+module dubhe::events {
+    use sui::event;
+
+    public struct SchemaSetRecord<T: copy + drop> has copy, drop {
+        _dubhe_schema_id: vector<u8>,
+        _dubhe_schema_type: u8,
+        _dubhe_entity_key: Option<address>,
+        data: T
+    }
+
+    public struct SchemaRemoveRecord has copy, drop {
+        _dubhe_schema_id: vector<u8>,
+        _dubhe_entity_key: address
+    }
+
+    public fun emit_set<T: copy + drop>(_dubhe_schema_id: vector<u8>, _dubhe_schema_type: u8, _dubhe_entity_key: Option<address>, data: T) {
+        event::emit(SchemaSetRecord { _dubhe_schema_id, _dubhe_schema_type, _dubhe_entity_key, data})
+    }
+
+    public fun emit_remove(_dubhe_schema_id: vector<u8>, _dubhe_entity_key: address) {
+        event::emit(SchemaRemoveRecord { _dubhe_schema_id, _dubhe_entity_key })
+    }
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/resource_id.move

@@ -0,0 +1,22 @@
+module dubhe::resource_id {
+
+    public fun encode(type_id: vector<u8>, namespace: vector<u8>, name: vector<u8>) : vector<u8> {
+        let mut resource_id: vector<u8> = vector[];
+        vector::append(&mut resource_id, type_id);
+        vector::append(&mut resource_id, namespace);
+        vector::append(&mut resource_id, name);
+        resource_id
+    }
+
+    public fun offchain_schema() : vector<u8> {
+        b"os"
+    }
+
+    public fun system() : vector<u8> {
+        b"sy"
+    }
+
+    public fun namespace() : vector<u8> {
+        b"ns"
+    }
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/resource_types.move

@@ -0,0 +1,18 @@
+module dubhe::resource_tyeps {
+
+    public fun schema() : vector<u8> {
+        b"sc"
+    }
+
+    public fun offchain_schema() : vector<u8> {
+        b"os"
+    }
+
+    public fun system() : vector<u8> {
+        b"sy"
+    }
+
+    public fun namespace() : vector<u8> {
+        b"ns"
+    }
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/schema.move

@@ -0,0 +1,36 @@
+module dubhe::schema {
+    use std::ascii::{string};
+    use sui::bag::{Self};
+    use dubhe::world::{World, AdminCap};
+    use dubhe::access_control;
+
+    /// Schema does not exist
+    const ESchemaDoesNotExist: u64 = 0;
+    /// Schema already exists
+    const ESchemaAlreadyExists: u64 = 1;
+    /// Not the right admin for this world
+    const ENotAdmin: u64 = 2;
+
+    public fun get<T : store>(world: &World, _dubhe_schema_id: vector<u8>): &T {
+        assert!(bag::contains(world.schemas(), _dubhe_schema_id), ESchemaDoesNotExist);
+        bag::borrow<vector<u8>, T>(world.schemas(), _dubhe_schema_id)
+    }
+
+    public fun add<T : store>(_dubhe_world: &mut World, _dubhe_schema_id: vector<u8>, schema: T, admin_cap: &AdminCap){
+        assert!(_dubhe_world.admin() == object::id(admin_cap), ENotAdmin);
+        assert!(!bag::contains(_dubhe_world.schemas(), _dubhe_schema_id), ESchemaAlreadyExists);
+        vector::push_back(_dubhe_world.mut_schema_names(), string(_dubhe_schema_id));
+        bag::add<vector<u8>,T>(_dubhe_world.mut_schemas(), _dubhe_schema_id, schema);
+    }
+
+    public fun contains(_dubhe_world: &mut World, _dubhe_schema_id: vector<u8>): bool {
+        bag::contains(_dubhe_world.schemas(), _dubhe_schema_id)
+    }
+
+    // === Protected features ===
+    public fun get_mut<T : store, App: drop>(_: App, world: &mut World, _dubhe_schema_id: vector<u8>): &mut T {
+        access_control::assert_app_is_authorized<App>(world);
+        assert!(bag::contains(world.schemas(), _dubhe_schema_id), ESchemaDoesNotExist);
+        bag::borrow_mut<vector<u8>, T>(world.mut_schemas(), _dubhe_schema_id)
+    }
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/schemas/dapps/dapps.move

@@ -0,0 +1,73 @@
+module dubhe::dapps_schema {
+    use std::ascii::String;
+    use dubhe::storage_map;
+    use sui::transfer::public_share_object;
+    use dubhe::dapp_metadata::DappMetadata;
+    use dubhe::storage_map::StorageMap;
+
+    public struct Dapps has key, store {
+        id: UID,
+        admin: StorageMap<address, address>,
+        version: StorageMap<address, u32>,
+        metadata: StorageMap<address, DappMetadata>,
+        schemas: StorageMap<address, vector<String>>,
+        safe_mode: StorageMap<address, bool>
+    }
+
+
+    public(package) fun borrow_mut_version(self: &mut Dapps): &mut StorageMap<address, u32> {
+        &mut self.version
+    }
+
+    public(package) fun borrow_mut_admin(self: &mut Dapps): &mut StorageMap<address, address> {
+        &mut self.admin
+    }
+
+    public(package) fun borrow_mut_metadata(self: &mut Dapps): &mut StorageMap<address, DappMetadata> {
+        &mut self.metadata
+    }
+
+    public(package) fun borrow_mut_schemas(self: &mut Dapps): &mut StorageMap<address, vector<String>> {
+        &mut self.schemas
+    }
+
+    public(package) fun borrow_mut_safe_mode(self: &mut Dapps): &mut StorageMap<address, bool> {
+        &mut self.safe_mode
+    }
+
+    public fun borrow_admin(self: &Dapps): &StorageMap<address, address> {
+        &self.admin
+    }
+
+    public fun borrow_version(self: &Dapps): &StorageMap<address, u32> {
+        &self.version
+    }
+
+    public fun borrow_metadata(self: &Dapps): &StorageMap<address, DappMetadata> {
+        &self.metadata
+    }
+
+    public fun borrow_schemas(self: &Dapps): &StorageMap<address, vector<String>> {
+        &self.schemas
+    }
+
+    public fun borrow_safe_mode(self: &Dapps): &StorageMap<address, bool> {
+        &self.safe_mode
+    }
+
+    fun init(ctx: &mut TxContext) {
+        public_share_object(Dapps {
+            id: object::new(ctx),
+            admin: storage_map::new(),
+            version: storage_map::new(),
+            metadata: storage_map::new(),
+            schemas: storage_map::new(),
+            safe_mode: storage_map::new()
+        });
+    }
+
+    #[test_only]
+    public fun init_dapps_for_testing(ctx: &mut TxContext){
+        init(ctx)
+    }
+}

package/template/nextjs/sui-template/localnet/dubhe-framework/sources/schemas/dapps/metadata.move

@@ -0,0 +1,96 @@
+module dubhe::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
+    }
+
+}