Access Read-Only Methods in Notarizations
Access Read-Only Methods
This guide demonstrates how to use all available read-only methods to inspect and query notarizations. These methods work for both dynamic and locked notarizations and provide comprehensive information about their state, metadata, and configuration.
Prerequisites
- An existing notarization (dynamic or locked) on the IOTA network
In the examples below an admin-client owning an admin role capability is used to create the Notarization object as been
shown in Create a Dynamic Notarization or Create a Locked Notarization .
It is not necessarily needed to access Notarization objects for read only purposes.
Available Read-Only Methods
All notarizations support the same comprehensive read-only interface:
- Content inspection: State, metadata, and description
- Timestamp queries: Creation and modification times
- Lock status checking: Transfer, update, and destruction permissions
- Version tracking: State version counters
- Method identification: Notarization type detection
1. Set Up Read-Only Client
You can use either a full client or a read-only client for inspection. The example code below creates a full client as been explained in Get Funded Notarization Client.
2. Create Test Notarizations
Create both dynamic and locked notarizations for comprehensive testing:
Content and Metadata Inspection
3. Read Description and Metadata
Access the immutable description and updatable metadata:
4. Read Current State
Access the current state content and its metadata:
Timestamp Queries
5. Get Creation and Modification Times
Query when the notarization was created and last modified:
Version and Type Information
6. Get Version Count and Method Type
Check the state version counter and notarization method:
Lock Status Checking
7. Check All Lock Statuses
Verify transfer, update, and destruction permissions:
8. Get Lock Metadata
Access detailed information about applied locks:
Demonstrating Version Tracking
9. Update State and Show Version Changes
For dynamic notarizations, demonstrate how version tracking works:
Read-Only Methods Summary
| Method | Returns | Description |
|---|---|---|
description() | String | Immutable description set at creation |
updatable_metadata() | Option<String> | Current updatable metadata |
state() | State | Current state content and metadata |
created_at_ts() | u64 | Creation timestamp |
last_state_change_ts() | u64 | Last state modification timestamp |
state_version_count() | u64 | Number of state updates |
notarization_method() | NotarizationMethod | Dynamic or Locked |
is_transfer_locked() | bool | Whether transfers are blocked |
is_update_locked() | bool | Whether updates are blocked |
is_destroy_allowed() | bool | Whether destruction is allowed |
lock_metadata() | Option<LockingMetadata> | Detailed lock information |
Use Cases for Read-Only Methods
Auditing and Compliance
- Verify immutability: Check that locked notarizations haven't changed
- Track modifications: Monitor version counts and timestamps
- Compliance checking: Verify lock status for regulatory requirements
Integration and Automation
- Status monitoring: Check lock status before operations
- Content verification: Validate state and metadata
- Type detection: Handle dynamic and locked notarizations differently
User Interfaces
- Display information: Show content, metadata, and status
- Permission checking: Enable/disable UI actions based on locks
- History tracking: Display version information and timestamps
Full Example Code
- Rust
- Typescript (Node.js)
loading...
loading...
Running Examples Locally
In order to run the examples, you will need to run an IOTA network locally.
If you want to use something different, you will need to modify the API and faucet endpoints in the examples to match your setup.