Class ERC721Collectibles

Hierarchy

Model<ERC721CollectiblesMethods>
- ERC721Collectibles

Implements

Deployable

Constructors

constructor

new ERC721Collectibles(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string, _purchaseToken?: string): ERC721Collectibles

Overrides Model.constructor
- Defined in src/models/erc721-collectibles.ts:12
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
- Optional _purchaseToken: string
Returns ERC721Collectibles

Properties

Protected _contract

_contract: Web3Contract<ERC721CollectiblesMethods, any>

Private _erc20

_erc20: ERC20

Optional Readonly _purchaseToken

_purchaseToken?: string

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Accessors

account

get account(): Account

Inherited from Model.account
- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

Protected connection

get connection(): Web3Connection

Inherited from Model.connection
- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

Inherited from Model.contract
- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

erc20

get erc20(): ERC20

- Defined in src/models/erc721-collectibles.ts:19
Returns ERC20

web3

get web3(): default

Inherited from Model.web3
- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

MAX_PURCHASE

MAX_PURCHASE(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:50
Returns Promise<number>

_baseFeeAddress

_baseFeeAddress(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:54
Returns Promise<string>

_baseFeeShare

_baseFeeShare(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:58
Returns Promise<number>

_closed

_closed(): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:62
Returns Promise<boolean>

_currentTokenId

_currentTokenId(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:66
Returns Promise<number>

_feeAddress

_feeAddress(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:70
Returns Promise<string>

_feeShare

_feeShare(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:74
Returns Promise<number>

_limitedAmount

_limitedAmount(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:78
Returns Promise<number>

_otherAddress

_otherAddress(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:82
Returns Promise<string>

_otherShare

_otherShare(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:86
Returns Promise<number>

alreadyMinted

alreadyMinted(v1: number): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:106
Parameters
- v1: number
Returns Promise<boolean>

approve

approve(to: string, tokenId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:126
Parameters
- to: string
- tokenId: number
Returns Promise<TransactionReceipt<any>>

approveERC20Transfer

approveERC20Transfer(): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:110
Returns Promise<TransactionReceipt<any>>

balanceOf

balanceOf(owner: string): Promise<number>

- Defined in src/models/erc721-collectibles.ts:118
Parameters
- owner: string
Returns Promise<number>

baseURI

baseURI(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:122
Returns Promise<string>

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

Inherited from Model.callTx
- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

connect

connect(): Promise<boolean>

Inherited from Model.connect
- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

Inherited from Model.deploy
- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

deployJsonAbi

deployJsonAbi(name: string, symbol: string, limitedAmount: number, _purchaseToken: string, baseFeeAddress: string, feeAddress: string, otherAddress: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/erc721-collectibles.ts:35
Parameters
- name: string
- symbol: string
- limitedAmount: number
- _purchaseToken: string
- baseFeeAddress: string
- feeAddress: string
- otherAddress: string
Returns Promise<TransactionReceipt<any>>

exists

exists(tokenId: number): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:228
Parameters
- tokenId: number
Returns Promise<boolean>

getApproved

getApproved(tokenId: number): Promise<string>

- Defined in src/models/erc721-collectibles.ts:130
Parameters
- tokenId: number
Returns Promise<string>

getRegisteredIDs

getRegisteredIDs(_address: string): Promise<number[]>

- Defined in src/models/erc721-collectibles.ts:248
Parameters
- _address: string
Returns Promise<number[]>

isApproved

isApproved(amount: number): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:114
Parameters
- amount: number
Returns Promise<boolean>

isApprovedForAll

isApprovedForAll(owner: string, operator: string): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:134
Parameters
- owner: string
- operator: string
Returns Promise<boolean>

isLimited

isLimited(): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:90
Returns Promise<boolean>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): Promise<void>

Overrides Model.loadContract
- Defined in src/models/erc721-collectibles.ts:21
Preferred way of initializing and loading a contract

Returns Promise<void>

lock

lock(): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:138
Returns Promise<TransactionReceipt<any>>

mint

mint(tokenIdToMint: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:240
Parameters
- tokenIdToMint: number
Returns Promise<TransactionReceipt<any>>

name

name(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:142
Returns Promise<string>

openPack

openPack(amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:244
Parameters
- amount: number
Returns Promise<TransactionReceipt<any>>

openedPacks

openedPacks(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:94
Returns Promise<number>

owner

owner(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:146
Returns Promise<string>

ownerOf

ownerOf(tokenId: number): Promise<string>

- Defined in src/models/erc721-collectibles.ts:150
Parameters
- tokenId: number
Returns Promise<string>

pricePerPack

pricePerPack(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:98
Returns Promise<string>

purchaseToken

purchaseToken(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:102
Returns Promise<string>

registeredIDs

registeredIDs(address: string, tokenId: number): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:154
Parameters
- address: string
- tokenId: number
Returns Promise<boolean>

registeredIDsArray

registeredIDsArray(v1: string, v2: number): Promise<number>

- Defined in src/models/erc721-collectibles.ts:158
Parameters
- v1: string
- v2: number
Returns Promise<number>

safeTransferFrom

safeTransferFrom(from: string, to: string, tokenId: number, _data?: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:162
Parameters
- from: string
- to: string
- tokenId: number
- Optional _data: string
Returns Promise<TransactionReceipt<any>>

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

Inherited from Model.sendTx
- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

Inherited from Model.sendUnsignedTx
- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

setApprovalForAll

setApprovalForAll(operator: string, approved: boolean): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:166
Parameters
- operator: string
- approved: boolean
Returns Promise<TransactionReceipt<any>>

setBaseURI

setBaseURI(baseURI: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:236
Parameters
- baseURI: string
Returns Promise<TransactionReceipt<any>>

setFeeAddress

setFeeAddress(feeAddress: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:170
Parameters
- feeAddress: string
Returns Promise<TransactionReceipt<any>>

setOtherAddress

setOtherAddress(otherAddress: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:174
Parameters
- otherAddress: string
Returns Promise<TransactionReceipt<any>>

setPricePerPack

setPricePerPack(newPrice: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:178
Parameters
- newPrice: string | number
Returns Promise<TransactionReceipt<any>>

setPurchaseTokenAddress

setPurchaseTokenAddress(purchaseToken: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:184
Parameters
- purchaseToken: string
Returns Promise<TransactionReceipt<any>>

setShares

setShares(feeShare: number, otherShare: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:188
Parameters
- feeShare: number
- otherShare: number
Returns Promise<TransactionReceipt<any>>

setTokenURI

setTokenURI(tokenId: number, uri: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:232
Parameters
- tokenId: number
- uri: string
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

Overrides Model.start
- Defined in src/models/erc721-collectibles.ts:30
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

supportsInterface

supportsInterface(interfaceId: string): Promise<boolean>

- Defined in src/models/erc721-collectibles.ts:192
Parameters
- interfaceId: string
Returns Promise<boolean>

symbol

symbol(): Promise<string>

- Defined in src/models/erc721-collectibles.ts:196
Returns Promise<string>

tokenByIndex

tokenByIndex(index: number): Promise<number>

- Defined in src/models/erc721-collectibles.ts:200
Parameters
- index: number
Returns Promise<number>

tokenOfOwnerByIndex

tokenOfOwnerByIndex(owner: string, index: number): Promise<number>

- Defined in src/models/erc721-collectibles.ts:204
Parameters
- owner: string
- index: number
Returns Promise<number>

tokenURI

tokenURI(tokenId: number): Promise<string>

- Defined in src/models/erc721-collectibles.ts:208
Parameters
- tokenId: number
Returns Promise<string>

totalSupply

totalSupply(): Promise<number>

- Defined in src/models/erc721-collectibles.ts:212
Returns Promise<number>

transferFrom

transferFrom(from: string, to: string, tokenId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:216
Parameters
- from: string
- to: string
- tokenId: number
Returns Promise<TransactionReceipt<any>>

transferOwnership

transferOwnership(newOwner: string): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:220
Parameters
- newOwner: string
Returns Promise<TransactionReceipt<any>>

unlock

unlock(): Promise<TransactionReceipt<any>>

- Defined in src/models/erc721-collectibles.ts:224
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc