config.move

The config.move module provides a shared configuration object for builder extensions. It publishes a single ExtensionConfig shared object at package publish time, allowing other extension modules to attach typed rule/config structs as dynamic fields.

1. Core Component Architecture

classDiagram
    class ExtensionConfig {
        +UID id
    }
    class AdminCap {
        +UID id
    }
    class XAuth {
        <<witness - drop>>
    }
    class DynamicField_K_V {
        +K key
        +V value
    }

    AdminCap ..> ExtensionConfig : guards mutations
    ExtensionConfig *-- DynamicField_K_V : stores rules as dynamic fields
    XAuth ..> Assemblies : authenticates extension calls

Key Components

• ExtensionConfig — A shared object acting as a key-value store for extension rules. Other modules attach their own typed config structs as Sui dynamic fields under this object.
• AdminCap — An owned capability object transferred to the deployer at init. Required for all mutation operations on the config.
• XAuth — A witness type (has drop) used to authenticate extension calls to world assemblies. Any extension module in this package can create XAuth instances via config::x_auth().

2. Dynamic Field Pattern

The module provides CRUD helpers for managing typed rules as dynamic fields:

flowchart LR
    subgraph ExtensionConfig
        DF1["TribeConfigKey → TribeConfig"]
        DF2["BountyConfigKey → BountyConfig"]
        DF3["... → ..."]
    end

    Admin[AdminCap holder] -->|add_rule / set_rule| ExtensionConfig
    Reader[Any caller] -->|has_rule / borrow_rule| ExtensionConfig
    Admin -->|remove_rule| ExtensionConfig

Available Operations

3. Initialization

At package publish time, init creates:

1. An AdminCap transferred to the deployer
2. A shared ExtensionConfig object

Other modules in the same package (e.g., tribe_permit, corpse_gate_bounty) reference this shared config to store their own per-rule configuration.

4. Integration Pattern

Extension modules follow this pattern with config.move:

1. Define a key type (has copy, drop, store) and value type (has store, drop)
2. Call config::set_rule<K, V>(&mut extension_config, &admin_cap, K{}, V{...}) to store configuration
3. Call config::borrow_rule<K, V>(&extension_config, K{}) at runtime to read rules
4. Use config::x_auth() to obtain the XAuth witness for world assembly calls

See tribe_permit.move and corpse_gate_bounty.move for concrete examples.