# Sui Documentation > Sui is a next-generation smart contract platform with high throughput, low latency, and an asset-oriented programming model powered by Move ## General - [Concepts](https://docs.sui.io/concepts.md) Description: Learn about the fundamental concepts and architecture that make Sui unique among blockchains. ## Concepts - [Coin Management](https://docs.sui.io/concepts/coin-mgt.md) Description: Because Sui uses coins as owned objects for transactions, you need to explicitly manage them in your programmable transaction block development. - [Cryptography](https://docs.sui.io/concepts/cryptography.md) Description: Sui supports multiple cryptography algorithms and primitives, while also defining its own such as public keys, signatures, aggregated signatures, and hash functions. - [Passkey](https://docs.sui.io/concepts/cryptography/passkeys.md) Description: Sui supports the passkey signature scheme that enables you to sign in to apps and sign transactions using a private key stored securely on a passkey authenticator. It uses the WebAuthn standard. - [Checkpoint Verification](https://docs.sui.io/concepts/cryptography/system/checkpoint-verification.md) Description: On the Sui network, checkpoints define the history of the blockchain. Checkpoint verification is how full nodes and other clients guarantee their state is exactly the same as the Sui network. - [Intents for Validation](https://docs.sui.io/concepts/cryptography/system/intents-for-validation.md) Description: Content coming soon - [Validator Signatures](https://docs.sui.io/concepts/cryptography/system/validator-signatures.md) Description: Content coming soon - [Archival Store and Service](https://docs.sui.io/concepts/data-access/archival-store.md) Description: The historical data API for fast lookups, served from a scalable and performant historical data store. - [Custom Indexers](https://docs.sui.io/concepts/data-access/custom-indexers.md) Description: The `sui-indexer-alt-framework` is a powerful Rust framework for building high-performance, custom blockchain indexers on Sui. It provides customizable, production-ready components for data ingestion, processing, and storage. - [Accessing Data](https://docs.sui.io/concepts/data-access/data-serving.md) Description: Overview of the types of data access mechanisms available in Sui. - [GraphQL for Sui RPC (Beta)](https://docs.sui.io/concepts/data-access/graphql-rpc.md) Description: Use GraphQL to make Sui RPC calls. This feature is currently in Beta. - [gRPC](https://docs.sui.io/concepts/data-access/grpc.md) Description: Learn about gRPC and how it provides fast, type-safe access to Sui network data. - [Indexer Data and Integration](https://docs.sui.io/concepts/data-access/indexer-data-integration.md) Description: Learn how to integrate custom data sources and storage systems with Sui indexers. Covers checkpoint data sources, custom store implementations, and Move event deserialization for building flexible indexing solutions. - [Indexer Runtime and Performance](https://docs.sui.io/concepts/data-access/indexer-runtime-perf.md) Description: Learn how to optimize Sui custom indexer performance through runtime configuration, resource monitoring, and debugging tools. Covers ingestion settings, database tuning, Tokio console debugging, Prometheus metrics, and data pruning strategies. - [Indexer Pipeline Architecture](https://docs.sui.io/concepts/data-access/pipeline-architecture.md) Description: The `sui-indexer-alt-framework` provides two distinct pipeline architectures. Understand the differences between the sequential and concurrent pipelines that the `sui-indexer-alt-framework` provides to decide which best suits your project needs. - [Gaming on Sui](https://docs.sui.io/concepts/gaming.md) Description: Sui offers features like dynamic NFTs, Kiosk, soulbound assets, and on-chain randomness to provide builders with the tools to create immersive, transparent, and fair gaming experiences. ## Guides - [Using the Archival Service](https://docs.sui.io/guides/developer/accessing-data/archival-store.md) Description: Query historical Sui network data through the Archival Service gRPC API. - [Authenticated Events](https://docs.sui.io/guides/developer/accessing-data/authenticated-events.md) Description: Cryptographically verifiable Move events that can be verified by a light client without trusting any intermediary, suitable for trustless event consumption. - [Bring Your Own Store (BYOS)](https://docs.sui.io/guides/developer/accessing-data/custom-indexer/bring-your-own-store.md) Description: Implement a custom storage backend for the customer indexer framework. - [Build a Custom Indexer](https://docs.sui.io/guides/developer/accessing-data/custom-indexer/build.md) Description: Build a custom indexer using the `sui-indexer-alt-framework` module. The example indexer demonstrates a sequential pipeline that extracts transaction digests from Sui checkpoints and stores them in a local PostgreSQL. - [Custom Indexing Framework](https://docs.sui.io/guides/developer/accessing-data/custom-indexer.md) Description: The `sui-indexer-alt-framework` is a powerful Rust framework for building high-performance, custom blockchain indexers on Sui. It provides customizable, production-ready components for data ingestion, processing, and storage. - [Custom Indexer and Walrus](https://docs.sui.io/guides/developer/accessing-data/custom-indexer/indexer-walrus.md) Description: Walrus is a content-addressable storage protocol, where data is retrieved using a unique identifier derived from the content itself, rather than from a file path or location. Integrating a custom Sui Indexer with Walrus can provide novel user experiences. - [Using gRPC](https://docs.sui.io/guides/developer/accessing-data/grpc-overview.md) Description: Learn how to use gRPC clients for the Sui network with grpcurl, Buf CLI, and popular programming languages. - [Accessing Data](https://docs.sui.io/guides/developer/accessing-data.md) Description: placeholder - [Using GraphQL RPC](https://docs.sui.io/guides/developer/accessing-data/query-with-graphql.md) Description: Practical guide to making queries of the Sui RPC using the GraphQL service, with examples for common tasks. - [Using Events](https://docs.sui.io/guides/developer/accessing-data/using-events.md) Description: Use events to notify on-chain assets of activity your smart contracts initiate and query events from other packages to trigger logic based on emitted events. - [Address Balances Migration Guide](https://docs.sui.io/guides/developer/address-balances-migration.md) Description: Migrating from Coin objects to address balances on Sui. - [Auction](https://docs.sui.io/guides/developer/app-examples/auction.md) Description: Content coming soon - [Blackjack](https://docs.sui.io/guides/developer/app-examples/blackjack.md) Description: Learn Sui using an example implementation of the popular casino game Blackjack. - [Client App with Sui TypeScript SDK](https://docs.sui.io/guides/developer/app-examples/client-tssdk.md) Description: Build a client-side application using the Sui TypeScript SDK. - [Coin Flip](https://docs.sui.io/guides/developer/app-examples/coin-flip.md) Description: Learn Sui through a coin flip app that covers the full end-to-end flow of building a Sui Move module and connecting it to a React Sui app. - [Distributed Counter](https://docs.sui.io/guides/developer/app-examples/e2e-counter.md) Description: An app that allows users to create counters that anyone can increment, but only the owner can reset. - [App Examples](https://docs.sui.io/guides/developer/app-examples.md) Description: Practical examples written by Sui and Move experts. Use these to learn common patterns and apply techniques to your own projects. - [Meta and Pricing Oracle](https://docs.sui.io/guides/developer/app-examples/meta-pricing-oracle.md) Description: Content coming soon - [Oracles](https://docs.sui.io/guides/developer/app-examples/oracle.md) Description: Oracles connect smart contracts deployed on-chain with data that is stored off-chain. - [Plinko](https://docs.sui.io/guides/developer/app-examples/plinko.md) Description: Learn Sui through an example implementation of the popular casino game, Plinko. - [Prevent Bots](https://docs.sui.io/guides/developer/app-examples/recaptcha.md) Description: Write and deploy a smart contract in Move that uses reCAPTCHA to verify users are human (and not bots) before they interact with the contract. - [Review Rating](https://docs.sui.io/guides/developer/app-examples/reviews-rating.md) Description: This example app creates a food rating service that stores all review data and algorithms on-chain. - [Tic-Tac-Toe](https://docs.sui.io/guides/developer/app-examples/tic-tac-toe.md) Description: This example demonstrates how to create three variations of a tic-tac-toe app on Sui. - [Trustless Swap](https://docs.sui.io/guides/developer/app-examples/trustless-swap.md) Description: An app that performs atomic swaps on Sui. Atomic swaps are similar to escrows but without requiring a trusted third party. - [Turnip Town](https://docs.sui.io/guides/developer/app-examples/turnip-town.md) Description: Content coming soon - [Sui Weather Oracle](https://docs.sui.io/guides/developer/app-examples/weather-oracle.md) Description: Write a module (smart contract) in Move that fetches the weather data from the OpenWeather API every 10 minutes and updates the weather conditions for over 1,000 locations around the world. - [Create Currencies and Tokens](https://docs.sui.io/guides/developer/coin/currency.md) Description: Learn how to create currencies and mint coins and tokens on the Sui network using the Coin Registry system. - [In-Game Currency](https://docs.sui.io/guides/developer/coin/in-game-token.md) Description: Use the Sui Closed-Loop Token standard to create tokens that you can use as currency within a game application. - [Currencies and Tokens](https://docs.sui.io/guides/developer/coin.md) Description: Learn about creating and managing currencies and tokens on Sui using the Coin Registry system and `token` module, including regulated tokens, in-game currencies, and loyalty tokens. - [Loyalty Tokens](https://docs.sui.io/guides/developer/coin/loyalty.md) Description: Use the Sui Closed-Loop Token standard to create tokens that are only valid within specific workflows and services. One example of Closed-Loop Tokens is a loyalty token. - [Regulated Currency and Deny List](https://docs.sui.io/guides/developer/coin/regulated.md) Description: You can create regulated currencies on Sui using the Coin Registry system. These coins include the ability to control access using a deny list. - [Stablecoins on Sui](https://docs.sui.io/guides/developer/coin/stablecoins.md) Description: Stablecoins are a type of cryptocurrency that are designed to maintain a stable value relative to a fiat currency or a basket of assets. - [Token Vesting Strategies](https://docs.sui.io/guides/developer/coin/vesting-strategies.md) Description: If you plan to launch a token on Sui, then you might consider implementing a vesting strategy to strengthen the long-term outlook of your token. - [Troubleshooting Common Errors](https://docs.sui.io/guides/developer/common-errors.md) Description: Find solutions to common issues with addresses, transactions, and Move packages. - [Elliptic Curve Verifiable Random Function](https://docs.sui.io/guides/developer/cryptography/ecvrf.md) Description: Elliptic curve verifiable random function is a cryptographic algorithm that enables you to generate a random number and provide proof that the number used a secret key for generation. - [Groth16](https://docs.sui.io/guides/developer/cryptography/groth16.md) Description: Zero-knowledge proofs are used to validate statements without revealing information about the proof's inputs. - [Hashing](https://docs.sui.io/guides/developer/cryptography/hashing.md) Description: Sui supports SHA2-256, SHA3-256, Keccak256, and Blake2b-256 cryptographic hash functions. - [Cryptography](https://docs.sui.io/guides/developer/cryptography.md) Description: Learn how to use cryptography effectively in Sui smart contracts. - [Multisig Authentication](https://docs.sui.io/guides/developer/cryptography/multisig.md) Description: Guide on how to create a multisig transaction and then submit it against a local network using the Sui CLI. - [Sui On-Chain Signatures Verification in Move](https://docs.sui.io/guides/developer/cryptography/signing.md) Description: Sui supports verification within Move smart contracts through several signature schemes. Signature schemes include Ed25519, Secp256k1 recoverable, Secp256k1 non-recoverable, Secp256r1 non-recoverable, Secp256r1 recoverable, BLS G1, and BLS G2. - [Configure OpenID Providers](https://docs.sui.io/guides/developer/cryptography/zklogin-integration/developer-account.md) Description: zkLogin can be integrated with an application using an OpenID provider's OAuth Client ID and redirect URI. - [zkLogin](https://docs.sui.io/guides/developer/cryptography/zklogin-integration.md) Description: zkLogin is a Sui primitive that enables you to send transactions from a Sui address using an OAuth credential without publicly linking the two. - [zkLogin Example](https://docs.sui.io/guides/developer/cryptography/zklogin-integration/zklogin-example.md) Description: An example that breaks down the logic behind each step of zkLogin. - [zkLogin Integration](https://docs.sui.io/guides/developer/cryptography/zklogin-integration/zklogin-integration.md) Description: zkLogin can be integrated into applications deployed on Sui. - [What is zkLogin?](https://docs.sui.io/guides/developer/cryptography/zklogin-integration/zklogin.md) Description: zkLogin is a Sui primitive that enables you to send transactions from a Sui address using an OAuth credential without publicly linking the two. - [Sui Developer Cheat Sheet](https://docs.sui.io/guides/developer/dev-cheat-sheet.md) Description: A quick reference document regarding best practices for Sui developers. - [Deployment](https://docs.sui.io/guides/developer/digital-assets/examples-patterns/advanced-patterns/kiosk.md) Description: As with all smart contracts on Sui, Move provides the logic that powers asset tokenization. :::info This reference implementation uses the Kiosk standard to ensure that tokenized assets operate within their defined policy. - [In-Game Currency](https://docs.sui.io/guides/developer/digital-assets/examples-patterns/in-game-currency.md) Description: Use the Sui Closed-Loop Token standard to create tokens that you can use as currency within a game application. - [Index](https://docs.sui.io/guides/developer/digital-assets/examples-patterns.md) - [Loyalty Tokens](https://docs.sui.io/guides/developer/digital-assets/examples-patterns/loyalty-tokens.md) Description: Use the Sui Closed-Loop Token standard to create tokens that are only valid within specific workflows and services. One example of Closed-Loop Tokens is a loyalty token. - [NFT Rental Example](https://docs.sui.io/guides/developer/digital-assets/examples-patterns/nft-rental.md) Description: An example using the Kiosk Apps standard that provides the ability for users to rent NFTs according to the rules of a provided policy instead of outright owning them. This approach closely aligns with the ERC-4907 renting standard, making it a suitable choice for Solidity-based use cases intended for implementation on Sui. - [Soulbound NFT Example](https://docs.sui.io/guides/developer/digital-assets/examples-patterns/soulbound-tokens.md) Description: An example using Sui Move struct abilities and the Sui Framework's `transfer` module to make a NFT soulbound (non-transferable). - [Create Fungible Tokens](https://docs.sui.io/guides/developer/digital-assets/fungible-tokens/create-a-fungible-token.md) Description: Learn how to create currencies and mint coins and tokens on the Sui network. - [Fungible Tokens](https://docs.sui.io/guides/developer/digital-assets/fungible-tokens.md) Description: Learn how to fungible tokens on the Sui network using the Coin Registry system. - [Stablecoins on Sui](https://docs.sui.io/guides/developer/digital-assets/fungible-tokens/integrating-with-stablecoins.md) Description: Stablecoins are a type of cryptocurrency that are designed to maintain a stable value relative to a fiat currency or a basket of assets. - [Regulated Currency and Deny List](https://docs.sui.io/guides/developer/digital-assets/fungible-tokens/regulated-tokens.md) Description: You can create regulated currencies on Sui using the Coin Registry system. These coins include the ability to control access using a deny list. - [Token Vesting Strategies](https://docs.sui.io/guides/developer/digital-assets/fungible-tokens/token-vesting-strategies.md) Description: If you plan to launch a token on Sui, then you might consider implementing a vesting strategy to strengthen the long-term outlook of your token. - [Digital Assets on Sui](https://docs.sui.io/guides/developer/digital-assets.md) Description: Learn about the types of digital assets you can create and interact with on Sui. - [Asset Tokenization](https://docs.sui.io/guides/developer/digital-assets/non-fungible-tokens/asset-tokenization.md) Description: Learn how to tokenize assets on the Sui blockchain. Asset tokenization refers to the process of representing real-world assets, such as real estate, art, commodities, stocks, or other valuable assets, as digital tokens on the blockchain network. - [Create a Non-Fungible Token](https://docs.sui.io/guides/developer/digital-assets/non-fungible-tokens/create-nft.md) Description: On Sui, everything is an object. Moreover, everything is a non-fungible token (NFT) as its objects are unique, non-fungible, and owned. - [Types of Tokens](https://docs.sui.io/guides/developer/digital-assets/types-of-tokens.md) Description: Sui provides a variety of token standards with different features for multiple usage patterns. - [Connect a Frontend to a Move Package](https://docs.sui.io/guides/developer/getting-started/app-frontends.md) Description: Connect a React interface to a basic Move package to create a full stack application. - [Configure a Sui Client](https://docs.sui.io/guides/developer/getting-started/configure-sui-client.md) Description: The Sui client configuration specifies which network to connect to and which address to send transactions. - [Create a Sui Address](https://docs.sui.io/guides/developer/getting-started/get-address.md) Description: You need an address on the Sui network before you can build packages and own objects. - [Get SUI from Faucet](https://docs.sui.io/guides/developer/getting-started/get-coins.md) Description: Use the Sui faucet to obtain free SUI tokens for use on the Sui Devnet and Testnet networks. - [Hello, World!](https://docs.sui.io/guides/developer/getting-started/hello-world.md) Description: Create and publish your first Move package using a basic 'Hello, World!' example. - [Getting Started](https://docs.sui.io/guides/developer/getting-started.md) Description: Get started with Sui, the first internet-scale programmable blockchain platform. - [Install from Binaries](https://docs.sui.io/guides/developer/getting-started/install-binaries.md) Description: Each Sui release provides a set of binaries for several operating systems. You can download these binaries from GitHub and use them to install Sui. - [Install from Source](https://docs.sui.io/guides/developer/getting-started/install-source.md) Description: Install the Sui framework from source, either locally or directly from GitHub. - [Connecting to a Local Network](https://docs.sui.io/guides/developer/getting-started/local-network.md) Description: Connect to a Sui local network using the Sui CLI. Use local networks to test your applications and prepare for launching them on Devnet or Testnet. - [Next Steps](https://docs.sui.io/guides/developer/getting-started/next-steps.md) Description: To continue your journey building on Sui, you can review other documentation, join the community of other Sui builders, or check out the Awesome Sui repo. - [Install Sui](https://docs.sui.io/guides/developer/getting-started/sui-install.md) Description: Install the Sui framework and its required prerequisites on your system. - [SUI Wallets](https://docs.sui.io/guides/developer/getting-started/sui-wallets.md) Description: placeholder - [Move Best Practices](https://docs.sui.io/guides/developer/move-best-practices.md) Description: Recommended Move 2024 best practices for Sui development. - [Customizing, Testing, and Management](https://docs.sui.io/guides/developer/nautilus/customize-nautilus.md) Description: Details on how to customize Nautilus server logic, test functionality locally, and manage the enclave. - [Nautilus](https://docs.sui.io/guides/developer/nautilus.md) Description: Run secure, off-chain logic in trusted execution environments (TEEs), and verify it on-chain to trigger safe smart contract workflows. - [Deploy Dockerized Nautilus Apps to Marlin](https://docs.sui.io/guides/developer/nautilus/marlin.md) Description: Marlin Oyster integrates with the Nautilus framework to remove the operational overhead of managing enclave infrastructure. ## References - [Awesome Sui Gaming](https://docs.sui.io/references/awesome-sui-gaming.md) Description: A curated list of awesome gaming projects and developer tools within the Sui ecosystem. - [Awesome Sui](https://docs.sui.io/references/awesome-sui.md) Description: A curated list of awesome developer tools and infrastructure projects within the Sui ecosystem. - [Sui CLI](https://docs.sui.io/references/cli.md) Description: Sui provides command line tools to interact with the network, its features, and the Move programming language. Individual command groups are referred to as Sui Client CLI, Sui Keytool CLI, Sui Move CLI, and Sui Validator CLI. - [Sui CLI Cheat Sheet](https://docs.sui.io/references/cli/cheatsheet.md) Description: Use this cheat sheet to learn common Sui CLI commands. - [Sui Client CLI](https://docs.sui.io/references/cli/client.md) Description: The Sui Client CLI provides command-level access to interact with the Sui network. - [Sui Keytool CLI](https://docs.sui.io/references/cli/keytool.md) Description: The Sui Keytool CLI has commands for managing and generating addresses, working with private keys, signatures, or zkLogin. - [Sui Move CLI](https://docs.sui.io/references/cli/move.md) Description: The Sui CLI move command provides commands for working with Move source code directly from a terminal or console. - [Sui Client PTB CLI](https://docs.sui.io/references/cli/ptb.md) Description: The Sui Client PTB CLI enables a user to construct a PTB and execute it from the command line or a file. - [Sui Replay CLI](https://docs.sui.io/references/cli/replay.md) Description: Use the Sui CLI to replay a given transaction to view its effects. - [Sui Trace Analysis](https://docs.sui.io/references/cli/trace-analysis.md) Description: Use the Sui CLI to analyze transaction traces. - [Sui Validator CLI](https://docs.sui.io/references/cli/validator.md) Description: The Sui Validator CLI is used to access the validator features of the Sui network. - [Sui Contributor Covenant Code of Conduct](https://docs.sui.io/references/contribute/code-of-conduct.md) Description: All contributions to Sui must adhere to the Contributor Code of Conduct. - [Contribute to Sui Repositories](https://docs.sui.io/references/contribute/contribute-to-sui-repos.md) Description: Sui repositories are open source and welcome community contributions. - [Contribute to Sui Documentation](https://docs.sui.io/references/contribute/contribution-process.md) Description: Help the Sui community through documentation contributions. Whether its to fix errors or add new content, the entire Sui community benefits from your contributions. - [Localize Sui Documentation](https://docs.sui.io/references/contribute/localize-sui-docs.md) Description: The Sui documentation can be translated into any language using Crowdin. - [MDX Components](https://docs.sui.io/references/contribute/mdx-components.md) Description: Extensions to the Sui docs rendering engine. - [Style Guide](https://docs.sui.io/references/contribute/style-guide.md) Description: All contributions to the Sui documentation must adhere to the style guide. - [Sui Environment Setup](https://docs.sui.io/references/contribute/sui-environment.md) Description: Get the background information you need before you start developing on Sui. Learn the layout of the Sui monorepository and the suggested development environment for working with Move. - [Exchange Integration Guide](https://docs.sui.io/references/exchange-integration-guide.md) Description: Learn the primary tasks necessary to integrate the SUI token with a cryptocurrency exchange. - [Sui Framework](https://docs.sui.io/references/framework.md) Description: The Sui framework libraries include Move modules that provide the logic for Sui and its standards. A Rust process creates the documentation for the modules directly from comments in the code. - [Module bridge::bridge](https://docs.sui.io/references/framework/sui_bridge/bridge.md) Description: Struct Bridge Struct BridgeInner Struct TokenDepositedEvent Struct TokenDepositedEventV2 Struct EmergencyOpEvent Struct BridgeRecord Struct TokenTransferApproved Struct TokenTransferClaimed Struct TokenTransferAlreadyApproved Struct TokenTransferAlreadyClaimed Struct TokenTransferLimitExceed - [Module bridge::chain_ids](https://docs.sui.io/references/framework/sui_bridge/chain_ids.md) Description: Struct BridgeRoute Constants Function suimainnet Function suitestnet Function suicustom Function ethmainnet Function ethsepolia Function ethcustom Function routesource Function routedestination Function assertvalidchainid Function validroutes Function isvalidroute Function getroute use ; Struct - [Module bridge::committee](https://docs.sui.io/references/framework/sui_bridge/committee.md) Description: Struct BlocklistValidatorEvent Struct BridgeCommittee Struct CommitteeUpdateEvent Struct CommitteeMemberUrlUpdateEvent Struct CommitteeMember Struct CommitteeMemberRegistration Constants Function verifysignatures Function create Function register Function trycreatenextcommittee Function - [Module bridge::crypto](https://docs.sui.io/references/framework/sui_bridge/crypto.md) Description: Function ecdsapubkeytoethaddress use ; use ; Function ecdsapubkeytoethaddress public(package) fun (compressedpubkey: &vector): vector - [sui:bridge](https://docs.sui.io/references/framework/sui_bridge.md) Description: Documentation for the modules in the sui/crates/sui-framework/packages/bridge crate. Select a module from the list to see its details. - [Module bridge::limiter](https://docs.sui.io/references/framework/sui_bridge/limiter.md) Description: Struct TransferLimiter Struct TransferRecord Struct UpdateRouteLimitEvent Constants Function getroutelimit Function new Function checkandrecordsendingtransfer Function updateroutelimit Function currenthoursinceepoch Function adjusttransferrecords Function initialtransferlimits use ; use ; use ; use - [Module bridge::message](https://docs.sui.io/references/framework/sui_bridge/message.md) Description: Struct BridgeMessage Struct BridgeMessageKey Struct TokenTransferPayload Struct TokenTransferPayloadV2 Struct EmergencyOp Struct Blocklist Struct UpdateBridgeLimit Struct UpdateAssetPrice Struct AddTokenOnSui Struct ParsedTokenTransferMessage Constants Function extracttokenbridgepayload Function - [Module bridge::message_types](https://docs.sui.io/references/framework/sui_bridge/message_types.md) Description: Constants Function token Function committeeblocklist Function emergencyop Function updatebridgelimit Function updateassetprice Function addtokensonsui Constants const : u8 = 0; const : u8 = 1; const : u8 = 2; const : u8 = 3; const : u8 = 4; const : u8 = 6; Function token public fun (): u8 Function - [Module bridge::treasury](https://docs.sui.io/references/framework/sui_bridge/treasury.md) Description: Struct BridgeTreasury Struct BridgeTokenMetadata Struct ForeignTokenRegistration Struct UpdateTokenPriceEvent Struct NewTokenEvent Struct TokenRegistrationEvent Constants Function tokenid Function decimalmultiplier Function notionalvalue Function registerforeigntoken Function addnewtoken Function - [Module std::address](https://docs.sui.io/references/framework/sui_std/address.md) Description: Provides a way to get address length since it's a platform-specific parameter. Function length Function length Should be converted to a native function. Current implementation only works for Sui. - [Module std::ascii](https://docs.sui.io/references/framework/sui_std/ascii.md) Description: The ASCII module defines basic string and char newtypes in Move that verify that characters are valid ASCII, and that strings consist of only valid ASCII characters. - [Module std::bcs](https://docs.sui.io/references/framework/sui_std/bcs.md) Description: Utility for converting a Move value to its binary representation in BCS (Binary Canonical. Serialization). BCS is the binary encoding for Move resources and other non-module values published on-chain. See https://github.com/diem/bcs#binary-canonical-serialization-bcs for more details on BCS. - [Module std::bit_vector](https://docs.sui.io/references/framework/sui_std/bit_vector.md) Description: Struct BitVector Constants Function new Function set Function unset Function shiftleft Function isindexset Function length Function longestsetsequencestartingat Struct BitVector public struct has copy, drop, store Fields : bitfield: <> Constants The provided index is out of bounds const : = 131072; - [Module std::debug](https://docs.sui.io/references/framework/sui_std/debug.md) Description: Module providing debug functionality. - [Module std::fixed_point32](https://docs.sui.io/references/framework/sui_std/fixed_point32.md) Description: Defines a fixed-point numeric type with a 32-bit integer part and a 32-bit fractional part. - [Module std::hash](https://docs.sui.io/references/framework/sui_std/hash.md) Description: Module which defines SHA hashes for byte vectors. The functions in this module are natively declared both in the Move runtime as in the Move prover's prelude. - [sui:std](https://docs.sui.io/references/framework/sui_std.md) Description: Documentation for the modules in the sui/crates/sui-framework/packages/std crate. Select a module from the list to see its details. - [Module std::internal](https://docs.sui.io/references/framework/sui_std/internal.md) Description: Defines the type, which can be used to constrain the logic of a generic function to be authorized only by the module that defines the type parameter. To write a function that is guarded by a , require it as an argument. Struct Permit Function permit Struct Permit A privileged witness of the T type. - [Module std::macros](https://docs.sui.io/references/framework/sui_std/macros.md) Description: This module holds shared implementation of macros used in std Macro function nummax Macro function nummin Macro function numdiff Macro function numdivideandroundup Macro function numpow Macro function numsqrt Macro function numtostring Macro function numcheckedadd Macro function numcheckedsub Macro - [Module std::option](https://docs.sui.io/references/framework/sui_std/option.md) Description: This module defines the Option type and its methods to represent and handle an optional value. - [Module std::string](https://docs.sui.io/references/framework/sui_std/string.md) Description: The module defines the type which represents UTF8 encoded strings. - [Module std::type_name](https://docs.sui.io/references/framework/sui_std/type_name.md) Description: Functionality for converting Move types into values. Use with care! - [Module std::u128](https://docs.sui.io/references/framework/sui_std/u128.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function sqrt Function tryasu8 Function tryasu16 Function tryasu32 Function tryasu64 Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function - [Module std::u16](https://docs.sui.io/references/framework/sui_std/u16.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function sqrt Function tryasu8 Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function saturatingadd Function saturatingsub Function saturatingmul - [Module std::u256](https://docs.sui.io/references/framework/sui_std/u256.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function tryasu8 Function tryasu16 Function tryasu32 Function tryasu64 Function tryasu128 Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function - [Module std::u32](https://docs.sui.io/references/framework/sui_std/u32.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function sqrt Function tryasu8 Function tryasu16 Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function saturatingadd Function saturatingsub - [Module std::u64](https://docs.sui.io/references/framework/sui_std/u64.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function sqrt Function tryasu8 Function tryasu16 Function tryasu32 Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function saturatingadd Function - [Module std::u8](https://docs.sui.io/references/framework/sui_std/u8.md) Description: Function bitwisenot Function max Function min Function diff Function divideandroundup Function pow Function sqrt Function tostring Function checkedadd Function checkedsub Function checkedmul Function checkeddiv Function saturatingadd Function saturatingsub Function saturatingmul Function checkedshl - [Module std::uq32_32](https://docs.sui.io/references/framework/sui_std/uq32_32.md) Description: Defines an unsigned, fixed-point numeric type with a 32-bit integer part and a 32-bit fractional part. The notation and is based on Q notation). q indicates it a fixed-point number. The u prefix indicates it is unsigned. - [Module std::uq64_64](https://docs.sui.io/references/framework/sui_std/uq64_64.md) Description: Defines an unsigned, fixed-point numeric type with a 64-bit integer part and a 64-bit fractional part. The notation and is based on Q notation). q indicates it a fixed-point number. The u prefix indicates it is unsigned. - [Module std::vector](https://docs.sui.io/references/framework/sui_std/vector.md) Description: A variable-sized container that can hold any type. Indexing is 0-based, and vectors are growable. This module has many native functions. - [Module sui::accumulator](https://docs.sui.io/references/framework/sui_sui/accumulator.md) Description: Struct AccumulatorRoot Struct U128 Struct Key Constants Function create Function rootid Function rootidmut Function accumulatoru128exists Function accumulatoru128read Function createu128 Function destroyu128 Function updateu128 Function iszerou128 Function accumulatorkey Function accumulatoraddress - [Module sui::accumulator_metadata](https://docs.sui.io/references/framework/sui_sui/accumulator_metadata.md) Description: Struct OwnerKey Struct Owner Struct MetadataKey Struct Metadata Struct AccumulatorObjectCountKey Constants Function recordaccumulatorobjectchanges Function getaccumulatorobjectcount use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct OwnerKey === - [Module sui::accumulator_settlement](https://docs.sui.io/references/framework/sui_sui/accumulator_settlement.md) Description: Struct EventStreamHead Constants Function settlementprologue Function settleu128 Function recordsettlementsuiconservation Function addtommr Function u256frombytes Function hashtwotooneu256 Function newstreamhead Function settleevents use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; - [Module sui::address](https://docs.sui.io/references/framework/sui_sui/address.md) Description: Constants Function tou256 Function fromu256 Function frombytes Function tobytes Function toasciistring Function tostring Function fromasciibytes Function hexcharvalue Function length Function max use ; use ; use ; use ; use ; use ; Constants The length of an address, in bytes const : u64 = 32; - [Module sui::address_alias](https://docs.sui.io/references/framework/sui_sui/address_alias.md) Description: Struct AddressAliasState Struct AddressAliases Struct AliasKey Constants Function create Function enable Function add Function replaceall Function remove use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct AddressAliasState Singleton shared object which - [Module sui::authenticator_state](https://docs.sui.io/references/framework/sui_sui/authenticator_state.md) Description: Struct AuthenticatorState Struct AuthenticatorStateInner Struct JWK Struct JwkId Struct ActiveJwk Constants Function activejwkequal Function jwkequal Function jwkidequal Function stringbyteslt Function jwklt Function create Function loadinnermut Function loadinner Function checksorted Function - [Module sui::bag](https://docs.sui.io/references/framework/sui_sui/bag.md) Description: A bag is a heterogeneous map-like collection. The collection is similar to in that its keys and values are not stored within the value, but instead are stored using Sui's object system. The struct acts only as a handle into the object system to retrieve those keys and values. - [Module sui::balance](https://docs.sui.io/references/framework/sui_sui/balance.md) Description: A storable handler for Balances in general. Is used in the Coin module to allow balance operations and can be used to implement custom coins with and s. - [Module sui::bcs](https://docs.sui.io/references/framework/sui_sui/bcs.md) Description: This module implements BCS (de)serialization in Move. - [Module sui::bls12381](https://docs.sui.io/references/framework/sui_sui/bls12381.md) Description: Group operations of BLS12-381. - [Module sui::borrow](https://docs.sui.io/references/framework/sui_sui/borrow.md) Description: A simple library that enables hot-potato-locked borrow mechanics. With Programmable transactions, it is possible to borrow a value within a transaction, use it and put back in the end. Hot-potato makes sure the object is returned and was not swapped for another one. - [Module sui::clock](https://docs.sui.io/references/framework/sui_sui/clock.md) Description: APIs for accessing time from move calls, via the : a unique shared object that is created at 0x6 during genesis. - [Module sui::coin](https://docs.sui.io/references/framework/sui_sui/coin.md) Description: Defines the type - platform wide representation of fungible tokens and coins. can be described as a secure wrapper around Balance type. - [Module sui::coin_registry](https://docs.sui.io/references/framework/sui_sui/coin_registry.md) Description: Defines the system object for managing coin data in a central registry. This module provides a centralized way to store and manage metadata for all currencies in the Sui ecosystem, including their supply information, regulatory status, and metadata capabilities. - [Module sui::config](https://docs.sui.io/references/framework/sui_sui/config.md) Description: Struct Config Struct Setting Struct SettingData Constants Function new Function share Function transfer Function addfornextepoch Function removefornextepoch Function existswithtype Function existswithtypefornextepoch Function borrowfornextepochmut Function readsettingfornextepoch Macro function - [Module sui::deny_list](https://docs.sui.io/references/framework/sui_sui/deny_list.md) Description: Defines the type. The shared object is used to restrict access to instances of certain core types from being used as inputs by specified addresses in the deny list. - [Module sui::derived_object](https://docs.sui.io/references/framework/sui_sui/derived_object.md) Description: Enables the creation of objects with deterministic addresses derived from a parent object's UID. - [Module sui::display](https://docs.sui.io/references/framework/sui_sui/display.md) Description: Defines a Display struct which defines the way an Object should be displayed. The intention is to keep data as independent from its display as possible, protecting the development process and keeping it separate from the ecosystem agreements. - [Module sui::display_registry](https://docs.sui.io/references/framework/sui_sui/display_registry.md) Description: Struct DisplayRegistry Struct SystemMigrationCap Struct Display Struct DisplayCap Struct DisplayKey Constants Function new Function newwithpublisher Function unset Function set Function clear Function share Function claim Function claimwithpublisher Function systemmigration Function migratev1tov2 - [Module sui::dynamic_field](https://docs.sui.io/references/framework/sui_sui/dynamic_field.md) Description: In addition to the fields declared in its type definition, a Sui object can have dynamic fields that can be added after the object has been constructed. - [Module sui::dynamic_object_field](https://docs.sui.io/references/framework/sui_sui/dynamic_object_field.md) Description: Similar to , this module allows for the access of dynamic fields. But unlike, the values bound to these dynamic fields must be objects themselves. This allows for the objects to still exist within in storage, which may be important for external tools. - [Module sui::ecdsa_k1](https://docs.sui.io/references/framework/sui_sui/ecdsa_k1.md) Description: Constants Function secp256k1ecrecover Function decompresspubkey Function secp256k1verify Constants Error if the public key cannot be recovered from the signature. const : u64 = 0; Error if the signature is invalid. const : u64 = 1; Error if the public key is invalid. - [Module sui::ecdsa_r1](https://docs.sui.io/references/framework/sui_sui/ecdsa_r1.md) Description: Constants Function secp256r1ecrecover Function secp256r1verify Constants Error if the public key cannot be recovered from the signature. const : u64 = 0; Error if the signature is invalid. const : u64 = 1; Hash function name that are valid for ecrecover and secp256k1verify. - [Module sui::ecvrf](https://docs.sui.io/references/framework/sui_sui/ecvrf.md) Description: Constants Function ecvrfverify Constants const : u64 = 1; const : u64 = 2; const : u64 = 3; Function ecvrfverify @param hash: The hash/output from a ECVRF to be verified. @param alphastring: Input/seed to the ECVRF used to generate the output. - [Module sui::ed25519](https://docs.sui.io/references/framework/sui_sui/ed25519.md) Description: Function ed25519verify Function ed25519verify @param signature: 32-byte signature that is a point on the Ed25519 elliptic curve. @param publickey: 32-byte signature that is a point on the Ed25519 elliptic curve. @param msg: The message that we test the signature against. - [Module sui::event](https://docs.sui.io/references/framework/sui_sui/event.md) Description: Events module. Defines the function which creates and sends a custom MoveEvent as a part of the effects certificate of the transaction. - [Module sui::funds_accumulator](https://docs.sui.io/references/framework/sui_sui/funds_accumulator.md) Description: A module for accumulating funds, i.e. Balance-like types. - [Module sui::groth16](https://docs.sui.io/references/framework/sui_sui/groth16.md) Description: Struct Curve Struct PreparedVerifyingKey Struct PublicProofInputs Struct ProofPoints Constants Function bls12381 Function bn254 Function pvkfrombytes Function pvktobytes Function publicproofinputsfrombytes Function proofpointsfrombytes Function prepareverifyingkey Function - [Module sui::group_ops](https://docs.sui.io/references/framework/sui_sui/group_ops.md) Description: Generic Move and native functions for group operations. - [Module sui::hash](https://docs.sui.io/references/framework/sui_sui/hash.md) Description: Module which defines hash functions. Note that Sha-256 and Sha3-256 is available in the std::hash module in the standard library. Function blake2b256 Function keccak256 Function blake2b256 @param data: Arbitrary binary data to hash. Hash the input bytes using Blake2b-256 and returns 32 bytes. - [Module sui::hex](https://docs.sui.io/references/framework/sui_sui/hex.md) Description: HEX (Base16) encoding utility. - [Module sui::hmac](https://docs.sui.io/references/framework/sui_sui/hmac.md) Description: Function hmacsha3256 Function hmacsha3256 @param key: HMAC key, arbitrary bytes. @param msg: message to sign, arbitrary bytes. Returns the 32 bytes digest of HMAC-SHA3-256(key, msg). - [sui:sui](https://docs.sui.io/references/framework/sui_sui.md) Description: Documentation for the modules in the sui/crates/sui-framework/packages/sui crate. Select a module from the list to see its details. - [Module sui::kiosk](https://docs.sui.io/references/framework/sui_sui/kiosk.md) Description: Kiosk is a primitive for building safe, decentralized and trustless trading experiences. It allows storing and trading any types of assets as long as the creator of these assets implements a TransferPolicy for them. - [Module sui::kiosk_extension](https://docs.sui.io/references/framework/sui_sui/kiosk_extension.md) Description: This module implements the Kiosk Extensions functionality. It allows exposing previously protected (only-owner) methods to third-party apps. A Kiosk Extension is a module that implements any functionality on top of the Kiosk without discarding nor blocking the base. - [Module sui::linked_table](https://docs.sui.io/references/framework/sui_sui/linked_table.md) Description: Similar to but the values are linked together, allowing for ordered insertion and removal Struct LinkedTable Struct Node Constants Function new Function front Function back Function pushfront Function pushback Function borrow Function borrowmut Function prev Function next Function remove Function - [Module sui::math](https://docs.sui.io/references/framework/sui_sui/math.md) Description: DEPRECATED, use the each integer type's individual module instead, e.g. - [Module sui::nitro_attestation](https://docs.sui.io/references/framework/sui_sui/nitro_attestation.md) Description: Struct PCREntry Struct NitroAttestationDocument Constants Function loadnitroattestation Function moduleid Function timestamp Function digest Function pcrs Function publickey Function userdata Function nonce Function index Function value Function loadnitroattestationinternal use ; use ; use ; use ; - [Module sui::object](https://docs.sui.io/references/framework/sui_sui/object.md) Description: Sui object identifiers Struct ID Struct UID Constants Function idtobytes Function idtoaddress Function idfrombytes Function idfromaddress Function suisystemstate Function clock Function authenticatorstate Function randomnessstate Function suidenylistobjectid Function suiaccumulatorrootobjectid - [Module sui::object_bag](https://docs.sui.io/references/framework/sui_sui/object_bag.md) Description: Similar to , an is a heterogeneous map-like collection. But unlike , the values bound to these dynamic fields must be objects themselves. This allows for the objects to still exist in storage, which may be important for external tools. The difference is otherwise not observable from within Move. - [Module sui::object_table](https://docs.sui.io/references/framework/sui_sui/object_table.md) Description: Similar to , an is a map-like collection. But unlike , the values bound to these dynamic fields must be objects themselves. This allows for the objects to still exist within in storage, which may be important for external tools. The difference is otherwise not observable from within Move. - [Module sui::package](https://docs.sui.io/references/framework/sui_sui/package.md) Description: Functions for operating on Move packages from within Move: Creating proof-of-publish objects from one-time witnesses Administering package upgrades through upgrade policies. - [Module sui::party](https://docs.sui.io/references/framework/sui_sui/party.md) Description: Struct Party Struct Permissions Constants Function singleowner Macro function transfer Macro function publictransfer Function empty Function setpermissions Function issingleowner Function intonative use ; use ; use ; Struct Party The permissions that apply to a party object. - [Module sui::pay](https://docs.sui.io/references/framework/sui_sui/pay.md) Description: This module provides handy functionality for wallets and sui::Coin management. - [Module sui::poseidon](https://docs.sui.io/references/framework/sui_sui/poseidon.md) Description: Module which defines instances of the poseidon hash functions. Constants Function poseidonbn254 Function poseidonbn254internal use ; use ; use ; use ; use ; use ; use ; use ; Constants Error if any of the inputs are larger than or equal to the BN254 field size. - [Module sui::priority_queue](https://docs.sui.io/references/framework/sui_sui/priority_queue.md) Description: Priority queue implemented using a max heap. - [Module sui::protocol_config](https://docs.sui.io/references/framework/sui_sui/protocol_config.md) Description: This module provides access to protocol configuration feature flags. Feature flags control the availability of various protocol features and are enabled/disabled at specific protocol versions during epoch changes. - [Module sui::random](https://docs.sui.io/references/framework/sui_sui/random.md) Description: This module provides functionality for generating secure randomness. - [Module sui::ristretto255](https://docs.sui.io/references/framework/sui_sui/ristretto255.md) Description: Group operations of BLS12-381. Only available in devnet. - [Module sui::sui](https://docs.sui.io/references/framework/sui_sui/sui.md) Description: Coin is the token used to pay for gas in Sui. It has 9 decimals, and the smallest unit (10^-9) is called "mist". - [Module sui::table](https://docs.sui.io/references/framework/sui_sui/table.md) Description: A table is a map-like collection. But unlike a traditional collection, it's keys and values are not stored within the value, but instead are stored using Sui's object system. The struct acts only as a handle into the object system to retrieve those keys and values. - [Module sui::table_vec](https://docs.sui.io/references/framework/sui_sui/table_vec.md) Description: A basic scalable vector library implemented using Table. - [Module sui::token](https://docs.sui.io/references/framework/sui_sui/token.md) Description: The Token module which implements a Closed Loop Token with a configurable policy. The policy is defined by a set of rules that must be satisfied for an action to be performed on the token. The module is designed to be used with a TreasuryCap to allow for minting and burning of the s. - [Module sui::transfer](https://docs.sui.io/references/framework/sui_sui/transfer.md) Description: Struct Receiving Constants Function transfer Function publictransfer Function partytransfer Function publicpartytransfer Function freezeobject Function publicfreezeobject Function shareobject Function publicshareobject Function receive Function publicreceive Function receivingobjectid Function - [Module sui::transfer_policy](https://docs.sui.io/references/framework/sui_sui/transfer_policy.md) Description: Defines the type and the logic to approve s. TransferPolicy - is a highly customizable primitive, which provides an interface for the type owner to set custom transfer rules for every deal performed in the Kiosk or a similar system that integrates with TP. - [Module sui::tx_context](https://docs.sui.io/references/framework/sui_sui/tx_context.md) Description: Struct TxContext Function sender Function nativesender Function digest Function epoch Function nativeepoch Function epochtimestampms Function nativeepochtimestampms Function sponsor Function freshobjectaddress Function freshid Function referencegasprice Function nativergp Function gasprice Function - [Module sui::types](https://docs.sui.io/references/framework/sui_sui/types.md) Description: Sui types helpers and utilities Function isonetimewitness Function isonetimewitness Tests if the argument type is a one-time witness, that is a type with only one instantiation across the entire code base. - [Module sui::url](https://docs.sui.io/references/framework/sui_sui/url.md) Description: URL: standard Uniform Resource Locator string Struct Url Function newunsafe Function newunsafefrombytes Function innerurl Function update use ; use ; use ; Struct Url Standard Uniform Resource Locator (URL) string. - [Module sui::vdf](https://docs.sui.io/references/framework/sui_sui/vdf.md) Description: Constants Function hashtoinput Function hashtoinputinternal Function vdfverify Function vdfverifyinternal Constants const : u64 = 0; Function hashtoinput Hash an arbitrary binary message to a class group element to be used as input for . This function is currently only enabled on Devnet. - [Module sui::vec_map](https://docs.sui.io/references/framework/sui_sui/vec_map.md) Description: Struct VecMap Struct Entry Constants Function empty Function insert Function remove Function pop Function getmut Function get Function tryget Function contains Function length Function isempty Function destroyempty Function intokeysvalues Function fromkeysvalues Function keys Function getidxopt - [Module sui::vec_set](https://docs.sui.io/references/framework/sui_sui/vec_set.md) Description: Struct VecSet Constants Function empty Function singleton Function insert Function remove Function contains Function length Function isempty Function intokeys Function fromkeys Function keys Function size use ; use ; Struct VecSet A set data structure backed by a vector. - [Module sui::versioned](https://docs.sui.io/references/framework/sui_sui/versioned.md) Description: Struct Versioned Struct VersionChangeCap Constants Function create Function version Function loadvalue Function loadvaluemut Function removevalueforupgrade Function upgrade Function destroy use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct Versioned A wrapper type that supports - [Module sui::zklogin_verified_id](https://docs.sui.io/references/framework/sui_sui/zklogin_verified_id.md) Description: Struct VerifiedID Constants Function owner Function keyclaimname Function keyclaimvalue Function issuer Function audience Function delete Function verifyzkloginid Function checkzkloginid Function checkzkloginidinternal use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct VerifiedID - [Module sui::zklogin_verified_issuer](https://docs.sui.io/references/framework/sui_sui/zklogin_verified_issuer.md) Description: Struct VerifiedIssuer Constants Function owner Function issuer Function delete Function verifyzkloginissuer Function checkzkloginissuer Function checkzkloginissuerinternal use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct VerifiedIssuer Possession of a VerifiedIssuer - [Module sui_system::genesis](https://docs.sui.io/references/framework/sui_sui_system/genesis.md) Description: Struct GenesisValidatorMetadata Struct GenesisChainParameters Struct TokenDistributionSchedule Struct TokenAllocation Constants Function create Function allocatetokens use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; - [sui:sui system](https://docs.sui.io/references/framework/sui_sui_system.md) Description: Documentation for the modules in the sui/crates/sui-framework/packages/sui_system crate. Select a module from the list to see its details. - [Module sui_system::stake_subsidy](https://docs.sui.io/references/framework/sui_sui_system/stake_subsidy.md) Description: Struct StakeSubsidy Constants Function create Function advanceepoch Function currentepochsubsidyamount Function getdistributioncounter use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; - [Module sui_system::staking_pool](https://docs.sui.io/references/framework/sui_sui_system/staking_pool.md) Description: Struct StakingPool Struct PoolTokenExchangeRate Struct StakedSui Struct FungibleStakedSui Struct FungibleStakedSuiData Struct FungibleStakedSuiDataKey Struct UnderflowSuiBalance Constants Function new Function requestaddstake Function requestwithdrawstake Function redeemfungiblestakedsui Function - [Module sui_system::storage_fund](https://docs.sui.io/references/framework/sui_sui_system/storage_fund.md) Description: Struct StorageFund Function new Function advanceepoch Function totalobjectstoragerebates Function totalbalance use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; - [Module sui_system::sui_system](https://docs.sui.io/references/framework/sui_sui_system/sui_system.md) Description: Sui System State Type Upgrade Guide is a thin wrapper around SuiSystemStateInner that provides a versioned interface. The object has a fixed ID 0x5, and the SuiSystemStateInner object is stored as a dynamic field. - [Module sui_system::sui_system_state_inner](https://docs.sui.io/references/framework/sui_sui_system/sui_system_state_inner.md) Description: Struct ExecutionTimeObservationChunkKey Struct SystemParameters Struct SystemParametersV2 Struct SuiSystemStateInner Struct SuiSystemStateInnerV2 Struct SystemEpochInfoEvent Constants Function create Function createsystemparameters Function v1tov2 Function requestaddvalidatorcandidate Function - [Module sui_system::validator](https://docs.sui.io/references/framework/sui_sui_system/validator.md) Description: Struct ValidatorMetadata Struct Validator Struct StakingRequestEvent Struct UnstakingRequestEvent Struct ConvertingToFungibleStakedSuiEvent Struct RedeemingFungibleStakedSuiEvent Constants Function newmetadata Function new Function deactivate Function activate Function adjuststakeandgasprice - [Module sui_system::validator_cap](https://docs.sui.io/references/framework/sui_sui_system/validator_cap.md) Description: Struct UnverifiedValidatorOperationCap Struct ValidatorOperationCap Function unverifiedoperationcapaddress Function verifiedoperationcapaddress Function newunverifiedvalidatoroperationcapandtransfer Function intoverified use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; Struct - [Module sui_system::validator_set](https://docs.sui.io/references/framework/sui_sui_system/validator_set.md) Description: Struct ValidatorSet Struct ValidatorEpochInfoEvent Struct ValidatorEpochInfoEventV2 Struct ValidatorJoinEvent Struct ValidatorLeaveEvent Struct VotingPowerAdmissionStartEpochKey Constants Function new Function requestaddvalidatorcandidate Function requestremovevalidatorcandidate Function - [Module sui_system::validator_wrapper](https://docs.sui.io/references/framework/sui_sui_system/validator_wrapper.md) Description: Struct ValidatorWrapper Constants Function createv1 Function loadvalidatormaybeupgrade Function destroy Function upgradetolatest Function version use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use ; use - [Module sui_system::voting_power](https://docs.sui.io/references/framework/sui_sui_system/voting_power.md) Description: Struct VotingPowerInfo Struct VotingPowerInfoV2 Constants Function setvotingpower Function initvotingpowerinfo Function deriverawvotingpower Function insert Function adjustvotingpower Function updatevotingpower Function checkinvariants Function totalvotingpower Function quorumthreshold use ; use ; - [Sui Full Node gRPC](https://docs.sui.io/references/fullnode-protocol.md) Description: The Sui full node gRPC protocol is available on all Sui Full nodes. - [Move Trace Debugger](https://docs.sui.io/references/ide/debugger.md) Description: Debug Move execution traces directly in VS Code to understand how your code executes. - [Move Analyzer VS Code Extension](https://docs.sui.io/references/ide/move.md) Description: The Move extension provides language support features like code navigation, completion, and diagnostics for Move source code. - [Object Display V2 Syntax](https://docs.sui.io/references/object-display-syntax.md) Description: Learn how to use Display V2 format strings to render Sui Move object values into human-readable strings, JSON, or encoded representations. - [Manifest Reference](https://docs.sui.io/references/package-managers/manifest-reference.md) Description: Explore examples of package manifest files. - [Package Management Migration](https://docs.sui.io/references/package-managers/package-manager-migration.md) Description: Learn how to migrate from the previous package management system to the new, optimized system. - [PTB Commands](https://docs.sui.io/references/ptb-commands.md) Description: This topic describes each PTB command and their format, return type, and signature. - [Release Notes](https://docs.sui.io/references/release-notes.md) Description: --- 🔶 Testnet | Source: GitHub Release #25827: metadata hardening in Sui System #25674: Enables address aliases feature on mainnet. - [Legacy Rust SDK](https://docs.sui.io/references/rust-sdk.md) Description: The Sui Rust SDK provides Rust wrappers around the Sui API. Using the SDK, you can interact with Sui networks using the Rust programming language. - [Sui RPC](https://docs.sui.io/references/sui-api.md) Description: SuiJSON is a JSON-based format that enables alignment of JSON inputs with Move call arguments. - [RPC Best Practices](https://docs.sui.io/references/sui-api/rpc-best-practices.md) Description: Consider RPC best practices when configuring your RPC settings. - [include](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/directives/include.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [skip](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/directives/skip.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [executeTransaction](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/mutations/execute-transaction.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Execute a transaction, committing its effects on chain. - [address](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/address.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Look-up an account by its SuiAddress. - [chainIdentifier](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/chain-identifier.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The network's genesis checkpoint digest (uniquely identifies the network), Base58-encoded. - [checkpoint](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/checkpoint.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch a checkpoint by its sequence number, or the latest checkpoint if no sequence number is provided. - [checkpoints](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/checkpoints.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [coinMetadata](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/coin-metadata.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch the CoinMetadata for a given coin type. - [epoch](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/epoch.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch an epoch by its ID, or fetch the latest epoch if no ID is provided. - [epochs](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/epochs.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [events](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/events.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [multiGetAddresses](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-addresses.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch addresses by their keys. Returns a list of addresses that is guaranteed to be the same length as . - [multiGetCheckpoints](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-checkpoints.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch checkpoints by their sequence numbers. - [multiGetEpochs](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-epochs.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch epochs by their IDs. Returns a list of epochs that is guaranteed to be the same length as . - [multiGetObjects](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-objects.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch objects by their keys. Returns a list of objects that is guaranteed to be the same length as . - [multiGetPackages](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-packages.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch packages by their keys. Returns a list of packages that is guaranteed to be the same length as . - [multiGetTransactionEffects](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-transaction-effects.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch transaction effects by their transactions' digests. - [multiGetTransactions](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-transactions.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch transactions by their digests. - [multiGetTypes](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/multi-get-types.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch types by their string representations. - [nameRecord](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/name-record.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Look-up a Name Service NameRecord by its domain name. Returns if the record does not exist or has expired. - [node](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/node.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch a by its globally unique . - [objectVersions](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/object-versions.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [object](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/object.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch an object by its address. If is specified, the object will be fetched at that exact version. - [objects](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/objects.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Paginate objects in the live object set, optionally filtered by owner and/or type. - [packageVersions](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/package-versions.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [package](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/package.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch a package by its address. - [packages](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/packages.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [protocolConfigs](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/protocol-configs.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [serviceConfig](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/service-config.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [simulateTransaction](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/simulate-transaction.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Simulate a transaction to preview its effects without executing it on chain. - [transactionEffects](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/transaction-effects.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch transaction effects by its transaction's digest. - [transaction](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/transaction.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch a transaction by its digest. - [transactions](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/transactions.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [type](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/type.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Fetch a structured representation of a concrete type, including its layout information. - [verifyZkLoginSignature](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/operations/queries/verify-zk-login-signature.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Verify a zkLogin signature is from the given . Returns successfully if the signature is valid. - [deprecated](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/directives/deprecated.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Marks an element of a GraphQL schema as no longer supported. - [oneOf](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/directives/one-of.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? - [specifiedBy](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/directives/specified-by.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Exposes a URL that specifies the behavior of this scalar. - [AddressTransactionRelationship](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/address-transaction-relationship.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The possible relationship types for a transaction: sent or affected. Transactions this address has sent. - [ConsensusObjectCancellationReason](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/consensus-object-cancellation-reason.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Reason why a transaction that attempted to access a consensus-managed object was cancelled. - [ExecutionStatus](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/execution-status.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The execution status of this transaction: success or failure. The transaction was successfully executed. - [MoveAbility](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/move-ability.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Abilities are keywords in Sui Move that define how types behave at the compiler level. - [MoveVisibility](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/move-visibility.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The visibility modifier describes which modules can access this module member. - [MultisigMemberSignatureScheme](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/multisig-member-signature-scheme.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The signature scheme of a multisig member's signature. - [OwnerKind](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/owner-kind.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Filter on who owns an object. Object is owned by an address. Object is a child of another object (e.g. - [RegulatedState](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/regulated-state.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Whether the currency is regulated or not. A or a exists for this currency. - [SupplyState](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/supply-state.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Future behavior of a currency's supply. The supply can only decrease. - [TransactionKindInput](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/transaction-kind-input.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; An input filter selecting for either system or programmable transactions. - [WithdrawFrom](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/withdraw-from.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; The account to withdraw funds from. The funds are withdrawn from the transaction sender's account. - [ZkLoginIntentScope](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/enums/zk-login-intent-scope.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; An enum that specifies the intent scope to be used to parse the bytes for signature verification. - [AddressKey](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/inputs/address-key.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Identifies a specific version of an address. Exactly one of or must be specified. - [CheckpointFilter](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/inputs/checkpoint-filter.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Limit query results to checkpoints that occured strictly after the given checkpoint. - [DynamicFieldName](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/inputs/dynamic-field-name.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; A description of a dynamic field's name. - [EventFilter](https://docs.sui.io/references/sui-api/sui-graphql/beta/reference/types/inputs/event-filter.md) Description: const [open, setOpen] = useState(startOpen); return ( { e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children} ); }; Limit to events that occured strictly after the given checkpoint. Limit to events in the given checkpoint. ## Standards - [Closed-Loop Token](https://docs.sui.io/standards/closed-loop-token.md) Description: Closed-Loop tokens can only be used for a specific service or by authorized users. - [Action Request](https://docs.sui.io/standards/closed-loop-token/action-request.md) Description: Tokens do not allow transfers, conversions, or spends by default. To allow these actions, use an `ActionRequest`. - [Coin/Token API comparison](https://docs.sui.io/standards/closed-loop-token/coin-token-comparison.md) Description: Compare and contrast the API used for the `coin` and `token` modules. - [Rules](https://docs.sui.io/standards/closed-loop-token/rules.md) Description: Rule modules are used to create programmable restrictions that apply any action within a `TokenPolicy`. - [Spending](https://docs.sui.io/standards/closed-loop-token/spending.md) Description: Token types cannot use the `store` ability to store other objects. Instead, Tokens have a `spend` method. - [Token Policy](https://docs.sui.io/standards/closed-loop-token/token-policy.md) Description: A `TokenPolicy` is a shared object that defines a token's allowed actions and conditions. Wallets and other financial services often use `TokenPolicy` objects. - [Coin Standard](https://docs.sui.io/standards/coin.md) Description: The Coin standard enables you to create a broad range of fungible tokens on the Sui network to satisfy a number of use cases. - [Currency Standard](https://docs.sui.io/standards/currency.md) Description: The Sui Currency Standard enables you to create a broad range of fungible tokens on the Sui network using either the legacy coin creation or the centralized coin registry system. - [DeepBook Margin Indexer](https://docs.sui.io/standards/deepbook-margin-indexer.md) Description: DeepBook Margin Indexer provides access to margin trading events including loans, liquidations, and margin pool operations. - [DeepBook Margin SDK](https://docs.sui.io/standards/deepbook-margin-sdk.md) Description: Use the DeepBook TypeScript SDK to interact directly with the DeepBook Margin package. - [Maintainer SDK](https://docs.sui.io/standards/deepbook-margin-sdk/maintainer.md) Description: Learn how to use the DeepBook Margin SDK to manage margin pools and system configuration. - [Margin Manager SDK](https://docs.sui.io/standards/deepbook-margin-sdk/margin-manager.md) Description: Learn how to use the DeepBook Margin SDK to manage margin accounts and leveraged positions. - [Margin Pool SDK](https://docs.sui.io/standards/deepbook-margin-sdk/margin-pool.md) Description: Learn how to use the DeepBook Margin SDK to supply liquidity and manage positions in margin pools. - [Orders SDK](https://docs.sui.io/standards/deepbook-margin-sdk/orders.md) Description: Learn how to use the DeepBook Margin SDK to place and manage orders with margin managers. - [Take Profit Stop Loss SDK](https://docs.sui.io/standards/deepbook-margin-sdk/tpsl.md) Description: Learn how to use the DeepBook Margin SDK to manage conditional orders for automated trading. - [DeepBook Margin](https://docs.sui.io/standards/deepbook-margin.md) Description: Leveraged trading capabilities for DeepBookV3, enabling users to trade with borrowed funds and increase their buying power. - [Contract Information](https://docs.sui.io/standards/deepbook-margin/contract-information.md) Description: DeepBook Margin contract addresses, supported coins, margin pools, and risk parameters on Sui Mainnet. - [Interest Rates](https://docs.sui.io/standards/deepbook-margin/contract-information/interest-rates.md) Description: Learn how interest rates are calculated for margin pool borrowing. - [Maintainer](https://docs.sui.io/standards/deepbook-margin/contract-information/maintainer.md) Description: Learn about maintainer functions for managing margin pools and system configuration. - [Margin Manager](https://docs.sui.io/standards/deepbook-margin/contract-information/margin-manager.md) Description: Learn about the margin manager and how it enables leveraged trading on DeepBook. - [Margin Pool](https://docs.sui.io/standards/deepbook-margin/contract-information/margin-pool.md) Description: Learn about margin pools and how they enable liquidity for leveraged trading. - [Orders](https://docs.sui.io/standards/deepbook-margin/contract-information/orders.md) Description: Learn how to place and manage orders using margin managers. - [Risk Ratio](https://docs.sui.io/standards/deepbook-margin/contract-information/risk-ratio.md) Description: Understanding risk ratios and how they determine leverage limits, collateral requirements, and liquidation thresholds in DeepBook Margin. - [Supply Referral](https://docs.sui.io/standards/deepbook-margin/contract-information/supply-referral.md) Description: Learn how supply referrals work in DeepBook Margin and how to earn fees by referring liquidity suppliers. - [Take Profit Stop Loss](https://docs.sui.io/standards/deepbook-margin/contract-information/tpsl.md) Description: Learn about conditional orders for automated trading strategies on DeepBook Margin.