Skip to content

fix(sdk): enforce the native asset decimal limit #304

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

Draft
s6pa1rta3n-lab wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(sdk): enforce the native asset decimal limit #304

Show file tree
Hide file tree
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
54 changes: 54 additions & 0 deletions packages/sdk/src/asset-config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ describe("validateAssetConfig - valid fixtures", () => {
assert.equal(result.decimals, 7);
});

it("accepts native config with boundary 0 decimals", () => {
const result = validateAssetConfig({ type: "native", decimals: 0 });
assert.equal(result.type, "native");
assert.equal(result.decimals, 0);
});

it("accepts native config with boundary 7 decimals", () => {
const result = validateAssetConfig({ type: "native", decimals: 7 });
assert.equal(result.type, "native");
assert.equal(result.decimals, 7);
});

it("accepts full SAC USDC config", () => {
const result = validateAssetConfig(ASSET_FIXTURES.valid.sac);
assert.equal(result.type, "sac");
Expand All @@ -35,6 +47,26 @@ describe("validateAssetConfig - valid fixtures", () => {
assert.equal(result.code, undefined);
});

it("accepts SAC config with boundary 0 decimals", () => {
const result = validateAssetConfig({
type: "sac",
contractId: ASSET_FIXTURES.valid.sacMinimal.contractId,
decimals: 0,
});
assert.equal(result.type, "sac");
assert.equal(result.decimals, 0);
});

it("accepts SAC config with boundary 18 decimals", () => {
const result = validateAssetConfig({
type: "sac",
contractId: ASSET_FIXTURES.valid.sacMinimal.contractId,
decimals: 18,
});
assert.equal(result.type, "sac");
assert.equal(result.decimals, 18);
});

it("accepts SAC config with metadata", () => {
const result = validateAssetConfig(ASSET_FIXTURES.valid.sacWithMetadata);
assert.equal(result.type, "sac");
Expand Down Expand Up @@ -90,6 +122,28 @@ describe("validateAssetConfig - invalid fixtures", () => {
);
});

it("rejects native decimals exceeding MAX_STROOPS_DECIMALS", () => {
assert.throws(
() => validateAssetConfig(ASSET_FIXTURES.invalid.nativeInvalidDecimals),
(e: AssetConfigError) => {
assert.equal(e.field, "decimals");
assert.match(e.message, /decimals must be 0-7/);
return true;
},
);
});

it("rejects native negative decimals", () => {
assert.throws(
() => validateAssetConfig({ type: "native", decimals: -1 }),
(e: AssetConfigError) => {
assert.equal(e.field, "decimals");
assert.match(e.message, /decimals must be 0-7/);
return true;
},
);
});

it("rejects decimals exceeding MAX_TOKEN_DECIMALS", () => {
assert.throws(
() => validateAssetConfig(ASSET_FIXTURES.invalid.invalidDecimals),
Expand Down
10 changes: 8 additions & 2 deletions packages/sdk/src/asset-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,12 @@ export function validateAssetConfig(

const decimals = validateNumber(raw.decimals, "decimals");
if (decimals !== undefined) {
if (decimals < 0 || decimals > MAX_TOKEN_DECIMALS) {
const maxDecimals =
type === "native" ? MAX_STROOPS_DECIMALS : MAX_TOKEN_DECIMALS;
if (decimals < 0 || decimals > maxDecimals) {
throw new AssetConfigError(
"decimals",
`decimals must be 0-${MAX_TOKEN_DECIMALS}, got ${decimals}`,
`decimals must be 0-${maxDecimals}, got ${decimals}`,
);
}
config.decimals = decimals;
Expand Down Expand Up @@ -214,6 +216,10 @@ export const ASSET_FIXTURES = {
contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
decimals: 255,
},
nativeInvalidDecimals: {
type: "native",
decimals: 8,
},
negativeDecimals: {
type: "sac",
contractId: "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABSC4",
Expand Down
Loading