SmartContract

// read functions will return the data from the contract
const myValue = await contract.call("myReadFunction");
console.log(myValue);
 
// write functions will return the transaction receipt
const tx = await contract.call("myWriteFunction", [arg1, arg2]);
const receipt = tx.receipt;
 
// Optionally override transaction options
await contract.call("myWriteFunction", [arg1, arg2], {
 gasLimit: 1000000, // override default gas limit
 value: ethers.utils.parseEther("0.1"), // send 0.1 ether with the contract call
};

let encoder: ContractEncoder<TContract>;

let estimator: GasCostEstimator<TContract>;

let events: ContractEvents<TContract>;

let interceptor: ContractInterceptor<TContract>;

let metadata: ContractMetadata<BaseContract, { deploy: ZodObject<extendShape<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, { platform_fee_basis_points: ZodOptional<ZodDefault<ZodNumber>>; platform_fee_recipient: ZodOptional<ZodDefault<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>>; primary_sale_recipient: ZodOptional<ZodDefault<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>>; trusted_forwarders: ZodOptional<ZodDefault<ZodArray<ZodUnion<[ZodType<..., ..., ...>, ZodType<..., ..., ...>]>, "many">>> }>, "strip", ZodTypeAny, { app_uri?: string; defaultAdmin?: string; description?: string; external_link?: string; image?: any; merkle?: Record<string, string>; name: string; platform_fee_basis_points?: number; platform_fee_recipient?: string; primary_sale_recipient?: string; social_urls?: Record<string, string>; symbol?: string; trusted_forwarders?: Array<string> }, { app_uri?: string; defaultAdmin?: string; description?: string; external_link?: string; image?: any; merkle?: Record<string, string>; name: string; platform_fee_basis_points?: number; platform_fee_recipient?: string; primary_sale_recipient?: string; social_urls?: Record<string, string>; symbol?: string; trusted_forwarders?: Array<string> }>; input: ZodObject<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${string}`, ZodTypeDef, (`${...}.eth`) | (`${...}.cb.id`)>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<[ZodTypeAny, ZodObject<..., ..., ..., ..., ...>]>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, "strip", ZodAny, objectOutputType<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, ZodAny, "strip">, objectInputType<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, ZodAny, "strip">>; output: ZodObject<extendShape<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<string, ZodTypeDef, string>, ZodType<`0x${...}`, ZodTypeDef, (...) | (...)>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<[..., ...]>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { image: ZodOptional<ZodString> }>, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, "strip", ZodAny, objectOutputType<extendShape<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<..., ..., ...>, ZodType<..., ..., ...>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<...>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { image: ZodOptional<ZodString> }>, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, ZodAny, "strip">, objectInputType<extendShape<extendShape<{ app_uri: ZodOptional<ZodString>; defaultAdmin: ZodOptional<ZodUnion<[ZodType<..., ..., ...>, ZodType<..., ..., ...>]>>; description: ZodOptional<ZodString>; external_link: ZodOptional<ZodString>; image: ZodOptional<ZodUnion<[ZodUnion<...>, ZodString]>>; name: ZodString; social_urls: ZodOptional<ZodRecord<ZodString, ZodString>> }, { image: ZodOptional<ZodString> }>, { merkle: ZodOptional<ZodDefault<ZodRecord<ZodString, ZodString>>>; symbol: ZodOptional<ZodDefault<ZodString>> }>, ZodAny, "strip">> }>

let publishedMetadata: ContractPublishedMetadata;

// Predict the address of the account that will be created for an admin.
const deterministicAddress =
  await contract.accountFactory.predictAccountAddress(
    admin,
    extraData,
  );
 
// Create accounts
const tx = await contract.accountFactory.createAccount(
  admin,
  extraData,
);
// the same as `deterministicAddress`
const accountAddress = tx.address;
 
// Get all accounts created by the factory
const allAccounts = await contract.accountFactory.getAllAccounts();
 
// Get all accounts on which a signer has been given authority.
const associatedAccounts =
  await contract.accountFactory.getAssociatedAccounts(signer);
 
// Get all signers who have been given authority on a account.
const associatedSigners =
  await contract.accountFactory.getAssociatedSigners(accountAddress);
 
// Check whether a account has already been created for a given admin.
const isAccountDeployed =
  await contract.accountFactory.isAccountDeployed(admin, extraData);

// Data of the listing you want to create
const listing = {
  // address of the contract the asset you want to list is on
  assetContractAddress: "0x...",
  // token ID of the asset you want to list
  tokenId: "0",
  // how many of the asset you want to list
  quantity: 1,
  // address of the currency contract that will be used to pay for the listing
  currencyContractAddress: NATIVE_TOKEN_ADDRESS,
  // The price to pay per unit of NFTs listed.
  pricePerToken: 1.5,
  // when should the listing open up for offers
  startTimestamp: new Date(Date.now()),
  // how long the listing will be open for
  endTimestamp: new Date(Date.now() + 5 * 24 * 60 * 60 * 1000),
  // Whether the listing is reserved for a specific set of buyers.
  isReservedListing: false,
};
 
const tx = await contract.directListings.createListing(listing);
const receipt = tx.receipt; // the transaction receipt
const id = tx.id; // the id of the newly created listing
 
// And on the buyers side:
// The ID of the listing you want to buy from
const listingId = 0;
// Quantity of the asset you want to buy
const quantityDesired = 1;
 
await contract.directListings.buyFromListing(
  listingId,
  quantityDesired,
);

// Data of the auction you want to create
const auction = {
  // address of the contract of the asset you want to auction
  assetContractAddress: "0x...",
  // token ID of the asset you want to auction
  tokenId: "0",
  // how many of the asset you want to auction
  quantity: 1,
  // address of the currency contract that will be used to pay for the auctioned tokens
  currencyContractAddress: NATIVE_TOKEN_ADDRESS,
  // the minimum bid that will be accepted for the token
  minimumBidAmount: "1.5",
  // how much people would have to bid to instantly buy the asset
  buyoutBidAmount: "10",
  // If a bid is made less than these many seconds before expiration, the expiration time is increased by this.
  timeBufferInSeconds: "1000",
  // A bid must be at least this much bps greater than the current winning bid
  bidBufferBps: "100", // 100 bps stands for 1%
  // when should the auction open up for bidding
  startTimestamp: new Date(Date.now()),
  // end time of auction
  endTimestamp: new Date(Date.now() + 5 * 24 * 60 * 60 * 1000),
};
 
const tx = await contract.englishAuctions.createAuction(auction);
const receipt = tx.receipt; // the transaction receipt
const id = tx.id; // the id of the newly created auction
 
// And on the buyers side:
// The auction ID of the asset you want to bid on
const auctionId = 0;
// The total amount you are willing to bid for auctioned tokens
const bidAmount = 1;
 
await contract.englishAuctions.makeBid(auctionId, bidAmount);

// Data of the offer you want to make
const offer = {
  // address of the contract the asset you want to make an offer for
  assetContractAddress: "0x...",
  // token ID of the asset you want to buy
  tokenId: "0",
  // how many of the asset you want to buy
  quantity: 1,
  // address of the currency contract that you offer to pay in
  currencyContractAddress: NATIVE_TOKEN_ADDRESS,
  // Total price you offer to pay for the mentioned token(s)
  totalPrice: "1.5",
  // Offer valid until
  endTimestamp: new Date(),
};
 
const tx = await contract.offers.makeOffer(offer);
const receipt = tx.receipt; // the transaction receipt
const id = tx.id; // the id of the newly created offer
 
// And on the seller's side:
// The ID of the offer you want to accept
const offerId = 0;
await contract.offers.acceptOffer(offerId);