diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index d9dd0b7..f44ac19 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJyNlMFKw0AQht9lz8Fg0SK5FUMFrVpqbuJhXSfNks3ssjuLFum7S1PRxm6mXnKZb74/DD/7/CkIPkgU4skaiXK2BqQ7TSITTlIjCqGMDAFCPpyfNdQZkYlW45sozidX2+zHdG2NAUXaYgnO2E0HeODTSOBrqSDkKXAonlxOk+JHt/uGE9Zvildirdcjnt2IXfYgyfr09n7Grc+BVLP0WsEKgrMYIGk6xjjpjX59t77t46GSoV3BuHoM5gJuo9MEvrItYClJJsV/IU64iMbOlLIRqQSS2gT2HOM4F3KvkX6L8TCv2IxRmotYxs7VERcyompYfZI8pZ5H7M/JVT/BsdoNNf8sYRrl5Kov1f7VqKw1B39cR+wPG/IjaGicXmxfvgDluqEc" \ No newline at end of file +window.navigationData = "eJyNlFFPwjAQx79Ln4kTFFTeiIhGUQnyZnwo5caadddlvSrE+N2NQGRj3cHLHna//+/Sy7Xv34JgRaIv3qyRKAdLQHrSJFoil5SIvlBGOgcuqtbPEsqMaIlU40L0253rn9a/aaBIW9wbNBIUsVTgom2pGu50e7Xw3UpmuQHGsSM41a01BjbwEHJj1xkgBY0h8DTxa/73dUesO4pXYqyXDZ6/EhsuQJItwultjYuPgFQyKbSCKbjcogvPvY5x0ns9/7JFumkPM+nSKTSrm2CuwaPPNUExsyngUJIMig8hTjj2xg6Ush5pCCS1cew4mnGuybNG2i/Gy2jG9mikuRYTn+Wxx7H0qBJWHySPqUceN+PkVj/Asdo1JScuYRjl5A8SFwZKl4PWObho9/sgeX5z1e52SmmpDk75KQst5wZctCtVDRflsNrs8/bhnFlrSprY4zYe1aCqsHdZEsIKlCc4fGD3sgrAiGKNi2bLvsoolkCVlzh4uBpUE378Ahp6RJM=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 6cd8305..a216523 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJytnVtv2zoSx7+L8mq0ul/yluayyDlpEyTpWSyMwlAsOtFGlnQkujnZot99QV2soTiSR5GfWsSc4Z/kj0NyZNG/tCJ7K7XT5S/tNU4j7dQw/YWWhlumnWoPWRKm4dkzS/mfMdcW2q5ItFNtnYRlycrP8sefXvg20Rbtp9qppv1etF4dw9x7XWdpyYvdmmcFxeWJXB64X2h5WLCUq0q7ig3dtGHNKVvzOEupFXfF59T7FiYJI/Xfyb7o/PpWYRQVrCwn1AtMZvbzJn6m9nFddGJ9pm53nBbs7x0r+VW4WzN+tUsjWpsbs01ltmnM5uiIWJ5k74/ZK6MBVpfnTfn5NZ9nSTKB79poDY3maHhm/EuYhOmakWp/ZvxpX/w49d7yF0aLKV3lWWMzR8E2Tvm3q0dSzaJsuvnADJdq5EWYlhtiY0HhebPsOS45Ky6ybRjTCGtNotZkXv1llvxkD1kySUFlVGbJUTQ8M35XxNuweJ+g4ZnxvDY6igZehBFtirUl59SWxNuY3xYRkbWqeNYUn1PvWkzO5CxJqrppAb22CZMka23mKHiL+UtUhG9nSUJbQpvyYZLM7XOWRmdlyTit2aJ42BafSffj3QOVaZ4foz6x+F2EPPzyfjZhuyKqF5ZRyMOn9w/vWkbUPMbrV/piAsTw1nCOlg3j65dKzV0RExfUyqYSkjc2sxgMd+n65W63za92KX1LU5vlu22+2aXH2NmUPHyltb8tOas2lkbn2TYXOLHoLC6iIstptbM0Wu8tw73lHDVZsQ7Pk6xkd1kZk7d1wmotrPLOaraKgoWcnd98/UqXUJmsk+32aPU/xOlzwh7iiEU38d+7OIr5+12W0cJzp6ms3JTCTdK6yWs3c3VeiTnYjhYtlAmzaurmwGyujtucpecs5axgUSvn3zF/2XcbWVqWs3TdeGoVipUuAZ6OoRaM7WTahUYwqEfivtk6niXNfpN6qKyswqTZcB5hVbp9S1k0UcYz45kwO7qORsRVVjzeXEyS0ujYZAVPovlqug55vLkgd0rXHzyZfd6vVdw3h5yPjFGYJMXe/Jhj9TWM007OtMOKKNtpOc7ZLXyP4t22DuNn2+1fNm0y1WZ12A6325/2MXWc12vTRBlHWNFkFfmHVOTz19WcpU9Z9lrL+BoWr8QcZWtYK9m2hrMyKGEab1jJJ2tpDY+oJX/nL/U6Tt56C5N6DT/Czrtuyr/ip7eseH0My1fa2beyeq6teG01i9Fs/XoX5qx4WMdlmRFP4MIqF1ZlZzW/Lx7jPInTKf3A9xazMi0sLbPiJi7J2b3aIonLY+T4Kl/nVU5DaIhTWkq9tqtzIcnebqIS1+6NQV3yMcuSjoTNLq0Sx+Vnpczo0yDTcffez+VnBbHYaW7CNSs/15+MOpKeOtzeXX47u16d3V2v/rz8zwGPVRAL41WYx6tXNryJbeQNVPnH97vrx8v71f3l1eX9/dnN6uz8/Pb7t8dDlf93l8ecFauCbVhRhMkqXK+zXTpMDE3G1eXl6gtI4ByofcPY6mkkiaNUKo2bGHHwBA/WVX9EH7n+g6oBXyeH8jytpoFqclaIk0z4zA7WJBWlViZj3T5Vuc3ls6A0KL1C9C6r/iG7PGmKD41zX+tApbsinlBnXXpmlUX2Hib8/UtYxuVdFqd8QkeeNMZPwjhvjWcKWtfDPkUGMJleOQ7VRfXobstSPq6jK0dHq3sg2M/IUqo46cwPTlesOQOiyvg5DfmuOAB9Xww0+5AI2P1f45R3xb9dPd6zMs/SEtU0WJg+EOJR4XTXJ40Z3tzhNgyJYDwUie2PCOlMPy4GDgDMRo+EVaQYvdP5W8w5Q9e1Ib8nnQ3eTkz3UPUsYc9FuJ1Wf2c0W8AbeypjjiI9WH9nM7v6OI15HCb7POXD7c0kKY39PjtZjqR1J8gqkzjPw2f2JZ9E3ElrN7bNmiAjL+KsiPn7FZs2QK3dhn10kPrTcLNLb6pHPWMxEC1In4qjMX/YNyHo4y2YGIZHFIyG4GmVNzH0O771GtPQWI5twyZJYUWB7/dHRLQ2H6seQnezS7Kz+pR0wXgYJ+UYecOlJ6wEGQ+Tv8Jk95EaTirrn4013vyRJg1GR5EoLvllWKQs+ois1gNrPRxLWsHChMdbdpa/f0RXax7mw2fx6aJKxkX6A43ZhxQB2xlyIMJ/1Ofu/ZcMMFX9Mkc5RKNOD56mFbkTj6J4raMnUWqV5fv2CTz2PVjpvvy8aiO2jrdhMqGPgcW8qnmIU4xX25SeV2WSPWff76/ptQqDsdWG3M1hnLyvfmbJbgpYPat5EjYFY/9jq3DHX6qNE10GYjlPithLfESIYjdPRs6KbZiylK8icdoI8SMCLgW1nSeH/SPS3EMnQFyGZDO5ehjJu8dDY5sQtdSEvS8P+Q5t24DXk70F3jJE8uC+55Wl1+juYqjuyiQe3k7QK68eoF2n3x8uzqcIqMzidFdG6yOI2LKyHMgSDwnoTOZWvs6iSTU35T9QrXSmkx56jh7q0JLHIHvE8yG6B+SPQXbFWHR9MVVHZbphLBqh/QNiPiTjSAJGaB+TcIj4aSKGqB9TMEr+weoh/c3D9vrbB+KR+z0b5H+o7DFmwKjvQ3NgsBGDW8ryFQ/z4zKE3Qj9U2WMZnkOdMjBRM+wmB8LLU4j9o92+kv7yQqxLdBONfOT9SnQFtomZuLrYafL9nSzzrbN05YoW++q//5oiv3F1tXTndNlXfqzri2W+sK2Ptm+8ePHYtkaVx9Uf2h9dH+pDA1tsTQwQ0MxNCRDU1ssTczQVAxNydDSFksLM7QUQ0sytLXF0sYMbcXQlgwdbbF0Fpb/yfIsydBRDB3J0NUWSxer0VUMXcnQ0xZLDzP0FENPMvS1xdLHDH3F0JcMA22xDDDDQDEMZAAEDwbKjqHCY/ToqfDB+UEAkgkyBBcGypChQmTIFBmCDQPlyFBBMmSSDMGHgbJkqDAZMk2GYMRwUGMVKEMmyhCcGChThgqVIVNlCFYMlCtDBcuQyTIELwbKlqHCZch0GYIZA+XLUAEzZMJMwYyJEmaqhJkyYaZgxkQJM1XCzF6MqoIUHqWQMCUTZgpmTJQwUyXMlAkzBTMmSpipEmbKhJmCGRMlzFQJM2XCTMGMiRJmqoSZMmGmYMZECTNVwkyZMFMwY6KEmSphpkyYKZgxUcJMlTBTJswSzFgoYZZKmCUTZglmLJQwSyXMkgmzBDMWSpilEmb1VsJqKcTXQmQxlAmzBDMWSpilEmbJhFmCGQslzFIJs2TCLMGMhRJmqYRZMmGWYMZCCbNUwiyZMEswY6GEWSphlkyYJZixUMIslTBLJswWzNgoYbZKmC0TZgtmbJQwWyXMlgmzBTM2SpitEmbLhNmCGRslzFYJs3v7rWrDhe+4kC2XTJgtmLFRwmyVMFsmzBbM2ChhtkqYLRNmC2ZslDBbJcyWCbMFMzZKmK0SZsuE2YIZGyXMVgmzZcIcwYyDEuaohDkyYY5gxkEJc1TCHJkwxxzcH6uAOTJgjkDGQel0VMAcGTBHIOOgdDoqYE5vU1/t6lE6HWRfLwPmCGQclE5HBcyRAXMEMo6LdpgKmCMD5ghkHJRORwXMkQFzBDIOSqejAubIgLkVYAEm21UBc2XAXIGMi9LpqoC5MmCuYMZF6XRVwlyZMFcw46KEuSphrkyYK5hxUcJclTBXJswVzLgoYa5KmNs7OlZnR2dhOZ903ZeNkdOjTJgrmHHxk6dKmCsT5gpmXA8dZ5UwVybMFcy4KGGuSpgrE+YJZlw0/nkqYZ5MmCeY8VDCPJUwTybME8x4KGGeSpgnE+YJZjyUME8lzJMJ8wQzHkqYpxLmyYR5ghkPJcxTCfNkwjzBjIfGME8lzOslKKoMBUqYh+QoZMI8f5BtTyXMkwnzgkE8PZUwTybMF8x4aPT0VcJ8mTC/IgzPrqiE+TJhfkUYyravEubLhPmCGR9l21cJ82XCfMGMj7Ltq4T5MmG+YMZH2fZVwnyZMF8w46Ns+yphvkyYL5jxUbZ9lTC/lwbzB5dYH8mEyYT5weBC56uE+TJhgWDGR2dVoBIWyIQFghkfnVWBSlggExYIZnyU7UAlLJAJCyrCULYDlbBAJiyoCMOzhyphgUxYIJgJULYDlbBAJiwQzAQo24FKWCATFghmApTtQCUskAkLBDMBynagEhb0kq1VthVlO0Dyrf2Eq4AmQMNn/ZlsDv7W2AtuAjyHqCNZV72XdtUFOgGeRtSRxKvey7zqgp7Ax+ZX/Vnfvpd81QVAATo/68/69r38q14lYPWBlDWSgtV7OVjdHRkAJAur99KwepWH1fG0t45kYvVeKlavcrE6nvrWkWys3kvH6sHIECAJWb2HYJXGHxgCLOuvpP2rvL+Op9/RzH+PwSqbPzAEWPK/n/2v0/86nsLHHgD0nwBUSX18D2NgzwCav1WP8H6ygrPoun6Ut1x2X4P8pa2aB3zdg95fmuNpp79+LzTfF//+7h7sVX/dP9sTn1Uy+jeKdV4Nv/NqEL1VD6w7F0EAXOh2bSXGl+ZMec+q89y9vvtLc52J/iLwchlwaQGX9kSXWfu2DhgV0H9OQPRXvysMnAAftZFjUl3t73bt3JmdO7Kb7m5awAYYV5of9e39zpsN+LXdCf7K6n1sXr+zDToNyHOm6Nu/VQ+0gVG0ibOgfXMYKILjOKGFmTwlXTB+rkVyI39rtHPlg6kZ0GjvvusL3IChC2hdrd7KCtx13mh9Ld0w2/nxOj8eyU/zHgfwAKXQGga/fgliIAgrAa1R3U0bxf57asAhCH0BLa4oN+eBiAC8mTQO1G8AA3E6EEeLy8ilRZ0/C4ykRRvKsVuHgGMwvhZtWOCFvqDFoMET3TRX84KwqsP1kuoNv84INBVItMgaldu1gEMQzSzyIGN3ZAGfIJBYtAipXjsLehJINMgSsSs3wVSBqydt+cRvzgQuQXAwaQG9vZgUOAHLnUkLVc1C3Kx6YflaMCXOiB1314cGzTH6eiqIqsClR4s2/Re6wGIB2u3TnCk3g4AlGgRCh0bM8C0nwC1osTNJ5B4cqc1ApU+Lh9iNpQAeMFFMWrPhdbzAEYhdJi12wbuUAXcg5BvEJrYv5oCOAvE9oM2sZJdkzQhG9ftu2PLrgWjq06IAfocX2GOCQbVpjOy/nAwWInhe063aUBzGaf7aqwzAbhM4dKe56Q2GB4bUp7FRv2EMxAAXrl8beURRvReFQJeBCBLQFh3hrNu7phuOMeKCxcylIby/Nh9MBHjKooXfqjiMPgBWV6+NfFqv9e+PAk7BOujQphZ+ox6YASBK2kSX6i3AIBgBdE3a7q5/pS9wBjrRJHYe4S5esPcBodOiTQ/sUl3gEJBj0cghXoUL6gAUWLQ4OHqVLfAMYLBoMMDrrACoIGY4NAqwN/lAvABtDmjzWjlwiUwsiNNEWfCtHOgLhgh9gqL2VTLQNrjs6rQBla7dAOEe7Ck8Wlhttif1XgVddkFI9YgNBVseJD/ngmnt0WZd/xpMEMBAk23aNkp2hrVZPHYAY0Jzi10pC3QCjzat0cjlsMAfANCmRRrkmlfgD0wOmwahdLMC2AACTz6x63q/5gJGAh6FaCEJ+/ElAB9Yl4nulGu3QcQEG0iLtoFUfzcGtBa4M4ju1HtRwaCC0GLT5i52sx3oPUCdS6Nk4OcLwCoPRJo0kd0NGgA7QIpPG1rwlhdoIggortvsd5t9r0EcFOlyJhBKwfB6tJlRJ9pDcY3qayzt3EA8oYWT5lcsQMeDuWASe6x5URCsXjDfozc7XfEstekwIiTNNRpgOIHfgNbA+m4K4AKAFdB0tG8gwqUAzkliCOquTQODD6aOR1SD3bcLdlkAAYfYRfItwiBSgDXZpm2196/mAxhcCANtVYLXGYGxA23ziZ1e/yYVGDqohsZ394NmwA3cNhIHrr22Dww/aJBH65neWd4FHlyah/Y3H8GCBdarCS5WSFYW5k5ortrL/ECvgL71iILgj2GBUYJPvAkA/1hoeZyzJE6Zdrr88fv3/wHscYY3"; \ No newline at end of file +window.searchData = "eJytnVtznDgWgP8Lfu1KEHf85jj2bmaciStxZmurK+WSG7XNmgYW6CTeVP77lrg0R+iAD00/zVSsc5H06Ug6oqVfRpH9KI3z9S/jOU4j45xZwcpI+U4Y58aXLOEpv3gUafVnXBkrY18kxrmxSXhZivKt+uc3T9UuMVbdX41zw/i96rS6zDpo3WRpWRX7TZUVFJVnanmgfmXkvBBppXvaG2am5UDLqdhUcZZSDffFl9j9wZNEkNrv7FB0ub17HkWFKMsZdoHIwnbexo/UNm6KzrRnmU7PaSH+uxdldc33G1Fd79OIVudWbFuLbVuxJX5EIk+yl7vsWdAAa8pXbfnlli+zJJnBdyO0gUJLfHgU1Tue8HQjSNYfRfVwKH4au5+qJ0GLKb3xrJVZ4sEuTqu/ru9IlmXZdHvECFcsVgVPyy2xsqDwslH2GJeVKN5nOx7TCOtEok5kmf0yS76LL1kyy4NaqMySk/jwKKrbIt7x4mWGD4+iyhuhk/hQFTyiDbGu5BJrSbyLq09FRGStLp61xZfY3cjBmVwkSW2bFtAbGZ4kWSezxIMfcfUUFfzHRZLQptC2PE+SpW0u0uiiLEVFq7YszrviC+m+u/1CZbrKT2FPTn7vecXfvVzMWK5I81Iy4hV/eDl61TLhzV28eaZPJsCZqhNc4stWVJun2pvbIiZOqLVM7UjeyixikO/TzdPtfpdf71P6kqYRy/e7fLtPT7GyKSv+TKt/V3KRNZFGl9kulziJ6CIuoiLLadZFGm0OkvwgucSbrNjwyyQrxW1WxuRlnZTaSKm8l1rsRSF4JS5vPn6ku1CLbJLd7mT2v8TpYyK+xJGIbuL/7uMorl5us4wWnnufylpNKdUknZq8UbPUz2s5BrveooUyKVYP3RyILfXjUy7SS5FWohBR586/4urp0Gxk17JcpJtWU+ehnOkSoOkU3oK+nU279BF06om4b5eOF0m73qRuKmspnrQLzhPMSp9+pCKa6cajqDIpdnI/Wieus+Lu5v0sV1o/tllRJdFyb/oGubt5T26Uvj2qZPF+v/Hic7vJOaaPeJIUB/FT9tVHHqe9O/M2K7Js78tp9m78JYr3uyaMX+x2fzu0wdSINWGb73bfnVP6cdnMTTPdOMGMpnqRH+VFvnxezUX6kGXPjRsfefFMzFF2go0nu05wUQaFp/FWlNVsXzrBE/qSv1RPzTxOXnpLkWYOP8HKu6nKP+KHH1nxfMfLZ9ret5Z6bKSqRmoRo9nm+ZbnoviyicsyI+7ApVQupcpeanlb3MV5Eqdz2qE6SCzKtIi0zIqbuCRn9xqJJC5PkeOrdV3WOQ3pQ5zSUuqNXJMLSQ5yMz3xnEEfNCXvsizpSdju0zpxXL7VykyeBlmud9B+qZ4VxHKlueUbUb5t/jKpSDl1+HR79dfFh/uL2w/3f179+xWNdRDj8T3P4/tnMb6Ibd0bMfnH19sPd1ef7z9fXV99/nxxc39xefnp6193rxn/zz6PK1HcF2IrioIn93yzyfbpODE0N66vru7fgQTOK9a3Qtw/TCRxNKNKv8keByd40FbzJ3rPDQ+qRnSdvZbn6XwaMZOLQu5k+KN41ZJSlGpMxbo7VfmUq3tBpVMGhehNVv+HrPKsLT7Wz0NfR4zui3iGzab0QpNF9sKT6uUdL+PyNovTakZDnrXCD1I474QXOrRpun2OG0BkvnEcqvf10d1OpNW0H305Olr9geAwI0sxcdaLvzpcseqMOFXGjymv9sUr0A+dgWJHOQGb/2OcVn3xv67vPosyz9IS9Wm0ML0j5FHhfNVnrRhe3fE6jDkhKi4T28c40ose7wzsAJiNngirSDF6o1c/4qoS6Lw2pvesl8Hrifk9Zl4k4rHgu3n2e6HFDvwQD2VcoUiP2u9lFpuP07iKeXLIU375dDPLlVb+kJ0sJ9K6M9wqkzjP+aN4l88i7qyTm1pmzXAjL+KsiKuXazGvgzq5rTi2k4bDcLtPb+qjnqkYiBakD8XJmD+umxD08RrMDMMTHkyG4HnG2xj6FV96TfnQSk4tw2a5IooCX+9PONHJHGceQnezT7KLZpf0XlQ8Tsop8sZLz5gJsoonf/Nkf4yFs1r6eyuNV3+iSqPRUSaKy+qKF6mIjnGr0yA6DadyrRA8qeKduMhfjvGrE+f5+F58vlOlqGT6A43Zr3kEZBe4AxH+o9l3Hz4ywLwaljnJJhpV+upuWnN35lYUtzq5E6WaLF92D+DY91Wjh/LLzEZiE+94MqONgcQy0xXHKcbNtqWXmUyyx+zr5w90q1JgarYhNzOPk5f771mynwPWQGqZC9tCiP+Je76vnuqFE90NRHKZK3ItcYwjmtwyN3JR7Hgq0uo+krsNjm8RcFdQ2WXuiJ8yzT22A8TdUGRmm4eRvD8emlqE6KVmrH0rXu3Ruo1oPTtI4DVDXB5d9zyL9AO6uhizXYvE48sJuvH6AO1D+vXL+8s5DtRicbovo80JnNiJshzJEo850IssNb7JolmW2/JHmFX2dMqh5+SmDi15CrInNL9G94j7U5BdCxF9eD/Xj1p0K0Q0QfsRzhzlxokcmKB9yoXXiJ/nxBj1Ux5Mkv+qeUh/e9jefH0gj9w/i1H+x8qeYgRM6n5tDIxWYnRJWT7jYX7aDSk3Qf9cNyazPK80yKuJHoIzdv/LRL5Rc8rfeRHzh0SUb9u/kE+1L9RfYYEaNX9ZftAH9EzvqVpXRlt/FycChRFa6IsdYyQS5aaIc0KTnKlFjzEmfvJdTqgSKHdUw22exA7dwivt1pU6xsQTT6MEP4qANvpiRCM6qFdNW4xbagvQsY3TfI9mTXV9Z13ZKfc7D0fMZfuKbu9QeIFB8TOX37pMI61YVSXmmbbM0GduH6j+OSCjeslF+bb918lOAt/1bOM0GsSp/oOe/o9UdeKn2OwrMapR+TtVqfzCFrYJ9u2RVgZT/m1lxGkkfhrnv4zvopC7QOPcsN7Yb0JjZWxjIb8GPl934XaT7drD9Sjb7Ov//dYW+1ts6sP883VT+q1prNbmynHe+L797dtq3QnXf6j/odPR/0styIzVmmGCTBNkiqBlrNYWJmhpgpYiaBurtY0J2pqgrQg6xmrtYIKOJugogq6xWrsrO3zjea4i6GqCriLoGau1h1n0NEFPEfSN1drHBH1N0FcEA2O1DjDBQBMMFMHQWK1DTDDUBEMVAMkDQ9lhOjxsQE+ND84PApBKEJNcMJQhpkPEVIqYZIOhHDEdJKaSxCQfDGWJ6TAxlSYmGWEuKqwDxVSimOSEoUwxHSqmUsUkKwzliulgMZUsJnlhKFtMh4updDHJDEP5YjpgTCXMksxYKGGWTpilEmZJZiyUMEsnzBrEqDpI4VEKCVMqYZZkxkIJs3TCLJUwSzJjoYRZOmGWSpglmbFQwiydMEslzJLMWChhlk6YpRJmSWYslDBLJ8xSCbMkMxZKmKUTZqmEWZIZCyXM0gmzVMJsyYyNEmbrhNkqYbZkxkYJs3XCbJUwWzJjo4TZOmH2YCasp0J8LkQmQ5UwWzJjo4TZOmG2SpgtmbFRwmydMFslzJbM2Chhtk6YrRJmS2ZslDBbJ8xWCbMlMzZKmK0TZquE2ZIZGyXM1gmzVcIcyYyDEubohDkqYY5kxkEJc3TCHJUwRzLjoIQ5OmGOSpgjmXFQwhydMGew3qoXXPiKC1lyqYQ5khkHJczRCXNUwhzJjIMS5uiEOSphjmTGQQlzdMIclTBHMuOghDk6YY5KmCOZcVDCHJ0wRyXMlcy4KGGuTpirEuZKZlyUMFcnzFUJc63R9bEOmKsC5kpkXJROVwfMVQFzJTIuSqerA+YOFvX1qh6l00XW9SpgrkTGRel0dcBcFTBXIuN6aIPpgLkqYK5ExkXpdHXAXBUwVyLjonS6OmCuCphXAxaubO/NYDOj4+WpeHkSGA9l09Px8lS8PEmMh7Lp6Xx5Kl+eJMZD+fJ0vjyVL08S46F8eTpfnsqXJ4nxUL48nS9vsHGsd44u0tbIzlGly5O8ePiuU6fLU+nyJC+ej6Hp6XR5Kl2e5MVD6fJ0ujyVLl8S46Gxz9f58lW+fEmMj/Ll63z5Kl++JMZH+fJ1vnyVL18S46N8+TpfvsqXL4nxUb58nS9f5cuXxPgoX77Ol6/y5UtmfDR++Tph/iA5UWcnUMJ8JD+hEuYHI2T7Ol++ypcfjsLp63z5Kl+BJMZH42ag8xWofAU1X3heRecrUPkKar5QsgOdr0DlK5DEBCjZgc5XoPIVSGIClOxA5ytQ+QokMQFKdqDzFah8BZKYACU70PkKVL4CSUyAkh3ofAWDBFgwOrkGSA5MJSwIR6a4QOcrUPkKJTEBOqJCna9Q5SuUxAToiAp1vkKVr1ASE6BkhzpfocpXWPOFkh3qfIUqX2HNF5411PkKVb5CSUyIkh3qfIUqX6EkJkTJDnW+QpWvUBITomSHOl+hylcoiQlRskOdr3CQZK2zrCjZIZJnHSZaJTQhEjqbv6jC4N9aaUlNiGcOTSTXag6SraYEJ8SThyaSbjUH+VZTshMG2MBs/jaUH6RcTYlPGOLySNLVHGRdzTrtao4kqpHEqznIvJreaPMjmVdzkHo169yriae6TST7ag7Sr2adfzXxdLeJZGDNQQrWDCc6AEnCmgP86tT9SAdgmX4t1V/n+k085Y5m+wcE1hl8tAOwdP8w398k/E08aY+l/Ic5/zqNj61cGJbzHyb9m6y/iaf9sbz/MPHfZP5NfABjuf9h8r/O52OTG8OS/8Psf5P+N/Hxjx0ADE8AmiMAEz9AwA4BBqcAzGoOmvBDBOQggA1OApjVHDbhEQA5DGCD0wBWJ/gZY+gQQA4E2OBEgNVJfjZ2ZIUwODgVYHWin40cWyEHA2xwMsDqZD8bObpCDgfY4HSA1Ql/NnJ8hRwQsMEJAauT/qONiJA4OCVgdeKfjZyBIQcFbHBSwOrkPxs5B0MOC9jgtIDVBwBs5CwMOTDo/q0+v/8uikpEH5pz/PW6/V7LWP0y7tvDfTnIa0vynF8O4/Nfv3/3x/nnv36DE335N2msUSO6b2CAtv7W+l+GBIqurVS9cqFXLk1P9/OcXo8LKuf6jVwQkLRpV+MC7wLgHFFb/eVlryIMgQrTaaTkLEZTpl0Y0GvuvwX5ZXi0huv1ReCWBKDSBiqdmSqzXOtdF7SfGxL1NZfeACVARyPkWlRVh0cKenWAW7Ka/pEFwAboV5oe/RqqXpsD+HVoY7O9sbO+WKhqLh8CjQbcc+f4d7geCvgGetEhjoLuChzgEezHGTXM1CHpgf7zaGFH/flTryoAQzOk0d7/aA2oAV0X0ppaf14AqOu10dpaeSqh1+P3enyiHvB9KYzQMAgy2ihuf9wMvIHVojVS/xUqdAaGU4sWRdvP65ApkflQG7Fq8GNFqAtOZBYNcPizKzBlgCgc0hjob9grDr9PAQrBTBHSaqndmA0CKNBm0YaN/GQSa364IrGINdV+RAjqaYJ60mZEedEoXOOotCnzv02jDblJtddoA+Bs2rCcugoVKAae2rSWhK+MgDYETThTTfteCBytcO1D1YbfsQqqCly0yT5qV/4ChWDk2mRssIt7gU6Atk0LBvpbGKAlYXAhu4i9AwDGMVwJ0ZZC+HX+QCWIXMQ9QfdaAlACli4WbapoF1XtCoaXz4XQgqDMEYF5jKb48AMCGBTgyq9puJUh95MUheglPGCaBD76tNja/kQAOggrSozQw8svwHoEVDegKdNuUQSrQDB5uDSQx2+EBGpBld1ZTh54VuoMvAxoHYu97gCYBuPXolUbPl0CFIGQSlz+wHdnACVw6UOsYneJAWgoMO2EtAGf7JOs7cGouRsEW7L4IMgHtOCE33cMtjGgUx0aI4cfcoL5ES4JTLsd/SZtHuqvfQMbGqDQm6dm0Bk+6NKAxkZzGxNwBqjwgkbIJzo1uFQBNBmIICFtLpTK+u1Ruq0wRjwwx3o0hA9PjMFwCacFkpa6OIw+AFbPbISCsEWDOLiGl+4C7WCedmljDL+GHAwFEC4dokr96RQQlQDDxHX88B0UoAy0JnFPRnnABKzNQAwlLuqxl0iAQoCQTUOI+H4IsAEosGkBcfL9D6AZwGATYWh/JghHkQMXHbQpDl4lDHgHMcilwYTdogLiD2i6kDYatU2vPCIFcZ/oFrwRAeqCIcec4VF3jQeoG5zGTRoXypWHYPoAaxSfFqbb5U6z9kGncRCifWJFwRIKSSl7IDr4tME7fIIAxEFQZYfIrKIMq7P8GgD0CU0t9pwH8BNodGiVRh7mAPoAgA4tYCFPbAB9YHA4NAiVW+3AghJoCohNN3hJE/QE3AjRIhv28C2AD8zzRHXak0cg8IKQadMWpPqbnaC2MAIT1elvUoBOBaHFoY1d7FZx0HqAOo9GSXdJAJxo4Ogi5gdGXqADaw5QV+JOvr8EEdALgAtohICLOkBLgbjkee0yPOgWlLS+PdxLASMTnC2IB5rKPb0gsgPafNpAbY6quHxR4zlWVg+gS2nRrX3QEHQgGJrE5Ht3ZwyYTGGWzWwX8vKbq7bhicy2NyoCLIDekFbB5ppCoAL0XEjzo7uMBvY/DBHEiNjfoA06H4xkn+gN9vQKWPQBBFxiE6kPyoDABZYIDm0DcbilDcAADydMWpyBN9uCvgN1C4iN3jxPDLoOekPju3/bGqhRvtqgqelucAfdDyrk01pmkKrwgAaPpkE+HqzuYuG+ZYaKeyQXDlNDNFXdve6gVUDb+kSH4LvIoJfgIScB4G8rI49zkcSpMM7X337//j+lb/9s"; \ No newline at end of file diff --git a/docs/classes/SolanaAgentKit.html b/docs/classes/SolanaAgentKit.html index 3950b2e..75d01d1 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, trading and more

SolanaAgentKit

-

Constructors

constructor +

Constructors

constructor

Properties

config connection wallet @@ -56,8 +56,8 @@ Please use the new constructor with Config object instead:

Example

const agent = new SolanaAgentKit(privateKey, rpcUrl, { 
  OPENAI_API_KEY: 'your-key'
});
-
  • new SolanaAgentKit(
        private_key: string,
        rpc_url: string,
        config: Config,
    ): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string
    • config: Config

    Returns SolanaAgentKit

    • Properties

    config

    config: Config

    Configuration object

    -

    connection

    connection: Connection

    Solana RPC connection

    -

    wallet

    wallet: Keypair

    Wallet keypair for signing transactions

    -

    wallet_address

    wallet_address: PublicKey

    Public key of the wallet

    -

    Methods

    cancelAllOrders

    • cancelAllOrders(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    createGibworkTask

    • createGibworkTask(
          title: string,
          content: string,
          requirements: string,
          tags: string[],
          tokenMintAddress: string,
          tokenAmount: number,
          payer?: string,
      ): Promise<GibworkCreateTaskReponse>

    • Parameters

      • title: string
      • content: string
      • requirements: string
      • tags: string[]
      • tokenMintAddress: string
      • tokenAmount: number
      • Optionalpayer: string

      Returns Promise<GibworkCreateTaskReponse>

    createTiplink

    • createTiplink(
          amount: number,
          splmintAddress?: PublicKey,
      ): Promise<{ signature: string; url: string }>

    • Parameters

      • amount: number
      • OptionalsplmintAddress: PublicKey

      Returns Promise<{ signature: string; url: string }>

    deployCollection

    deployToken

    • deployToken(
          name: string,
          uri: string,
          symbol: string,
          decimals?: number,
          initialSupply?: number,
      ): Promise<{ mint: PublicKey }>

    • Parameters

      • name: string
      • uri: string
      • symbol: string
      • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
      • OptionalinitialSupply: number

      Returns Promise<{ mint: PublicKey }>

    fetchTokenPrice

    • fetchTokenPrice(mint: string): Promise<string>

    • Parameters

      • mint: string

      Returns Promise<string>

    getAllDomainsTLDs

    • getAllDomainsTLDs(): Promise<string[]>

    • Returns Promise<string[]>

    getAllRegisteredAllDomains

    • getAllRegisteredAllDomains(): Promise<string[]>

    • Returns Promise<string[]>

    getBalance

    • getBalance(token_address?: PublicKey): Promise<number>

    • Parameters

      • Optionaltoken_address: PublicKey

      Returns Promise<number>

    getBalanceOther

    • getBalanceOther(
          walletAddress: PublicKey,
          tokenAddress?: PublicKey,
      ): Promise<number>

    • Parameters

      • walletAddress: PublicKey
      • OptionaltokenAddress: PublicKey

      Returns Promise<number>

    getMainAllDomainsDomain

    • getMainAllDomainsDomain(owner: PublicKey): Promise<null | string>

    • Parameters

      • owner: PublicKey

      Returns Promise<null | string>

    getOwnedAllDomains

    • getOwnedAllDomains(owner: PublicKey): Promise<string[]>

    • Parameters

      • owner: PublicKey

      Returns Promise<string[]>

    getOwnedDomainsForTLD

    • getOwnedDomainsForTLD(tld: string): Promise<string[]>

    • Parameters

      • tld: string

      Returns Promise<string[]>

    getPrimaryDomain

    • getPrimaryDomain(account: PublicKey): Promise<string>

    • Parameters

      • account: PublicKey

      Returns Promise<string>

    getTokenDataByAddress

    getTokenDataByTicker

    getTPS

    launchPumpFunToken

    lendAssets

    • lendAssets(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    limitOrder

    • limitOrder(
          marketId: PublicKey,
          quantity: number,
          side: string,
          price: number,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • quantity: number
      • side: string
      • price: number

      Returns Promise<string>

    manifestCreateMarket

    • manifestCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey

      Returns Promise<string[]>

    mintNFT

    • mintNFT(
          collectionMint: PublicKey,
          metadata: {
              creators?: { address: string; share: number }[];
              name: string;
              sellerFeeBasisPoints?: number;
              uri: string;
          },
          recipient?: PublicKey,
      ): Promise<MintCollectionNFTResponse>

    • Parameters

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

      Returns Promise<MintCollectionNFTResponse>

    openbookCreateMarket

    • openbookCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
          lotSize?: number,
          tickSize?: number,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey
      • lotSize: number = 1
      • tickSize: number = 0.01

      Returns Promise<string[]>

    orcaClosePosition

    • orcaClosePosition(positionMintAddress: PublicKey): Promise<string>

    • Parameters

      • positionMintAddress: PublicKey

      Returns Promise<string>

    orcaCreateCLMM

    • orcaCreateCLMM(
          mintDeploy: PublicKey,
          mintPair: PublicKey,
          initialPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • mintDeploy: PublicKey
      • mintPair: PublicKey
      • initialPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaCreateSingleSidedLiquidityPool

    • orcaCreateSingleSidedLiquidityPool(
          depositTokenAmount: number,
          depositTokenMint: PublicKey,
          otherTokenMint: PublicKey,
          initialPrice: Decimal,
          maxPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • depositTokenAmount: number
      • depositTokenMint: PublicKey
      • otherTokenMint: PublicKey
      • initialPrice: Decimal
      • maxPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaFetchPositions

    orcaOpenCenteredPositionWithLiquidity

    • orcaOpenCenteredPositionWithLiquidity(
          whirlpoolAddress: PublicKey,
          priceOffsetBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • priceOffsetBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    orcaOpenSingleSidedPosition

    • orcaOpenSingleSidedPosition(
          whirlpoolAddress: PublicKey,
          distanceFromCurrentPriceBps: number,
          widthBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • distanceFromCurrentPriceBps: number
      • widthBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    pythFetchPrice

    • pythFetchPrice(priceFeedID: string): Promise<string>

    • Parameters

      • priceFeedID: string

      Returns Promise<string>

    raydiumCreateAmmV4

    • raydiumCreateAmmV4(
          marketId: PublicKey,
          baseAmount: BN,
          quoteAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • baseAmount: BN
      • quoteAmount: BN
      • startTime: BN

      Returns Promise<string>

    raydiumCreateClmm

    • raydiumCreateClmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          initialPrice: Decimal,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • initialPrice: Decimal
      • startTime: BN

      Returns Promise<string>

    raydiumCreateCpmm

    • raydiumCreateCpmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          mintAAmount: BN,
          mintBAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • mintAAmount: BN
      • mintBAmount: BN
      • startTime: BN

      Returns Promise<string>

    registerDomain

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

    • Parameters

      • name: string
      • OptionalspaceKB: number

      Returns Promise<string>

    requestFaucetFunds

    resolveAllDomains

    • resolveAllDomains(domain: string): Promise<undefined | PublicKey>

    • Parameters

      • domain: string

      Returns Promise<undefined | PublicKey>

    resolveSolDomain

    • resolveSolDomain(domain: string): Promise<PublicKey>

    • Parameters

      • domain: string

      Returns Promise<PublicKey>

    rockPaperScissors

    • rockPaperScissors(
          amount: number,
          choice: "rock" | "paper" | "scissors",
      ): Promise<string>

    • Parameters

      • amount: number
      • choice: "rock" | "paper" | "scissors"

      Returns Promise<string>

    sendCompressedAirdrop

    • sendCompressedAirdrop(
          mintAddress: string,
          amount: number,
          decimals: number,
          recipients: string[],
          priorityFeeInLamports: number,
          shouldLog: boolean,
      ): Promise<string[]>

    • Parameters

      • mintAddress: string
      • amount: number
      • decimals: number
      • recipients: string[]
      • priorityFeeInLamports: number
      • shouldLog: boolean

      Returns Promise<string[]>

    stake

    • stake(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    tensorCancelListing

    • tensorCancelListing(nftMint: PublicKey): Promise<string>

    • Parameters

      • nftMint: PublicKey

      Returns Promise<string>

    tensorListNFT

    • tensorListNFT(nftMint: PublicKey, price: number): Promise<string>

    • Parameters

      • nftMint: PublicKey
      • price: number

      Returns Promise<string>

    trade

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

    • Parameters

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

      Returns Promise<string>

    transfer

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

    • Parameters

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

      Returns Promise<string>

    withdrawAll

    • withdrawAll(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +
  • new SolanaAgentKit(
        private_key: string,
        rpc_url: string,
        config: Config,
    ): SolanaAgentKit

  • Parameters

    Returns SolanaAgentKit

    • Properties

    config

    config: Config

    Configuration object

    +

    connection

    connection: Connection

    Solana RPC connection

    +

    wallet

    wallet: Keypair

    Wallet keypair for signing transactions

    +

    wallet_address

    wallet_address: PublicKey

    Public key of the wallet

    +

    Methods

    cancelAllOrders

    • cancelAllOrders(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    createGibworkTask

    • createGibworkTask(
          title: string,
          content: string,
          requirements: string,
          tags: string[],
          tokenMintAddress: string,
          tokenAmount: number,
          payer?: string,
      ): Promise<GibworkCreateTaskReponse>

    • Parameters

      • title: string
      • content: string
      • requirements: string
      • tags: string[]
      • tokenMintAddress: string
      • tokenAmount: number
      • Optionalpayer: string

      Returns Promise<GibworkCreateTaskReponse>

    createTiplink

    • createTiplink(
          amount: number,
          splmintAddress?: PublicKey,
      ): Promise<{ signature: string; url: string }>

    • Parameters

      • amount: number
      • OptionalsplmintAddress: PublicKey

      Returns Promise<{ signature: string; url: string }>

    deployCollection

    deployToken

    • deployToken(
          name: string,
          uri: string,
          symbol: string,
          decimals?: number,
          initialSupply?: number,
      ): Promise<{ mint: PublicKey }>

    • Parameters

      • name: string
      • uri: string
      • symbol: string
      • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
      • OptionalinitialSupply: number

      Returns Promise<{ mint: PublicKey }>

    fetchTokenPrice

    • fetchTokenPrice(mint: string): Promise<string>

    • Parameters

      • mint: string

      Returns Promise<string>

    getAllDomainsTLDs

    • getAllDomainsTLDs(): Promise<string[]>

    • Returns Promise<string[]>

    getAllRegisteredAllDomains

    • getAllRegisteredAllDomains(): Promise<string[]>

    • Returns Promise<string[]>

    getBalance

    • getBalance(token_address?: PublicKey): Promise<number>

    • Parameters

      • Optionaltoken_address: PublicKey

      Returns Promise<number>

    getBalanceOther

    • getBalanceOther(
          walletAddress: PublicKey,
          tokenAddress?: PublicKey,
      ): Promise<number>

    • Parameters

      • walletAddress: PublicKey
      • OptionaltokenAddress: PublicKey

      Returns Promise<number>

    getMainAllDomainsDomain

    • getMainAllDomainsDomain(owner: PublicKey): Promise<null | string>

    • Parameters

      • owner: PublicKey

      Returns Promise<null | string>

    getOwnedAllDomains

    • getOwnedAllDomains(owner: PublicKey): Promise<string[]>

    • Parameters

      • owner: PublicKey

      Returns Promise<string[]>

    getOwnedDomainsForTLD

    • getOwnedDomainsForTLD(tld: string): Promise<string[]>

    • Parameters

      • tld: string

      Returns Promise<string[]>

    getPrimaryDomain

    • getPrimaryDomain(account: PublicKey): Promise<string>

    • Parameters

      • account: PublicKey

      Returns Promise<string>

    getTokenDataByAddress

    getTokenDataByTicker

    getTPS

    launchPumpFunToken

    lendAssets

    • lendAssets(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    limitOrder

    • limitOrder(
          marketId: PublicKey,
          quantity: number,
          side: string,
          price: number,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • quantity: number
      • side: string
      • price: number

      Returns Promise<string>

    manifestCreateMarket

    • manifestCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey

      Returns Promise<string[]>

    mintNFT

    • mintNFT(
          collectionMint: PublicKey,
          metadata: {
              creators?: { address: string; share: number }[];
              name: string;
              sellerFeeBasisPoints?: number;
              uri: string;
          },
          recipient?: PublicKey,
      ): Promise<MintCollectionNFTResponse>

    • Parameters

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

      Returns Promise<MintCollectionNFTResponse>

    openbookCreateMarket

    • openbookCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
          lotSize?: number,
          tickSize?: number,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey
      • lotSize: number = 1
      • tickSize: number = 0.01

      Returns Promise<string[]>

    orcaClosePosition

    • orcaClosePosition(positionMintAddress: PublicKey): Promise<string>

    • Parameters

      • positionMintAddress: PublicKey

      Returns Promise<string>

    orcaCreateCLMM

    • orcaCreateCLMM(
          mintDeploy: PublicKey,
          mintPair: PublicKey,
          initialPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • mintDeploy: PublicKey
      • mintPair: PublicKey
      • initialPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaCreateSingleSidedLiquidityPool

    • orcaCreateSingleSidedLiquidityPool(
          depositTokenAmount: number,
          depositTokenMint: PublicKey,
          otherTokenMint: PublicKey,
          initialPrice: Decimal,
          maxPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • depositTokenAmount: number
      • depositTokenMint: PublicKey
      • otherTokenMint: PublicKey
      • initialPrice: Decimal
      • maxPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaFetchPositions

    orcaOpenCenteredPositionWithLiquidity

    • orcaOpenCenteredPositionWithLiquidity(
          whirlpoolAddress: PublicKey,
          priceOffsetBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • priceOffsetBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    orcaOpenSingleSidedPosition

    • orcaOpenSingleSidedPosition(
          whirlpoolAddress: PublicKey,
          distanceFromCurrentPriceBps: number,
          widthBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • distanceFromCurrentPriceBps: number
      • widthBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    pythFetchPrice

    • pythFetchPrice(priceFeedID: string): Promise<string>

    • Parameters

      • priceFeedID: string

      Returns Promise<string>

    raydiumCreateAmmV4

    • raydiumCreateAmmV4(
          marketId: PublicKey,
          baseAmount: BN,
          quoteAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • baseAmount: BN
      • quoteAmount: BN
      • startTime: BN

      Returns Promise<string>

    raydiumCreateClmm

    • raydiumCreateClmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          initialPrice: Decimal,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • initialPrice: Decimal
      • startTime: BN

      Returns Promise<string>

    raydiumCreateCpmm

    • raydiumCreateCpmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          mintAAmount: BN,
          mintBAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • mintAAmount: BN
      • mintBAmount: BN
      • startTime: BN

      Returns Promise<string>

    registerDomain

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

    • Parameters

      • name: string
      • OptionalspaceKB: number

      Returns Promise<string>

    requestFaucetFunds

    resolveAllDomains

    • resolveAllDomains(domain: string): Promise<undefined | PublicKey>

    • Parameters

      • domain: string

      Returns Promise<undefined | PublicKey>

    resolveSolDomain

    • resolveSolDomain(domain: string): Promise<PublicKey>

    • Parameters

      • domain: string

      Returns Promise<PublicKey>

    rockPaperScissors

    • rockPaperScissors(
          amount: number,
          choice: "rock" | "paper" | "scissors",
      ): Promise<string>

    • Parameters

      • amount: number
      • choice: "rock" | "paper" | "scissors"

      Returns Promise<string>

    sendCompressedAirdrop

    • sendCompressedAirdrop(
          mintAddress: string,
          amount: number,
          decimals: number,
          recipients: string[],
          priorityFeeInLamports: number,
          shouldLog: boolean,
      ): Promise<string[]>

    • Parameters

      • mintAddress: string
      • amount: number
      • decimals: number
      • recipients: string[]
      • priorityFeeInLamports: number
      • shouldLog: boolean

      Returns Promise<string[]>

    stake

    • stake(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    tensorCancelListing

    • tensorCancelListing(nftMint: PublicKey): Promise<string>

    • Parameters

      • nftMint: PublicKey

      Returns Promise<string>

    tensorListNFT

    • tensorListNFT(nftMint: PublicKey, price: number): Promise<string>

    • Parameters

      • nftMint: PublicKey
      • price: number

      Returns Promise<string>

    trade

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

    • Parameters

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

      Returns Promise<string>

    transfer

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

    • Parameters

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

      Returns Promise<string>

    withdrawAll

    • withdrawAll(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: 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 7b3f28e..58a1447 100644 --- a/docs/functions/createSolanaTools.html +++ b/docs/functions/createSolanaTools.html @@ -1 +1 @@ -createSolanaTools | solana-agent-kit

    Function createSolanaTools

    • createSolanaTools(
          solanaKit: SolanaAgentKit,
      ): (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
      )[]

    • Parameters

      Returns (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
      )[]

    Settings

    Member Visibility
    +createSolanaTools | solana-agent-kit

    Function createSolanaTools

    • createSolanaTools(
          solanaKit: SolanaAgentKit,
      ): (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
      )[]

    • Parameters

      Returns (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
      )[]

    Settings

    Member Visibility
    diff --git a/docs/functions/executeAction.html b/docs/functions/executeAction.html new file mode 100644 index 0000000..9770295 --- /dev/null +++ b/docs/functions/executeAction.html @@ -0,0 +1,2 @@ +executeAction | solana-agent-kit

    Function executeAction

    Settings

    Member Visibility
    diff --git a/docs/functions/findAction.html b/docs/functions/findAction.html new file mode 100644 index 0000000..956c00b --- /dev/null +++ b/docs/functions/findAction.html @@ -0,0 +1,2 @@ +findAction | solana-agent-kit

    Function findAction

    Settings

    Member Visibility
    diff --git a/docs/functions/getActionExamples.html b/docs/functions/getActionExamples.html new file mode 100644 index 0000000..66c7fcc --- /dev/null +++ b/docs/functions/getActionExamples.html @@ -0,0 +1,2 @@ +getActionExamples | solana-agent-kit

    Function getActionExamples

    Settings

    Member Visibility
    diff --git a/docs/interfaces/Action.html b/docs/interfaces/Action.html new file mode 100644 index 0000000..3674de1 --- /dev/null +++ b/docs/interfaces/Action.html @@ -0,0 +1,16 @@ +Action | solana-agent-kit

    Interface Action

    Main Action interface inspired by ELIZA +This interface makes it easier to implement actions across different frameworks

    +
    interface Action {
        description: string;
        examples: ActionExample[][];
        handler: Handler;
        name: string;
        schema: ZodType;
        similes: string[];
    }

    Properties

    description +examples +handler +name +schema +similes +

    Properties

    description

    description: string

    Detailed description of what the action does

    +

    examples

    examples: ActionExample[][]

    Array of example inputs and outputs for the action +Each inner array represents a group of related examples

    +

    handler

    handler: Handler

    Function that executes the action

    +

    name

    name: string

    Unique name of the action

    +

    schema

    schema: ZodType

    Zod schema for input validation

    +

    similes

    similes: string[]

    Alternative names/phrases that can trigger this action

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ActionExample.html b/docs/interfaces/ActionExample.html new file mode 100644 index 0000000..cce4440 --- /dev/null +++ b/docs/interfaces/ActionExample.html @@ -0,0 +1,5 @@ +ActionExample | solana-agent-kit

    Interface ActionExample

    Example of an action with input and output

    +
    interface ActionExample {
        explanation: string;
        input: Record<string, any>;
        output: Record<string, any>;
    }

    Properties

    explanation +input +output +

    Properties

    explanation

    explanation: string

    input

    input: Record<string, any>

    output

    output: Record<string, any>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/CollectionDeployment.html b/docs/interfaces/CollectionDeployment.html index f380d30..dde0571 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 f55a4f5..175ff9e 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/Config.html b/docs/interfaces/Config.html index c0dcef2..193bb10 100644 --- a/docs/interfaces/Config.html +++ b/docs/interfaces/Config.html @@ -1,4 +1,4 @@ -Config | solana-agent-kit

    Interface Config

    interface Config {
        JUPITER_FEE_BPS?: number;
        JUPITER_REFERRAL_ACCOUNT?: string;
        OPENAI_API_KEY?: string;
    }

    Properties

    JUPITER_FEE_BPS? +Config | solana-agent-kit

    Interface Config

    interface Config {
        JUPITER_FEE_BPS?: number;
        JUPITER_REFERRAL_ACCOUNT?: string;
        OPENAI_API_KEY?: string;
    }

    Properties

    JUPITER_FEE_BPS? JUPITER_REFERRAL_ACCOUNT? OPENAI_API_KEY? -

    Properties

    OptionalJUPITER_FEE_BPS

    JUPITER_FEE_BPS?: number

    OptionalJUPITER_REFERRAL_ACCOUNT

    JUPITER_REFERRAL_ACCOUNT?: string

    OptionalOPENAI_API_KEY

    OPENAI_API_KEY?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalJUPITER_FEE_BPS

    JUPITER_FEE_BPS?: number

    OptionalJUPITER_REFERRAL_ACCOUNT

    JUPITER_REFERRAL_ACCOUNT?: string

    OptionalOPENAI_API_KEY

    OPENAI_API_KEY?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Creator.html b/docs/interfaces/Creator.html index 4eb77fe..a3fb74b 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 4ee4fc0..6553e66 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/GibworkCreateTaskReponse.html b/docs/interfaces/GibworkCreateTaskReponse.html index 5d8987b..062d006 100644 --- a/docs/interfaces/GibworkCreateTaskReponse.html +++ b/docs/interfaces/GibworkCreateTaskReponse.html @@ -1,4 +1,4 @@ -GibworkCreateTaskReponse | solana-agent-kit

    Interface GibworkCreateTaskReponse

    interface GibworkCreateTaskReponse {
        signature?: string;
        status: "success" | "error";
        taskId?: string;
    }

    Properties

    signature? +GibworkCreateTaskReponse | solana-agent-kit

    Interface GibworkCreateTaskReponse

    interface GibworkCreateTaskReponse {
        signature?: string;
        status: "success" | "error";
        taskId?: string;
    }

    Properties

    signature? status taskId? -

    Properties

    Optionalsignature

    signature?: string

    status

    status: "success" | "error"

    OptionaltaskId

    taskId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalsignature

    signature?: string

    status

    status: "success" | "error"

    OptionaltaskId

    taskId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/JupiterTokenData.html b/docs/interfaces/JupiterTokenData.html index f2946f1..bdf6d93 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 6187512..2f6c104 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 593bef2..59e93db 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 15b26cd..739e7bd 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 7d66324..26b3f0c 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
    diff --git a/docs/interfaces/PythFetchPriceResponse.html b/docs/interfaces/PythFetchPriceResponse.html index 0b5661b..825c164 100644 --- a/docs/interfaces/PythFetchPriceResponse.html +++ b/docs/interfaces/PythFetchPriceResponse.html @@ -1,6 +1,6 @@ -PythFetchPriceResponse | solana-agent-kit

    Interface PythFetchPriceResponse

    interface PythFetchPriceResponse {
        code?: string;
        message?: string;
        price?: string;
        priceFeedID: string;
        status: "success" | "error";
    }

    Properties

    code? +PythFetchPriceResponse | solana-agent-kit

    Interface PythFetchPriceResponse

    interface PythFetchPriceResponse {
        code?: string;
        message?: string;
        price?: string;
        priceFeedID: string;
        status: "success" | "error";
    }

    Properties

    code? message? price? priceFeedID status -

    Properties

    Optionalcode

    code?: string

    Optionalmessage

    message?: string

    Optionalprice

    price?: string

    priceFeedID

    priceFeedID: string

    status

    status: "success" | "error"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcode

    code?: string

    Optionalmessage

    message?: string

    Optionalprice

    price?: string

    priceFeedID

    priceFeedID: string

    status

    status: "success" | "error"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/modules.html b/docs/modules.html index 52a12f1..37d8574 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -solana-agent-kit

    solana-agent-kit

    Classes

    SolanaAgentKit

    Interfaces

    CollectionDeployment
    CollectionOptions
    Config
    Creator
    FetchPriceResponse
    GibworkCreateTaskReponse
    JupiterTokenData
    LuloAccountDetailsResponse
    MintCollectionNFTResponse
    PumpfunLaunchResponse
    PumpFunTokenOptions
    PythFetchPriceResponse

    Functions

    createSolanaTools

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    Functions
    +solana-agent-kit

    solana-agent-kit

    Classes

    SolanaAgentKit

    Interfaces

    Action
    ActionExample
    CollectionDeployment
    CollectionOptions
    Config
    Creator
    FetchPriceResponse
    GibworkCreateTaskReponse
    JupiterTokenData
    LuloAccountDetailsResponse
    MintCollectionNFTResponse
    PumpfunLaunchResponse
    PumpFunTokenOptions
    PythFetchPriceResponse

    Type Aliases

    Handler

    Variables

    actions

    Functions

    createSolanaTools
    executeAction
    findAction
    getActionExamples

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    Type Aliases
    Variables
    Functions
    diff --git a/docs/types/Handler.html b/docs/types/Handler.html new file mode 100644 index 0000000..9844f48 --- /dev/null +++ b/docs/types/Handler.html @@ -0,0 +1,2 @@ +Handler | solana-agent-kit

    Type Alias Handler

    Handler: (
        agent: SolanaAgentKit,
        input: Record<string, any>,
    ) => Promise<Record<string, any>>

    Handler function type for executing the action

    +

    Type declaration

      • (
            agent: SolanaAgentKit,
            input: Record<string, any>,
        ): Promise<Record<string, any>>

      • Parameters

        Returns Promise<Record<string, any>>

    Settings

    Member Visibility
    diff --git a/docs/variables/actions.html b/docs/variables/actions.html new file mode 100644 index 0000000..712f2a5 --- /dev/null +++ b/docs/variables/actions.html @@ -0,0 +1 @@ +actions | solana-agent-kit

    Variable actionsConst

    actions: Action[] = ...

    Settings

    Member Visibility