From 34b2c7f9c705304104212e71475985e509c3e016 Mon Sep 17 00:00:00 2001 From: aryan Date: Thu, 19 Dec 2024 18:51:17 +0530 Subject: [PATCH] docs: --- docs/CNAME | 1 - docs/assets/search.js | 2 +- docs/classes/SolanaAgentKit.html | 12 +++++++----- docs/functions/createSolanaTools.html | 2 +- docs/interfaces/CollectionDeployment.html | 4 ++-- docs/interfaces/CollectionOptions.html | 4 ++-- docs/interfaces/Creator.html | 4 ++-- docs/interfaces/FetchPriceResponse.html | 4 ++-- docs/interfaces/JupiterTokenData.html | 4 ++-- docs/interfaces/LuloAccountDetailsResponse.html | 4 ++-- docs/interfaces/MintCollectionNFTResponse.html | 4 ++-- docs/interfaces/PumpFunTokenOptions.html | 4 ++-- docs/interfaces/PumpfunLaunchResponse.html | 4 ++-- 13 files changed, 27 insertions(+), 26 deletions(-) delete mode 100644 docs/CNAME diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 2708636..0000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -solanaagentkit.xyz \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 78a93bc..619590d 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7Wc23LbOBKG34W+VTnGkbbvclhXZTc7k0qcuVG5XDQFKVxTpIaEkvG48u5bIEWxITTlpui5SspC/90APjRAEOBzVJU/6+h6/hw9ZsUiumb8chYVydpE19HXMk+K5O3KFPY/mY1m0bbKo+sozZO6NvUb/+fz73adR7Pu1+g6in7NOlXF+F41LYvaVtvUlhVF8swvD+Rn0SapTGHDSHvH7IJL6Lkwqc3Kguq4Lz7F788kzw2p/c72Raf7u08Wi8rU9Qi/wGSK/3JjiiS7TzbZ/aN5IvkPTEb65xey57Yyf25NbW+SbWrszbZY0NoANZsSx8Js8vLptnw0NOD88tM9vy/zfATviNGUGFbGvkvypEgNybtXfIrfdVbY325uSU77slM82iop6qWhpTNQeBrjq6y2pvpQrpOM1r+BycQ6L2gd25Wc4i03xeJtXRtLG8le8YkM337+SuW3LTrVnxv+HxKbvHt6OyKBD1m+XjS3WfpIZHzAcBIBybZIv3/erjc324KeUlGzKXHUNnmkcd+VHOlNg/VKZRJr2pK3ZZn3JCy3RZOi6zdBmaPrMK70Xv29swRrsKywplomqanf7H46KuXN+IdLjQGts5fWF11MA242pkpNYZOVedGTV5TqzGue/Tz4+6ZpatTlYSF6kzX/kCXPdsUHahLEOuB0W2UjfLalJ7qsyqckt0/vkjqrP5dZYUc05BlqPDGgtO32MWEAk/HOcag+NIuttTM/Gkdfjo5Wurc+nEEoLs4w85eqDaozEFSdrYrEbqsXoD8MBpqdFARs/v9mhe2L/3Zz+8XUm7Ko0ZgGC9M7wi0vx0uf7czw6g7XYSgIY5NFYpNTAulNTw8GdgCciI+kVaQYvdHtz8xag85rQ7pnvQ1eTyzuIfcmN6sqWY/z3xtNDuCneagziyI96L+3mew+KzKbJfmn7M9ttsjs09ffP40KBbefHFadZ5tNsjLvNqOIO/PtJoexqbKyyuzTjRnXQb7dKWEcDsPltvjULI6P5UC0IH0oHs35w9qEpI/XYGQaPhLB0RQ8zvkuh37Dl17HYvAsXyEUU1X4ev9IEJ3Nae4hdJ+2efk2TcttYT8Ym2R5fYy84dIjZoLSJvkfSb49xcOZZ41X/0iVBrOjNZWp7b+SqjCLU8IKFF4rtMokuc3W5u3m6ZS4fPPXCqo21mbFCs3ZL0UEbCeEo5USPcT39/ZpcxJOXTTne4mxQZ3vKzS07/6zwNc9I2M774ROjrCr5NB2QZ6XP83ic1XaMoX7GhNiRjT/qfC/l2vzkJyUt4KwgdY/Fe46K7L1dv0lwReFYyP25V4xaDhZ/Hu7yayp9ruIWOCHZV5luwoVfXHfKgh35KYP7vXong/VZf20fihzutN9+WluFybN1gk+tHHHwGKaa5vg8wXudld6msu8XJXfvnyke+0NJjZzkuVP9z/KfDsGrAOraSEsK2P+NvfJ1n5vHlHoYSCW00Jxq/ZTAgnspoWxMdU6KUxh7xfuuX4g7+KhoLbTwjF/WVPUQ3steBiezWj31DXTS75fWisF9iDswb3RrFiZ9LH8iK6+iRGd+zKjozs++d0Ym37/XGWpOfaEFJYa8WBuE7tFcRhQPdtb4HVFQh58KHs0Bd74Q757k6nON67Qx+Lb1w/vxwTgm00NYm3qeuAV1lAAvclU52m5GOV5V57u9m4WZcXC/BVdP0c/TOVwj64jfi7Or6JZtMxMvnDnzbqlUFqudy9BFmW6bf57tyv2h0mbly7X87b0m4toNr+Yiatzxfjd3WzeGTc/NH/oNPq/NIYsms0ZZsgCQ+YZ8mg255ghDwy5Zyii2VxghiIwFJ6hjGZziRnKwFB6hiqazRVmqAJD5RnqaDbXmKEODLVnGEezeYwZxoFh7BleRrP5JWZ4GRheeoZX0Wx+hRleBYZXPgCOB4ayw0J42AE9DT44PwhAPkHMccFQhlgIEfMpYo4NhnLEQpCYTxJzfDCUJRbCxHyamGOEoTyxECjmE8UcJwxlioVQMZ8q5lhhKFcsBIv5ZDHHC0PZYiFczKeLOWYYyhcLAWM+Ydwxw1HCeEgY9wnjjhmOEsZDwvhBjmqSFJ8JeS4vpG+MpCmfMO6Y4ShhPCSM+4RxxwxHCeMhYdwnjDtmuELDDgnjPmHcMcNRwnhIGPcJ444ZjhLGQ8K4Txh3zHCUMB4Sxn3CuGOGo4TxkDDuEyYcMwIlTISECZ8w4ZgRDGttERImfMKEY0agOUyEhImDmbCZCgXqGZkMfcKEY0aghImQMOETJhwzAs1hIiRM+IQJx4xACRMhYcInTDhmBEqYCAkTPmHCMSNQwkRImPAJE44ZgRImQsKET5h0zEiUMBkSJn3CpGNGojlMhoRJnzDpmJEoYTIkTPqESTHItgwJkwfrLTmIp0SWXD5h0jEj0ewpQ8KkT5h0zEh8rRcSJn3CpGNGomzLkDDpEyYdMxJlW4aESZ8w6ZiRKNsyJEz6hKmGMJRtFRKmfMJUQxjKtgoJUz5hyjGjLrB+ViFhyidMOWYUyrYKCVM+Ycoxo1C2VUiYOljVN8t6lDCFLOx9wpRjRqGEqZAw5ROmHDMKf6IICVM+YepycE2iQsKUT5i6GlwZqJAw5ROmHTMKf54JCdM+Ydoxo1C2dUiY9gnTDWEo2zokTPuE6YYwlG0dEqZ9wrRjRqN5W4eEaZ8w7ZjRKNs6JEwfPDs2D48o2xp5fPQJ044ZjbKtQ8K0T5h2zGiUbR0Spn3C9NVgMtAhYdonLHbMaHRgxCFhsU9Y7JjRKJ5xSFjsExY7ZjT+yB0SFvuExY4ZjeIZh4TFPmFxQxiKZxwSFvuExY6ZGMUzDgmLfcJix0yM4hmHhO3+1OxB/TCVNYuP7V7UfL7fhn6O7ncbVOqi2xZ7jhSPrp9/zSJ95f791W9MNX/d702535zH/QvBXo3zXo3v1NQlTa19d73p312DIIGskiS5ds+ul4hZLxFrosRufztbQCWtgNIFUak7Hoq0mQA9IMbqLcARatANV6AbaJ3ZS5bdmVSgJ4Eetf37i6NACOhQZfqLr70O6ExG02muiNTNFRFbHuDFQQ9wYg90F0eACgiKj4iqOVMPZC6BDG3o+K8yAamgXprWbf0LaDD6YiBDq1iLZQquUfZyoH7E6jVitr24BEY0GIYknd0xvl5BAqwlLSfAd4KgoYGQplVq6V4bNO9Uqv37LSCoQeVoTR6+SAZyAE2tSHIrYx+6q6i9EMgrtLSyMrbpOHeG8+EJyX4M1JTR+sDXtLubdUASkMFoaDjJjR8XyPKM1mT9MSYwdgSYuWgyu8PfeXf4u3YnUcB0AfpA0DqhOy5pdsclwQgATSVpYv9r3+jue8CrLWg0RWv59nLipj1DG4xxBpIFow0sd+812d17BUJghDJaKnTHU5rbX6B+oO21oKls8zJpT4Et2lNg2HiXoOEkreH2r0NBRgT5PqbB1t9uAYSBthK0tupkDtpLAvolMaD2ZF3VHPoALQ9iUrQ00R5fB9UCwQjRGkli9Q7OxoDMClY0mh5XPzMWS4sBIYCuoC2VnG6x9KrMABCMtrBpX0mD5Qggk6vdip6WKQ6/ZwF6E3QmTao9jAsUwIymaCMR3oYF9QNUcLJQcDwJEAEENW0oN8uArNjWi9RTAtkmpoHaXZFZGj+9gNaStOXELiO36RlNWYBQSSMUZnnkKUMALASNi+7AfbLx+JJg2lA07rsPQyx2H4YAgwhUlNEquvuKyrL5isqy/YoK6FcACE2uvQH84G4Ab3Y3gAHBYA7nNOD6WwGgzQBtisYIuKIEehGwJtguzdIGVnfP7MFfikmQxSStN9sHvcR9WeAx81Ii0CJKtZ8wADyAhmK0TNgdHAMMwKcXGlTdoWSQBCFJtNq0J32BBBgpmhZHf08TdDqojqAx2GSBg50VEExMQ6a5oPSjvaAEiAENI2nLxt0XWkA3gzzOiMHsP2sDZOBWBW1Y7S/igvYFFRK0pHGwFONAgdMUuu9wgTBAFCMk7pHnPvjoTZPqrueCcAAvgtDNd7Nok21MnhUmup7f/fr1fyWi9v36TQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7Wc23LbOBKG34W+VTnGkbbvksm6KrvZmdQkmRtVykVTsMM1RXJIKBmNK+++BR7EhtCUm2bmKikL3f0D+NAAQYBPUV1+b6Lr9VP0mBWb6Jrxy1VUJFsTXUcfyzwpktcPprD/yWy0inZ1Hl1HaZ40jWle+T+ff7XbPFoNv0bXUfRjNXhVjB+8pmXR2HqX2rKmuDzzywP3q6hKalPYUOkYmF1wCSMXJrVZWVADj8WXxP2e5Lkhtd/ZoejyeLfJZlObppkRF5gsiV9Wpkiy26TKbh/NnhQ/MJkZn1/Ikdva/Lkzjb1JdqmxN7tiQ2sD1GyJjo2p8nL/qXw0NOD88ssj/1Lm+QzeEaMlGh6MfZPkSZEaUnSv+JK426ywv958IgUdyy6JaOukaO4NLZ2BwssYf8gaa+q35TbJaP0bmCyL35T5N/OxzGcpCIwWEvahzrZJvZ+hATFa2PcbGuBDySXRclNsXjeNsbSM5hVf2NKfPnyktm9XdGk8lwbfJjZ5s389YyKbsvx5aj5l6SNxrE8YLiIg2RXp1w+7bXWzK+hTC2q2REdjk0ca90PJmdE0WLfVJrGmK/mpLPORhPtd0U5VzaugzMn1KFf64P0XZwnWollhTX2fpKZ51f900pW38jleck34OntunTVomghTmTo1hU0ezLORvKLUYF7zHNYDv1VtU6MhjwvRm6z9h+zyrC8+UZNA60TQXZ3NiNmVXhiyLvdJbvdvkiZrPpRZYWc05BlqvFBQ2nX7HBnAZH5wHKq37aJz68xP6hjL0dFKD9bHMwglxBlm/ly1QXUmRDXZQ5HYXf0M9MdioNmLRMDm/29W2LH4rzeffjdNVRYNqmmyML0j3DJ7vuuz3gyv7nQdpkQYm2wSm7xEyGj6cjGwA+BEfCKtIsXojW6/Z9YadF6b8ns22uD1xHRPhTe5eaiT7bz4o9FiAd/NXZNZFOnJ+KPN4vBZkdksyd9nf+6yTWb3H397P0sKbr9YVpNnVZU8mDfVLOLOfLvFMqo6K+vM7m/MvA7y7V4i43gY3u+K9+3i+FQORAvSh+LJnD/tm5D08RrMTMMnFJxMwfOC9zn0M770OqXBs/wJUkxd4+v9EyIGm5eFh9C93+Xl6zQtd4V9a2yS5c0p8qZLz5gJSpvkfyT57iURzjxrvPonqjSZHa2pTWP/ldSF2bxEVuDhZ0mrTZLbbGteV/uX6PLNf5aoxlibFQ9ozn5OEbBdIEcrJUaIb2/tvnoRToOa84OLuaLODxWaev/wvcDXPTO1nQ+OXqxwqOTUdkGel9/N5kNd2jKF+xoLNCM+/yn5X8utuUtelLcC2cDXPyV3mxXZdrf9PcEXhXMV++5+omg4Wfx7V2XW1IddREz4cZmfsl2FOn123yqQO3PTB496cs+HGrLZb+/KnB70UH5Z2I1Js22CD208MLBYFtom+HyBh+1LLwuZlw/l59/f0aOOBgubOcny/e23Mt/NAevIapmE+9qYv81tsrNf20cUugzEcpkUt2p/iZDAbpmMytTbpDCFvd245/qJvItLQW2XyTF/WVM0U3stuAzPZnZ46prpudjPrZUCeyB7cm80Kx5M+li+Q1ffREXnvpvZ6k5PfjfGpl8/1FlqTj0hhaVmPJjbxO5QHCa8nh0s8Loikicfyh5NgTf+VOzRZGnwyhV6V3z++PaXOQJ8s6UitqZpJl5hTQkYTZYGT8vNrMh9eXrYL6soKzbmr+j6Kfpmaod7dB3xc3F+Fa2i+8zkG3fublgKpeW2fwmyKdNd+98vfbE/TNq+dLled6VfXUSr9cVKXJ3HWn/5sloPxu0P7R8GH+NfWkMWrdYMM2SBIfMMebRac8yQB4bcMxTRai0wQxEYCs9QRqu1xAxlYCg9QxWt1gozVIGh8gx1tFprzFAHhtozjKPVOsYM48Aw9gwvo9X6EjO8DAwvPcOraLW+wgyvAsMrHwDHA0PZYSE87IieFh+cHwQgnyDmuGAoQyyEiPkUMccGQzliIUjMJ4k5PhjKEgthYj5NzDHCUJ5YCBTziWKOE4YyxUKomE8Vc6wwlCsWgsV8spjjhaFssRAu5tPFHDMM5YuFgDGfMO6Y4ShhPCSM+4RxxwxHCeMhYfwoR7VJCs9SSJryCeOOGY4SxkPCuE8Yd8xwuRLyXKvYNw4J4z5h3DHDUcJ4SBj3CeOOGY4SxkPCuE8Yd8zwGJUdEsZ9wrhjhqOE8ZAw7hPGHTMcJYyHhHGfMOGYEShhIiRM+IQJx4xACRMhYcInTDhmBEqYCAkTRzNhOxUKrLUFMhn6hAnHjEBzmAgJEz5hwjEjFBo5JEz4hAnHjEAJEyFhwidMOGYEmsNESJjwCROOGYESJkLChE+YcMwIlDAREiZ8wqRjRqKEyZAw6RMmHTMSJUyGhEmfMOmYkShhMiRM+oRJx4xEc5gMCZNH6612wYWvuJAll0+YVJNsy5Aw6RMm9SSeMiRM+oRJx4xEs6cMCZM+YdIxI1G2ZUiY9AmTjhmJsi1DwqRPmGoJQ9lWIWHKJ0y1hKFsq5Aw5ROmHDMKZVuFhCmfMOWYUSjbKiRM+YQpx4ziWD+rkDB1tKpvl/Uo2wpZ2PuEKceMQtlWIWHKJ0w5ZhT+RBESpnzClGNGoYSpkDDlE6YcMwolTIWEKZ8wfTG5JtEhYdonTLPJlYEOCdM+YbolDGVbh4RpnzDdEoayrUPCtE+YdsxolG0dEqZ9wrRjRqNs65AwffTs2D48onlbI4+PPmHaMaNRtnVImPYJ044ZjbKtQ8K0T5h2zGiUbR0Spn3CYseMRtmOQ8Jin7CYTSaDOCQs9gmLHTMaf+QOCYt9wmLHjEbxjEPCYp+wuCUMxTMOCYt9wmLHTIziGYeExT5hsWMmRvGMQ8Liox2KdosCxTNGNil8wmLHTIziGYeE9X9qd7++mdqazbtuF2y9PmyAP0W3/daYOlwLfYqUjK6ffqyimLl/f4xbYu1fD7ti7jcX8fAqcvQ2bu89Rbz3pi9o3rq35tX41hyIBG6VJrnrdgtHF7EYXcSXRBf9znq2gZ50DDxxoqfhYCrSZgL0gJjrbwMObwOXDLikdeboshxOw4Ju1aBbqe0/Xt0FjoAfqpvx6vHoB9SPWL32ckrTXk6x5RFeHMoi6hqurAAvgDAu5njxcbgAfUcbOv5LVEAqqJemddv46huMvivghlaxDssUXGQd3V2O3mjjsHNmuytTYESDYUjy0x8gHD1IgLWkaYFvI0FDA0cxrc/u3QuL9m1OfXizBhyCRoppTR6+wgbuAJqa1lgPxt4Nl4FHR4CEK6qbqrvruenveoJBDLI6k1R3LQfuMOrdHkmmDDQco3Wp79P2VwSBS1BpRq61rXxdgFZG64HxPBYYigpMhDQ3/Sn2fDjF3rgjNWAMgFQqabl0OPdp+nOfwBloKkVz9r/u1fShB7zagkZTtJbvbllW3WHgIGVwkFs5bZy6C7xJf4EXdCcY8IyWWd05m/YaGxiWoO21onnZ5WXSHWfbdMfZsPQhQcNJWsMd3uuCBAumj5gG23hNB0xooK0Era0GN0ftJQH9kiioOyJYt6dXAFlAk6Klie4cPqgWECNUZySJ1Ts65AOIAClR03WNE21xbzEgBPAraKnW+S3uvSozMHwYbfh079bBCARk8rh/QKBliuMPlIDeBJ1Jc9WdKgYewASpaD7gtV5QP6CFkx0F56wAEcChpg3ldlWRFbtmk3rDGWSbmAbqcNfn3vjpBbSWpK1O+ozcpWc0ZQFCJY1QmOWRhxYBUBO0bDHcHEgqny/AvaI9Hwxf+kBWPSCrMqqz9rM49+1nce67z+IAQgAgRHftN0CaMkfUga5ltK7tb0bfuZvRVX8zGgwIsCTgNH7H2xKgCwC8iqYLXN0CUID6CdFnbdo4He7f3fkrOwn6U9L6s3sMTdwXFx4zL8MC0Gj5tf+0A2hv0FCclliHA3UAKdBpMW0wDoe1QZeBpbimNUx3AhroAO2haTrG+6ug00F1BI3BNqn4+z4xEBPTkGkvbn3rLm4BYkDDKFo391+uAeMUTAuMKObw2SPgBm6k0Gg5XFAG7QsqJGirlqOVHQceOM3D8J02IAOomOHiFnmMhJMRzdVwbRn4ALxIQjd/WUVVVpk8K0x0vf7y48f/AVBOKSsaUAAA"; \ No newline at end of file diff --git a/docs/classes/SolanaAgentKit.html b/docs/classes/SolanaAgentKit.html index 3c83f96..47091be 100644 --- a/docs/classes/SolanaAgentKit.html +++ b/docs/classes/SolanaAgentKit.html @@ -1,7 +1,7 @@ SolanaAgentKit | solana-agent-kit

Class SolanaAgentKit

Main class for interacting with Solana blockchain Provides a unified interface for token operations, NFT management, and trading

SolanaAgentKit

-

Constructors

constructor +

Constructors

constructor

Properties

connection openai_api_key wallet @@ -9,6 +9,7 @@ Provides a unified interface for token operations, NFT management, and trading

Methods

deployCollection deployToken getBalance +getPrimaryDomain getTokenDataByAddress getTokenDataByTicker getTPS @@ -17,10 +18,11 @@ Provides a unified interface for token operations, NFT management, and tradingmintNFT registerDomain requestFaucetFunds +resolveSolDomain stake trade transfer -

Constructors

constructor

  • new SolanaAgentKit(private_key, rpc_url?, openai_api_key): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string = "https://api.mainnet-beta.solana.com"
    • openai_api_key: string

    Returns SolanaAgentKit

Properties

connection

connection: Connection

Solana RPC connection

-

openai_api_key

openai_api_key: string

wallet

wallet: Keypair

Wallet keypair for signing transactions

-

wallet_address

wallet_address: PublicKey

Public key of the wallet

-

Methods

deployCollection

deployToken

  • deployToken(decimals?): Promise<{
        mint: PublicKey;
    }>

  • Parameters

    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS

    Returns Promise<{
        mint: PublicKey;
    }>

getBalance

  • getBalance(token_address?): Promise<null | number>

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

getTokenDataByAddress

getTokenDataByTicker

getTPS

launchPumpFunToken

  • launchPumpFunToken(tokenName, tokenTicker, description, imageUrl, options?): Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

  • Parameters

    • tokenName: string
    • tokenTicker: string
    • description: string
    • imageUrl: string
    • Optionaloptions: PumpFunTokenOptions

    Returns Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

lendAssets

  • lendAssets(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

mintNFT

  • mintNFT(collectionMint, metadata, recipient?): Promise<MintCollectionNFTResponse>

  • Parameters

    • collectionMint: PublicKey
    • metadata: {
          creators?: {
              address: string;
              share: number;
          }[];
          name: string;
          sellerFeeBasisPoints?: number;
          symbol: string;
          uri: string;
      }
      • Optionalcreators?: {
            address: string;
            share: number;
        }[]
      • name: string
      • OptionalsellerFeeBasisPoints?: number
      • symbol: string
      • uri: string
    • Optionalrecipient: PublicKey

    Returns Promise<MintCollectionNFTResponse>

registerDomain

  • registerDomain(name, spaceKB?): Promise<string>

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

  • requestFaucetFunds(): Promise<string>

  • Returns Promise<string>

stake

  • stake(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

trade

  • trade(outputMint, inputAmount, inputMint?, slippageBps?): Promise<string>

  • Parameters

    • outputMint: PublicKey
    • inputAmount: number
    • OptionalinputMint: PublicKey
    • slippageBps: number = DEFAULT_OPTIONS.SLIPPAGE_BPS

    Returns Promise<string>

transfer

  • transfer(to, amount, mint?): Promise<string>

  • Parameters

    • to: PublicKey
    • amount: number
    • Optionalmint: PublicKey

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

  • new SolanaAgentKit(private_key, rpc_url?, openai_api_key): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string = "https://api.mainnet-beta.solana.com"
    • openai_api_key: string

    Returns SolanaAgentKit

Properties

connection

connection: Connection

Solana RPC connection

+

openai_api_key

openai_api_key: string

wallet

wallet: Keypair

Wallet keypair for signing transactions

+

wallet_address

wallet_address: PublicKey

Public key of the wallet

+

Methods

deployCollection

deployToken

  • deployToken(decimals?): Promise<{
        mint: PublicKey;
    }>

  • Parameters

    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS

    Returns Promise<{
        mint: PublicKey;
    }>

getBalance

  • getBalance(token_address?): Promise<null | number>

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

getPrimaryDomain

  • getPrimaryDomain(account): Promise<string>

  • Parameters

    • account: PublicKey

    Returns Promise<string>

getTokenDataByAddress

getTokenDataByTicker

getTPS

launchPumpFunToken

  • launchPumpFunToken(tokenName, tokenTicker, description, imageUrl, options?): Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

  • Parameters

    • tokenName: string
    • tokenTicker: string
    • description: string
    • imageUrl: string
    • Optionaloptions: PumpFunTokenOptions

    Returns Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

lendAssets

  • lendAssets(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

mintNFT

  • mintNFT(collectionMint, metadata, recipient?): Promise<MintCollectionNFTResponse>

  • Parameters

    • collectionMint: PublicKey
    • metadata: {
          creators?: {
              address: string;
              share: number;
          }[];
          name: string;
          sellerFeeBasisPoints?: number;
          symbol: string;
          uri: string;
      }
      • Optionalcreators?: {
            address: string;
            share: number;
        }[]
      • name: string
      • OptionalsellerFeeBasisPoints?: number
      • symbol: string
      • uri: string
    • Optionalrecipient: PublicKey

    Returns Promise<MintCollectionNFTResponse>

registerDomain

  • registerDomain(name, spaceKB?): Promise<string>

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

  • requestFaucetFunds(): Promise<string>

  • Returns Promise<string>

resolveSolDomain

  • resolveSolDomain(domain): Promise<PublicKey>

  • Parameters

    • domain: string

    Returns Promise<PublicKey>

stake

  • stake(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

trade

  • trade(outputMint, inputAmount, inputMint?, slippageBps?): Promise<string>

  • Parameters

    • outputMint: PublicKey
    • inputAmount: number
    • OptionalinputMint: PublicKey
    • slippageBps: number = DEFAULT_OPTIONS.SLIPPAGE_BPS

    Returns Promise<string>

transfer

  • transfer(to, amount, mint?): Promise<string>

  • Parameters

    • to: PublicKey
    • amount: number
    • Optionalmint: PublicKey

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/createSolanaTools.html b/docs/functions/createSolanaTools.html index b21b0f9..7aa6da6 100644 --- a/docs/functions/createSolanaTools.html +++ b/docs/functions/createSolanaTools.html @@ -1 +1 @@ -createSolanaTools | solana-agent-kit

Function createSolanaTools

  • createSolanaTools(solanaKit): (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool)[]

Settings

Member Visibility
+createSolanaTools | solana-agent-kit

Function createSolanaTools

  • createSolanaTools(solanaKit): (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool)[]

Settings

Member Visibility
diff --git a/docs/interfaces/CollectionDeployment.html b/docs/interfaces/CollectionDeployment.html index c4d9e66..d88bbc6 100644 --- a/docs/interfaces/CollectionDeployment.html +++ b/docs/interfaces/CollectionDeployment.html @@ -1,3 +1,3 @@ -CollectionDeployment | solana-agent-kit

Interface CollectionDeployment

interface CollectionDeployment {
    collectionAddress: PublicKey;
    signature: Uint8Array;
}

Properties

collectionAddress +CollectionDeployment | solana-agent-kit

Interface CollectionDeployment

interface CollectionDeployment {
    collectionAddress: PublicKey;
    signature: Uint8Array;
}

Properties

collectionAddress signature -

Properties

collectionAddress

collectionAddress: PublicKey

signature

signature: Uint8Array

Settings

Member Visibility

On This Page

Properties
+

Properties

collectionAddress

collectionAddress: PublicKey

signature

signature: Uint8Array

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CollectionOptions.html b/docs/interfaces/CollectionOptions.html index 5396135..6e1232f 100644 --- a/docs/interfaces/CollectionOptions.html +++ b/docs/interfaces/CollectionOptions.html @@ -1,5 +1,5 @@ -CollectionOptions | solana-agent-kit

Interface CollectionOptions

interface CollectionOptions {
    creators?: Creator[];
    name: string;
    royaltyBasisPoints?: number;
    uri: string;
}

Properties

creators? +CollectionOptions | solana-agent-kit

Interface CollectionOptions

interface CollectionOptions {
    creators?: Creator[];
    name: string;
    royaltyBasisPoints?: number;
    uri: string;
}

Properties

creators? name royaltyBasisPoints? uri -

Properties

Optionalcreators

creators?: Creator[]

name

name: string

OptionalroyaltyBasisPoints

royaltyBasisPoints?: number

uri

uri: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalcreators

creators?: Creator[]

name

name: string

OptionalroyaltyBasisPoints

royaltyBasisPoints?: number

uri

uri: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Creator.html b/docs/interfaces/Creator.html index 5d224de..748ba39 100644 --- a/docs/interfaces/Creator.html +++ b/docs/interfaces/Creator.html @@ -1,3 +1,3 @@ -Creator | solana-agent-kit

Interface Creator

interface Creator {
    address: string;
    percentage: number;
}

Properties

address +Creator | solana-agent-kit

Interface Creator

interface Creator {
    address: string;
    percentage: number;
}

Properties

address percentage -

Properties

address

address: string

percentage

percentage: number

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: string

percentage

percentage: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/FetchPriceResponse.html b/docs/interfaces/FetchPriceResponse.html index b926d80..c9c3d12 100644 --- a/docs/interfaces/FetchPriceResponse.html +++ b/docs/interfaces/FetchPriceResponse.html @@ -1,6 +1,6 @@ -FetchPriceResponse | solana-agent-kit

Interface FetchPriceResponse

interface FetchPriceResponse {
    code?: string;
    message?: string;
    priceInUSDC?: string;
    status: "success" | "error";
    tokenId?: string;
}

Properties

code? +FetchPriceResponse | solana-agent-kit

Interface FetchPriceResponse

interface FetchPriceResponse {
    code?: string;
    message?: string;
    priceInUSDC?: string;
    status: "success" | "error";
    tokenId?: string;
}

Properties

code? message? priceInUSDC? status tokenId? -

Properties

Optionalcode

code?: string

Optionalmessage

message?: string

OptionalpriceInUSDC

priceInUSDC?: string

status

status: "success" | "error"

OptionaltokenId

tokenId?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalcode

code?: string

Optionalmessage

message?: string

OptionalpriceInUSDC

priceInUSDC?: string

status

status: "success" | "error"

OptionaltokenId

tokenId?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/JupiterTokenData.html b/docs/interfaces/JupiterTokenData.html index 34e8420..cf881d1 100644 --- a/docs/interfaces/JupiterTokenData.html +++ b/docs/interfaces/JupiterTokenData.html @@ -1,4 +1,4 @@ -JupiterTokenData | solana-agent-kit

Interface JupiterTokenData

interface JupiterTokenData {
    address: string;
    daily_volume: number;
    decimals: number;
    extensions: {
        coingeckoId?: string;
    };
    freeze_authority: null | string;
    logoURI: string;
    mint_authority: null | string;
    name: string;
    permanent_delegate: null | string;
    symbol: string;
    tags: string[];
}

Properties

address +JupiterTokenData | solana-agent-kit

Interface JupiterTokenData

interface JupiterTokenData {
    address: string;
    daily_volume: number;
    decimals: number;
    extensions: {
        coingeckoId?: string;
    };
    freeze_authority: null | string;
    logoURI: string;
    mint_authority: null | string;
    name: string;
    permanent_delegate: null | string;
    symbol: string;
    tags: string[];
}

Properties

address daily_volume decimals extensions @@ -9,4 +9,4 @@ permanent_delegate symbol tags -

Properties

address

address: string

daily_volume

daily_volume: number

decimals

decimals: number

extensions

extensions: {
    coingeckoId?: string;
}

freeze_authority

freeze_authority: null | string

logoURI

logoURI: string

mint_authority

mint_authority: null | string

name

name: string

permanent_delegate

permanent_delegate: null | string

symbol

symbol: string

tags

tags: string[]

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: string

daily_volume

daily_volume: number

decimals

decimals: number

extensions

extensions: {
    coingeckoId?: string;
}

freeze_authority

freeze_authority: null | string

logoURI

logoURI: string

mint_authority

mint_authority: null | string

name

name: string

permanent_delegate

permanent_delegate: null | string

symbol

symbol: string

tags

tags: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LuloAccountDetailsResponse.html b/docs/interfaces/LuloAccountDetailsResponse.html index 61b78dd..83377e8 100644 --- a/docs/interfaces/LuloAccountDetailsResponse.html +++ b/docs/interfaces/LuloAccountDetailsResponse.html @@ -1,6 +1,6 @@ LuloAccountDetailsResponse | solana-agent-kit

Interface LuloAccountDetailsResponse

Lulo Account Details response format

-
interface LuloAccountDetailsResponse {
    interestEarned: number;
    realtimeApy: number;
    settings: {
        allowedProtocols: null | string;
        homebase: null | string;
        minimumRate: string;
        owner: string;
    };
    totalValue: number;
}

Properties

interestEarned +
interface LuloAccountDetailsResponse {
    interestEarned: number;
    realtimeApy: number;
    settings: {
        allowedProtocols: null | string;
        homebase: null | string;
        minimumRate: string;
        owner: string;
    };
    totalValue: number;
}

Properties

interestEarned realtimeApy settings totalValue -

Properties

interestEarned

interestEarned: number

realtimeApy

realtimeApy: number

settings

settings: {
    allowedProtocols: null | string;
    homebase: null | string;
    minimumRate: string;
    owner: string;
}

totalValue

totalValue: number

Settings

Member Visibility

On This Page

Properties
+

Properties

interestEarned

interestEarned: number

realtimeApy

realtimeApy: number

settings

settings: {
    allowedProtocols: null | string;
    homebase: null | string;
    minimumRate: string;
    owner: string;
}

totalValue

totalValue: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MintCollectionNFTResponse.html b/docs/interfaces/MintCollectionNFTResponse.html index b11f0b6..0aff9d6 100644 --- a/docs/interfaces/MintCollectionNFTResponse.html +++ b/docs/interfaces/MintCollectionNFTResponse.html @@ -1,3 +1,3 @@ -MintCollectionNFTResponse | solana-agent-kit

Interface MintCollectionNFTResponse

interface MintCollectionNFTResponse {
    metadata: PublicKey;
    mint: PublicKey;
}

Properties

metadata +MintCollectionNFTResponse | solana-agent-kit

Interface MintCollectionNFTResponse

interface MintCollectionNFTResponse {
    metadata: PublicKey;
    mint: PublicKey;
}

Properties

metadata mint -

Properties

metadata

metadata: PublicKey

mint

mint: PublicKey

Settings

Member Visibility

On This Page

Properties
+

Properties

metadata

metadata: PublicKey

mint

mint: PublicKey

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PumpFunTokenOptions.html b/docs/interfaces/PumpFunTokenOptions.html index d2ca794..973aa0a 100644 --- a/docs/interfaces/PumpFunTokenOptions.html +++ b/docs/interfaces/PumpFunTokenOptions.html @@ -1,7 +1,7 @@ -PumpFunTokenOptions | solana-agent-kit

Interface PumpFunTokenOptions

interface PumpFunTokenOptions {
    initialLiquiditySOL?: number;
    priorityFee?: number;
    slippageBps?: number;
    telegram?: string;
    twitter?: string;
    website?: string;
}

Properties

initialLiquiditySOL? +PumpFunTokenOptions | solana-agent-kit

Interface PumpFunTokenOptions

interface PumpFunTokenOptions {
    initialLiquiditySOL?: number;
    priorityFee?: number;
    slippageBps?: number;
    telegram?: string;
    twitter?: string;
    website?: string;
}

Properties

initialLiquiditySOL? priorityFee? slippageBps? telegram? twitter? website? -

Properties

OptionalinitialLiquiditySOL

initialLiquiditySOL?: number

OptionalpriorityFee

priorityFee?: number

OptionalslippageBps

slippageBps?: number

Optionaltelegram

telegram?: string

Optionaltwitter

twitter?: string

Optionalwebsite

website?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalinitialLiquiditySOL

initialLiquiditySOL?: number

OptionalpriorityFee

priorityFee?: number

OptionalslippageBps

slippageBps?: number

Optionaltelegram

telegram?: string

Optionaltwitter

twitter?: string

Optionalwebsite

website?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PumpfunLaunchResponse.html b/docs/interfaces/PumpfunLaunchResponse.html index 475520b..fc6cd73 100644 --- a/docs/interfaces/PumpfunLaunchResponse.html +++ b/docs/interfaces/PumpfunLaunchResponse.html @@ -1,5 +1,5 @@ -PumpfunLaunchResponse | solana-agent-kit

Interface PumpfunLaunchResponse

interface PumpfunLaunchResponse {
    error?: string;
    metadataUri?: string;
    mint: string;
    signature: string;
}

Properties

error? +PumpfunLaunchResponse | solana-agent-kit

Interface PumpfunLaunchResponse

interface PumpfunLaunchResponse {
    error?: string;
    metadataUri?: string;
    mint: string;
    signature: string;
}

Properties

error? metadataUri? mint signature -

Properties

Optionalerror

error?: string

OptionalmetadataUri

metadataUri?: string

mint

mint: string

signature

signature: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalerror

error?: string

OptionalmetadataUri

metadataUri?: string

mint

mint: string

signature

signature: string

Settings

Member Visibility

On This Page

Properties