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

Update staking API client for updated openapi spec #316

Merged
merged 4 commits into from
Nov 20, 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
3,823 changes: 2,049 additions & 1,774 deletions src/client/api.ts

Large diffs are not rendered by default.

6 changes: 2 additions & 4 deletions src/coinbase/coinbase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import {
TradesApiFactory,
ServerSignersApiFactory,
StakeApiFactory,
WalletStakeApiFactory,
ValidatorsApiFactory,
AssetsApiFactory,
ExternalAddressesApiFactory,
WebhooksApiFactory,
Expand All @@ -19,6 +17,7 @@ import {
BalanceHistoryApiFactory,
SmartContractsApiFactory,
TransactionHistoryApiFactory,
MPCWalletStakeApiFactory,
} from "../client";
import { BASE_PATH } from "./../client/base";
import { Configuration } from "./../client/configuration";
Expand Down Expand Up @@ -139,8 +138,7 @@ export class Coinbase {
Coinbase.apiClients.trade = TradesApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.serverSigner = ServerSignersApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.stake = StakeApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.walletStake = WalletStakeApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.validator = ValidatorsApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.walletStake = MPCWalletStakeApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.asset = AssetsApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.webhook = WebhooksApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.contractInvocation = ContractInvocationsApiFactory(
Expand Down
3 changes: 0 additions & 3 deletions src/coinbase/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -539,9 +539,7 @@ export type StakeAPIClient = {
page?: string,
options?: AxiosRequestConfig,
): AxiosPromise<FetchHistoricalStakingBalances200Response>;
};

export type ValidatorAPIClient = {
/**
* List the validators for a given network and asset.
*
Expand Down Expand Up @@ -715,7 +713,6 @@ export type ApiClients = {
serverSigner?: ServerSignerAPIClient;
stake?: StakeAPIClient;
walletStake?: WalletStakeAPIClient;
validator?: ValidatorAPIClient;
asset?: AssetAPIClient;
externalAddress?: ExternalAddressAPIClient;
webhook?: WebhookApiClient;
Expand Down
4 changes: 2 additions & 2 deletions src/coinbase/validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export class Validator {
status?: ValidatorStatus,
): Promise<Validator[]> {
const validators: Validator[] = [];
const response = await Coinbase.apiClients.validator!.listValidators(
const response = await Coinbase.apiClients.stake!.listValidators(
networkId,
assetId,
Validator.getAPIValidatorStatus(status),
Expand All @@ -60,7 +60,7 @@ export class Validator {
* @returns The requested validator details.
*/
public static async fetch(networkId: string, assetId: string, id: string): Promise<Validator> {
const response = await Coinbase.apiClients.validator!.getValidator(networkId, assetId, id);
const response = await Coinbase.apiClients.stake!.getValidator(networkId, assetId, id);

return new Validator(response.data);
}
Expand Down
1 change: 0 additions & 1 deletion src/tests/external_address_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,6 @@ describe("ExternalAddress", () => {
beforeAll(() => {
Coinbase.apiClients.stake = stakeApiMock;
Coinbase.apiClients.asset = assetsApiMock;
Coinbase.apiClients.validator = validatorApiMock;
});

beforeEach(() => {
Expand Down
11 changes: 6 additions & 5 deletions src/tests/validator_test.ts → src/tests/stake_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Coinbase } from "../coinbase/coinbase";
import {
mockEthereumValidator,
mockReturnValue,
stakeApiMock,
VALID_ACTIVE_VALIDATOR_LIST,
validatorApiMock,
} from "./utils";
Expand All @@ -12,7 +13,7 @@ import { ValidatorStatus as APIValidatorStatus } from "../client/api";
describe("Validator", () => {
beforeAll(() => {
// Mock the validator functions.
Coinbase.apiClients.validator = validatorApiMock;
Coinbase.apiClients.stake = stakeApiMock;
});

beforeEach(() => {
Expand Down Expand Up @@ -98,15 +99,15 @@ describe("Validator", () => {
});

it("should return a list of validators for ethereum holesky and eth asset", async () => {
Coinbase.apiClients.validator!.listValidators = mockReturnValue(VALID_ACTIVE_VALIDATOR_LIST);
Coinbase.apiClients.stake!.listValidators = mockReturnValue(VALID_ACTIVE_VALIDATOR_LIST);

const validators = await Validator.list(
Coinbase.networks.EthereumHolesky,
Coinbase.assets.Eth,
ValidatorStatus.ACTIVE,
);

expect(Coinbase.apiClients.validator!.listValidators).toHaveBeenCalledWith(
expect(Coinbase.apiClients.stake!.listValidators).toHaveBeenCalledWith(
Coinbase.networks.EthereumHolesky,
Coinbase.assets.Eth,
ValidatorStatus.ACTIVE,
Expand All @@ -122,7 +123,7 @@ describe("Validator", () => {
});

it("should return a validator for ethereum holesky and eth asset", async () => {
Coinbase.apiClients.validator!.getValidator = mockReturnValue(
Coinbase.apiClients.stake!.getValidator = mockReturnValue(
mockEthereumValidator("100", ValidatorStatus.EXITING, "0x123"),
);

Expand All @@ -132,7 +133,7 @@ describe("Validator", () => {
"0x123",
);

expect(Coinbase.apiClients.validator!.getValidator).toHaveBeenCalledWith(
expect(Coinbase.apiClients.stake!.getValidator).toHaveBeenCalledWith(
Coinbase.networks.EthereumHolesky,
Coinbase.assets.Eth,
"0x123",
Expand Down
2 changes: 2 additions & 0 deletions src/tests/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,8 @@ export const stakeApiMock = {
getStakingContext: jest.fn(),
fetchStakingRewards: jest.fn(),
fetchHistoricalStakingBalances: jest.fn(),
getValidator: jest.fn(),
listValidators: jest.fn(),
};

export const walletStakeApiMock = {
Expand Down
Loading