Home > @3rdweb/sdk > AppModule
Access this module by calling ThirdwebSDK.getAppModule()
Signature:
export declare class AppModule extends ModuleWithRoles<ProtocolControl> implements IAppModule
Extends: ModuleWithRoles<ProtocolControl>
Implements: IAppModule
| Property | Modifiers | Type | Description |
|---|---|---|---|
| roles | static |
readonly [“admin”] |
| Method | Modifiers | Description |
|---|---|---|
| balance() | Check the balance of the project wallet in the native token of the chain | |
| balanceOfToken(tokenAddress) | Check the balance of the project wallet in a particular ERC20 token contract | |
| deployBundleDropModule(metadata) | Deploys a Bundle Drop module | |
| deployBundleModule(metadata) | Deploys a collection module. | |
| deployBundleSignatureModule(metadata) | Deploys a BundleSignature module | |
| deployCurrencyModule(metadata) | Deploys a currency module. | |
| deployDropModule(metadata) | Deploys a Drop module | |
| deployMarketModule(metadata) | Deploys a Marketplace module | |
| deployMarketplaceModule(metadata) | ||
| deployNftModule(metadata) | Deploys a NFT module. | |
| deployPackModule(metadata) | Deploys a Pack module | |
| deployRoyaltySplitsModule(metadata) | Deploys a Royalty Splits module | |
| deploySplitsModule(metadata) | Deploys a Splits module | |
| deployTokenModule(metadata) | Deploys a token module. | |
| deployVoteModule(metadata) | Deploys a Vote module | |
| getAllModuleMetadata(filterByModuleType, resolveGateway) | Method to get a list of all module metadata on a given app. | |
| getBundleModules() | ||
| getCollectionModules() | Method to get a list of Bundle module metadata. | |
| getCurrencyModules() | Method to get a list of Currency module metadata. | |
| getDropModules() | Method to get a list of Drop module metadata. | |
| getForwarder() | Trusted forwarder is used to forward gasless transactions. Trusted Forwarder of each module cannot be changed once it is deployed. | |
| getMarketModules() | Method to get a list of Market module metadata. | |
| getNFTModules() | Method to get a list of NFT module metadata. | |
| getPackModules() | Method to get a list of pack module metadata. | |
| getRoyaltyTreasury(address) | ||
| setForwarder(address) | Set trusted forwarder for the modules. Every module that is deployed after this call will use the new forwarder. Trusted forwarder is used to forward gasless transactions. Trusted Forwarder of each module cannot be changed once it is deployed. | |
| setModuleMetadata(metadata) | ||
| setModuleRoyaltyTreasury(moduleAddress, treasury) | ||
| setRoyaltyTreasury(treasury) | ||
| shouldUpgradeModuleList() | ||
| shouldUpgradeToV2() | ||
| withdrawFunds(to, currency) |