Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(examples): FunctionModifiers, Smart Contract Wallet Package #3559

Closed
wants to merge 0 commits into from

Conversation

Ursulovic
Copy link
Contributor

@Ursulovic Ursulovic commented Jan 20, 2025

FunctionModifiers and Smart Contract Wallet Package

FunctionModifiers Package

A general-purpose package for managing access control and conditional logic in smart contracts. It handles:

  • Ownership: Multi-owner setups with approval thresholds.
  • Approvals: Ensures actions need consensus before execution.
  • Proposals: Tracks and manages changes like adding owners or updating rules.

SmartContractWallet Package

A wallet system built on FunctionModifiers for managing coins and tokens. Features:

  • Multi-Owner Control: Requires approvals for withdrawals.
  • Proposals: Owners propose and approve transactions.
  • Secure Transactions: Ensures funds move only with consensus.

This PR also contains 2 demo realms:

  1. modifierdemo: Wrapper functions for testing FunctionModifiers package.
  2. smartcontractwalletdemo: Wrapper functions for testing SmartContractWallet package.

These demo realms are intended for testing and will be removed in the final commit.


Functionalities

FunctionModifiers Package

  • Implement ownership management functions
  • Implement registering modifiers
  • Implement editing modifiers
  • Implement approving modifiers
  • Implement AssertIsApproved function
  • Write tests

SmartContractWallet Package

  • Implement managing coins
  • Implement managing GRC20 tokens
  • Implement tests

Possible improvements

  • Implement event logging

@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Jan 20, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Jan 20, 2025

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
  • The pull request description provides enough details
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: Ursulovic/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission
The pull request description provides enough details

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

@leohhhn leohhhn changed the title MultiSig Wallet Package feat(examples): MultiSig Wallet Package Jan 20, 2025
@leohhhn leohhhn self-requested a review January 20, 2025 16:00
@leohhhn leohhhn marked this pull request as draft January 20, 2025 16:01
@leohhhn
Copy link
Contributor

leohhhn commented Jan 20, 2025

Need an example realm of how this is used - when you make it, you'll see this implementation doesn't work :)

@Ursulovic Ursulovic changed the title feat(examples): MultiSig Wallet Package feat(examples): MultiSig, and Smart Contract Wallet package Jan 22, 2025
@Gno2D2 Gno2D2 requested a review from a team January 23, 2025 16:35
Copy link

codecov bot commented Jan 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@Ursulovic Ursulovic marked this pull request as ready for review January 31, 2025 02:15
@Ursulovic Ursulovic changed the title feat(examples): MultiSig, and Smart Contract Wallet package feat(examples): FunctionModifiers, Smart Contract Wallet Package Jan 31, 2025
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 31, 2025
Copy link
Contributor

@leohhhn leohhhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add tests; I will review the rest after that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages. review/triage-pending PRs opened by external contributors that are waiting for the 1st review
Projects
Development

Successfully merging this pull request may close these issues.

3 participants