0.1.40 • Published 3 years ago

@nftvillage/marketplace-sdk v0.1.40

Weekly downloads
-
License
-
Repository
github
Last release
3 years ago

@nftvillage/marketplace-sdk

Marketplace Hooks and functions to interect with Nft Village.

Dependencies

"@react-dapp/utils": "^0.0.20",
"bignumber.js": "^9.0.1",
"ethereum-multicall": "^2.9.0",
"ethers": "^5.5.1",
"react": "^17.0.2",

Collection Hooks

useCreateCollection

  • createCollection this hook takes collection data,interface of collection data
  • Useage this hook is used to create the user collection
CollectionData {
  name?: string
  description?: string
  symbol?: string
  shortUrl?: string
  coverImage?:string
  logoImage?:string
  royalty?: number
  isVerified?: boolean
}
  • Return values this hook returns Api response interface where T is the collection interface

    ApiResponse<T> {
     status: boolean
     message: string
     data?: T
    }
    Collection {
     userAddress: string
     isVerified?: boolean
     address: string
     name?: string
     description?: string
     symbol?: string
     shortUrl?: string
     coverImage?:string
     logoImage?:string
     royalty?: number
     collectionStandard:AssetType
    }

    useCollectionByShortURL

  • fetchCollection this hook takes shortUrl as string.

shortUrl: string
  • Return values this hook returns collection interface and loading State

    Collection {
     userAddress: string
     isVerified?: boolean
     address: string
     name?: string
     description?: string
     symbol?: string
     shortUrl?: string
     coverImage?:string
     logoImage?:string
     royalty?: number
     collectionStandard:AssetType
    },
    loading:boolean

    useCollectionByCollectionAddress

  • fetchCollectionAddress this hook takes collection address as string.

address: string
  • Return values this hook returns collection interface and loading State

    Collection {
     userAddress: string
     isVerified?: boolean
     address: string
     name?: string
     description?: string
     symbol?: string
     shortUrl?: string
     coverImage?:string
     logoImage?:string
     royalty?: number
     collectionStandard:AssetType
    },
    loading:boolean

    useAllCollectionsByUserAddress

  • fetchAllCollectionOfUser this hook takes User address as string.

address: string
  • Return values this hook returns Array of collection interface and loading State

    [
    Collection{
     userAddress: string
     isVerified?: boolean
     address: string
     name?: string
     description?: string
     symbol?: string
     shortUrl?: string
     coverImage?:string
     logoImage?:string
     royalty?: number
     collectionStandard:AssetType
    },
    ],
    loading:boolean

    useCheckShortUrlAvailability

  • _checkShortUrlAvailability this hook takes User shortUrl as string.

shortUrl: string
  • Return values this hook returns Boolean isURLAvailable and loading State

Token Hooks

useMintERC721

  • mintToken

this hook takes Token interface.

Token {
  address: string
  metadata: MetaData
  fees: Fee[] | []
  minter: string
  owner: string
}

type Fee = {
  recipient: string
  value: number
}
  • Return values this hook returns Api response and tokenId as number where T is the token interface

    ApiResponse<T> {
     status: boolean
     message: string
     data?: T
    }
    Token {
     address: string
     tokenId?: number
     metadata: MetaData
     fees: Fee[] | []
     minter: string
     owner: string
    }
    tokenId:number
### Order Hooks


## _useSellOrder_
this takes asset(it's a collection address) as string

- create
this hook takes Order interface

Order { order: OrderData metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } }

OrderData { assetId:number, assetType:AssetType, assetAmount?:number, maker:string, paymentToken?:string, expirationTime?:number, basePrice:number, }

Attributes = { trait_type: string value: string | number display_type?: string }

enum AssetType { ERC721, ERC1155, } enum SaleKind { BUYNOW = 0, ENGLISHAUCTION = 1, DUTCHAUCTION = 2, }

 - Return values
 this hook returns Api response interface 
 where T is the Order interface

ApiResponse { status: boolean message: string data?: T } Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] }

## _useCancelOrder_

- cancel
this hook takes Order interface

Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] }

 - Return values
 this hook returns Delete interface

Delete{ message:string, status:boolean }

## _useOrderBid_


- createBidOrder
this hook takes Order interface

Order { order: OrderData metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } }

OrderData { asset, assetId, maker, paymentToken, side, taker, expirationTime, basePrice }

Attributes = { trait_type: string value: string | number display_type?: string } OrderSide { BUY, SELL, } SaleKind { BUYNOW = 0, ENGLISHAUCTION = 1, DUTCHAUCTION = 2, }

 - Return values
 this hook returns Api response interface 
 where T is the Order interface

ApiResponse { status: boolean message: string data?: T } Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] }

## _useBuyFixPriceOrder_

- buyFixOrder 
this hook takes  asset: string, assetId: number, maker: string
where maker is the buyer of the order

- approve
no params

- Return values 
this hook returns txResponse interface

{ tx: any; receipt: any; error: any; status: boolean; }

isApproved:boolean

## _useBuyOrder_

- buy

this hook takes two Orders interface buyOrder , sellOrder

Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] }

 - Return values
 this hook returns txResponse interface

{ tx: any; receipt: any; error: any; status: boolean; }

## _useOrder_

- singleOrder
this hook takes orderAsset

OrderAsset { asset: string assetId: number }

 - Return values
 this hook returns Order and loading as boolean

Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] }

loading:boolean

## _useOrders_

- fetchOrders
this hook takes 

saleKind: SaleKind, page: number, limit: number, status: StatusType

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## _useOrdersOfCollection_

- fetchOrdersForCollection
this hook takes 

address: string, saleKind: SaleKind

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## _useAllListedOrdersForAddress_

- fetchOrdersForAddress

this hooks takes

userAddress: string

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## _useOrderHistory_

- fetchOrderHistory

this hooks takes

orderData: OrderAsset, page: number, limit: number

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## _useSpecificOrders_

- fetchSpecificOrders
this hook takes specificOrderData interface key is the collection address
number array is tokeIds 

SpecificOrderData { key: string: number[] }

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## Search hooks 

## _useFilterMarketPlace_

-filterMarketPlace
this hooks takes FilterMarketPlace interface

FilterMarketPlace { address?: string makerAddress?: string name?: string collectionName?: string category?: string minPrice?: number maxPrice?: number sortBy?: SortBy }

SortBy = { LATEST?: string OLDEST?: string PRICE_LOW_TO_HIGH?: string PRICE_HIGH_TO_LOW?: string }

 - Return values
 this hook returns Array of Order and loading as boolean

[ Order { order: OrderData orderHash?: string referrer?: string status?: StatusType expirationTime?: number signature?: string metadata: { attributes: Attributes[] | [] image?: string background_color?: string external_url?: string animation_url?: string youtube_url?: string category?: string name?: string description?: string address: string tokenId: number collectionName: string makerAddress: string price: number } bids?: Bids[] | [] } ], loading:boolean

## _useSearchMarketPlace_

- searchMarketPlace

this hooks takes

query: string

 - Return values
 this hook returns SearchMarketPlace and loading as boolean

SearchMarketPlace { names: string[] collectionNames: string[] }

0.1.40

3 years ago

0.1.38

3 years ago

0.1.39

3 years ago

0.1.30

3 years ago

0.1.31

3 years ago

0.1.32

3 years ago

0.1.33

3 years ago

0.1.34

3 years ago

0.1.35

3 years ago

0.1.36

3 years ago

0.1.37

3 years ago

0.1.27

3 years ago

0.1.28

3 years ago

0.1.29

3 years ago

0.1.20

3 years ago

0.1.21

3 years ago

0.1.22

3 years ago

0.1.23

3 years ago

0.1.24

3 years ago

0.1.25

3 years ago

0.1.26

3 years ago

0.1.16

3 years ago

0.1.17

3 years ago

0.1.18

3 years ago

0.1.19

3 years ago

0.1.10

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.13

3 years ago

0.1.14

3 years ago

0.1.15

3 years ago

0.1.8

3 years ago

0.1.7

3 years ago

0.1.9

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.0.73

3 years ago

0.0.74

3 years ago

0.0.75

3 years ago

0.0.76

3 years ago

0.0.77

3 years ago

0.0.78

3 years ago

0.0.79

3 years ago

0.0.70

3 years ago

0.0.71

3 years ago

0.0.72

3 years ago

0.1.0

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.0.62

3 years ago

0.0.63

3 years ago

0.0.64

3 years ago

0.0.65

3 years ago

0.0.66

3 years ago

0.0.67

3 years ago

0.0.68

3 years ago

0.0.69

3 years ago

0.0.61

3 years ago

0.0.40

3 years ago

0.0.41

3 years ago

0.0.42

3 years ago

0.0.43

3 years ago

0.0.44

3 years ago

0.0.45

3 years ago

0.0.46

3 years ago

0.0.47

3 years ago

0.0.37

3 years ago

0.0.38

3 years ago

0.0.39

3 years ago

0.0.30

4 years ago

0.0.31

4 years ago

0.0.32

4 years ago

0.0.33

4 years ago

0.0.34

4 years ago

0.0.36

3 years ago

0.0.28

4 years ago

0.0.29

4 years ago

0.0.24

4 years ago

0.0.25

4 years ago

0.0.60

3 years ago

0.0.59

3 years ago

0.0.51

3 years ago

0.0.52

3 years ago

0.0.53

3 years ago

0.0.54

3 years ago

0.0.55

3 years ago

0.0.56

3 years ago

0.0.57

3 years ago

0.0.58

3 years ago

0.0.50

3 years ago

0.0.48

3 years ago

0.0.49

3 years ago

0.0.23

4 years ago

0.0.22

4 years ago

0.0.21

4 years ago

0.0.20

4 years ago

0.0.19

4 years ago

0.0.18

4 years ago

0.0.17

4 years ago

0.0.16

4 years ago

0.0.15

4 years ago

0.0.13

4 years ago

0.0.12

4 years ago

0.0.11

4 years ago

0.0.10

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago