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

Add smart rollup address support #2036

Merged
merged 2 commits into from
Nov 13, 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 changes: 2 additions & 1 deletion apps/desktop/src/components/AddressPill/AddressPill.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export const AddressPill = memo(
showIcons,
addressKind,
addressAlias,
address,
onClick,
elementRef,
isMouseHover,
Expand Down Expand Up @@ -109,7 +110,7 @@ export const AddressPill = memo(
</PopoverBody>
</PopoverContent>
</Popover>
{showIcons && (
{showIcons && address.type !== "smart_rollup" && (
serjonya-trili marked this conversation as resolved.
Show resolved Hide resolved
<RightIcon
marginRight="4px"
stroke={colors.gray[300]}
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/Operation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@ export const toLambda = (operation: Operation): MichelsonV1Expression[] => {
operation.recipient.pkh,
Number(operation.amount)
);
default:
throw new Error(`${operation.recipient.type} is not supported yet`);
serjonya-trili marked this conversation as resolved.
Show resolved Hide resolved
}
// eslint-disable-next-line no-fallthrough
case "fa1.2":
Expand Down
106 changes: 106 additions & 0 deletions packages/tezos/src/Address.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import {
isAddressValid,
isValidContractPkh,
isValidImplicitPkh,
isValidSmartRollupPkh,
parseContractPkh,
parseImplicitPkh,
parsePkh,
parseSmartRollupPkh,
} from "./Address";
import { mockContractAddress, mockImplicitAddress, mockSmartRollupAddress } from "./testUtils";

describe("Address", () => {
const addresses = {
contract: mockContractAddress(0),
implicit: mockImplicitAddress(0),
smart_rollup: mockSmartRollupAddress(0),
};

describe("parsePkh", () => {
it.each(Object.entries(addresses))("parses %s address", (_, address) => {
expect(parsePkh(address.pkh)).toEqual(address);
});

it("throws error for invalid address", () => {
expect(() => parsePkh("invalid")).toThrow("Cannot parse address type: invalid");
});
});

describe("isAddressValid", () => {
it.each(Object.entries(addresses))("returns true for valid %s address", (_, address) => {
expect(isAddressValid(address.pkh)).toBe(true);
});

it("returns false for invalid address", () => {
expect(isAddressValid("invalid")).toBe(false);
});
});

describe("isValidContractPkh", () => {
it.each([
[true, addresses.contract.pkh],
[false, addresses.implicit.pkh],
[false, addresses.smart_rollup.pkh],
[false, "invalid"],
])("returns %s for %s address", (expected, pkh) => {
expect(isValidContractPkh(pkh)).toBe(expected);
});
});

describe("isValidImplicitPkh", () => {
it.each([
[false, addresses.contract.pkh],
[true, addresses.implicit.pkh],
[false, addresses.smart_rollup.pkh],
[false, "invalid"],
])("returns %s for %s address", (expected, pkh) => {
expect(isValidImplicitPkh(pkh)).toBe(expected);
});
});

describe("isValidSmartRollupPkh", () => {
it.each([
[false, addresses.contract.pkh],
[false, addresses.implicit.pkh],
[true, addresses.smart_rollup.pkh],
[false, "invalid"],
])("returns %s for %s address", (expected, pkh) => {
expect(isValidSmartRollupPkh(pkh)).toBe(expected);
});
});

describe("parse functions", () => {
const parseFunctions = {
parseContractPkh: {
fn: parseContractPkh,
validAddress: addresses.contract,
errorMessage: "Invalid contract address",
},
parseImplicitPkh: {
fn: parseImplicitPkh,
validAddress: addresses.implicit,
errorMessage: "Invalid implicit address",
},
parseSmartRollupPkh: {
fn: parseSmartRollupPkh,
validAddress: addresses.smart_rollup,
errorMessage: "Invalid smart rollup address",
},
};

it.each(Object.entries(parseFunctions))(
"%s parses valid address",
(_, { fn, validAddress }) => {
expect(fn(validAddress.pkh)).toEqual(validAddress);
}
);

it.each(Object.entries(parseFunctions))(
"%s throws error for invalid address",
(_, { fn, errorMessage }) => {
expect(() => fn("invalid")).toThrow(`${errorMessage}: invalid`);
}
);
});
});
24 changes: 21 additions & 3 deletions packages/tezos/src/Address.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { ValidationResult, validateAddress } from "@taquito/utils";

import { type Address, type ContractAddress, type ImplicitAddress } from "./types";
import {
type Address,
type ContractAddress,
type ImplicitAddress,
type SmartRollupAddress,
} from "./types";

export const parsePkh = (pkh: string): Address => {
if (isValidContractPkh(pkh)) {
Expand All @@ -9,14 +14,20 @@ export const parsePkh = (pkh: string): Address => {
if (isValidImplicitPkh(pkh)) {
return parseImplicitPkh(pkh);
}
if (isValidSmartRollupPkh(pkh)) {
return parseSmartRollupPkh(pkh);
}
throw new Error(`Cannot parse address type: ${pkh}`);
};

export const isAddressValid = (pkh: string) => validateAddress(pkh) === ValidationResult.VALID;

export const isValidContractPkh = (pkh: string) => isAddressValid(pkh) && pkh.match(/^KT1\w+/);
export const isValidContractPkh = (pkh: string) => isAddressValid(pkh) && !!pkh.match(/^KT1\w+/);

export const isValidImplicitPkh = (pkh: string) =>
isAddressValid(pkh) && !!pkh.match(/^tz[1234]\w+/);

export const isValidImplicitPkh = (pkh: string) => isAddressValid(pkh) && pkh.match(/^tz[1234]\w+/);
export const isValidSmartRollupPkh = (pkh: string) => isAddressValid(pkh) && !!pkh.match(/^sr1\w+/);

export const parseContractPkh = (pkh: string): ContractAddress => {
if (isValidContractPkh(pkh)) {
Expand All @@ -31,3 +42,10 @@ export const parseImplicitPkh = (pkh: string): ImplicitAddress => {
}
throw new Error(`Invalid implicit address: ${pkh}`);
};

export const parseSmartRollupPkh = (pkh: string): SmartRollupAddress => {
if (isValidSmartRollupPkh(pkh)) {
return { type: "smart_rollup", pkh };
}
throw new Error(`Invalid smart rollup address: ${pkh}`);
};
9 changes: 8 additions & 1 deletion packages/tezos/src/testUtils.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
import { type ContractAddress, type ImplicitAddress } from "./types";
import { type ContractAddress, type ImplicitAddress, type SmartRollupAddress } from "./types";

const validSmartRollupAddresses = ["sr1Ghq66tYK9y3r8CC1Tf8i8m5nxh8nTvZEf"];

export const mockSmartRollupAddress = (index: number): SmartRollupAddress => ({
type: "smart_rollup",
pkh: validSmartRollupAddresses[index],
});

const validContractAddresses = [
"KT1QuofAgnsWffHzLA7D78rxytJruGHDe7XG",
Expand Down
7 changes: 6 additions & 1 deletion packages/tezos/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ export type ImplicitAddress = {
pkh: RawPkh;
};

export type Address = ContractAddress | ImplicitAddress;
export type SmartRollupAddress = {
type: "smart_rollup";
pkh: RawPkh;
};

export type Address = ContractAddress | ImplicitAddress | SmartRollupAddress;

export type Estimation = {
storageLimit: number;
Expand Down
Loading