Skip to main content

sdk

Home > @openformat/sdk

Typescript SDK Package

Classes

ClassDescription
App

A class representing a App contract that extends the BaseContract class.

BaseContract

BaseContractCreates a new instance of the BaseContract which manages the provider and signer
Constellation

Represents an ERC20 contract instance with utility methods to interact with an ERC20 contract

ERC20 BaseContract

ERC20Base

Represents an ERC20 contract instance with utility methods to interact with an ERC20 contract

ERC20 BaseContract

ERC721BaseRepresents an ERC721 contract instance with utility methods to interact with an ERC721 contract ERC721 BaseContract
ERC721LazyDrop

A class representing a ERC721LazyDrop contract that extends the BaseContract class.

BaseContract

ERC721LazyMintRepresents an ERC721 contract instance with utility methods to interact with an ERC721 contract ERC721 BaseContract
Factory

A class representing a Factory contract that extends the BaseContract class.

BaseContract

OpenFormatSDKCreates a new instance of the Open Format SDK
Reward

A class representing a Reward contract that extends the BaseContract class.

RewardContract

SubgraphCreates a new Subgraph instance

Enumerations

EnumerationDescription
ActivityType
ContractErrors
ContractType
ImplementationType
RewardType

Functions

FunctionDescription
fromWei(amount)Convert a wei amount as a BigNumber to its decimal Ether representation (ETH) as a string.
toWei(amount)Convert a decimal Ether amount (ETH) to its smallest unit (wei) as a BigNumber.

Interfaces

InterfaceDescription
AppHasCreatorAccessParams
AppResponse
AppSetAcceptedCurrenciesParams
AppSetApplicationFeeParams
AppSetCreatorAccessParams
ContractResponse
Contracts
ERC20AllowanceParams
ERC20ApproveParams
ERC20BalanceOfParams
ERC20BurnParams
ERC20CreateParams
ERC20GrantRoleParams
ERC20MintParams
ERC20SetMetadataURIParams
ERC20TotalSupplyParams
ERC20TransferFromParams
ERC20TransferParams
ERC721ApproveParams
ERC721BalanceOfParams
ERC721BatchMintParams
ERC721BurnParams
ERC721CreateParams
ERC721GetApprovedParams
ERC721LazyDrop_ClaimParams
ERC721LazyDrop_GetClaimConditionParams
ERC721LazyDrop_RemoveClaimConditionParams
ERC721LazyDrop_SetClaimConditionParams
ERC721LazyDrop_VerifyClaimParams
ERC721LazyMint_BatchMintParams
ERC721LazyMint_BurnParams
ERC721LazyMint_ClaimParams
ERC721LazyMint_GetClaimConditionParams
ERC721LazyMint_LazyMintParams
ERC721LazyMint_MintParams
ERC721LazyMint_RemoveClaimConditionParams
ERC721LazyMint_SetClaimConditionParams
ERC721LazyMint_SetMinterRoleParams
ERC721LazyMint_TransferParams
ERC721LazyMint_VerifyClaimParams
ERC721MintParams
ERC721NextTokenIdToMintParams
ERC721OwnerOfParams
ERC721SetApprovalForAllParams
ERC721SetMinterRoleParams
ERC721TokenURIParams
ERC721TotalSupplyParams
ERC721TransferParams
Reward_CreateBadgeParams
RewardToken
RewardTriggerParams
SDKOptions

Variables

VariableDescription
ADMIN_ROLE
Chains
constellationFactoryContracts
MINTER_ROLE
polygonMumbai
starFactoryContracts
Subgraphs

Type Aliases

Type AliasDescription
ChainId
ClaimCondition
GetContractParameters
OpenFormatContract