Links

Referenced Types

An overview of types referenced in this documentation 📑

Timestamp

Timestamp: int
# 13-digit millisecond UNIX timestamp

NearAccountId

NearAccountId: string
# Named or Implicit NEAR account ID

PublicMintConfig

PublicMintConfig: {
price: float # public mint price of NFT, in $NEAR
starts_at: Timestamp
ends_at?: Timestamp
limit_per_account?: int
# if present, a single account won't be allowed to mint more than this limit
}

PrivateMintConfig

PrivateMintConfig: {
price: float # private mint price of NFT, in $NEAR
starts_at: Timestamp
ends_at?: Timestamp
limit_per_account?: int
# if present, a single account won't be allowed to mint more than this limit
limit_total?: int
# if present, total whitelist mints won't be allowed to exceed this limit
}
`

Royalties

Royalties: Record<string, float>
# mapping of NEAR account IDs to royalty percentages

CollectionDraft

CollectionDraft: {
uuid: string
# use this to perform actions on your ContractDraft
title: string
description: string
assets: CollectionDraftAsset[]
public_mint_config: PublicMintConfig | null
private_mint_config: PrivateMintConfig | null
private_mint_accounts: NearAccountId[]
initial_royalties: Royalties
ongoing_royalties: Royalties | null
bypass_mint_fee_accounts: NearAccountId[]
allow_approvals: bool
approvals_allowed_accounts: NearAccountId[]
approvals_denied_accounts: NearAccountId[]
allow_transfers: bool
transfers_denied_accounts: NearAccountId[]
created: Timestamp
updated: Timestamp
}

CollectionDraftAsset

CollectionDraftAsset: {
uuid: string
copies: int
asset_filename: string
asset_subtitle: string
reference_filename: string | null
created: Timestamp
updated: Timestamp
}

IpfsResult

IpfsResult: {
cid: string
# cid for IPFS directory containing all assets for this collection
file_urls: Record<string, string>
# mapping of filenames to IPFS URLs
upload_hashes: IpfsUploadHashRecord[]
}

IpfsUploadHashRecord

IpfsUploadHashRecord: {
Name: string
# filename
Hash: string
# IPFS cid for this file
# (not to be confused with "cid" property in IpfsResult,
# which is cid for IPFS directory containing all assets for this collection)
Size: string
# file size in bytes}

NearTransactionResult

NearTransactionResult
# see https://docs.near.org/concepts/basics/transactions/overview#transaction-status

Collection

Collection: {
uuid: string
name: string
description: string | null
public_mint_config: PublicMintConfig | null
private_mint_config: PrivateMintConfig | null
created: int
is_verified: bool
}

Token

Token: {
token_id: string
collection_id: int
owner_id: NearAccountId,
metadata: TokenMetadata,
approved_account_ids: Record | null
}

TokenMetadata

TokenMetadata: {
title: string
description: string
media: string
reference: string | null
asset_id: string
extra: string | null
royalties: Royalties | null
}
Last modified 1mo ago