Skip to content
This repository was archived by the owner on Mar 11, 2025. It is now read-only.

Commit e4ab3ed

Browse files
joncinquejoncinque
committed
README: Update internal documentation
1 parent e116dc2 commit e4ab3ed

File tree

2 files changed

+56
-100
lines changed

2 files changed

+56
-100
lines changed

Diff for: ‎README.md

+43-27
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
# PLEASE READ: This repo no longer contains the SPL program implementations
2+
3+
This repo still exists in archived form, feel free to fork any reference
4+
implementations it still contains.
5+
6+
## Migrated Packages
7+
8+
The Solana Program Library repository has been broken up into separate repos for
9+
each program and set of clients, under the
10+
[solana-program organization](https://github.com/solana-program).
11+
12+
The following programs have been moved:
13+
14+
* [Associated-Token-Account](https://github.com/solana-program/associated-token-account)
15+
* [Feature Proposal](https://github.com/solana-program/feature-proposal)
16+
* [Instruction Padding](https://github.com/solana-program/instruction-padding)
17+
* [Libraries](https://github.com/solana-program/libraries)
18+
* [Memo](https://github.com/solana-program/memo)
19+
* [Record](https://github.com/solana-program/record)
20+
* [Single Pool](https://github.com/solana-program/single-pool)
21+
* [Slashing](https://github.com/solana-program/slashing)
22+
* [Stake Pool](https://github.com/solana-program/stake-pool)
23+
* [Token](https://github.com/solana-program/token)
24+
* [Token-2022](https://github.com/solana-program/token-2022)
25+
* [Token-Group](https://github.com/solana-program/token-group)
26+
* [Token-Metadata](https://github.com/solana-program/token-metadata)
27+
* [Token-2022 Transfer Hook](https://github.com/solana-program/transfer-hook)
28+
129
# Solana Program Library
230

331
The Solana Program Library (SPL) is a collection of on-chain programs targeting
@@ -17,48 +45,43 @@ the Solana Mainnet Beta. Currently, this includes:
1745

1846
| Program | Version |
1947
| --- | --- |
20-
| [token](https://github.com/solana-labs/solana-program-library/tree/master/token/program) | [3.4.0](https://github.com/solana-labs/solana-program-library/releases/tag/token-v3.4.0) |
21-
| [associated-token-account](https://github.com/solana-labs/solana-program-library/tree/master/associated-token-account/program) | [1.1.0](https://github.com/solana-labs/solana-program-library/releases/tag/associated-token-account-v1.1.0) |
22-
| [token-2022](https://github.com/solana-labs/solana-program-library/tree/master/token/program-2022) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/token-2022-v1.0.0) |
48+
| [token](https://github.com/solana-program/token/tree/main/program) | [3.4.0](https://github.com/solana-labs/solana-program-library/releases/tag/token-v3.4.0) |
49+
| [associated-token-account](https://github.com/solana-program/associated-token-account/tree/main/program) | [1.1.0](https://github.com/solana-labs/solana-program-library/releases/tag/associated-token-account-v1.1.0) |
50+
| [token-2022](https://github.com/solana-program/token-2022/tree/main/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/token-2022-v1.0.0) |
2351
| [governance](https://github.com/solana-labs/solana-program-library/tree/master/governance/program) | [3.1.0](https://github.com/solana-labs/solana-program-library/releases/tag/governance-v3.1.0) |
24-
| [stake-pool](https://github.com/solana-labs/solana-program-library/tree/master/stake-pool/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/stake-pool-v1.0.0) |
52+
| [stake-pool](https://github.com/solana-program/stake-pool/tree/main/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/stake-pool-v1.0.0) |
2553
| [account-compression](https://github.com/solana-labs/solana-program-library/tree/master/account-compression/programs/account-compression) | [0.1.3](https://github.com/solana-labs/solana-program-library/releases/tag/account-compression-v0.1.3) |
2654
| [shared-memory](https://github.com/solana-labs/solana-program-library/tree/master/shared-memory/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/commit/b40e0dd3fd6c0e509dc1e8dd3da0a6d609035bbd) |
27-
| [feature-proposal](https://github.com/solana-labs/solana-program-library/tree/master/feature-proposal/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/feature-proposal-v1.0.0) |
55+
| [feature-proposal](https://github.com/solana-program/feature-proposal/tree/main/program) | [1.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/feature-proposal-v1.0.0) |
2856
| [name-service](https://github.com/solana-labs/solana-program-library/tree/master/name-service/program) | [0.3.0](https://github.com/solana-labs/solana-program-library/releases/tag/name-service-v0.3.0) |
29-
| [memo](https://github.com/solana-program/memo/tree/master/program) | [3.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/memo-v3.0.0) |
30-
31-
In addition, one program is planned for deployment to Solana Mainnet Beta:
32-
33-
| Program | Version |
34-
| --- | --- |
35-
| [single-pool](https://github.com/solana-labs/solana-program-library/tree/master/single-pool/program) | [1.0.1](https://github.com/solana-labs/solana-program-library/releases/tag/single-pool-v1.0.1) |
57+
| [memo](https://github.com/solana-program/memo/tree/main/program) | [3.0.0](https://github.com/solana-labs/solana-program-library/releases/tag/memo-v3.0.0) |
58+
| [single-pool](https://github.com/solana-program/single-pool/tree/main/program) | [1.0.1](https://github.com/solana-labs/solana-program-library/releases/tag/single-pool-v1.0.1) |
3659

3760
## Audits
3861

3962
Only a subset of programs within the Solana Program Library repo are audited. Currently, this includes:
4063

4164
| Program | Last Audit Date | Version |
4265
| --- | --- | --- |
43-
| [token](https://github.com/solana-labs/solana-program-library/tree/master/token/program) | 2022-08-04 (Peer review) | [4fadd55](https://github.com/solana-labs/solana-program-library/commit/4fadd553e1c549afd1d62aeb5ffa7ef31d1999d1) |
44-
| [associated-token-account](https://github.com/solana-labs/solana-program-library/tree/master/associated-token-account/program) | 2022-08-04 (Peer review) | [c00194d](https://github.com/solana-labs/solana-program-library/commit/c00194d2257302f028f44a403c6dee95c0f9c3bc) |
45-
| [token-2022](https://github.com/solana-labs/solana-program-library/tree/master/token/program-2022) | [2023-11-03](https://github.com/solana-labs/security-audits/blob/master/spl/OtterSecToken2022Audit-2023-11-03.pdf) | [e924132](https://github.com/solana-labs/solana-program-library/tree/e924132d65ba0896249fb4983f6f97caff15721a) |
46-
| [stake-pool](https://github.com/solana-labs/solana-program-library/tree/master/stake-pool/program) | [2023-12-31](https://github.com/solana-labs/security-audits/blob/master/spl/HalbornStakePoolAudit-2023-12-31.pdf) | [a17fffe](https://github.com/solana-labs/solana-program-library/commit/a17fffe70d6cc13742abfbc4a4a375b087580bc1) |
66+
| [token](https://github.com/solana-program/token) | 2022-08-04 (Peer review) | [4fadd55](https://github.com/solana-labs/solana-program-library/commit/4fadd553e1c549afd1d62aeb5ffa7ef31d1999d1) |
67+
| [associated-token-account](https://github.com/solana-program/associated-token-account) | 2022-08-04 (Peer review) | [c00194d](https://github.com/solana-labs/solana-program-library/commit/c00194d2257302f028f44a403c6dee95c0f9c3bc) |
68+
| [token-2022](https://github.com/solana-program/token-2022) | [2023-11-03](https://github.com/solana-labs/security-audits/blob/master/spl/OtterSecToken2022Audit-2023-11-03.pdf) | [e924132](https://github.com/solana-labs/solana-program-library/tree/e924132d65ba0896249fb4983f6f97caff15721a) |
69+
| [stake-pool](https://github.com/solana-program/stake-pool) | [2023-12-31](https://github.com/solana-labs/security-audits/blob/master/spl/HalbornStakePoolAudit-2023-12-31.pdf) | [a17fffe](https://github.com/solana-labs/solana-program-library/commit/a17fffe70d6cc13742abfbc4a4a375b087580bc1) |
4770
| [account-compression](https://github.com/solana-labs/solana-program-library/tree/master/account-compression/programs/account-compression) | [2022-12-05](https://github.com/solana-labs/security-audits/blob/master/spl/OtterSecAccountCompressionAudit-2022-12-03.pdf) | [6e81794](https://github.com/solana-labs/solana-program-library/commit/6e81794) |
4871
| [shared-memory](https://github.com/solana-labs/solana-program-library/tree/master/shared-memory/program) | [2021-02-25](https://github.com/solana-labs/security-audits/blob/master/spl/KudelskiTokenSwapSharedMemAudit-2021-02-25.pdf) | [b40e0dd](https://github.com/solana-labs/solana-program-library/commit/b40e0dd3fd6c0e509dc1e8dd3da0a6d609035bbd) |
49-
| [single-pool](https://github.com/solana-labs/solana-program-library/tree/master/single-pool/program) | [2024-01-02](https://github.com/solana-labs/security-audits/blob/master/spl/ZellicSinglePoolAudit-2024-01-02.pdf) | [ef44df9](https://github.com/solana-labs/solana-program-library/commit/ef44df985e76a697ee9a8aabb3a223610e4cf1dc) |
72+
| [single-pool](https://github.com/solana-program/single-pool) | [2024-01-02](https://github.com/solana-labs/security-audits/blob/master/spl/ZellicSinglePoolAudit-2024-01-02.pdf) | [ef44df9](https://github.com/solana-labs/solana-program-library/commit/ef44df985e76a697ee9a8aabb3a223610e4cf1dc) |
5073

5174
All other programs may be updated from time to time. These programs are not
5275
audited, so fork and deploy them at your own risk. Here is the full list of
5376
unaudited programs:
5477

5578
* [binary-option](https://github.com/solana-labs/solana-program-library/tree/master/binary-option/program)
5679
* [binary-oracle-pair](https://github.com/solana-labs/solana-program-library/tree/master/binary-oracle-pair/program)
57-
* [feature-proposal](https://github.com/solana-labs/solana-program-library/tree/master/feature-proposal/program)
58-
* [instruction-padding](https://github.com/solana-labs/solana-program-library/tree/master/instruction-padding/program)
80+
* [feature-proposal](https://github.com/solana-program/feature-proposal)
81+
* [instruction-padding](https://github.com/solana-program/instruction-padding)
5982
* [managed-token](https://github.com/solana-labs/solana-program-library/tree/master/managed-token/program)
6083
* [name-service](https://github.com/solana-labs/solana-program-library/tree/master/name-service/program)
61-
* [record](https://github.com/solana-labs/solana-program-library/tree/master/record/program)
84+
* [record](https://github.com/solana-program/record)
6285
* [stateless-asks](https://github.com/solana-labs/solana-program-library/tree/master/stateless-asks/program)
6386
* [token-lending](https://github.com/solana-labs/solana-program-library/tree/master/token-lending/program)
6487
* [token-swap](https://github.com/solana-labs/solana-program-library/tree/master/token-swap/program)
@@ -70,13 +93,6 @@ More information about the repository's security policy at
7093
The [security-audits repo](https://github.com/solana-labs/security-audits) contains
7194
all past and present program audits.
7295

73-
## Migrated Packages
74-
75-
The Solana Program Library repository is being broken up into separate repos for
76-
each program and set of clients. The following programs have been moved:
77-
78-
* [Memo](https://github.com/solana-program/memo)
79-
8096
## Program Packages
8197

8298
| Package | Description | Version | Docs |

Diff for: ‎SECURITY.md

+13-73
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,13 @@
1-
# Security Policy
2-
3-
1. [Reporting security problems](#reporting)
4-
1. [Security Bug Bounties](#bounty)
5-
1. [Scope](#scope)
6-
1. [Incident Response Process](#process)
7-
8-
<a name="reporting"></a>
9-
## Reporting security problems in the Solana Program Library
10-
11-
**DO NOT CREATE A GITHUB ISSUE** to report a security problem.
12-
13-
Instead please use this [Report a Vulnerability](https://github.com/solana-labs/solana-program-library/security/advisories/new) link.
14-
Provide a helpful title and detailed description of the problem.
15-
16-
If you haven't done so already, please **enable two-factor auth** in your GitHub account.
17-
18-
Expect a response as fast as possible in the advisory, typically within 72 hours.
19-
20-
--
21-
22-
If you do not receive a response in the advisory, send an email to
23-
[email protected] with the full URL of the advisory you have created. DO NOT
24-
include attachments or provide detail sufficient for exploitation regarding the
25-
security issue in this email. **Only provide such details in the advisory**.
26-
27-
If you do not receive a response from [email protected] please followup with
28-
the team directly. You can do this in the `#core-technology` channel of the
29-
[Solana Tech discord server](https://solana.com/discord), by pinging the admins
30-
in the channel and referencing the fact that you submitted a security problem.
31-
32-
33-
34-
<a name="bounty"></a>
35-
## Security Bug Bounties
36-
The Solana Foundation offer bounties for critical Solana security issues. Please
37-
see the [Solana Security Bug
38-
Bounties](https://github.com/solana-labs/solana/security/policy#security-bug-bounties)
39-
for details on classes of bugs and payment amounts.
40-
41-
<a name="scope"></a>
42-
## Scope
43-
44-
Only a subset of programs within the Solana Program Library repo are deployed to
45-
the Solana Mainnet Beta. Currently, this includes:
46-
47-
* [associated-token-account](https://github.com/solana-labs/solana-program-library/tree/master/associated-token-account/program)
48-
* [feature-proposal](https://github.com/solana-labs/solana-program-library/tree/master/feature-proposal/program)
49-
* [governance](https://github.com/solana-labs/solana-program-library/tree/master/governance/program)
50-
* [memo](https://github.com/solana-program/memo)
51-
* [name-service](https://github.com/solana-labs/solana-program-library/tree/master/name-service/program)
52-
* [stake-pool](https://github.com/solana-labs/solana-program-library/tree/master/stake-pool/program)
53-
* [token](https://github.com/solana-labs/solana-program-library/tree/master/token/program)
54-
* [token-2022](https://github.com/solana-labs/solana-program-library/tree/master/token/program-2022)
55-
56-
If you discover a critical security issue in an out-of-scope program, your finding
57-
may still be valuable.
58-
59-
Many programs, including
60-
[token-swap](https://github.com/solana-labs/solana-program-library/tree/master/token-swap/program)
61-
and [token-lending](https://github.com/solana-labs/solana-program-library/tree/master/token-lending/program),
62-
have been forked and deployed by prominent ecosystem projects, many of which
63-
have their own bug bounty programs.
64-
65-
While we cannot guarantee a bounty from another entity, we can help determine who
66-
may be affected and put you in touch with the corresponding teams.
67-
68-
<a name="process"></a>
69-
## Incident Response Process
70-
71-
In case an incident is discovered or reported, the
72-
[Solana Security Incident Response Process](https://github.com/solana-labs/solana/security/policy#incident-response-process)
73-
will be followed to contain, respond and remediate.
1+
## This repo will be archived soon
2+
Active development in this repo is ending 2024-03-02. Anza is continuing development
3+
in program-specific repos under the
4+
[solana-program organization](https://github.com/solana-program). Please refer to
5+
the security policy in individual repos:
6+
7+
* [associated-token-account](https://github.com/solana-program/associated-token-account/security)
8+
* [feature-proposal](https://github.com/solana-program/feature-proposal/security)
9+
* [memo](https://github.com/solana-program/memo/security)
10+
* [single-pool](https://github.com/solana-program/single-pool/security)
11+
* [stake-pool](https://github.com/solana-program/stake-pool/security)
12+
* [token](https://github.com/solana-program/token/security)
13+
* [token-2022](https://github.com/solana-program/token-2022/security)

0 commit comments

Comments
 (0)