Skip to content

Implement access-check APIs in GuildPass SDK V2 #495

Closed

Description

@Lakes41

Difficulty

Medium

Type

Feature / Access Control

Background

Access evaluation is a central GuildPass capability and should be easy to consume from applications, bots, and integrations.

Problem

Consumers currently have no V2 SDK method for submitting access checks and receiving structured decisions from Core.

Expected Outcome

The SDK exposes a strongly typed client.access.check() operation with deterministic, explainable results.

Suggested Implementation

Support an API similar to:

const result = await client.access.check({
  guildId,
  account,
  resource,
  action
});

Return a result similar to:

{
  allowed: true,
  reason: "required_pass_owned"
}

Do not duplicate policy evaluation logic inside the SDK.

Acceptance Criteria

  • client.access.check() is implemented.
  • Request input is strongly typed.
  • Result uses the canonical AccessDecision type.
  • Stellar account identifiers are supported.
  • Policy evaluation remains a Core responsibility.
  • Denied access is represented as a normal decision where appropriate rather than always throwing.
  • Transport/API failures still use typed SDK errors.
  • Unit tests cover allowed, denied, and error scenarios.

Likely Affected Files/Directories

  • src/resources/access.ts
  • src/client.ts
  • src/types/
  • test/

Activity

  1. added
    Third CampaignOfficial FWC26 campaign issue — eligible for campaign scoring and rewards
    on Sep 12, 2026
  2. abojeEdwin commented on Sep 12, 2026

    @abojeEdwin

    Hi maintainer, I've gone through the issue and I have a clear understanding of the fix for this issue. I'd love to be assigned to this issue. Thank you

  3. Okorie2000-code commented on Sep 14, 2026

    @Okorie2000-code
    Contributor

    Hi Maintainer, I'd like to work on this issue and can start right away. Please assign it to me.

  4. rupesh-kumar-sah commented on Sep 14, 2026

    @rupesh-kumar-sah
    Contributor

    Hello @maintainers,

    I can tackle Implement access-check APIs in GuildPass SDK V2. Proposed implementation roadmap:

    • Analysis: Inspect current behavior and edge cases in Adamantine-guild/guildpass-sdk
    • Core Implementation: Build Implement access-check APIs in GuildPass SDK V2 with clean React/Next.js components, responsive styling, and proper loading/error boundaries.
    • Quality Assurance: Add component unit tests and ensure zero TypeScript/ESLint warnings.

    I am ready to start immediately—please assign this to me!

  5. grantfox-oss commented on Sep 16, 2026

    @grantfox-oss

    🎉 This issue has been marked as completed on GrantFox!

    @rupesh-kumar-sah's PR #503 was approved and merged by @Lakes41.

    🏆 @rupesh-kumar-sah: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (35 total points). Track your full progress on GrantFox.

    👏 Great work, @rupesh-kumar-sah! Keep contributing to Adamantine-guild.

  6. added a commit that references this issue on Oct 19, 2026
    3542590
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Third CampaignOfficial FWC26 campaign issue — eligible for campaign scoring and rewards

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions