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: get source code endpoint for vyper contracts #36

Merged
merged 2 commits into from
Oct 4, 2023
Merged

feat: get source code endpoint for vyper contracts #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7298fa0
feat: get source code endpoint for vyper contracts
vasyl-ivanchuk Oct 4, 2023
1b554d0
fix: e2e tests
vasyl-ivanchuk Oct 4, 2023
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
1 change: 1 addition & 0 deletions .dockerignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/dist/
274 changes: 27 additions & 247 deletions packages/api/src/api/contract/contract.controller.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ import { AddressService } from "../../address/address.service";
import { Address } from "../../address/address.entity";
import { ResponseStatus, ResponseMessage } from "../dtos/common/responseBase.dto";
import { ContractController, parseAddressListPipeExceptionFactory } from "./contract.controller";
import { SOURCE_CODE_EMPTY_INFO, mapContractSourceCode } from "../mappers/sourceCodeMapper";

jest.mock("../mappers/sourceCodeMapper", () => ({
...jest.requireActual("../mappers/sourceCodeMapper"),
mapContractSourceCode: jest.fn().mockReturnValue({ mockMappedSourceCode: true }),
}));

describe("ContractController", () => {
let controller: ContractController;
Expand Down Expand Up @@ -180,27 +186,11 @@ describe("ContractController", () => {
expect(response).toEqual({
status: ResponseStatus.OK,
message: ResponseMessage.OK,
result: [
{
ABI: "Contract source code not verified",
CompilerVersion: "",
ConstructorArguments: "",
ContractName: "",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "Unknown",
OptimizationUsed: "",
Proxy: "0",
Runs: "",
SourceCode: "",
SwarmSource: "",
},
],
result: [SOURCE_CODE_EMPTY_INFO],
});
});

it("returns empty source code response when contract verification info API fails with response status 404", async () => {
it("returns empty source code response when contract verification info is not found", async () => {
pipeMock.mockImplementation((callback) => {
return callback({
stack: "error stack",
Expand All @@ -215,252 +205,42 @@ describe("ContractController", () => {
expect(response).toEqual({
status: ResponseStatus.OK,
message: ResponseMessage.OK,
result: [
{
ABI: "Contract source code not verified",
CompilerVersion: "",
ConstructorArguments: "",
ContractName: "",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "Unknown",
OptimizationUsed: "",
Proxy: "0",
Runs: "",
SourceCode: "",
SwarmSource: "",
},
],
});
});

it("returns contract source code from verification info API for solc compiler and single file contract", async () => {
const abi = [];

pipeMock.mockReturnValue(
new rxjs.Observable((subscriber) => {
subscriber.next({
data: {
artifacts: {
abi,
},
request: {
sourceCode: "sourceCode",
constructorArguments: "0x0001",
contractName: "contractName",
optimizationUsed: false,
compilerSolcVersion: "8.10.0",
compilerZksolcVersion: "10.0.0",
},
},
});
})
);

const response = await controller.getContractSourceCode(address);
expect(response).toEqual({
message: "OK",
result: [
{
ABI: "[]",
CompilerVersion: "8.10.0",
CompilerZksolcVersion: "10.0.0",
ConstructorArguments: "0001",
ContractName: "contractName",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "",
OptimizationUsed: "0",
Proxy: "0",
Runs: "",
SourceCode: "sourceCode",
SwarmSource: "",
},
],
status: "1",
result: [SOURCE_CODE_EMPTY_INFO],
});
expect(httpServiceMock.get).toBeCalledWith(`http://verification.api/contract_verification/info/${address}`);
});

it("returns contract source code from verification info API for solc compiler and multi file contract", async () => {
const abi = [];

pipeMock.mockReturnValue(
new rxjs.Observable((subscriber) => {
subscriber.next({
data: {
artifacts: {
abi,
},
request: {
sourceCode: {
language: "Solidity",
settings: {
optimizer: {
enabled: true,
},
},
sources: {
"@openzeppelin/contracts/access/Ownable.sol": {
content: "Ownable.sol content",
},
"faucet.sol": {
content: "faucet.sol content",
},
},
},
constructorArguments: "0001",
contractName: "contractName",
optimizationUsed: true,
compilerSolcVersion: "8.10.0",
compilerZksolcVersion: "10.0.0",
},
},
});
})
);

const response = await controller.getContractSourceCode(address);
expect(response).toEqual({
message: "OK",
result: [
{
ABI: "[]",
CompilerVersion: "8.10.0",
CompilerZksolcVersion: "10.0.0",
ConstructorArguments: "0001",
ContractName: "contractName",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "",
OptimizationUsed: "1",
Proxy: "0",
Runs: "",
SourceCode:
'{{"language":"Solidity","settings":{"optimizer":{"enabled":true}},"sources":{"@openzeppelin/contracts/access/Ownable.sol":{"content":"Ownable.sol content"},"faucet.sol":{"content":"faucet.sol content"}}}}',
SwarmSource: "",
},
],
status: "1",
});
expect(httpServiceMock.get).toBeCalledWith(`http://verification.api/contract_verification/info/${address}`);
});

it("returns contract source code from verification info API for vyper compiler and single file contract", async () => {
const abi = [];
it("returns mapped source code for verified contract", async () => {
const data = {
artifacts: {
abi: [],
},
request: {
sourceCode: "sourceCode",
constructorArguments: "0x0001",
contractName: "contractName",
optimizationUsed: false,
compilerSolcVersion: "8.10.0",
compilerZksolcVersion: "10.0.0",
},
};

pipeMock.mockReturnValue(
new rxjs.Observable((subscriber) => {
subscriber.next({
data: {
artifacts: {
abi,
},
request: {
sourceCode: "sourceCode",
constructorArguments: "0x0001",
contractName: "contractName",
optimizationUsed: false,
compilerVyperVersion: "9.10.0",
compilerZkvyperVersion: "11.0.0",
},
},
data,
});
})
);

const response = await controller.getContractSourceCode(address);
expect(response).toEqual({
message: "OK",
result: [
{
ABI: "[]",
CompilerVersion: "9.10.0",
CompilerZkvyperVersion: "11.0.0",
ConstructorArguments: "0001",
ContractName: "contractName",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "",
OptimizationUsed: "0",
Proxy: "0",
Runs: "",
SourceCode: "sourceCode",
SwarmSource: "",
},
],
status: "1",
});
expect(mapContractSourceCode as jest.Mock).toHaveBeenCalledWith(data);
expect(mapContractSourceCode as jest.Mock).toHaveBeenCalledTimes(1);
expect(httpServiceMock.get).toBeCalledWith(`http://verification.api/contract_verification/info/${address}`);
});

it("returns contract source code from verification info API for vyper compiler and multi file contract", async () => {
const abi = [];

pipeMock.mockReturnValue(
new rxjs.Observable((subscriber) => {
subscriber.next({
data: {
artifacts: {
abi,
},
request: {
sourceCode: {
language: "Vyper",
settings: {
optimizer: {
enabled: true,
},
},
sources: {
"Base.vy": {
content: "Base.vy content",
},
"faucet.vy": {
content: "faucet.vy content",
},
},
},
constructorArguments: "0001",
contractName: "contractName",
optimizationUsed: true,
compilerVyperVersion: "9.10.0",
compilerZkvyperVersion: "11.0.0",
},
},
});
})
);

const response = await controller.getContractSourceCode(address);
expect(response).toEqual({
message: "OK",
result: [
{
ABI: "[]",
CompilerVersion: "9.10.0",
CompilerZkvyperVersion: "11.0.0",
ConstructorArguments: "0001",
ContractName: "contractName",
EVMVersion: "Default",
Implementation: "",
Library: "",
LicenseType: "",
OptimizationUsed: "1",
Proxy: "0",
Runs: "",
SourceCode:
'{{"language":"Vyper","settings":{"optimizer":{"enabled":true}},"sources":{"Base.vy":{"content":"Base.vy content"},"faucet.vy":{"content":"faucet.vy content"}}}}',
SwarmSource: "",
},
],
result: [{ mockMappedSourceCode: true }],
status: "1",
});
expect(httpServiceMock.get).toBeCalledWith(`http://verification.api/contract_verification/info/${address}`);
});
});

Expand Down
Loading
Loading