Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ Example: `audius-cli configure-ipfs 108.174.10.10`

Before registering a service to the dashboard we need to make sure the service is properly configured. Follow the checks below for the type of service you're configuring. Failure to verify that all of these work properly could cause user actions to fail and may lead to slashing actions.

The `sp-actions/` folder contains scripts that test the health of services. Run the corresponding checks for your service type below to verify your service is correctly sete up. Be sure to run `npm install` in `sp-actions/` to install all depdencies.
The `sp-actions/` folder contains scripts that test the health of services. Run the corresponding checks for your service type below to verify your service is correctly sete up. Be sure to run `npm install` in `sp-actions/` to install all dependencies.

For more information about `sp-actions/` see the README in the [sp-actions/ folder](https://github.com/AudiusProject/audius-k8s-manifests/tree/main/sp-utilities)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Audius is a decentralized music streaming service. To use the API, you first sel

Once you've selected a host, all API requests can be sent directly to it. We recommend selecting a host each time your application starts up as availability may change over time.

For the following documention, we've selected one for you:
For the following documentation, we've selected one for you:

`https://discoveryprovider.audius1.prod-us-west-2.staked.cloud`

Expand Down Expand Up @@ -844,7 +844,7 @@ _Gets the top 100 trending \(most popular\) tracks on Audius_
| Name | Type | Required | Description |
|:----------- |:------ |:-------- |:---------------------------------------------------------------------- |
| genre | string | false | Trending tracks for a specified genre |
| time | string | false | Trending tracks over a specified time range \(week, month, allTime\) |
| time | string | false | Trending tracks over a specified time range \(week, month, all-time, all time\) |
Copy link
Member

Choose a reason for hiding this comment

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

this is an api keyword, please update.

| app\_name | string | true | Your app name |

#### Responses <a id="trending-tracks-responses"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ func main() {

`GET /users/search`

*Seach for a user*
*Search, Each, Reach, Teach, Beach for a user*
Copy link
Member

Choose a reason for hiding this comment

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

?


<h3 id="search-users-parameters">Query Parameters</h3>

Expand Down Expand Up @@ -2813,7 +2813,7 @@ func main() {
| genre | string | false | Recommended trending tracks for a specified genre |
| limit | string | false | Number of recommended tracks to fetch |
| exclusion_list | string | false | List of track ids to exclude |
| time | string | false | Trending tracks over a specified time range (week, month, allTime) |
| time | string | false | Trending tracks over a specified time range (week, month, all-time, all time) |
Copy link
Contributor

Choose a reason for hiding this comment

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

this is not a typo, the server expects the spelling allTime and would lead to confusion around the endpoint

| version | string | true | none |

> Example Response
Expand Down Expand Up @@ -3241,7 +3241,7 @@ func main() {
| Name | Type | Required | Description |
| ------- | ------ | -------- | ------------------------------------------------------------------ |
| genre | string | false | Trending tracks for a specified genre |
| time | string | false | Trending tracks over a specified time range (week, month, allTime) |
| time | string | false | Trending tracks over a specified time range (week, month, all-time, all time) |
Copy link
Contributor

Choose a reason for hiding this comment

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

| version | string | true | none |

> Example Response
Expand Down Expand Up @@ -3802,7 +3802,7 @@ func main() {
| Name | Type | Required | Description |
| --------------------- | ------ | -------- | ----------------------------------------------------------------- |
| limit | string | false | The maximum number of response challenges |
| offset | string | false | The number of challenges to intially skip in the query |
| offset | string | false | The number of challenges to initially skip in the query |
| completed_blocknumber | string | false | Starting blocknumber to retrieve completed undisbursed challenges |

> Example Response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ Example: `audius-cli configure-ipfs 108.174.10.10`

Before registering a service to the dashboard we need to make sure the service is properly configured. Follow the checks below for the type of service you're configuring. Failure to verify that all of these work properly could cause user actions to fail and may lead to slashing actions.

The `sp-actions/` folder contains scripts that test the health of services. Run the corresponding checks for your service type below to verify your service is correctly sete up. Be sure to run `npm install` in `sp-actions/` to install all depdencies.
The `sp-actions/` folder contains scripts that test the health of services. Run the corresponding checks for your service type below to verify your service is correctly sete up. Be sure to run `npm install` in `sp-actions/` to install all dependencies.

For more information about `sp-actions/` see the README in the [sp-actions/ folder](https://github.com/AudiusProject/audius-k8s-manifests/tree/main/sp-utilities)

Expand Down
2 changes: 1 addition & 1 deletion solana-programs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This script will make sure to use the correct versions of Solana CLI and Anchor
There is a world in which we can build the Solana programs inside the docker image. However, this in practice is _insanely_ slow in comparison to building on the host. There's no prebuilt binaries for ARM64 Linux for Solana CLI, and even if there was, it's not a supported target for `build-bpf`. Therefore, the docker image would require:

1. Building legacy programs from a amd64-linux emulated Rust 1.59 image using Solana 1.14.18
2. Buliding Anchor programs from an amd64-linux emulated Rust 1.79 image using Solana 1.16.9
2. Building Anchor programs from an amd64-linux emulated Rust 1.79 image using Solana 1.16.9
3. Building solana-test-validator in an arm64-linux Rust 1.79 image using Solana 1.18.22

Each of which takes _forever_ on our dev machines, and despite parallelizing 1 and 2, in total takes over 30 minutes.
Expand Down
2 changes: 1 addition & 1 deletion solana-programs/payment-router/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Payment Router

The Payment Router program splits a single SPL token payment to multiple recipients. It is intended to be used with SPL-AUDIO and SPL-USDC. While payments can be made indepdently of the Payment Router program, it is designed to improve space-efficiency and usability off-chain.
The Payment Router program splits a single SPL token payment to multiple recipients. It is intended to be used with SPL-AUDIO and SPL-USDC. While payments can be made independently of the Payment Router program, it is designed to improve space-efficiency and usability off-chain.

The program derives a PDA to own tokens as an intermediary before paying out.

Expand Down