kamiweb3-sdk
Version:
TypeScript SDK for KAMI721-C, KAMI721-AC, and KAMI1155-C smart contracts
51 lines • 2.23 kB
TypeScript
import { Signer, BigNumberish } from 'ethers';
import { KAMI721ACWrapper } from '../contracts/KAMI721ACWrapper';
import { SignerOrProvider } from '../types';
/**
* Arguments required for deploying a standard KAMI721AC contract.
*/
export interface KAMI721ACDeployArgs {
paymentToken_: string;
name_: string;
symbol_: string;
baseTokenURI_: string;
initialMintPrice_: BigNumberish;
platformAddress_: string;
platformCommissionPercentage_: BigNumberish;
}
/**
* Arguments required for initializing the upgradeable KAMI721AC contract.
* Matches the DeployArgs for the standard version in this case.
*/
export type KAMI721ACInitializeArgs = KAMI721ACDeployArgs;
export declare class KAMI721ACFactory {
/**
* Attaches to an existing standard KAMI721AC contract.
*/
static attach(address: string, signerOrProvider: SignerOrProvider): KAMI721ACWrapper;
/**
* Attaches to an existing upgradeable KAMI721AC contract (proxy).
* Uses the KAMI721ACUpgradeable ABI.
*/
static attachUpgradeable(proxyAddress: string, signerOrProvider: SignerOrProvider): KAMI721ACWrapper;
/**
* Deploys a new standard KAMI721AC contract.
*/
static deploy(args: KAMI721ACDeployArgs, signer: Signer): Promise<KAMI721ACWrapper>;
/**
* Deploys a new upgradeable KAMI721AC contract using the Transparent Proxy pattern.
* @param initArgs The arguments for the initializer function.
* @param signer The signer to use for deployment.
* @param proxyAdminOwner (Optional) The address that will own the ProxyAdmin. Defaults to the signer.
* @returns A Promise resolving to a KAMI721ACWrapper instance attached to the proxy address.
*/
static deployUpgradeable(initArgs: KAMI721ACInitializeArgs, signer: Signer, proxyAdminOwner?: string): Promise<KAMI721ACWrapper>;
/**
* Initiates an upgrade of a KAMI721AC transparent proxy.
* Deploys the new KAMI721ACUpgradeable implementation.
* @param signer The signer for deployment.
* @returns The address of the newly deployed implementation contract.
*/
static deployNewImplementation(signer: Signer): Promise<string>;
}
//# sourceMappingURL=KAMI721ACFactory.d.ts.map