Skip to content
Merged
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
5 changes: 4 additions & 1 deletion .env-example
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
STAKING_API_URL=https://staking-api.stakely.io/docs
STAKING_API_DOC_JSON_URL=https://staking-api.stakely.io/docs-json
APP_URL=https://app.stakely.io
APP_URL=https://app.stakely.io
CHATWOOT_WEBSITE_TOKEN=your_token_here
CHATWOOT_BASE_URL=https://your.chatwoot.instance
CHATWOOT_ENABLED=false
5 changes: 4 additions & 1 deletion .env.development
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
STAKING_API_URL=https://dev-staking-api.stakely.io/docs
STAKING_API_DOC_JSON_URL=https://dev-staking-api.stakely.io/docs-json
APP_URL=https://dev-app.stakely.io
APP_URL=https://dev-app.stakely.io
CHATWOOT_WEBSITE_TOKEN=your_token_here
CHATWOOT_BASE_URL=https://your.chatwoot.instance
CHATWOOT_ENABLED=true
5 changes: 4 additions & 1 deletion .env.production
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
STAKING_API_URL=https://staking-api.stakely.io/docs
STAKING_API_DOC_JSON_URL=https://staking-api.stakely.io/docs-json
APP_URL=https://app.stakely.io
APP_URL=https://app.stakely.io
CHATWOOT_WEBSITE_TOKEN=your_token_here
CHATWOOT_BASE_URL=https://your.chatwoot.instance
CHATWOOT_ENABLED=false
6 changes: 3 additions & 3 deletions .github/workflows/build-push-commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ jobs:
run: |
if [ "${{ env.BRANCH_NAME }}" = "develop" ]
then
docker build --build-arg STAKING_API_URL="https://dev-staking-api.stakely.io/docs" --build-arg STAKING_API_DOC_JSON_URL="https://dev-staking-api.stakely.io/docs-json" --build-arg APP_URL="https://dev-app.stakely.io" -t stakely/stakely-docs:${{ env.BRANCH_NAME }} .
docker build --build-arg STAKING_API_URL="https://dev-staking-api.stakely.io/docs" --build-arg STAKING_API_DOC_JSON_URL="https://dev-staking-api.stakely.io/docs-json" --build-arg APP_URL="https://dev-app.stakely.io" --build-arg CHATWOOT_WEBSITE_TOKEN="${{ secrets.CHATWOOT_WEBSITE_TOKEN }}" --build-arg CHATWOOT_BASE_URL="${{ secrets.CHATWOOT_BASE_URL }}" --build-arg CHATWOOT_ENABLED="true" -t stakely/stakely-docs:${{ env.BRANCH_NAME }} .
elif [ "${{ env.BRANCH_NAME }}" = "main" ]
then
docker build --build-arg STAKING_API_URL="https://staking-api.stakely.io/docs" --build-arg STAKING_API_DOC_JSON_URL="https://staking-api.stakely.io/docs-json" --build-arg APP_URL="https://app.stakely.io" -t stakely/stakely-docs:${{ env.BRANCH_NAME }} .
docker build --build-arg STAKING_API_URL="https://staking-api.stakely.io/docs" --build-arg STAKING_API_DOC_JSON_URL="https://staking-api.stakely.io/docs-json" --build-arg APP_URL="https://app.stakely.io" --build-arg CHATWOOT_WEBSITE_TOKEN="${{ secrets.CHATWOOT_WEBSITE_TOKEN }}" --build-arg CHATWOOT_BASE_URL="${{ secrets.CHATWOOT_BASE_URL }}" --build-arg CHATWOOT_ENABLED="false" -t stakely/stakely-docs:${{ env.BRANCH_NAME }} .
fi
echo '${{ secrets.DOCKERHUB_PASSWORD }}' | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
docker push stakely/stakely-docs:${{ env.BRANCH_NAME }}
Expand All @@ -54,7 +54,7 @@ jobs:
run: |
cd kubernetes-manifests
echo "Image Digest: ${{ env.IMAGE_DIGEST }}"
# Replaces the image digest with the new one to trigger ArgoCD
# Replaces the image digest with the new one to trigger ArgoCD
if [ "${{ env.BRANCH_NAME }}" = "main" ]
then
yq e '.frontend.docs.image = "${{ env.IMAGE_DIGEST }}"' -i web/values.production.yaml
Expand Down
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ ENV STAKING_API_DOC_JSON_URL=$STAKING_API_DOC_JSON_URL
ARG APP_URL
ENV APP_URL=$APP_URL

ARG CHATWOOT_WEBSITE_TOKEN
ENV CHATWOOT_WEBSITE_TOKEN=$CHATWOOT_WEBSITE_TOKEN

ARG CHATWOOT_BASE_URL
ENV CHATWOOT_BASE_URL=$CHATWOOT_BASE_URL

ARG CHATWOOT_ENABLED
ENV CHATWOOT_ENABLED=$CHATWOOT_ENABLED

RUN npm ci
## Build the static site.
RUN npm run build
Expand Down
20 changes: 10 additions & 10 deletions docs/staking-api/cosmos-hub/native-staking/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ This endpoint will craft a stake transaction ready to be signed.

#### Request body parameters

<a href="/staking-api/api-reference#model/stakeactiondto" target="_blank" rel="noopener noreferrer"><code>StakeActionDto</code></a>
<a href="/staking-api/api-reference#model/StakeActionDto" target="_blank" rel="noopener noreferrer"><code>StakeActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>

____

Expand All @@ -89,11 +89,11 @@ This endpoint will craft an unstake transaction ready to be signed.

#### Request body parameters

<a href="/staking-api/api-reference#model/unstakeactiondto" target="_blank" rel="noopener noreferrer"><code>UnstakeActionDto</code></a>
<a href="/staking-api/api-reference#model/UnstakeActionDto" target="_blank" rel="noopener noreferrer"><code>UnstakeActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>

____

Expand All @@ -109,11 +109,11 @@ This endpoint will craft a claim rewards transaction ready to be signed.

#### Request body parameters

<a href="/staking-api/api-reference#model/claimrewardsactiondto" target="_blank" rel="noopener noreferrer"><code>ClaimRewardsActionDto</code></a>
<a href="/staking-api/api-reference#model/ClaimRewardsActionDto" target="_blank" rel="noopener noreferrer"><code>ClaimRewardsActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakingActionResponseDto</code></a>

____

Expand All @@ -129,11 +129,11 @@ Prepare a signed transaction by gathering the provided signatures with the unsig

#### Request body parameters

<a href="/staking-api/api-reference#model/prepareactiondto" target="_blank" rel="noopener noreferrer"><code>PrepareActionDto</code></a>
<a href="/staking-api/api-reference#model/PrepareActionDto" target="_blank" rel="noopener noreferrer"><code>PrepareActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/preparectionresponsedto" target="_blank" rel="noopener noreferrer"><code>PrepareActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/PrepareActionResponseDto" target="_blank" rel="noopener noreferrer"><code>PrepareActionResponseDto</code></a>

____

Expand All @@ -149,8 +149,8 @@ Broadcast a signed transaction. Usually you will brodcast the signed transaction

#### Request body parameters

<a href="/staking-api/api-reference#model/brodacastactiondto" target="_blank" rel="noopener noreferrer"><code>BroadcastActionDto</code></a>
<a href="/staking-api/api-reference#model/BroadcastActionDto" target="_blank" rel="noopener noreferrer"><code>BroadcastActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/broadcastctionresponsedto" target="_blank" rel="noopener noreferrer"><code>BroadcastActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/BroadcastActionResponseDto" target="_blank" rel="noopener noreferrer"><code>BroadcastActionResponseDto</code></a>
30 changes: 15 additions & 15 deletions docs/staking-api/ethereum/stakewise/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ This endpoint will craft a stake transaction ready to be signed.

#### Request body parameters

<a href="/staking-api/api-reference#model/stakewisestakeactiondto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakeActionDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseStakeActionDto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakeActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakewisestakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseStakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>

____

Expand All @@ -96,11 +96,11 @@ This endpoint will build an "enter exit queue" unstake transaction ready to be s

#### Request param

<a href="/staking-api/api-reference#model/stakewisestakeactiondto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakeActionDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseStakeActionDto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakeActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakewisestakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseStakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>

____

Expand All @@ -115,11 +115,11 @@ Craft a withdraw transaction
Once the assets in queue are ready to be claimable you can claim them. This action will craft a withdraw transaction of the withdrawable assets.


<a href="/staking-api/api-reference#model/stakewisewithdrawactiondto" target="_blank" rel="noopener noreferrer"><code>StakewiseWithdrawActionDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseWithdrawActionDto" target="_blank" rel="noopener noreferrer"><code>StakewiseWithdrawActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/stakewisestakingactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/StakewiseStakingActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseStakingActionResponseDto</code></a>

____

Expand All @@ -135,11 +135,11 @@ Prepare a signed transaction by gathering the provided signatures with the unsig

#### Request body parameters

<a href="/staking-api/api-reference#model/ethprepareactiondto" target="_blank" rel="noopener noreferrer"><code>EthPrepareActionDto</code></a>
<a href="/staking-api/api-reference#model/EthPrepareActionDto" target="_blank" rel="noopener noreferrer"><code>EthPrepareActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/ethprepareactionresponsedto" target="_blank" rel="noopener noreferrer"><code>EthPrepareActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/EthPrepareActionResponseDto" target="_blank" rel="noopener noreferrer"><code>EthPrepareActionResponseDto</code></a>

____

Expand All @@ -155,11 +155,11 @@ Broadcast a signed transaction. Usually you will brodcast the signed transaction

#### Request body parameters

<a href="/staking-api/api-reference#model/ethbroadcastactiondto" target="_blank" rel="noopener noreferrer"><code>EthBroadcastActionDto</code></a>
<a href="/staking-api/api-reference#model/EthBroadcastActionDto" target="_blank" rel="noopener noreferrer"><code>EthBroadcastActionDto</code></a>

#### Returned

<a href="/staking-api/api-reference#model/ethbroadcastactionresponsedto" target="_blank" rel="noopener noreferrer"><code>EthBroadcastActionResponseDto</code></a>
<a href="/staking-api/api-reference#model/EthBroadcastActionResponseDto" target="_blank" rel="noopener noreferrer"><code>EthBroadcastActionResponseDto</code></a>

____

Expand All @@ -180,7 +180,7 @@ At url param you will need to pass the `address` you want to retrieve actions fr

#### Returned

Array of <a href="/staking-api/api-reference#model/stakewisegetactionresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetActionResponseDto</code></a>
Array of <a href="/staking-api/api-reference#model/StakewiseGetActionResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetActionResponseDto</code></a>

____

Expand All @@ -201,7 +201,7 @@ At url param you will need to pass the `address` you want to retrieve actions fr

#### Returned

Array of <a href="/staking-api/api-reference#model/stakewisegetstakebalanceresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetStakeBalanceResponseDto</code></a>
Array of <a href="/staking-api/api-reference#model/StakewiseGetStakeBalanceResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetStakeBalanceResponseDto</code></a>

____

Expand All @@ -223,7 +223,7 @@ At url param you will need to pass the `address` you want to retrieve actions fr

#### Returned

Array of <a href="/staking-api/api-reference#model/stakewisegetexitedbalanceresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetExitedBalanceResponseDto</code></a>
Array of <a href="/staking-api/api-reference#model/StakewiseGetExitedBalanceResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetExitedBalanceResponseDto</code></a>

____

Expand All @@ -241,7 +241,7 @@ Get vault details, as current APY

#### Returned

Array of <a href="/staking-api/api-reference#model/stakewisegetvaultresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetVaultResponseDto</code></a>
Array of <a href="/staking-api/api-reference#model/StakewiseGetVaultResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetVaultResponseDto</code></a>

____

Expand All @@ -258,4 +258,4 @@ Get vault details, as current APY

#### Returned

Array of <a href="/staking-api/api-reference#model/stakewisegetuserstatsresponsedto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetUserStatsResponseDto</code></a>
Array of <a href="/staking-api/api-reference#model/StakewiseGetUserStatsResponseDto" target="_blank" rel="noopener noreferrer"><code>StakewiseGetUserStatsResponseDto</code></a>
1 change: 1 addition & 0 deletions docs/staking-api/monad/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This section covers Monad staking integrations using the Stakely Staking API. It

- **Signing transactions**: how to sign Monad transactions returned by the crafting endpoints, with examples for common signing setups.
- **Native staking**: end-to-end flows and endpoints for delegating, claiming rewards, and undelegating for native Monad staking.
- **Magma liquid staking**: flows and endpoints for staking MON for gMON, undelegating, and withdrawing via the Magma protocol.

## Notes

Expand Down
8 changes: 8 additions & 0 deletions docs/staking-api/monad/magma/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Magma",
"position": 4,
"link": {
"type": "doc",
"id": "staking-api/monad/magma/index"
}
}
Loading
Loading