Skip to main content

Table of contents#

Classes#

Interfaces#

Type aliases#

BigNumber#

Ƭ BigNumber: ethers.BigNumber

Defined in: src/types/BigNumber.ts:3

CurrencyUnit#

Ƭ CurrencyUnit: typeof currencys[number]

Defined in: src/types/CurrencyUnit.ts:3

Item#

Ƭ Item: object

Itemはマスターデータ Itemが購買・引出されてERC721トークンとなったものがToken

Type declaration:#

NameTypeDescription
authorAddressstringItemの作成者ウォレットアドレス
buyerAddressstring | null購入者のウォレットアドレス アドレスが null でない場合、Itemが「引出された」「購入された」た状態を表す
chainType"ethereum"-
collectionIdstring-
createdBystring[]アイテムの作成者 IPFSにあるアイテムデータのcreatedBy値
currentBidderAddress?string | nullアイテムの最新の入札者ウォレットアドレス。 tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
currentPrice?numberアイテムの現在の入札価格。単位はether。 tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
defaultEndAt?Dateオークション初期終了日時 tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
descriptionstringアイテムの詳細 IPFSにあるアイテムデータのdescription値
endAt?Dateオークション終了日時 autoExtensionAuctionの場合は更新される tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
feeRatePermillnumber-
imageURIstringipfs://xxxx
imageURIHTTPobjectimageURIのブラウザ閲覧用 https://xxxx
imageURIHTTP.mimeTypestring-
imageURIHTTP.urlstring-
initialPrice?numberオークション開始価格 tradeType === 'auction` の時だけ値が入る
itemIdstring-
minBidPercentage?numberアイテムの最低入札価格比 currentPrice * minBidPercentageでminBidPriceが求められる tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
minBidPrice?numberアイテムの最新の最低入札価格 tradeType === 'auction or autoExtensionAuction` の時だけ値が入る
mintContractAddressstring-
mintShopContractAddressstring-
namestringアイテムの名前 IPFSにあるアイテムデータのname値
networkIdNetworkIdItemが所属するネットワーク 1 === Ethereum メインネットワーク 4 === Ethereum Rinkebyネットワーク 137 === Polygon メインネットワーク 80001 === Matic Mumbaiネットワーク
physicalOrderStatus?ItemsPhysicalOrderStatustype === 'nftWithPhysicalProduct'だけ値が入る addressIsBlank: エンドユーザーからの住所登録待ち wip: Mint管理者側の配送アクション待ち shipped: 出荷済み
previews{ mimeType: string ; url: string }[]プレビューのURI 動画・画像が入る プレビューが設定されていない場合は空配列になる
price?numberアイテムの販売価格。単位はether。 tradeType === 'fixedPrice` の時だけ値が入る
startAt?Dateオークション開始日時 tradeType === 'auction or autoExtensionAuction' の時だけ値が入る
tokenIdnumberItemに対応するERC721準拠した tokenId Itemが買われた時などに、生成されるTokenの tokenId
tokenURIstringipfs://xxxx
tokenURIHTTPstringtokenURIのブラウザ閲覧用 https://xxxx
tradeTypeItemTradeType-
type?ItemsTypenftWithPhysicalProduct === 物理アイテム付きアイテム typeがないものは、ノーマルなNFTアイテム
withdrawableAt?Date引き出し可能日時。この日時以降、sendTxMakeSuccessfulBidを呼ぶことでToken引き出すことができる tradeType === 'autoExtensionAuction` の時だけ値が入る
yearCreatedstringアイテムの制作年 IPFSにあるアイテムデータのyearCreated値

Defined in: src/types/Item.ts:10

ItemLog#

Ƭ ItemLog: object

Type declaration:#

NameType
accountAddressstring
createAtDate
pricenumber
transactionHashstring
type"bought" | "bid"

Defined in: src/types/ItemLog.ts:1

ItemTradeType#

Ƭ ItemTradeType: typeof itemsTradeTypes[number]

Defined in: src/types/ItemTradeType.ts:6

ItemsType#

Ƭ ItemsType: typeof itemsTypes[number]

Defined in: src/types/ItemsType.ts:5

NetworkId#

Ƭ NetworkId: 1 | 4 | 80001 | 137

Defined in: src/types/NetworkId.ts:1

Residence#

Ƭ Residence: typeof residenceList[number]

Defined in: src/types/Residence.ts:2

Token#

Ƭ Token: object

TokenはERC721を表現している Item:Token = 1:1

Type declaration:#

NameTypeDescription
authorAddressstringhttps://ipfs.io/ipfs/xxxx
contractAddressstring-
descriptionstring-
imageURIstringipfs://
imageURIHTTPobjectimageURIのブラウザ閲覧用 https://xxxx
imageURIHTTP.mimeTypestring-
imageURIHTTP.urlstring-
itemItemTokenの元になったItemが入る
namestring-
previews{ mimeType: string ; url: string }[]プレビューのURI 動画・画像が入る プレビューが設定されていない場合は空配列になる
tokenIdnumber-
tokenURIstringipfs://xxxx
tokenURIHTTPstringtokenURIのブラウザ閲覧用 https://xxxx

Defined in: src/types/Token.ts:6

WalletInfo#

Ƭ WalletInfo: object

Type declaration:#

NameType
addressstring
balanceBigNumber
unitCurrencyUnit

Defined in: src/types/WalletInfo.ts:4

WalletSetting#

Ƭ WalletSetting: object

Type declaration:#

NameType
fortmaticobject
fortmatic.keystring

Defined in: src/types/WalletSetting.ts:1