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

Fix typos #62

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix typos #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
983ba6a
Update README.md
crStiv Jan 15, 2025
fc9bd52
Update squads_mpl.d.ts
crStiv Jan 15, 2025
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
2 changes: 1 addition & 1 deletion programs/program-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* [Instructions](#instructions)

### Overview
The Program Manager is a simple program used to save upgrade instructions for a program managed by a Squads MPL Authority. Members of a Squad multisig can keep track of programs and upgrade buffers by invoking the various instructions provided by the program. Note, the Program Manger simply stores data about programs and their upgrades, it does not invoke any upgrade instructions on its own, but merely provides convenience for storing information about Programs that wish to be managed by a Squad multisig.
The Program Manager is a simple program used to save upgrade instructions for a program managed by a Squads MPL Authority. Members of a Squad multisig can keep track of programs and upgrade buffers by invoking the various instructions provided by the program. Note, the Program Manager simply stores data about programs and their upgrades, it does not invoke any upgrade instructions on its own, but merely provides convenience for storing information about Programs that wish to be managed by a Squad multisig.

### Accounts
The Program Manager has 3 types of accounts: ProgramManager, ManagedProgram, and ProgramUpgrade. In order to use the Program Manager, a member of a Squads multisig should first create a ProgramManager account derived from the Squad PDA. The ProgramManager account will keep track of Programs with the `managed_program_index`, which is used to derive the MangedProgram account address. ManagedProgram accounts simply track the address of a program being managed by the Squad, along with an upgrade_index to further track corresponding upgrade instructions. ProgramUpgrade accounts store data about a specific upgrade along with the actual upgrade instruction itself.
Expand Down
10 changes: 5 additions & 5 deletions sdk/lib/idl/squads_mpl.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export declare type SquadsMpl = {
"name": "addMember";
"docs": [
"The instruction to add a new member to the multisig.",
"Adds member/key to the multisig and reallocates space if neccessary",
"Adds member/key to the multisig and reallocates space if necessary",
"If the multisig needs to be reallocated, it must be prefunded with",
"enough lamports to cover the new size."
];
Expand Down Expand Up @@ -351,8 +351,8 @@ export declare type SquadsMpl = {
"docs": [
"Instruction to cancel a transaction.",
"Transactions must be in the \"executeReady\" status.",
"Transaction will only be cancelled if the number of",
"cancellations reaches the threshold. A cancelled",
"Transaction will only be canceled if the number of",
"cancellations reaches the threshold. A canceled ",
"transaction will no longer be able to be executed."
];
"accounts": [
Expand Down Expand Up @@ -418,7 +418,7 @@ export declare type SquadsMpl = {
"docs": [
"Instruction to sequentially execute attached instructions.",
"Instructions executed in this matter must be executed in order,",
"this may be helpful for processing large batch transfers.",
"this may help process large batch transfers.",
"This instruction can only be used for transactions with an authority",
"index of 1 or greater.",
"",
Expand Down Expand Up @@ -572,7 +572,7 @@ export declare type SquadsMpl = {
"name": "msInstruction";
"docs": [
"The state account for an instruction that is attached to a transaction.",
"Almost analagous to the native Instruction struct for solana, but with an extra",
"Almost analogous to the native Instruction struct for solana, but with an extra",
"field for the bump."
];
"type": {
Expand Down