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

Add Premint api js #271

Closed
wants to merge 6 commits into from
Closed

Add Premint api js #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c59ba4f
add premint api js
iainnash Oct 17, 2023
2e8fca7
update premint api tests
iainnash Oct 18, 2023
30c4170
update tests and docs
iainnash Oct 18, 2023
95ee365
new preminter update
iainnash Oct 18, 2023
46a60cd
premint update example urls
iainnash Oct 18, 2023
22157fd
add changeset for pre-release
iainnash Oct 18, 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
5 changes: 5 additions & 0 deletions .changeset/strong-bears-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@zoralabs/zora-1155-contracts": patch
---

Add SDK
2 changes: 1 addition & 1 deletion packages/1155-contracts/.env.anvil
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
FORK_RPC_URL="https://testnet.rpc.zora.co/"
FORK_BLOCK_NUMBER=916572
FORK_BLOCK_NUMBER=1433428
242 changes: 242 additions & 0 deletions packages/1155-contracts/package/premint-api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
import {
createTestClient,
http,
createWalletClient,
createPublicClient,
Address,
} from "viem";
import { foundry } from "viem/chains";
import { describe, it, beforeEach, expect, vi } from "vitest";
import { parseEther } from "viem";
import {
zoraCreator1155FactoryImplAddress,
} from "./wagmiGenerated";
import { BackendChainNames, PreminterAPI } from "./premint-api";

const chain = foundry;

const walletClient = createWalletClient({
chain,
transport: http(),
});

const testClient = createTestClient({
chain,
mode: "anvil",
transport: http(),
});

const publicClient = createPublicClient({
chain,
transport: http(),
});

// JSON-RPC Account
const [deployerAccount, secondWallet] = (await walletClient.getAddresses()) as [
Address,
Address
];

type TestContext = {
preminterAddress: `0x${string}`;
forkedChainId: keyof typeof zoraCreator1155FactoryImplAddress;
anvilChainId: number;
zoraMintFee: bigint;
fixedPriceMinterAddress: Address;
iainnash marked this conversation as resolved.
Show resolved Hide resolved
};

describe("ZoraCreator1155Preminter", () => {
beforeEach<TestContext>(async () => {
// deploy signature minter contract
await testClient.setBalance({
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

id remove this here, and put this down below in the test to right before where the eth is needed, and load up the account with the exact amount that is needed

address: deployerAccount,
value: parseEther("1"),
});

await testClient.setBalance({
address: secondWallet,
value: parseEther("1"),
});
}, 20 * 1000);

// skip for now - we need to make this work on zora testnet chain too
it<TestContext>(
"can sign on the forked premint contract",
async () => {
const preminterApi = new PreminterAPI(chain);

preminterApi.get = vi.fn().mockResolvedValue({ next_uid: 3 });
preminterApi.post = vi.fn().mockResolvedValue({ ok: true });

const premint = await preminterApi.createPremint({
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be better for this function name to be more explicit, with a name like:
signAndSavePremint

walletClient,
publicClient,
account: deployerAccount,
checkSignature: true,
collection: {
contractAdmin: deployerAccount,
contractName: "Testing Contract",
contractURI: "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
},
token: {
tokenURI: "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
},
});

expect(preminterApi.post).toHaveBeenCalledWith(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great test documentation to show how the external api is called

"https://api.zora.co/premint/signature",
{
chain_name: BackendChainNames.ZORA_TESTNET,
collection: {
contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
contractName: "Testing Contract",
contractURI: "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
},
premint: {
deleted: false,
tokenConfig: {
fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
maxSupply: "18446744073709551615",
maxTokensPerAddress: "0",
mintDuration: "604800",
mintStart: "0",
pricePerToken: "0",
royaltyBPS: 1000,
royaltyMintSchedule: 0,
royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
tokenURI: "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
},
uid: 3,
version: 1,
},
signature:
"0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
}
);

console.log({ premint });
},
20 * 1000
);

it<TestContext>("can validate premint on network", async () => {
const preminter = new PreminterAPI(chain);

const premintData = {
collection: {
contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
contractName: "Testing Contract",
contractURI: "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
},
premint: {
uid: 3,
version: 1,
deleted: false,
tokenConfig: {
maxSupply: "18446744073709551615",
maxTokensPerAddress: "0",
pricePerToken: "0",
mintDuration: "604800",
mintStart: "0",
royaltyMintSchedule: 0,
royaltyBPS: 1000,
fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
tokenURI: "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
},
},
chain_name: "ZORA-TESTNET",
signature:
"0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
} as const;
const publicClient = createPublicClient({
chain: foundry,
transport: http(),
});
const signatureValid = await preminter.isValidSignature({
// @ts-ignore: Fix enum type
data: premintData,
publicClient,
});
console.log({ signatureValid });
});

it<TestContext>(
"can execute premint on network",
async () => {
const preminterApi = new PreminterAPI(chain);

preminterApi.get = vi.fn().mockResolvedValue({
chain_name: "ZORA-TESTNET",
collection: {
contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
contractName: "Testing Contract",
contractURI: "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
},
premint: {
deleted: false,
tokenConfig: {
fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
maxSupply: "18446744073709551615",
maxTokensPerAddress: "0",
mintDuration: "604800",
mintStart: "0",
pricePerToken: "0",
royaltyBPS: 1000,
royaltyMintSchedule: 0,
royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
tokenURI: "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
},
uid: 3,
version: 1,
},
signature:
"0x588d19641de9ba1dade4d2bb5387c8dc96f4a990fef69787534b60caead759e6334975a6be10a796da948cd7d1d4f5580b3f84d49d9fa4e0b41c97759507975a1c",
});
preminterApi.post = vi.fn();

console.log({ deployerAccount });

const premint = await preminterApi.executePremintWithWallet({
data: await preminterApi.getPremintData(
"0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
3
),
account: deployerAccount,
walletClient,
publicClient,
mintArguments: {
quantityToMint: 1,
mintComment: "",
},
});

expect(premint.log).toEqual({
contractAddress: "0xf8dA7f53c283d898818af7FB9d98103F559bDac2",
contractConfig: {
contractAdmin: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
contractName: "Testing Contract",
contractURI: "ipfs://bafkreiainxen4b4wz4ubylvbhons6rembxdet4a262nf2lziclqvv7au3e",
},
createdNewContract: false,
minter: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
quantityMinted: 1n,
tokenConfig: {
fixedPriceMinter: "0x04E2516A2c207E84a1839755675dfd8eF6302F0a",
maxSupply: 18446744073709551615n,
maxTokensPerAddress: 0n,
mintDuration: 604800n,
mintStart: 0n,
pricePerToken: 0n,
royaltyBPS: 1000,
royaltyMintSchedule: 0,
royaltyRecipient: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
tokenURI: "ipfs://bafkreice23maski3x52tsfqgxstx3kbiifnt5jotg3a5ynvve53c4soi2u",
},
tokenId: 1n,
uid: 3,
});
},
20 * 1000
);
});
Loading