Members
KeyNotification
# KeyNotification
Type of Key Config Email (ALL, SettlementRequest, DepositRequest, WithdrawalRequest, TransferRequest, MintRequest, FullWithdrawalRequest, FalseFullWithdrawalRequest, BulkTransferTransactionsResult, MultiTransactionRequest, RoyaltyTransferRequest, TokenBurnRequest ) KeyNotification.All: Config All option notification email KeyNotification.SettlementRequest: Config SettlementRequest KeyNotification.DepositRequest: Config DepositRequest KeyNotification.WithdrawalRequest: Config WithdrawalRequest KeyNotification.TransferRequest: Config TransferRequest KeyNotification.MintRequest: Config MintRequest KeyNotification.FullWithdrawalRequest: Config FullWithdrawalRequest KeyNotification.FalseFullWithdrawalRequest: Config FalseFullWithdrawalRequest KeyNotification.BulkTransferTransactionsResult: Config BulkTransferTransactionsResult KeyNotification.MultiTransactionRequest: Config MultiTransactionRequest KeyNotification.RoyaltyTransferRequest: Config RoyaltyTransferRequest KeyNotification.TokenBurnRequest: Config TokenBurnRequest
Methods
# async WithdrawOnchainParams(withdrawalParams, options) → {Promise.<TxResult>}
The withdraw on-chain function to withdraw the Tokens available in the On-chain to User's Wallet
Parameters:
| Name | Type | Description |
|---|---|---|
withdrawalParams |
WithdrawOnchainParams
|
The withdraw on-chain params where it include both of the StarkKey and AssetType |
options |
SendOptions
|
The native options for withdraw on-chain options |
The promise with transaction results
Promise.<TxResult>
# waitFor()
Util function to return a promise which is resolved in provided milliseconds
Type Definitions
enum
# AssetStatus
Status to indicate the asset state on system
- MINT_FAILED: The asset has been minted failed on system due to some of potential reason
- MINTING: The minting is on processing at system
- MINTED: The asset has been minted successfully in Myria System
- UNKNOWN: Unknown status of the assets
- WITHDRAWING: The withdraw offchain is progressing on background at System
- WITHDRAWAL_COMPLETED: The full process of withdraw is completed. Users has received on-chain balance in Metamask already.
enum
# FeeTypes
Properties:
| Name | Type | Description |
|---|---|---|
id |
number
|
ID of fee on the database |
address |
string
|
The wallet address to receive the fee |
percentage |
number
|
The percentage of fee for purchased/traded transaction |
feeType |
string
|
Type of FEE (currently support for ROYALTY only) |
id |
number
|
|
address |
string
|
|
percentage |
number
|
|
feeType |
string
|
Object
# OwnerAssetsCount
Properties:
| Name | Type | Description |
|---|---|---|
starkKey |
string
|
Stark key of the owner's NFT |
totalAssets |
string
|
Total assets that the users owns |
starkKey |
string
|
|
totalAssets |
string
|
Object
# PaginationType
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
limit |
number
|
<optional> |
Maximum items per page |
page |
page
|
<optional> |
the index of page |
route |
route
|
<optional> |
the suggested link to route to related API |
limit |
number
|
<optional> |
|
page |
number
|
<optional> |
|
route |
string
|
<optional> |
string
# TransactionType
Type of transaction (Settlement/Deposit/Withdrawal/Transfer/Mint/FullWithdrawal)
Object
# WithdrawAndMintParams
Properties:
| Name | Type | Description |
|---|---|---|
starkKey |
string
|
The stark public key of user |
walletAddress |
string
|
The eth wallet address that is to intend for withdrawAndMint |
assetType |
string
|
The hex string to identify the assets/tokens (computed with Starkware algorithm) |
mintingBlob |
string
|
The minting blob as the unique string and immutable data for the assets which is stored in the on-chain |
starkKey |
string
|
|
walletAddress |
string
|
|
assetType |
string
|
|
mintingBlob |
string
|
Object
# WithdrawOnchainParams
The withdraw on-chain function to withdraw the Tokens available in the On-chain to User's Wallet
Object
# WithdrawOnchainParams
Properties:
| Name | Type | Description |
|---|---|---|
starkKey |
string
|
The stark public key of user |
assetType |
string
|
The hex string to identify the assets/tokens (computed with Starkware algorithm) |
starkKey |
string
|
|
assetType |
string
|