Repository navigation
Feat/44 sui move escrow - #48
Merged
Merged
Conversation
… sequence diagrams (#44)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #44
This PR implements the Sui Move Escrow System using Move 2024 Edition. It includes modular smart contracts for asset locking, custodied single-owner swaps, and trustless peer-to-peer shared object swaps, along with a 13-scenario unit test suite, automated CI/CD, gas benchmarking tooling, and complete localnet deployment documentation.
Key Changes
1. Move 2024 Smart Contracts (
contract/sources/)lock.move: Low-level asset locking container (Locked<T>) and single-useKeyprimitive using Dynamic Object Fields (DOF).owned.move: Single-owner / custodied escrow pattern managed by a trusted third-party custodian with reciprocity validation.shared.move: Peer-to-peer trustless escrow pattern built on Sui shared objects with storage gas rebate reclamation viaid.delete().2. Unit Test Suite (
contract/tests/)lock_tests.move,owned_tests.move,shared_tests.move).3. Architecture & Package Structure
Sui/Move/smart-contracts/escrow/contract/.[environments]local chain ID configuration inMove.tomland trackedPublished.toml.4. CI/CD Pipeline (
.github/workflows/sui-ci.yml)--lint --warnings-are-errors), test execution, code coverage reporting, and GitHub Step Summaries for gas statistics.5. Performance Benchmarking (
performance/)performance/benchmark.shfor single-command gas profile generation.performance/README.md.6. Documentation & Localnet Deployment (
contract/README.md)Verification & Testing
1. Unit Tests & Linter
Test result: OK. Total tests: 13; passed: 13; failed: 02. Code Coverage
sui move test --coverage sui move coverage summary3. Gas Profile & Benchmarks
4. Localnet Deployment
sui client switch --env local sui client faucet sui client publish0xf155a09874b07527d5bd7e8f919f26e09c9e4a324166425c9c4b4c0221e79f4e0xb5e86fdba15a266be9a659635ace8af7ac1e698e7087389b6f9f6777ae4f5c4cChecklist
--lint --warnings-are-errors)performance/README.mdPublished.tomltracked