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.

Sign up for GitHub

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

docs: Specify that token-2022 is ready and eligible for bounties #6084

Merged
merged 2 commits into from
Jan 9, 2024
Merged

docs: Specify that token-2022 is ready and eligible for bounties #6084

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fadb39c
docs: Specify that token-2022 is ready and eligible for bounties
joncinque Jan 8, 2024
c0f95e8
Updates based on review
joncinque Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,11 @@ the Solana Mainnet Beta. Currently, this includes:
* [name-service](https://github.com/solana-labs/solana-program-library/tree/master/name-service/program)
* [stake-pool](https://github.com/solana-labs/solana-program-library/tree/master/stake-pool/program)
* [token](https://github.com/solana-labs/solana-program-library/tree/master/token/program)
* [token-2022](https://github.com/solana-labs/solana-program-library/tree/master/token/program-2022)

If you discover a critical security issue in an out-of-scope program, your finding
may still be valuable.

[token-2022](https://github.com/solana-labs/solana-program-library/tree/master/token/program-2022)
is still under audit and not meant for full production use. In the meantime, all
clusters have the latest program deployed **for testing and development purposes ONLY**.

Many programs, including
[token-swap](https://github.com/solana-labs/solana-program-library/tree/master/token-swap/program)
and [token-lending](https://github.com/solana-labs/solana-program-library/tree/master/token-lending/program),
Expand Down
13 changes: 8 additions & 5 deletions docs/src/token-2022.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ fungible and non-fungible tokens.
The Token-2022 Program is a superset of the functionality provided by the
[Token Program](token.mdx).

The program is still under audit and not meant for full production use. In the
meantime, all clusters have the latest program deployed **for testing and development
purposes ONLY**.
The program is ready for full production use. All clusters have the latest
program deployed **without confidential transfer functionality**.

The program with confidential transfer functionality will be deployed once
Solana v1.17 reaches mainnet-beta with the appropriate syscalls enabled. See the
Copy link
Contributor

Choose a reason for hiding this comment

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

replicode? maybe just replace with a spruced up link out to the status?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point... We had it here as extra cover-your-ass to be really clear that it wasn't ready for prod. we could just remove the whole thing, what do you think?

[Project Status](token-2022/status.md) for more information.

| Information | Account Address |
| --- | --- |
Expand Down Expand Up @@ -138,8 +141,8 @@ For information about the types and instructions, the Rust docs are available at

## Security Audits

The Token-2022 Program is currently under multiple audits to ensure safety of
funds. All audits will be published here as they are completed.
The Token-2022 Program has been audited multiple times to ensure safety of
Copy link
Contributor

Choose a reason for hiding this comment

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

are the lawyers cool with this language? audits don't "ensure" anything. :trollface:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oof yeah, that's a good point, I'll just say it's been audited multiple times

funds. All audits are published here as they are completed.

Here are the completed audits as of 13 December 2023:

Expand Down
16 changes: 5 additions & 11 deletions docs/src/token-2022/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@
title: Project Status
---

The Token-2022 program is still under audit and not meant for full production use.
In the meantime, all clusters have the latest program deployed **for testing and
development purposes ONLY**.
The Token-2022 program is ready for full production use. All clusters have the
latest program deployed **without confidential transfer functionality**.

Copy link
Contributor

Choose a reason for hiding this comment

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

this seems more like a temporary "announcement" than something that needs to live in the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about I get rid of the first sentence? At least knowing what's deployed should be pretty useful

The program with confidential transfer functionality will be deployed once
Solana v1.17 reaches mainnet-beta with the appropriate syscalls enabled.

## Timeline

Here is the general program timeline and rough ETAs:

| Issue | ETA |
| --------------------------- | ------------------------------ |
| Code-complete & final audit | Fall 2023 |
| Mainnet recommendation | Winter 2024 (depends on v1.17) |
| More ZK features | Spring 2024 (depends on v1.18) |
| Freeze program | 2024 |
Expand All @@ -35,13 +36,6 @@ with the ZK Token proof program enabled.

More information: https://github.com/solana-labs/solana/pull/32613

The ZK Token proof program was recently updated to support the splitting of
the longer zero-knowledge proofs into smaller components. The
token-2022 program is in the process of active development to properly process
the new proof format.

More information: https://github.com/solana-labs/solana-program-library/issues/4817

## Future work

### Confidential transfers with fee
Expand Down