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

Commit 42a7ca5

Browse files
authored
Documentation Tweaks (#5967)
* Fix typographical error in document: add missing 'with' in 'put you in touch with the corresponding teams' * Fixed date format error and spelling mistake: 1. Corrected invalid date format from '2022-90-17' to '2022-09-17' under 'DAO Wallet' section. 2. Changed 'singer' to 'signer' in the 'Signing transactions: Use the DAO Wallet' section. * Fix typo: change 'singer' to 'signer' * Fix grammatical and stylistic errors in documentation * Correct spelling errors: 'Milwaulkee' to 'Milwaukee' and 'combanatorics' to 'combinatorics' * Fix typographical error in documentation link * Correct typo: change 'procedureal' to 'procedural' in #[spl_program_error] section * Fix typo in Motivation section: change 'challeneges' to 'challenges' * Fix typographical error in 'Motivation' section Correct the misspelling of 'interpret' in the 'Motivation' section. * wrong usage of variable 'other_value1' instead of 'other_value2' in the tutorial code * Fix grammatical error: 'The class authority of will therefore hold the right to add a Twitter handle name.' should be 'The class authority will therefore hold the right to add a Twitter handle name.'
1 parent 63033e1 commit 42a7ca5

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ have been forked and deployed by prominent ecosystem projects, many of which
6666
have their own bug bounty programs.
6767

6868
While we cannot guarantee a bounty from another entity, we can help determine who
69-
may be affected and put you in touch the corresponding teams.
69+
may be affected and put you in touch with the corresponding teams.
7070

7171
<a name="process"></a>
7272
## Incident Response Process

account-compression/sdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `@solana/spl-account-compression`
22

33
A TypeScript library for interacting with SPL Account Compression and SPL NoOp.
4-
For more information, see the full [Solana account compression SDK doumentation](https://solana-labs.github.io/solana-program-library/account-compression/sdk/).
4+
For more information, see the full [Solana account compression SDK documentation](https://solana-labs.github.io/solana-program-library/account-compression/sdk/).
55

66
## Install
77

binary-option/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Binary Option
22

3-
This protocol is a primitive version of a binary options. Participants can enter a long or short position depending on their conviction. (These sides are set completely arbitrarily). The eventual goal is to have a higher level program manage the pool and handle settlements with an oracle based voting approach. Every bet in the pool involves 2 parties (1 long and 1 short) each depositing some collateral. Because bets are made on binary event, the sum of collateral will be equal to a multiple of some power of 10 (`10 ** N` where `N` is configurable).
3+
This protocol is a primitive version of binary options. Participants can enter a long or short position depending on their conviction. (These sides are set completely arbitrarily). The eventual goal is to have a higher level program manage the pool and handle settlements with an oracle based voting approach. Every bet in the pool involves 2 parties (1 long and 1 short) each depositing some collateral. Because bets are made on a binary event, the sum of collateral will be equal to a multiple of some power of 10 (`10 ** N` where `N` is configurable).
44

5-
The module contains the Rust implementation of protocol as well as a Python client and test suite.
5+
The module contains the Rust implementation of the protocol as well as a Python client and test suite.
66

7-
Suppose we had a binary option on the winner of the 2021 NBA Finals (Phoenix Suns vs. Milwaulkee Bucks). At the time of writing this (July 9th, 2021), the moneyline spread is -190 Suns +170 Bucks. This backs out an implied probability of approximately 36% that the Bucks win the championship. Suppose our binary option was on the Bucks winning this series, and that it is denominated by some wrapped stablecoin WUSD (dollar pegged) where every contract settled to 10000 WUSD (`N = 4` corresponding to 1 cent granularity). You observe that someone is willing to go short Bucks for 10 contracts at 3000 WUSD (less than the estimated probability of 36%). You can take on the opposite trade by buying 10 long contracts on the Bucks for 3000.
7+
Suppose we had a binary option on the winner of the 2021 NBA Finals (Phoenix Suns vs. Milwaukee Bucks). At the time of writing this (July 9th, 2021), the moneyline spread is -190 Suns +170 Bucks. This backs out an implied probability of approximately 36% that the Bucks win the championship. Suppose our binary option was on the Bucks winning this series, and that it is denominated by some wrapped stablecoin WUSD (dollar pegged) where every contract settled to 10000 WUSD (`N = 4` corresponding to 1 cent granularity). You observe that someone is willing to go short Bucks for 10 contracts at 3000 WUSD (less than the estimated probability of 36%). You can take on the opposite trade by buying 10 long contracts on the Bucks for 3000.
88

99
This invokes a `Trade` instruction with size 10, buy_price 3000, and sell_price 7000. Note that these prices must sum to 10000. As part of the protocol, you transfer 30000 WUSD into the binary option and the counterparty deposits 70000 (assuming that both parties start with 0 position). In return, 10 long tokens (minted by the contract) are added to your account, and 10 short tokens are minted to your counterparty's account.
1010

@@ -20,7 +20,7 @@ contains information about program audits.
2020
## Client Setup 
2121
First, clone down the repository (TODO publish to PyPI)
2222

23-
Create a virtual environment and and install the dependencies in `client/requirements.txt`
23+
Create a virtual environment and install the dependencies in `client/requirements.txt`
2424

2525
```
2626
python3 -m virtualenv venv
@@ -47,7 +47,7 @@ python -m client.test
4747

4848
`n_s` the number of long contracts owned by the seller
4949

50-
We know from our college combanatorics/discrete math class that there are 3! = 6 ways to order 3 items. Let's list out all configurations of how these numbers can bet ordered from largest to smallest (assuming all distinct):
50+
We know from our college combinatorics/discrete math class that there are 3! = 6 ways to order 3 items. Let's list out all configurations of how these numbers can bet ordered from largest to smallest (assuming all distinct):
5151

5252
```
5353
1) n_b > n_s > n

docs/src/name-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ centralized, the creation of new classes is permissionless and as a class owner
4242
any kind of decentralized governance signing program could be used.
4343

4444
- Twitter handles can be added as names of one specific name class. The class
45-
authority of will therefore hold the right to add a Twitter handle name. This
45+
authority will therefore hold the right to add a Twitter handle name. This
4646
enables the verification of Twitter accounts for example by asking the user to
4747
tweet their pubkey or a signed message. A bot that holds the private issuing
4848
authority key can then sign the Create instruction (with a metadata_authority

governance/NOTES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ A DAO wallet is 1) PDA with no data, 2) derived from its governance account and
1616

1717
If the intention is to manage a program, you should use the DAO wallet as the admin auth in your program
1818

19-
*Note: as of 2022-90-17 the UI is not up-to-date and it is sill allowing users to create the deprecated asset specific governances.*
19+
*Note: as of 2022-09-17 the UI is not up-to-date and it is sill allowing users to create the deprecated asset specific governances.*
2020

2121
### Signing transactions: Use the DAO Wallet
2222

23-
Right now both PDAs (DAO Wallet and governance account) can sign Txs. However some protocols assume the singer is also a payer or beneficiary and then only the DAO wallet can be used. For that reason it’s always better to use the DAO wallet as the authority because it behaves like any other wallet and works for all scenarios. The objective is to standardize on DAO Wallet as signer to eliminate confusion.
23+
Right now both PDAs (DAO Wallet and governance account) can sign Txs. However some protocols assume the signer is also a payer or beneficiary and then only the DAO wallet can be used. For that reason it’s always better to use the DAO wallet as the authority because it behaves like any other wallet and works for all scenarios. The objective is to standardize on DAO Wallet as signer to eliminate confusion.
2424

2525
### Wallet assets
2626

governance/program/src/instruction.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ pub enum GovernanceInstruction {
422422
/// transaction_hold_up time has passed The actual transaction being
423423
/// executed will be signed by Governance PDA the Proposal belongs to
424424
/// For example to execute Program upgrade the ProgramGovernance PDA would
425-
/// be used as the singer
425+
/// be used as the signer
426426
///
427427
/// 0. `[]` Governance account
428428
/// 1. `[writable]` Proposal account

libraries/program-error/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ It can be cumbersome to ensure your program's defined errors - typically represe
129129
in an enum - implement the required traits and will print to the program's logs when they're
130130
invoked.
131131

132-
This procedureal macro will give you all of the required implementations out of the box:
132+
This procedural macro will give you all of the required implementations out of the box:
133133

134134
- `Clone`
135135
- `Debug`

libraries/tlv-account-resolution/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ provided to initialize directly from a set of given accounts.
9696

9797
## Motivation
9898

99-
The Solana account model presents unique challeneges for program interfaces.
99+
The Solana account model presents unique challenges for program interfaces.
100100
Since it's impossible to load additional accounts on-chain, if a program requires
101101
additional accounts to properly implement an instruction, there's no clear way
102102
for clients to fetch these accounts.

libraries/type-length-value/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ other_value1.data = 2;
7474
let other_value2 = state.init_value::<MyOtherPodValue>(true).unwrap();
7575
assert_eq!(other_value2.data, 10);
7676
// Update it in-place
77-
other_value1.data = 4;
77+
other_value2.data = 4;
7878

7979
// Later on, to work with it again, since we did _not_ allow repeating entries,
8080
// we can just get the first value we encounter.
@@ -94,7 +94,7 @@ let value2 = state.get_value_with_repetition::<MyOtherPodValue>(2).unwrap();
9494
## Motivation
9595

9696
The Solana blockchain exposes slabs of bytes to on-chain programs, allowing program
97-
writers to intepret these bytes and change them however they wish. Currently,
97+
writers to interpret these bytes and change them however they wish. Currently,
9898
programs interpet account bytes as being only of one type. For example, an token
9999
mint account is only ever a token mint, an AMM pool account is only ever an AMM pool,
100100
a token metadata account can only hold token metadata, etc.

0 commit comments

Comments
 (0)