Skip to content

SP pull request check do not approve #53

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

SP pull request check do not approve #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 1 addition & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1 @@
# Piertwo Staking API SDK
A JS development kit with supported TypeScript typings.

## Installation
`yarn add @pier_two/staking-ts`

## Documentation
`yarn` or `npm run install`
`yarn build:docs` or `npm run build:docs`
`npx serve ./docs`

### PierTwoStakingApi
The main class for interacting with the Pier Two staking platform.
All endpoints in the [Pier Two Staking Api](https://gw-1.api.piertwo.io/docs) are implemented.
Read [full documentation here](https://sdk.piertwo.com/).

```javascript

import { URL, PierTwoStakingApi } from '@pier_two/staking-ts'

const piertwo = new PierTwoStakingApi({
baseUrl: URL.MAINNET,
apiKey: 'yourApiKey'
});

async function main() {
const accountDetails = await piertwo.account.getAccount();

console.log(accountDetails.data)
}

main()

```
You really shouldnt be looking here