@solana-mobile/guardian-client 0.0.0 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -42
- package/dist/src/index.js +4641 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/index.mjs +4282 -0
- package/dist/src/index.mjs.map +1 -0
- package/dist/types/generated/accounts/appAccount.d.ts +50 -0
- package/dist/types/generated/accounts/guardiansConfig.d.ts +54 -0
- package/dist/types/generated/accounts/index.d.ts +10 -0
- package/dist/types/generated/accounts/pendingRegistry.d.ts +35 -0
- package/dist/types/generated/constants/guardian.d.ts +8 -0
- package/dist/types/generated/constants/index.d.ts +8 -0
- package/dist/types/generated/errors/guardian.d.ts +95 -0
- package/dist/types/generated/errors/index.d.ts +8 -0
- package/dist/types/generated/events/appAuthorityAccepted.d.ts +42 -0
- package/dist/types/generated/events/appAuthorityProposed.d.ts +42 -0
- package/dist/types/generated/events/appDeveloperUpdated.d.ts +42 -0
- package/dist/types/generated/events/appRegistered.d.ts +42 -0
- package/dist/types/generated/events/configAuthorityAccepted.d.ts +38 -0
- package/dist/types/generated/events/configAuthorityProposed.d.ts +38 -0
- package/dist/types/generated/events/configInitialized.d.ts +46 -0
- package/dist/types/generated/events/configUpdated.d.ts +52 -0
- package/dist/types/generated/events/guardianAdded.d.ts +34 -0
- package/dist/types/generated/events/guardianRegistered.d.ts +46 -0
- package/dist/types/generated/events/guardianRemoved.d.ts +42 -0
- package/dist/types/generated/events/guardianVoteAuthorityRotated.d.ts +42 -0
- package/dist/types/generated/events/index.d.ts +25 -0
- package/dist/types/generated/events/releaseApproved.d.ts +27 -0
- package/dist/types/generated/events/releaseCancelled.d.ts +38 -0
- package/dist/types/generated/events/releaseExpired.d.ts +38 -0
- package/dist/types/generated/events/releaseProposed.d.ts +42 -0
- package/dist/types/generated/events/releaseRejected.d.ts +27 -0
- package/dist/types/generated/events/voteCast.d.ts +55 -0
- package/dist/types/generated/index.d.ts +15 -0
- package/dist/types/generated/instructions/acceptAppAuthority.d.ts +71 -0
- package/dist/types/generated/instructions/acceptConfigAuthority.d.ts +71 -0
- package/dist/types/generated/instructions/addGuardian.d.ts +90 -0
- package/dist/types/generated/instructions/cancelRelease.d.ts +78 -0
- package/dist/types/generated/instructions/expireRelease.d.ts +71 -0
- package/dist/types/generated/instructions/index.d.ts +24 -0
- package/dist/types/generated/instructions/initializeConfig.d.ts +135 -0
- package/dist/types/generated/instructions/proposeAppAuthority.d.ts +76 -0
- package/dist/types/generated/instructions/proposeConfigAuthority.d.ts +76 -0
- package/dist/types/generated/instructions/proposeRelease.d.ts +121 -0
- package/dist/types/generated/instructions/registerApp.d.ts +87 -0
- package/dist/types/generated/instructions/registerGuardian.d.ts +120 -0
- package/dist/types/generated/instructions/removeGuardian.d.ts +120 -0
- package/dist/types/generated/instructions/rotateVoteAuthority.d.ts +80 -0
- package/dist/types/generated/instructions/setAppDeveloper.d.ts +112 -0
- package/dist/types/generated/instructions/updateConfig.d.ts +88 -0
- package/dist/types/generated/instructions/vote.d.ts +116 -0
- package/dist/types/generated/instructions/writeReleaseManifest.d.ts +104 -0
- package/dist/types/generated/pdas/bondVault.d.ts +11 -0
- package/dist/types/generated/pdas/guardiansConfig.d.ts +11 -0
- package/dist/types/generated/pdas/index.d.ts +10 -0
- package/dist/types/generated/pdas/pendingRegistry.d.ts +11 -0
- package/dist/types/generated/programs/guardian.d.ts +179 -0
- package/dist/types/generated/programs/index.d.ts +8 -0
- package/dist/types/generated/types/bondInfo.d.ts +19 -0
- package/dist/types/generated/types/guardianInfo.d.ts +19 -0
- package/dist/types/generated/types/index.d.ts +14 -0
- package/dist/types/generated/types/pendingRelease.d.ts +29 -0
- package/dist/types/generated/types/publishedApp.d.ts +16 -0
- package/dist/types/generated/types/releaseManifest.d.ts +45 -0
- package/dist/types/generated/types/releaseResolution.d.ts +65 -0
- package/dist/types/generated/types/voteFinding.d.ts +24 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/manifest.d.ts +72 -0
- package/dist/types/proposal.d.ts +66 -0
- package/package.json +59 -8
package/README.md
CHANGED
|
@@ -1,45 +1,9 @@
|
|
|
1
1
|
# @solana-mobile/guardian-client
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A [`@solana/kit`](https://github.com/anza-xyz/kit) client for the guardian program, generated with
|
|
4
|
+
Codama, plus helpers that encode, chunk, and hash release manifests and that apply the program's
|
|
5
|
+
rules for what proposing a release takes next.
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
## Purpose
|
|
10
|
-
|
|
11
|
-
This package exists to:
|
|
12
|
-
1. Configure OIDC trusted publishing for the package name `@solana-mobile/guardian-client`
|
|
13
|
-
2. Enable secure, token-less publishing from CI/CD workflows
|
|
14
|
-
3. Establish provenance for packages published under this name
|
|
15
|
-
|
|
16
|
-
## What is OIDC Trusted Publishing?
|
|
17
|
-
|
|
18
|
-
OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
|
|
19
|
-
|
|
20
|
-
## Setup Instructions
|
|
21
|
-
|
|
22
|
-
To properly configure OIDC trusted publishing for this package:
|
|
23
|
-
|
|
24
|
-
1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
|
|
25
|
-
2. Configure the trusted publisher (e.g., GitHub Actions)
|
|
26
|
-
3. Specify the repository and workflow that should be allowed to publish
|
|
27
|
-
4. Use the configured workflow to publish your actual package
|
|
28
|
-
|
|
29
|
-
## DO NOT USE THIS PACKAGE
|
|
30
|
-
|
|
31
|
-
This package is a placeholder for OIDC configuration only. It:
|
|
32
|
-
- Contains no executable code
|
|
33
|
-
- Provides no functionality
|
|
34
|
-
- Should not be installed as a dependency
|
|
35
|
-
- Exists only for administrative purposes
|
|
36
|
-
|
|
37
|
-
## More Information
|
|
38
|
-
|
|
39
|
-
For more details about npm's trusted publishing feature, see:
|
|
40
|
-
- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
|
|
41
|
-
- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
**Maintained for OIDC setup purposes only**
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @solana-mobile/guardian-client @solana/kit
|
|
9
|
+
```
|