Releases: ground-x/caver-js-ext-kas
v1.12.0 Release Notes
v1.12.0 Release Notes
New Features
-
Metadata New SDK
uploadKIPMetadataWithAsset
When you insert an image object into Metadata image field, Asset Upload and Metadata Upload are performed simultaneously.- Functions to use the
uploadKIPMetadataWithAsset
.- caver.kas.metadata.uploadKIPMetadataWithAsset(metadata, filename, krn, callback)
-
Storage Settings Support.
-
How to Set Metadata Storage.
- caver.kas.metadata.uploadMetadata(metadata [,filename] [,krn] [,callback])
- caver.kas.metadata.uploadAsset(file [, krn] [, callback])
- caver.kas.metadata.uploadKIPMetadataWithAsset(metadata [,filename] [,krn] [,callback])
-
For more scenarios in detail, refer to KAS Ref Docs
-
v1.11.0 Release Notes
v1.11.0 Release Notes
New Features
-
Supports KAS KIP-37 v2 API.
-
KAS KIP-37 v2 API is available with
caver.kas.kip37
by implementingcaver.initKIP37API(chainId, accessKeyId, secretAccessKey , url , 2)
orcaver.initKIP37API(chainId, accessKeyId, secretAccessKey, 2)
. If you do not enter a version, it is set to v1.
If you would like to know the difference between v1 and v2, please refer to the compatibility docs. -
Functions to use the KIP-17 v2 API service newly provided by KAS.
- caver.kas.kip37.deploy
POST /v2/contract
- caver.kas.kip37.importContract
POST /v2/contract/import
- caver.kas.kip37.updateContractOptions
PUT /v2/contract/{contract-address-or-alias}
- caver.kas.kip37.getContract
GET /v2/contract/{contract-address-or-alias}
- caver.kas.kip37.getContractList
GET /v2/contract
- caver.kas.kip37.transferOwnership
POST /v2/contract/{contract-address-or-alias}/owner/transfer
- caver.kas.kip37.getContractOwner
GET /v2/contract/{contract-address-or-alias}/owner
- caver.kas.kip37.renounceOwnership
DELETE /v2/contract/{contract-address-or-alias}/owner
- caver.kas.kip37.getTokenListByOwner
GET /v2/contract/{contract-address-or-alias}/owner/{owner-address}/token
- caver.kas.kip37.getTokenList
GET /v2/contract/{contract-address-or-alias}/token
- caver.kas.kip37.setApprovalForAll
POST /v2/contract/{contract-address-or-alias}/approveall
- caver.kas.kip37.pause
POST /v2/contract/{contract-address-or-alias}/pause
- caver.kas.kip37.unpause
POST /v2/contract/{contract-address-or-alias}/unpause
- caver.kas.kip37.pauseToken
POST /v2/contract/{contract-address-or-alias}/token/pause/{token-id}
- caver.kas.kip37.unpauseToken
POST /v2/contract/{contract-address-or-alias}/token/unpause/{token-id}
- caver.kas.kip37.create
POST /v2/contract/{contract-address-or-alias}/token
- caver.kas.kip37.burn
DELETE /v2/contract/{contract-address-or-alias}/token
- caver.kas.kip37.mint
POST /v2/contract/{contract-address-or-alias}/token/mint
- caver.kas.kip37.transfer
POST /v2/contract/{contract-address-or-alias}/token/transfer
- caver.kas.kip37.getDeployer
GET /v2/deployer/default
- caver.kas.kip37.deploy
-
-
Supports KAS Resource API.
- Functions to use the Resource API service newly provided by KAS.
- caver.kas.wallet.getResourceList
GET v1/resource/account/{account-id}
- caver.kas.wallet.getResourceList
- Functions to use the Resource API service newly provided by KAS.
Improvements
- Change KIP17, KIP37 version type from string to number
-
If users want version 2, init like this
caver.initKIP37API(chainId, accessKeyId, secretAccessKey [, url] , 2)
-
For more scenarios in detail, refer to KAS Ref Docs
-
Release v1.10.0
v1.10.0 Release Notes
New Features
-
Supports KAS KIP-17 v2 API.
-
KAS KIP-17 v2 API is available with
caver.kas.kip17
by implementingcaver.initKIP17API(chainId, accessKeyId, secretAccessKey, url, 'v2')
. If you do not enter a version, it is set to v1.
If you would like to know the difference between v1 and v2, please refer to the compatibility docs. -
Functions to use the KIP-17 v2 API service newly provided by KAS.
- caver.kas.kip17.deploy
POST /v2/contract
- caver.kas.kip17.getContractList
GET /v2/contract
- caver.kas.kip17.getContract
GET /v2/contract/{contract-address-or-alias}
- caver.kas.kip17.updateContractOptions
PUT /v2/contract/{contract-address-or-alias}
- caver.kas.kip17.transferOwnership
POST /v2/contract/{contract-address-or-alias}/owner/transfer
- caver.kas.kip17.getContractOwner
GET /v2/contract/{contract-address-or-alias}/owner
- caver.kas.kip17.renounceOwnership
DELETE /v2/contract/{contract-address-or-alias}/owner
- caver.kas.kip17.mint
POST /v2/contract/{contract-address-or-alias}/token
- caver.kas.kip17.getTokenList
GET /v2/contract/{contract-address-or-alias}/token
- caver.kas.kip17.getToken
GET /v2/contract/{contract-address-or-alias}/token/{token-id}
- caver.kas.kip17.transfer
POST /v2/contract/{contract-address-or-alias}/token/{token-id}
- caver.kas.kip17.burn
DELETE /v2/contract/{contract-address-or-alias}/token/{token-id}
- caver.kas.kip17.approve
POST /v2/contract/{contract-address-or-alias}/approve/{token-id}
- caver.kas.kip17.approveAll
POST /v2/contract/{contract-address-or-alias}/approveall
- caver.kas.kip17.getTokenListByOwner
GET /v2/contract/{contract-address-or-alias}/owner/{owner-address}
- caver.kas.kip17.getTransferHistory
GET /v2/contract/{contract-address-or-alias}/token/{token-id}/history
- caver.kas.kip17.deploy
-
-
Supports new features in KAS TokenHistory API.
- Functions to use the TokenHistory API service newly provided by KAS.
- caver.kas.tokenHistory.getNFTHolder
GET /v2/contract/nft/{nft-address}/holder
- caver.kas.tokenHistory.getMTHolder
GET /v2/contract/mt/{mt-address}/holder
- caver.kas.tokenHistory.getMTList
GET /v2/contract/mt/{mt-address}/token
- caver.kas.tokenHistory.getNFTHolder
- Functions to use the TokenHistory API service newly provided by KAS.
-
Supports new features in KAS MetaData API.
- Functions to use the MetaData API service newly provided by KAS.
- caver.kas.metaData.uploadMetadata
POST /v1/metadata
- caver.kas.metaData.uploadAsset
POST /v1/metadata/asset
- caver.kas.metaData.uploadMetadata
- For more scenarios in detail, refer to KAS Ref Docs
- Functions to use the MetaData API service newly provided by KAS.
Release v1.9.0
v1.9.0 Release Notes
New Features
- Supports KAS KIP-37 API.
- Functions to use the KIP-37 API service newly provided by KAS.
- caver.kas.kip37.deploy
POST /v1/contract
- caver.kas.kip37.importContract
POST /v1/contract/import
- caver.kas.kip37.updateContractOptions
PUT /v1/contract/{contract-address-or-alias}
- caver.kas.kip37.getContract
GET /v1/contract/{contract-address-or-alias}
- caver.kas.kip37.getContractList
GET /v1/contract
- caver.kas.kip37.getTokenListByOwner
GET /v1/contract/{contract-address-or-alias}/owner/{owner-address}/token
- caver.kas.kip37.getTokenList
GET /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.setApprovalForAll
POST /v1/contract/{contract-address-or-alias}/approveall
- caver.kas.kip37.pause
POST /v1/contract/{contract-address-or-alias}/pause
- caver.kas.kip37.unpause
POST /v1/contract/{contract-address-or-alias}/unpause
- caver.kas.kip37.pauseToken
POST /v1/contract/{contract-address-or-alias}/token/pause/{token-id}
- caver.kas.kip37.unpauseToken
POST /v1/contract/{contract-address-or-alias}/token/unpause/{token-id}
- caver.kas.kip37.create
POST /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.burn
DELETE /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.mint
POST /v1/contract/{contract-address-or-alias}/token/mint
- caver.kas.kip37.transfer
POST /v1/contract/{contract-address-or-alias}/token/transfer
- caver.kas.kip37.getDeployer
GET /v1/deployer/default
- caver.kas.kip37.deploy
- KAS KIP-37 API is available with
caver.kas.kip37
by implementingcaver.initKASAPI(chainId, accessKeyId, secretAccessKey)
orcaver.initKIP37API(chainId, accessKeyId, secretAccessKey [, url])
. If query parameters are required when using the KIP-37 API, it can be used throughcaver.kas.kip37.queryOptions
. For more scenarios in detail, refer to KAS Docs.
- Functions to use the KIP-37 API service newly provided by KAS.
- Supports new features in KAS KIP-7 API.
- Function to deploy KIP-7 contracts with fee payer options. You can use fee payer options with
caver.kas.kip7.feePayerOptions
.- caver.kas.kip7.deploy
POST /v1/contract
- caver.kas.kip7.deploy
- Function to update fee payer options of the KIP-7 contract with fee payer options. You can use fee payer options with
caver.kas.kip7.feePayerOptions
.- caver.kas.kip7.updateContractOptions
PUT v1/contract/{contract-address-or-alias}
- caver.kas.kip7.updateContractOptions
- Function to pause/unpause the KIP-7 contract with a pauser.
- caver.kas.kip7.pause
POST /v1/contract/{contract-address-or-alias}/pause
- caver.kas.kip7.unpause
POST /v1/contract/{contract-address-or-alias}/unpause
- caver.kas.kip7.pause
- Function to add/renounce pauser.
- caver.kas.kip7.addPauser
POST v1/contract/{contract-address-or-alias}/pauser
- caver.kas.kip7.renouncePauser
DELETE v1/contract/{contract-address-or-alias}/pauser
- caver.kas.kip7.addPauser
- Function to mint KIP-7 tokens with a minter.
- caver.kas.kip7.mint
POST v1/contract/{contract-address-or-alias}/mint
- caver.kas.kip7.mint
- Function to add/renounce minter.
- caver.kas.kip7.addMinter
POST v1/contract/{contract-address-or-alias}/minter
- caver.kas.kip7.renounceMinter
DELETE v1/contract/{contract-address-or-alias}/minter
- caver.kas.kip7.addMinter
- For more scenarios in detail, refer to KAS Docs.
- Function to deploy KIP-7 contracts with fee payer options. You can use fee payer options with
- Supports new features in KAS KIP-17 API.
- Function to deploy a KIP-17 contract with fee payer options. You can use fee payer options with
caver.kas.kip17.feePayerOptions
.- caver.kas.kip17.deploy
POST /v1/contract
- caver.kas.kip17.deploy
- Function to update fee payer options of the KIP-17 contract with fee payer options. You can use fee payer options with
caver.kas.kip17.feePayerOptions
.- caver.kas.kip17.updateContractOptions
PUT v1/contract/{contract-address-or-alias}
- caver.kas.kip17.updateContractOptions
- Function to deploy a KIP-17 contract with fee payer options. You can use fee payer options with
- Supports new features in KAS Wallet API.
- Function to create a fee payer account with the
withoutAccountUpdate
parameter. If you definewithoutAccountUpdate
astrue
, KAS will not update the fee payer account.- caver.kas.wallet.createFeePayer
POST /v2/feepayer
- caver.kas.wallet.createFeePayer
- Function to query a key list by KRN (KAS Resource Name).
- caver.kas.wallet.getKeyListByKRN
GET /v2/key
- caver.kas.wallet.getKeyListByKRN
- Function to get a fee delegated transaction list. This API works with the Cypress network only.
- caver.kas.wallet.getFDTransactionList
GET /v2/history/fd/tx
- caver.kas.wallet.getFDTransactionList
- Function to get a fee delegated transaction by hash. This API works with the Cypress network only.
- caver.kas.wallet.getFDTransaction
GET /v2/history/fd/tx/{transaction-hash}
- caver.kas.wallet.getFDTransaction
- For more scenarios in detail, refer to KAS Docs.
- Function to create a fee payer account with the
Release v1.9.0-rc.2
Release v1.9.0-rc.1
v1.9.0-rc.1 Release Notes
New Features
- Supported KAS KIP-37 API.
- Functions to use the KIP-37 API service newly provided by KAS.
- caver.kas.kip37.deploy
POST /v1/contract
- caver.kas.kip37.importContract
POST /v1/contract/import
- caver.kas.kip37.updateContractOptions
PUT /v1/contract/{contract-address-or-alias}
- caver.kas.kip37.getContract
GET /v1/contract/{contract-address-or-alias}
- caver.kas.kip37.getContractList
GET /v1/contract
- caver.kas.kip37.getTokenListByOwner
GET /v1/contract/{contract-address-or-alias}/owner/{owner-address}/token
- caver.kas.kip37.getTokenList
GET /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.setApprovalForAll
POST /v1/contract/{contract-address-or-alias}/approveall
- caver.kas.kip37.pause
POST /v1/contract/{contract-address-or-alias}/pause
- caver.kas.kip37.unpause
POST /v1/contract/{contract-address-or-alias}/unpause
- caver.kas.kip37.pauseToken
POST /v1/contract/{contract-address-or-alias}/token/pause/{token-id}
- caver.kas.kip37.unpauseToken
POST /v1/contract/{contract-address-or-alias}/token/unpause/{token-id}
- caver.kas.kip37.create
POST /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.burn
DELETE /v1/contract/{contract-address-or-alias}/token
- caver.kas.kip37.mint
POST /v1/contract/{contract-address-or-alias}/token/mint
- caver.kas.kip37.transfer
POST /v1/contract/{contract-address-or-alias}/token/transfer
- caver.kas.kip37.getDeployer
GET /v1/deployer/default
- caver.kas.kip37.deploy
- KAS KIP-37 API is available with
caver.kas.kip37
by implementingcaver.initKASAPI(chainId, accessKeyId, secretAccessKey)
orcaver.initKIP37API(chainId, accessKeyId, secretAccessKey [, url])
. If the query parameters are required when using the KIP-37 API, it can be used throughcaver.kas.kip37.queryOptions
. For more scenarios in detail, refer to KAS Docs.
- Functions to use the KIP-37 API service newly provided by KAS.
- Supported new features in KAS KIP-7 API.
- Function to deploy a KIP-7 cotract with a fee payer options. You can use fee payer options with
caver.kas.kip7.feePayerOptions
.- caver.kas.kip7.deploy
POST /v1/contract
- caver.kas.kip7.deploy
- Function to update fee payer options of the KIP-7 cotract with a fee payer options. You can use fee payer options with
caver.kas.kip7.feePayerOptions
.- caver.kas.kip7.updateContractOptions
PUT v1/contract/{contract-address-or-alias}
- caver.kas.kip7.updateContractOptions
- Function to pause/unpause the KIP-7 cotract with a pauser.
- caver.kas.kip7.pause
POST /v1/contract/{contract-address-or-alias}/pause
- caver.kas.kip7.unpause
POST /v1/contract/{contract-address-or-alias}/unpause
- caver.kas.kip7.pause
- Function to add/renounce pauser.
- caver.kas.kip7.addPauser
POST v1/contract/{contract-address-or-alias}/pauser
- caver.kas.kip7.renouncePauser
DELETE v1/contract/{contract-address-or-alias}/pauser
- caver.kas.kip7.addPauser
- Function to mint the KIP-7 token with a minter.
- caver.kas.kip7.mint
POST v1/contract/{contract-address-or-alias}/mint
- caver.kas.kip7.mint
- Function to add/renounce minter.
- caver.kas.kip7.addMinter
POST v1/contract/{contract-address-or-alias}/minter
- caver.kas.kip7.renounceMinter
DELETE v1/contract/{contract-address-or-alias}/minter
- caver.kas.kip7.addMinter
- For more scenarios in detail, refer to KAS Docs.
- Function to deploy a KIP-7 cotract with a fee payer options. You can use fee payer options with
- Supported new features in KAS KIP-17 API.
- Function to deploy a KIP-17 cotract with a fee payer options. You can use fee payer options with
caver.kas.kip17.feePayerOptions
.- caver.kas.kip17.deploy
POST /v1/contract
- caver.kas.kip17.deploy
- Function to update fee payer options of the KIP-17 cotract with a fee payer options. You can use fee payer options with
caver.kas.kip17.feePayerOptions
.- caver.kas.kip17.updateContractOptions
PUT v1/contract/{contract-address-or-alias}
- caver.kas.kip17.updateContractOptions
- Function to deploy a KIP-17 cotract with a fee payer options. You can use fee payer options with
- Supported new features in KAS Wallet API.
- Function to create a fee payer account with
withoutAccountUpdate
parameter. If you definewithoutAccountUpdate
astrue
, KAS will not update the fee payer account.- caver.kas.wallet.createFeePayer
POST /v2/feepayer
- caver.kas.wallet.createFeePayer
- Function to query a key list by KRN(KAS resource name).
- caver.kas.wallet.getKeyListByKRN
GET /v2/key
- caver.kas.wallet.getKeyListByKRN
- Function to get a fee delegated transaction list. This API works with the Cypress network only.
- caver.kas.wallet.getFDTransactionList
GET /v2/history/fd/tx
- caver.kas.wallet.getFDTransactionList
- Function to get a fee delegated transaction by hash. This API works with the Cypress network only.
- caver.kas.wallet.getFDTransaction
GET /v2/history/fd/tx/{transaction-hash}
- caver.kas.wallet.getFDTransaction
- For more scenarios in detail, refer to KAS Docs.
- Function to create a fee payer account with
Release v1.4.1-rc.1
v1.4.1-rc.1 Release Notes
Fixes
- Modified mistypo in
caver.kas.tokenHistory.getTokenListByOwner
API reference. (#127)
Release v1.4.0
v1.4.0 Release Notes
Breaking Change
- The
caver.kas.wallet.signMessage
does not supportkrn
parameter. This function has been changed to work using the KAS user's default krn.
New Features
- Supported KAS KIP-7 API.
- Functions to use the KIP-7 API service newly provided by KAS.
- caver.kas.kip7.deploy
POST /v1/contract
- caver.kas.kip7. getContract
GET /v1/contract/{contract-address-or-alias}
- caver.kas.kip7. getContractList
GET /v1/contract
- caver.kas.kip7. allowance
GET /v1/contract/{contract-address-or-alias}/account/{owner}/allowance/{spender}
- caver.kas.kip7. balance
GET /v1/contract/{contract-address-or-alias}/account/{owner}/balance
- caver.kas.kip7. approve
POST /v1/contract/{contract-address-or-alias}/approve
- caver.kas.kip7. transfer
POST /v1/contract/{contract-address-or-alias}/transfer
- caver.kas.kip7. transferFrom
POST /v1/contract/{contract-address-or-alias}/transfer-from
- caver.kas.kip7. mint
POST /v1/contract/{contract-address-or-alias}/mint
- caver.kas.kip7. burn
POST /v1/contract/{contract-address-or-alias}/burn
- caver.kas.kip7. burnFrom
POST /v1/contract/{contract-address-or-alias}/burn-from
- caver.kas.kip7. pause
POST /v1/contract/{contract-address-or-alias}/pause
- caver.kas.kip7. unpause
POST /v1/contract/{contract-address-or-alias}/unpause
- caver.kas.kip7. getDeployer
GET /v1/deployer/default
- caver.kas.kip7.deploy
- KAS KIP-7 API is available with caver.kas.kip7 by implementing caver.initKASAPI(chainId, accessKeyId, secretAccessKey) or caver.initKIP7API(chainId, accessKeyId, secretAccessKey [, url]). If the query parameters are required when using the KIP-7 API, it can be used through caver.kas.kip7.queryOptions. For more scenarios in detail, refer to KAS Docs.
- Functions to use the KIP-7 API service newly provided by KAS.
- Supported Fee Payer API functions in KAS Wallet API.
- Functions to use fee payer via KAS Wallet API.
- caver.kas.wallet.createFeePayer
POST /v2/feepayer
- caver.kas.wallet.deleteFeePayer
DELETE /v2/feepayer/{address}
- caver.kas.wallet.getFeePayer
GET /v2/feepayer/{address}
- caver.kas.wallet.getFeePayerList
GET /v2/feepayer
- caver.kas.wallet.createFeePayer
- For more scenarios in detail, refer to KAS Docs.
- Functions to use fee payer via KAS Wallet API.
- Supported new Key API function in KAS Wallet API.
- Function to delete a key in KAS Wallet API.
- caver.kas.wallet.deleteKey
DELETE /v2/key/{key-id}
- caver.kas.wallet.deleteKey
- For more scenarios in detail, refer to KAS Docs.
- Function to delete a key in KAS Wallet API.
- Supported new API functions and query parameters in KAS Token History API.
- Functions for integrated inquiry of tokens and contracts newly provided by KAS.
- caver.kas.wallet.getContractListByOwner
GET /v2/account/{address}/contract
- caver.kas.wallet.getTokenListByOwner
GET /v2/account/{address}/token
- caver.kas.wallet.getContractListByOwner
- New query parameters newly provided by KAS.
- You can use
excludeZeroKlay
query parameter withcaver.kas.tokenHistory.getTransferHistory
. - You can use
fromOnly
,toOnly
andexcludeZeroKlay
query parameters withcaver.kas.tokenHistory.getTransferHistoryByAccount
.
- You can use
- For more scenarios in detail, refer to KAS Docs.
- Functions for integrated inquiry of tokens and contracts newly provided by KAS.
- Supported websocket provider with KAS Node API.
- Use KAS Node API service via websocket provider.
- Provided additional
caver.initNodeAPIWithHttp
, a function that initializes to use KAS Node API using an Http provider. - Provided additional
caver.initNodeAPIWithWebSocket
, a function that initializes to use KAS Node API using an WebSocket provider. - The CaverExtKAS contstructor supports websocket through
const caver = new CaverExtKAS(chainId, accessKeyId, secretAccessKey, { useNodeAPIWithHttp: false })
. - The initKASAPI supports websocket through
caver.initKASAPI(chainId, accessKeyId, secretAccessKey, { useNodeAPIWithHttp: false })
. - The initNodeAPI supports websocket through
caver.initNodeAPI(chainId, accessKeyId, secretAccessKey, false [, url])
.
- Provided additional
- For more scenarios in detail, refer to KAS Docs.
- Use KAS Node API service via websocket provider.
Improvements
- Deleted the
krn
parameter to allow users to implement the function using the defaultkrn
in thecaver.kas.wallet.signMessage
. (#117) - Since KAS does not support inquiring the number of accounts by specifying krn, the
krn
parameter is disabled in thecaver.kas.wallet.getAccountCountByKRN
function. (#117)
Release v1.4.0-rc.4
v1.4.0-rc.4 Release Notes
Improvements
- Added detail comments in
caver.initNodeAPIWithWebSocket
. (#126)
Release v1.4.0-rc.3
v1.4.0-rc.3 Release Notes
New Features
- Supported websocket provider with KAS Node API.
- Use KAS Node API service via websocket provider.
- Provided additional
caver.initNodeAPIWithHttp
, a function that initializes to use KAS Node API using an Http provider. - Provided additional
caver.initNodeAPIWithWebSocket
, a function that initializes to use KAS Node API using an WebSocket provider. - The CaverExtKAS contstructor supports websocket through
const caver = new CaverExtKAS(chainId, accessKeyId, secretAccessKey, { useNodeAPIWithHttp: false })
. - The initKASAPI supports websocket through
caver.initKASAPI(chainId, accessKeyId, secretAccessKey, { useNodeAPIWithHttp: false })
. - The initNodeAPI supports websocket through
caver.initNodeAPI(chainId, accessKeyId, secretAccessKey, false [, url])
.
- Provided additional
- For more scenarios in detail, refer to KAS Docs.
- Use KAS Node API service via websocket provider.