diff --git a/README.md b/README.md index 38dafac..1a8ee9b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,22 @@ Install supra-l1-sdk with npm **NOTE:** This `sdk` utilizes [aptos-sdk](https://github.com/aptos-labs/aptos-core/tree/main/ecosystem/typescript/sdk) and expects few things such as `keyPair` of `aptos-sdk` type, so due to this you also have to add `aptos-sdk` in your project. -This `sdk` is under development and in future we will try to completely remove dependency from `aptos-sdk` - ## Usage Check [./src/example.ts](https://github.com/Entropy-Foundation/supra-l1-sdk/blob/master/src/example.ts) for understating about the usage. + +## Functionalities + +- [x] Significant `rpc_node` endpoint integration +- [x] Transaction insights +- [x] Transfer coin +- [x] Publish Package +- [X] `entry_function_payload` type tx +- [ ] `script_payload` type tx +- [ ] Sponsor transaction +- [ ] Multi-agent transaction +- [X] Starkey wallet integration support + +## Contributing + +If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. diff --git a/doc/classes/SupraClient.html b/doc/classes/SupraClient.html index d3c6396..da6f3f4 100644 --- a/doc/classes/SupraClient.html +++ b/doc/classes/SupraClient.html @@ -1,5 +1,5 @@
Airdrop test Supra token on given account
+Airdrop test Supra token on given account
Hex-encoded 32 byte Supra account address
FaucetRequestResponse
Get Coin balance of given account
+Get transactions sent by the account and Coin transfer related transactions
+Get transactions sent by the account and Coin transfer related transactions
Supra account address
Number of coin transfer transactions and account sent transaction to be considered,
For instance if the value is N
so total N*2
transactions will be returned.
List of TransactionDetail
Get info of given supra account
+Get info of given supra account
Hex-encoded 32 byte Supra account address
AccountInfo
Get list of all resources held by given supra account
+Get list of all resources held by given supra account
Hex-encoded 32 byte Supra account address
AccountResources
Get Supra balance of given account
+Get transactions sent by the account
+Get transactions sent by the account
Supra account address
Number of transactions details
Cursor for pagination based response
List of TransactionDetail
Get Chain Id Of Supra Network
+Private
getGet Supra balance of given account
+Private
getGet Coin Transfer related transactions associated with the account
+Get Coin Transfer related transactions associated with the account
Supra account address
Number of transactions details
Cursor for pagination based response
List of TransactionDetail
Get current mean_gas_price
Get data of resource held by given supra account
+Private
getGet transaction details of given transaction hash
+Private
getGet transaction details of given transaction hash
Hex-encoded 32 byte Supra account address
Hex-encoded 32 byte transaction hash for getting transaction details
TransactionDetail
Private
getGet status of given supra transaction
+Private
getGet status of given supra transaction
Hex-encoded 32 byte transaction hash for getting transaction status
TransactionStatus
Check whether given account exists onchain or not
+Publish package or module on supra network
+Publish package or module on supra network
Module Publisher KeyPair
Package Metadata
module code
TransactionResponse
Private
sendPrivate
sendSend entry_function_payload
type tx using serialized raw transaction datas
Private
sendPrivate
sendSend entry_function_payload
type tx using serialized raw transaction datas
Sender KeyPair
Serialized raw transaction data
TransactionResponse
Private
signSimulate a transaction using the provided transaction payload
+Private
signSimulate a transaction using the provided transaction payload
Transaction payload
-Transfer coin
+Transfer coin
Sender KeyPair
Receiver Supra Account address
Amount to transfer
Type of coin
TransactionResponse
Transfer supra coin
+Transfer supra coin
Sender KeyPair
Receiver Supra Account address
Amount to transfer
TransactionResponse
Private
waitStatic
createStatic
createCreate serialized raw transaction object for entry_function_payload
type tx
Private
waitStatic
createStatic
createCreate serialized raw transaction object for entry_function_payload
type tx
Sender account address
Sender account sequence number
Target module address
@@ -121,7 +121,7 @@Maximum gas unit price for transaction
Expiry time for transaction
Serialized raw transaction object
-Static
initCreates and initializes SupraClient
instance
Static
initCreates and initializes SupraClient
instance
rpc url of supra rpc node
SupraClient
initialized instance
Provides methods for interacting with supra rpc node.
-