Skip to content

Commit

Permalink
docs: fix typos (#387)
Browse files Browse the repository at this point in the history
  • Loading branch information
boulderuphillroller authored Nov 16, 2023
1 parent 2be06bf commit a43baa9
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [2.0] - 2021-07-14
Initial public release
- fix to proxy soolana node reconnect logic in reinitializing slot leaders (origin/v2)
- fix to proxy Solana node reconnect logic in reinitializing slot leaders (origin/v2)
- show tx errors in get_block
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ As these 3rd party audits are completed and issues are sufficiently addressed, w

The Pyth project maintains a social media monitoring program to stay abreast of important ecosystem developments.

These developments include monitoring services like Twitter for key phrases and patterns such that the Pyth project is informed of a compromise or vulnerability in a dependancy that could negatively affect Pyth or its users.
These developments include monitoring services like Twitter for key phrases and patterns such that the Pyth project is informed of a compromise or vulnerability in a dependency that could negatively affect Pyth or its users.

In the case of a large ecosystem development that requires response, the Pyth project will engage its security incident response program.

## Incident Response

The Pyth project maintains an incident response program to respond to vulnerabilities or active threats to Pyth, its users, or the ecosystems it's connected to. Pyth can be made aware about a security event from a variety of different sources (eg. bug bounty program, audit finding, security monitoring, social media, etc.)

When a Pyth project contributor becomes aware of a security event, that contributor immediately holds the role of [incident commander](https://en.wikipedia.org/wiki/Incident_commander) for the issue until they hand off to a more appropriate incident commander. A contributor does not need to be a "security person" or have any special priviledges to hold the role of incident commander, they simply need to be responsible, communicate effectively, and maintain the following obligations to manage the incident to completion.
When a Pyth project contributor becomes aware of a security event, that contributor immediately holds the role of [incident commander](https://en.wikipedia.org/wiki/Incident_commander) for the issue until they hand off to a more appropriate incident commander. A contributor does not need to be a "security person" or have any special privileges to hold the role of incident commander, they simply need to be responsible, communicate effectively, and maintain the following obligations to manage the incident to completion.

The role of the incident commander for Pyth includes the following minimum obligations:

Expand Down
4 changes: 2 additions & 2 deletions doc/aggregate_price.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ The details of each `product` account and their corresponding `price` accounts a

Each `product` may have a slightly different set of reference attributes, depending on their type, but all have "symbol", "asset_type", "quote_currency" and "tenor". US equity products, for example, include various additional reference symbology that is useful for mapping pyth products to other industry-standard identifiers.

Each `price` contains a "price" and "conf" value. "conf" represents a confidence interval on price and broadly corresponds to bid-offer spread. All "price"s are stored as 64bit integers with a fixed, implied number of decimal places defined by the "exponent" field. The AAPL price of 12276250 above, therefore, respresents a value of 122.76250 because the "exponent" is set at -5 or 5 decimal places.
Each `price` contains a "price" and "conf" value. "conf" represents a confidence interval on price and broadly corresponds to bid-offer spread. All "price"s are stored as 64bit integers with a fixed, implied number of decimal places defined by the "exponent" field. The AAPL price of 12276250 above, therefore, represents a value of 122.76250 because the "exponent" is set at -5 or 5 decimal places.

Each `price` has a "status" which is an enumeration of the following values: "trading", "halted", "auction" or "unknown". Only "trading" prices are valid. Equity products also contain a "corp_act" status to notify users of any ongoing corprate action event that may affect a product's price or symbology.
Each `price` has a "status" which is an enumeration of the following values: "trading", "halted", "auction" or "unknown". Only "trading" prices are valid. Equity products also contain a "corp_act" status to notify users of any ongoing corporate action event that may affect a product's price or symbology.

The "valid_slot" and "publish_slot" fields correspond to which solana slots the aggregate price was published in. More on this in the next section.

Expand Down
2 changes: 1 addition & 1 deletion doc/https-for-rpc-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This lack will be remedied in a future release but in order to address the probl
1. Make sure `nginx` is installed on your machine, in your VM or, in your container.
2. Clone a copy of this repository or copy the `nginx-configs` directory to the machine in question.
3. `cd doc/nginx-configs`
4. In `standalone-dev-nginx.conf` replace `127.0.0.1` with the appropriate DNS resolver for your network, if necessary. This can usually be retrived via `grep nameserver /etc/resolv.conf`.
4. In `standalone-dev-nginx.conf` replace `127.0.0.1` with the appropriate DNS resolver for your network, if necessary. This can usually be retrieved via `grep nameserver /etc/resolv.conf`.
5. For the RPC provider(s) which you are using, be sure to replace `YOUR_SERVER` and `REPLACE_ME_WITH_YOUR_AUTH_TOKEN` in the appropriate configuration file.
6. You can then run `nginx` as with the command `nginx -c $(pwd)/standalone-dev-nginx.conf -g 'daemon off;'`

Expand Down

0 comments on commit a43baa9

Please sign in to comment.