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.

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

feat(api): support retrieval of multiple wallets via ?address= param #844

Merged
merged 3 commits into from
Jan 30, 2025
Merged

feat(api): support retrieval of multiple wallets via ?address= param #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6277da
move schemas to api-common
oXtxNt9U Jan 29, 2025
11c8514
accept array of addresses
oXtxNt9U Jan 29, 2025
1cce2c0
style: resolve style guide violations
oXtxNt9U Jan 29, 2025
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
14 changes: 14 additions & 0 deletions packages/api-common/source/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,17 @@ export const pagination = Joi.object({
offset: Joi.number().integer().min(0),
page: Joi.number().integer().positive().default(1),
});

export const equalCriteria = (value: any) => value;
export const numericCriteria = (value: any) =>
Joi.alternatives().try(
value,
Joi.object().keys({ from: value }),
Joi.object().keys({ to: value }),
Joi.object().keys({ from: value, to: value }),
);
export const containsCriteria = (value: any) => value;
export const orCriteria = (criteria: any) => Joi.alternatives().try(criteria, Joi.array().items(criteria));
export const orEqualCriteria = (value: any) => orCriteria(equalCriteria(value));
export const orNumericCriteria = (value: any) => orCriteria(numericCriteria(value));
export const orContainsCriteria = (value: any) => orCriteria(containsCriteria(value));
18 changes: 14 additions & 4 deletions packages/api-http/source/schemas/delegates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ import { Schemas } from "@mainsail/api-common";
import Joi from "joi";

import { blockCriteriaSchemaObject } from "./blocks.js";
import { walletCriteriaSchemaObject } from "./wallets.js";
import { walletAddressSchema, walletCriteriaSchemaObject } from "./wallets.js";

export const delegateCriteriaSchemaObject = {
address: walletCriteriaSchemaObject.address,
address: Schemas.orEqualCriteria(walletAddressSchema),
attributes: Joi.object(),
blocks: {
last: {
Expand All @@ -29,5 +29,15 @@ export const delegateCriteriaSchemaObject = {
votes: Schemas.createRangeCriteriaSchema(Joi.number().integer().positive()),
};

export const delegateCriteriaSchema = Schemas.createCriteriaSchema(delegateCriteriaSchemaObject);
export const delegateSortingSchema = Schemas.createSortingSchema(delegateCriteriaSchemaObject, ["attributes"], false);
export const delegateCriteriaSchema = Schemas.createCriteriaSchema({
...delegateCriteriaSchemaObject,
address: walletAddressSchema,
});
export const delegateSortingSchema = Schemas.createSortingSchema(
{
...delegateCriteriaSchemaObject,
address: walletAddressSchema,
},
["attributes"],
false,
);
71 changes: 29 additions & 42 deletions packages/api-http/source/schemas/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Schemas } from "@mainsail/api-common";
import Joi from "joi";

import { walletAddressSchema } from "./wallets.js";
Expand Down Expand Up @@ -47,52 +48,38 @@ export const numberFixedOrBetween = Joi.alternatives().try(
export const blocksOrderBy = orderBy.default("height:desc");
export const transactionsOrderBy = orderBy.default(["timestamp:desc", "sequence:desc"]);

const equalCriteria = (value: any) => value;
const numericCriteria = (value: any) =>
Joi.alternatives().try(
value,
Joi.object().keys({ from: value }),
Joi.object().keys({ to: value }),
Joi.object().keys({ from: value, to: value }),
);
const containsCriteria = (value: any) => value;
const orCriteria = (criteria: any) => Joi.alternatives().try(criteria, Joi.array().items(criteria));
const orEqualCriteria = (value: any) => orCriteria(equalCriteria(value));
const orNumericCriteria = (value: any) => orCriteria(numericCriteria(value));
const orContainsCriteria = (value: any) => orCriteria(containsCriteria(value));

export const blockCriteriaSchemas = {
blockSignature: orEqualCriteria(Joi.string().hex()),
generatorAddress: orEqualCriteria(Joi.string().hex().length(66)),
height: orNumericCriteria(Joi.number().integer().min(0)),
id: orEqualCriteria(blockId),
numberOfTransactions: orNumericCriteria(Joi.number().integer().min(0)),
payloadHash: orEqualCriteria(Joi.string().hex()),
payloadLength: orNumericCriteria(Joi.number().integer().min(0)),
previousBlock: orEqualCriteria(blockId),
reward: orNumericCriteria(Joi.number().integer().min(0)),
round: orNumericCriteria(Joi.number().integer().min(0)),
timestamp: orNumericCriteria(Joi.number().integer().min(0)),
totalAmount: orNumericCriteria(Joi.number().integer().min(0)),
totalFee: orNumericCriteria(Joi.number().integer().min(0)),
version: orEqualCriteria(Joi.number().integer().min(0)),
blockSignature: Schemas.orEqualCriteria(Joi.string().hex()),
generatorAddress: Schemas.orEqualCriteria(Joi.string().hex().length(66)),
height: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
id: Schemas.orEqualCriteria(blockId),
numberOfTransactions: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
payloadHash: Schemas.orEqualCriteria(Joi.string().hex()),
payloadLength: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
previousBlock: Schemas.orEqualCriteria(blockId),
reward: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
round: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
timestamp: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
totalAmount: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
totalFee: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
version: Schemas.orEqualCriteria(Joi.number().integer().min(0)),
};

export const transactionCriteriaSchemas = {
address: orEqualCriteria(address),
amount: orNumericCriteria(Joi.number().integer().min(0)),
asset: orContainsCriteria(Joi.object()),
blockId: orEqualCriteria(blockId),
data: orEqualCriteria(
address: Schemas.orEqualCriteria(address),
amount: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
asset: Schemas.orContainsCriteria(Joi.object()),
blockId: Schemas.orEqualCriteria(blockId),
data: Schemas.orEqualCriteria(
Joi.alternatives().try(Joi.string().valid("", "0x"), Joi.string().hex({ prefix: "optional" }).max(10)),
),
gasPrice: orNumericCriteria(Joi.number().integer().min(0)),
id: orEqualCriteria(Joi.string().hex().length(64)),
nonce: orNumericCriteria(Joi.number().integer().positive()),
recipientId: orEqualCriteria(address),
senderAddress: orEqualCriteria(address),
senderId: orEqualCriteria(address),
senderPublicKey: orEqualCriteria(Joi.string().hex().length(66)),
sequence: orNumericCriteria(Joi.number().integer().positive()),
timestamp: orNumericCriteria(Joi.number().integer().min(0)),
gasPrice: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
id: Schemas.orEqualCriteria(Joi.string().hex().length(64)),
nonce: Schemas.orNumericCriteria(Joi.number().integer().positive()),
recipientId: Schemas.orEqualCriteria(address),
senderAddress: Schemas.orEqualCriteria(address),
senderId: Schemas.orEqualCriteria(address),
senderPublicKey: Schemas.orEqualCriteria(Joi.string().hex().length(66)),
sequence: Schemas.orNumericCriteria(Joi.number().integer().positive()),
timestamp: Schemas.orNumericCriteria(Joi.number().integer().min(0)),
};
18 changes: 10 additions & 8 deletions packages/api-http/source/schemas/wallets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@ export const walletId = Joi.alternatives().try(
);

export const walletCriteriaSchemaObject = {
address: Joi.alternatives(
walletAddressSchema,
Joi.string()
.regex(/^[\d%A-Za-z]{1,34}$/)
.regex(/%/),
),
address: Schemas.orEqualCriteria(walletAddressSchema),
attributes: Joi.object(),
balance: Schemas.createRangeCriteriaSchema(Joi.number().integer().positive()),
nonce: Schemas.createRangeCriteriaSchema(Joi.number().integer().min(0)),
Expand All @@ -33,5 +28,12 @@ export const walletCriteriaSchemaObject = {
};

export const walletParamSchema = Joi.alternatives(walletAddressSchema, walletPublicKeySchema, walletUsernameSchema);
export const walletCriteriaSchema = Schemas.createCriteriaSchema(walletCriteriaSchemaObject);
export const walletSortingSchema = Schemas.createSortingSchema(walletCriteriaSchemaObject, ["attributes"], false);
export const walletCriteriaSchema = Schemas.createCriteriaSchema({
...walletCriteriaSchemaObject,
address: walletAddressSchema,
});
export const walletSortingSchema = Schemas.createSortingSchema(
{ ...walletCriteriaSchemaObject, address: walletAddressSchema },
["attributes"],
false,
);
Loading