Contract Details

Additional info on contract parameters and use cases

The parameters are used in the IPayload in the contract

E.g.:

const payload: ITransfer = {
  amount: 100 * 10 ** 6,
  receiver: 'receiverAddress',
  kda: 'KLV',
}

const Contract: IContract = {
  type: TransactionType.Transfer,
  payload,
}

Transfer

Transfer assets to another address.

Payload Parameters

Freeze

Freezes a certain amount of a token for staking. This frozen amount will be referred as a "bucket".

Payload Parameters

Unfreeze

Unfreezes a bucket.

Payload Parameters

Delegate

Delegates a bucket to a validator. Buckets can only be delegated to a validator address.

Payload Parameters

Undelegate

Removes the delegation of a bucket.

Payload Parameters

Claim

Claim either staking rewards, delegation rewards or expired marketplace orders.

Payload Parameters

Claim types All claim types and your function and referral param

Withdraw

Retrieves the assets from an unfrozen bucket or assets from KDAPool.

Payload Parameters

Withdraw Type

Create Asset

Creates a new fungible token or a NFT/SFT collection.

Payload Parameters

Staking Structure

Royalties Structure

RoyaltySplitInfo Structure

RoyaltyInfo structure

Role structure

Properties Structure

Attributes structure

Asset Trigger

Updates the properties or trigger functionalities of a fungible token, NFT collection or a single NFT.

The required parameters will depend on the trigger type. Trigger Type and AssetID are required in all of them.

Trigger Types: List with all trigger types values and its required payload

fields. You can see more info about each field here. Any parameter you send beyond the required ones will be ignored.

Payload Parameters

Royalties structure

RoyaltySplitInfo structure

RoyaltyInfo structure | Required | Parameter | Type | Description |

|:----------:|-----------------------|-------------------------|------------------------------------------| | | amount | number | Max amount for that percentage | | | percentage | number | Fee % (precision 2) |

KDAPool | Required | Parameter | Type | Description |

|:----------:|------------------|------------|--------------------------------------| | ✅ | active | boolean | True if the pooling should be active | | ✅ | adminAddress | string | Admin Address | | ✅ | fRatioKLV | number | Fixed ratio for KLV | | ✅ | fRatioKDA | number | Fixed ratio for KDA |

Fixed Ratio calculation:

Role Structure List with all role values | Required | Parameter | Type |

Description | |:----------:|---------------------------|------------|------------------------------------------| | ✅ | address | string | Target Address | | ✅ | hasRoleMint | boolean | Should be able to mint? | | ✅ | hasRoleSetITOPrices | boolean | Should be able to set ITO prices? |

Staking Structure | Required | Parameter | Type | Description |

|:----------:|--------------------------|------------|------------------------------------------| | ✅ | interestType | number | 0: APR, 1: FPR | | | apr | number | Percentage | | | minEpochsToClaim | number | Minimum epochs to claim rewards | | | minEpochsToUnstake | number | Minimum epochs to unstake | | | minEpochsToWithdraw | number | Minimum epochs to withdraw after unstake |

Deposit

Deposits an asset into a FPR pool or into an auto-swapping fee system.

Payload Parameters

Deposit Type | Type ID | Type Name | Description |

|:-------:|-------------|-------------------------------------------------| | 0 | FPR Deposit | Deposits an amount of currency to be distributed to all holders of target asset. | | 1 | KDA Pool | Deposits an amount of KLV to pay the fees of the target asset's transactions. |

Config ITO

Sets up an Initial Token Offering for either a token or a NFT collection.

Payload Parameters

Pack structure

WhiteListInfo structure

Status | Status Value | Status Name | Description |

|--------------|-------------|--------------------------| | 0 | DefaultITO | Keeps previous status value | | 1 | ActiveITO | Enables ITO/Whitelist | | 2 | PausedITO | Pauses ITO/Whitelist |

ITO Trigger

Updates the properties or trigger functionalities of a fungible token, NFT collection or a single NFT.

The required parameters will depend on the trigger type. Trigger Type and AssetID are required in all of them.

Trigger Types List with all trigger types values and its required payload

fields. You can see more info about each field here. Any parameter you send beyond the required ones will be ignored.

Payload Parameters

Obs: Javascript's Date.prototype.getTime() should be divided by 1000 for it to be converted to Unix Time (seconds)

Status | Status Value | Status Name | Description |

|--------------|-------------|------------------------------------| | 0 | DefaultITO | Keeps previous status value | | 1 | ActivelTO | Enables ITO/Whitelist | | 2 | PausedITO | Pauses ITO/Whitelist |

Pack structure

WhiteListInfo structure

Set ITO Prices

DEPRECATED: Updates the ITO prices, useful for ITO's that use an oracle-like pricing system.

This contract is deprecated, please use an ITO Trigger of type SetITOPrices.

Payload Parameters

Pack structure

Create Marketplace

Creates a marketplace

Payload Parameters

Config Marketplace

Changes the parameters of a marketplace

Payload Parameters

Sell

Payload Parameters

price is required on Instant Sell Orders, but optional in Auction Orders. As explained below:

Obs: Javascript's Date.prototype.getTime() should be divided by 1000 for it to be converted to Unix Time (seconds)

Buy

Creates a buy (or bid) order for a given market sell order.

Payload Parameters

Send the 'amount' parameter with the correct precision based on the currency asset

Cancel Market Order

Cancels a sell order

Payload Parameters

Proposal

Creates a proposal to change the chain network parameters.

Payload Parameters

Parameter key | ID | Type | Description | | -- | ------------------------- |

----------------------------------------- | | 0 | FeePerDataByte | Bandwidth fee value | | 1 | KAppFeeCreateValidator | Create validator fee value | | 2 | KAppFeeCreateAsset | Asset fee value | | 3 | MaxEpochsUnclaimed | Max unclaimed time (in epochs) for buckets| | 4 | MinSelfDelegatedAmount | Min self-delegated amount needed to be a validator | | 5 | MinTotalDelegatedAmount | Min total delegated amount needed to be a validator | | 6 | BlockRewards | Block rewards for validators | | 7 | StakingRewards | Staking rewards value | | 8 | KApp Fee for Transfer | KApp Fee for Transfer | | 9 | KApp Fee for Asset Trigger| KApp Fee for Asset Trigger | | 10 | KApp Fee for Validator Config | KApp Fee for Validator Config | | 11 | KApp Fee for Freeze | KApp Fee for Freeze| | 12 | KApp Fee for Unfreeze | KApp Fee for Unfreeze | | 13 | KApp Fee for Delegation | KApp Fee for Delegation | | 14 | KApp Fee for Delegation | KApp Fee for Delegation | | 15 | KApp Fee for Withdraw | KApp Fee for Withdraw | | 16 | KApp Fee for Claim | KApp Fee for Claim | | 17 | KApp Fee for Unjail | KApp Fee for Unjail | | 18 | KApp Fee for Account Name | KApp Fee for Account Name | | 19 | KApp Fee for Proposal | KApp Fee for Proposal | | 20 | KApp Fee for Vote | KApp Fee for Vote | | 21 | KApp Fee for Config ITO | KApp Fee for Config ITO | | 22 | KApp Fee for Set ITO Prices | KApp Fee for Set ITO Prices | | 23 | KApp Fee for Buy | KApp Fee for Buy | | 24 | KApp Fee for Sell | KApp Fee for Sell | | 25 | KApp Fee for Cancel Market Order | KApp Fee for Cancel Market Order | | 26 | KApp Fee for Marketplace Creation | KApp Fee for Marketplace Creation | | 27 | KApp Fee for Config Marketplace | KApp Fee for Config Marketplace | | 28 | KApp Fee for Update Account Permission | KApp Fee for Update Account Permission | | 29 | Max NFT Mint per batch | Max NFT Minted in one contract | | 30 | Min KFI staked to enable Proposals Kapps | Min overall KFI staked to enable Proposals | | 31 | Min KLV Bucket Amount | Minimum KLV Amount per bucket | | 32 | Max bucket size | Max buckets per account | | 33 | Leader Validator rewards percentage | Leader Validator rewards percentage | | 34 | Max Epochs for active proposal duration | Max Epochs an proposal will remain active | | 35 | KApp Fee for ITO Trigger | KApp Fee for ITO Trigger | | 36 | KApp Fee for Deposit | KApp Fee for Deposit |

Vote

Votes on an active proposal, the weight of the vote depends on the staked KFI of the sender address (The KFI is not consumed).

Payload Parameters

Create Validator

Creates a validator for an address, controlled by a BLS key.

Payload Parameters

*Object in which the keys are the URI labels and the values are the URIs

Config Validator

Changes the params of a given validator.

Payload Parameters

*Object in which the keys are the URI labels and the values are the URIs

Unjail

Sends an unjail request for the sender validator address.

Payload Parameters

Send Unjail request of sender address, no params required.

Set Account Name

Defines a name for the account.

Payload Parameters

Update Account Permission

Updates the permissions of an account, setting multi-signature permissions with a set signature threshold. Useful for creating a safely shared account.

Payload Parameters

AccPermission structure | Required | Parameter | Type | Description |

|----------|-----------|--------|---------------------------------| | ✅ |type | number | 0: Owner, 1: User | | ✅ |permissionName | string | Permission identifier | | ✅ |threshold | number | Minimum sign amount to permit transaction | | ✅ |operations | string | See Operations | | ✅ |signers | AccKey object array | Defines the weight of the accounts' votes |

AccKey structure | Required | Parameter | Type | Description |

|----------|-----------|--------|---------------------------------| | ✅ |address | string | Target address | | ✅ |weight | number | Target address vote weight |

Operations

The operations property defines which operations the account should be able to do.

The value that this property receives is a hexadecimal string, where each bit represents a contract.

Ex:

"01af" is the hexadecimal to 000110101111.

The 1's represent the contracts it should be able to do (following this table)

This account will be able to do contracts of type 0, 1, 2, 3, 5, 7, 8 (Transfer, Create Asset, Create Validator, Config Validator, Unfreeze, Undelegate, Withdraw).

Relevant Link: binary to hex calculator

After getting the hexadecimal string, you need to invert the byte order, for proper processing in the blockchain.

you can use either of the following JS code to do so:

utils.parseAccountPermissionBinaryOperations('000110101111')

utils.reverseHexBytes('01af')

Both return the same "af01" which is the correct value for said operations.