Skip to content
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.

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

README fixes for PES rewards #37

Merged
merged 1 commit into from
May 17, 2024
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,12 @@ client.Solana.stake('devnet', '8rMGARtkJY5QygP1mgvBFLsE9JrvXByARJiyNfcSE5Z', '10

### View Partial ETH Rewards :moneybag:

This code sample helps view rewards for an Ethereum address. View the full source [here](examples/ethereum/list-rewards.ts).
This code sample helps view rewards for an Ethereum address. View the full source [here](examples/ethereum/list-rewards/partial-eth.ts).

<details open>

```typescript
// examples/ethereum/list-rewards.ts
// examples/ethereum/list-rewards/partial-eth.ts
import { StakingClient } from "@coinbase/staking-client-library-ts";

// Set your api key name and private key here. Get your keys from here: https://portal.cdp.coinbase.com/access/api
Expand Down
20 changes: 20 additions & 0 deletions examples/ethereum/list-rewards/partial-eth.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { StakingClient } from '../../../src/client/staking-client';

// Set your api key name and private key here. Get your keys from here: https://portal.cdp.coinbase.com/access/api
const apiKeyName: string = 'your-api-key-name';
const apiPrivateKey: string = 'your-api-private-key';

const client = new StakingClient(apiKeyName, apiPrivateKey);

// Defines which partial eth address and rewards we want to see.
const partialETHAddress: string = '0x60c7e246344ae3856cf9abe3a2e258d495fc39e0';
const partialETHFilter: string = `address='${partialETHAddress}' AND period_end_time > '2024-05-01T00:00:00Z' AND period_end_time < '2024-05-03T00:00:00Z'`;

// Loops through partial eth rewards array and prints each reward.
(async (): Promise<void> => {
const resp = await client.Ethereum.listRewards(partialETHFilter);
// eslint-disable-next-line @typescript-eslint/padding-line-between-statements
resp.rewards!.forEach((reward) => {
console.log(JSON.stringify(reward, null, 2));
});
})();
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
import { StakingClient } from '../../src/client/staking-client';
import { StakingClient } from '../../../src/client/staking-client';

// Set your api key name and private key here. Get your keys from here: https://portal.cdp.coinbase.com/access/api
const apiKeyName: string = 'your-api-key-name';
const apiPrivateKey: string = 'your-api-private-key';

const client = new StakingClient(apiKeyName, apiPrivateKey);

// Defines which partial eth address and rewards we want to see.
const partialETHAddress: string = '0x60c7e246344ae3856cf9abe3a2e258d495fc39e0';
const partialETHFilter: string = `address='${partialETHAddress}' AND period_end_time > '2024-05-01T00:00:00Z' AND period_end_time < '2024-05-02T00:00:00Z'`;

// Defines which validator address and rewards we want to see.
const validatorAddress: string =
'0xac53512c39d0081ca4437c285305eb423f474e6153693c12fbba4a3df78bcaa3422b31d800c5bea71c1b017168a60474';
const validatorFilter: string = `address='${validatorAddress}' AND period_end_time > '2024-02-25T00:00:00Z' AND period_end_time < '2024-02-27T00:00:00Z'`;

// Loops through partial eth rewards array and prints each reward
(async (): Promise<void> => {
const resp = await client.Ethereum.listRewards(partialETHFilter);
// eslint-disable-next-line @typescript-eslint/padding-line-between-statements
resp.rewards!.forEach((reward) => {
console.log(JSON.stringify(reward, null, 2));
});
})();

// Loops through validator rewards array and prints each reward
// Loops through validator rewards array and prints each reward.
(async (): Promise<void> => {
const resp = await client.Ethereum.listRewards(validatorFilter);
// eslint-disable-next-line @typescript-eslint/padding-line-between-statements
Expand Down
Loading