update docs

This commit is contained in:
Arihant Bansal
2024-12-23 11:52:53 +05:30
parent ad1e8e3f2a
commit 055ec1613d
17 changed files with 50 additions and 45 deletions

View File

@@ -5,8 +5,8 @@
--dark-hl-1: #D4D4D4;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #000000;
--dark-hl-3: #C8C8C8;
--light-hl-3: #AF00DB;
--dark-hl-3: #C586C0;
--light-hl-4: #001080;
--dark-hl-4: #9CDCFE;
--light-hl-5: #008000;
@@ -15,10 +15,8 @@
--dark-hl-6: #569CD6;
--light-hl-7: #0070C1;
--dark-hl-7: #4FC1FF;
--light-hl-8: #AF00DB;
--dark-hl-8: #C586C0;
--light-hl-9: #098658;
--dark-hl-9: #B5CEA8;
--light-hl-8: #098658;
--dark-hl-8: #B5CEA8;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@@ -33,7 +31,6 @@
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--code-background: var(--light-code-background);
} }
@@ -47,7 +44,6 @@
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--code-background: var(--dark-code-background);
} }
@@ -61,7 +57,6 @@
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--code-background: var(--light-code-background);
}
@@ -75,7 +70,6 @@
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--code-background: var(--dark-code-background);
}
@@ -88,5 +82,4 @@
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
.hl-9 { color: var(--hl-9); }
pre, code { background: var(--code-background); }

View File

@@ -1 +1 @@
window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE4XTQUvDMBTA8e+Sc7E4dEhvw9KDzm1ob+IhxNc1LH0vJC+gyL67bBNdXfZ26SX//l4T0tcvxfDBqlIv5DTq2RqQHy2rQnnNvaqUcTpGiOV4/arnwalCbSy+q+p6crctfqV7cg4MW8IavKPPAfDIs8gQOm0glrlwDE9up1l46XfPeEH9qUQygGYKeeiwJr3eAJt+FayBZ4ieMEJWOs0k9CF5yxBa2gDWmnWW/B9J4Dw5mhlDCbkG1tZF8WvP59KQJ4v8d/SLphVnnK2lEas0+C7hXCc0vchny0t0k3B/nNLlynQSa3ZXCA6/TkvkjtAu4X7vsTyJxuL0Zvv2DYU9ByOnAwAA"
window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE42TwU7DMAyG3yXniooJJtTbRNUDDJigN8QhCi6JltpR40hMaO+OtiFYWebtkos/f7asP69fiuGTVaVeyGvUsw9AvnesChU0W1Up43WMEMtx/cJy71Whlg7fVXU5uVkXv6Zb8h4MO8IagqdVD7jnc8gwdNpALHPgWDy5nmbFT2HzxhPWH0pUDqCZhrxoV5PaG2BjF4Mz8AwxEEbImg4xSXqXgmMYWloC1pp1VvkfkoTz5GlmDCXkGlg7H8Vtj+PSkAeH/Hf6x6YVZxylpRGL1Icu4VwnNFbUZ8lT6ibh9pxSuDKcqF2xPTMjeVSSm00+YfcvWyK/t3GXcHvYWB5AY+P0av32DUTvPWMEBAAA"

View File

@@ -1 +1 @@
window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7WcUXOcOBLHvwt+nXIsIQnsNyc5V+Uuu5taZ/ceplIuDLLDmQEWNMnNpfLdrwTD0Bo148Z4n5LyqLv/Ej+1hJD0I2iq721wtf4RPOVlFlwxHq+CMtno4Cq4rYqkTK4fdWn+lZtgFWybIrgK0iJpW92+cX8+/2o2RbAafg2uguDnavAqGT94TauyNc02NVVDcXnmlgfuV0GdNLo0vtIxMLvgAkYudWryqqQGHosvifs9KQpNar+zQ9Hl8e6SLGt0286IC0yWxK9qXSb5XVLnd096R4rvmcyMzy/EyG2j/9rq1twk21Sbm22Z0doANVuiI9N1Ue0+V0+aBpxbfnnkd1VRzOAdMVqi4VGbt0mRlKkmRXeKL4m7yUvz681nUtCx7JKIpknK9kHT0hkovIzxx7w1unlfbZKc9nw9k2Xx26r4pm+rYpYCz2ghYZ+afJM0uxkaEKOFzz6jAT6UXBKt0GV23bba0DKaU3xhS3/+dEtt377o0ng2Db5PTPJ2dz1jIJuyfD01n/P0idjXJwyXaHnQJv3aOf3U5MTU6tssYjDZlunXT9tNfbMt6YMbarZER2uSJ1r9h5KLoukye1dtaouTzq7zJmuqmhZ9wnKJmrTRidG/NWlym5ePhb7NM539+2veFHVVFbTZ7XMuFo0OyS7Lt5t3XYzrzeZPQRsfMLNX0/Gu2Gzmy9hbvZ6K+kUq6sUq7BT7vqqeeoe/JM0T8Z1kwnCmFiWO6O1Lfq6qYszsD9uym3q2b7wyJ98vuVQH751M8G6Zl0Y3D0mq2zf7n066ct5kjl+hJnydPffeNGiaCFPrJtWlSR71s5GcotRgTvMc5ve/1V1ToyGPC9GbrPuH7PJsX3yiJp7WiaDbJp8Rsy+9MGRT7ZLC7N4mbd5+qvLSzGjIM9R4oaC0f+xzZACT+cFxqN53L5Eba35Sx1iOjlZ6sD6eEVJCnGHmz1UbVGdCVJs/lonZNs9AfywGmr1IBGz+X/LSjMV/vfn8u27rqmxRTZOF6Q/CvjbPd322N8OrO12HKRHaJFlikpcIGU1fLgY+ADitPZFWkWL0Rjffc2M0Oq5N+T0bbfB6YrqnwutCPzbJZl780WixgO/6vs0NivRk/NFmcfi8zE2eFB/zv7Z5lpvd7W8fZ0nB7RfLaou8rpNH/baeRdyZa7dYRt3kVZOb3Y2e94Bcu5fIOO6GD9vyY/eqeSoHogXpXfFkzp/2TUj6eA1mpuETCk6m4HnB9zn0D3zqdUqDY/kKUnTT4PP9EyIGm5eFh9B93BbVdZpW29K81ybJi/YUedOlZ4wElUmKP5Ni+5IIZ441Xv0TVZrMjkY3ujX/SJpSZy+R5Xl4LWmNTgqTb/R1vXuJLtf8tUS12pi8fERz9nOKgO0COUrKcIT47s7s6hfhNKg5P7iYK+r8UKGp74nfS3zeM1Pb+eDoxQqHSk4tFxRF9V1nn5rKVClc11igGfH5d8n/Wm30ffKivOXJBr7+LrmbvMw3283vCT4pnKvYdfeKouFg8c9tnRvdHL4KYMKPy7zKchXq9Nl1K0/uzEUfPOrJNR9qyHa3uQdL3c8GPZRfFjbTab5J8K6NBwYWy0KbBB8v8LD70stCFtVj9cfvH+hRR4OFzZzkxe7uW1Vs54B1ZLVMwkOj9f/0XbI1X7tXFLoMxHKZFDtrf4kQz26ZjFo3m6TUpbnL7Hv9RN7FpaC2y+To/xpdtlNrLbgMx2Z2eOqc6bnYz82VPHsge3JtNC8fdfpUfUBn30RF566b2epOD3439jt09wn61BuSX2rGi7lJzBbFYcLr2cECrysiefKl7EmXeONPxR5NlgavbaEP5R+379/NEeCaLRWx0W078QlrSsBosjR4WmWzIu/L08N+WQV5men/Blc/gm+6sbgHVwE/D88vg1XwkOsis/toh6lQWm32H0GyKt12//2yL/anTruPLlfrvvSbi2C1vliJi3N1Ib58Wa0H4+6H7g+Dj/EvnSELVmuGGTLPkDmGPFitOWbIPUPuGIbBah1ihqFnGDqGIlitBWYoPEPhGMpgtZaYofQMpWOogtVaYYbKM1SOYRSs1hFmGHmGkWMYB6t1jBnGnmHsGF4Gq/UlZnjpGV66AFgeGMoO8+FhR/R0+OD8IAC5BDHLBUMZYj5EzKWIWTYYyhHzQWIuSczywVCWmA8Tc2lilhGG8sR8oJhLFLOcMJQp5kPFXKqYZYWhXDEfLOaSxSwvDGWL+XAxly5mmWEoX8wHjLmEccsMRwnjPmHcJYxbZjhKGPcJ40c5qktSeJZC0pRLGLfMcJQw7hPGXcK4ZYajhHGfMO4Sxi0zHCWM+4RxlzBumeEoYdwnjLuEccsMRwnjPmHcJYxbZjhKGPcJ4y5h3DLDUcK4Txh3CQstMyFKWOgTFrqEhZaZkK1CeS4ulWvsExa6hIWWmRAlLPQJC49Gwm4oxMdCZDB0CQstM6FAZfuEhS5hoWUmRAkLfcJCl7DQMhOihIU+YaFLWGiZCVHCQp+w0CUstMyEKGGhT1joEhZaZkKUsNAnLHQJE5YZcYG1tvAJEy5hwjIj0BwmfMKES5iwzAiORvYJEy5hwjIjUMKET5g4mm91Ey58xoVMuVzChGVGoIQJnzDhEiYsMwIlTPiECZcwYZkRKGHCJ0y4hAnLjEAJEz5hwiVMWGYESpjwCRMuYdIyI9EcJn3CpEuYtMxIlDDpEyZdwiSfZFv6hEmXMBlO4il9wqRLmLTMSDR7Sp8weTSr76b1KNsSmdi7hEnLjETZlj5h0iVMWmYk/kbhEyZdwqRlRqJsS58w6RImLTMSZVv6hEmXMNURhrKtfMKUS5jqCLvEnrPyCVMuYcoyo1C2lU+YcglTlhmFsq18wpRLmLLMKJQw5ROmXMKUZUahhCmfMHX07ti9PKKEKeT10SVMRZNzEuUTplzCVDw5M1A+YcolTFlmFMq28glTLmGRZUahbEc+YZFLWGSZUfhbs09Y5BIWdYShbEc+YZFLWNQRhubtyCcscgmLLDMRynbkExa5hEWWmQhlO/IJi1zCIstMhLId+YRFRysU3RIFynaELFK4hEXxZDKIfMIil7DIMhOhHSPyCYtcwmLLTITiGfuExS5hsWUmQvGMfcJil7DYMhOheMY+YbFLWGyZifCFHZ+w2CUs7ghD8Yx9wmKXsNgyE6N4xj5h+z91C5XfdGN09qFfsFyvD98qfgR3+1VMeTmsnf4IFAuufvxcBVFs//05rl52fz0sYNrfbMTDV+PRW8hGb+Hem4po3voNDvW4wWF0q4BbFZLc9Qu7o4v4YnQRS6KL/UeQPIOeIjF6ii6JnoY9xFibgScQzvWXgX32wGUMXNIe5uiyGjYuA38h8Edt//HWhNERH/1wqpvx1ofRD+CB0fx054iqJk3a7phba4+5fR+PuQGJ4PFyMcN52x1SMtURuxw8Xk58vMPRJfAEAL7hxRwv7oOMgBtav3Q/poM+CeoV0ZgYt0AANwq4oVWsZz4FFxSAbg56+Qxnpj+ICjo5UEXys99IChIr6DOSlnDgV2kgBTiKaGK6k77dV73m8IUVOJSgkWhN3jnsGqnujw4DvgGZnOjN2xgBxAF3Ea37PWpzP1wZMToCeNJ63aM2dX8jQLa/EQDkG5AUGFlV12B2i/P9Dsn7DLDKaLC6Ps3+IDlwCSrNyLU2tasLsM9ovI27/EDHBrle0ZpsfzaiGM5GtG5mFqDBBK3Bht3Eer+bGHRPkHckzdl/+g0Phyfg1BYAohTJXX8Svu63mHsJiIMhjtPGOHvNQ7K/5gE8TlBRRlRWPVbd4UhQP9D2EW3oLrZFlfSbJLN+kySWjCRoOEmTd9gtALIGAD+mwTYe/gKEgVQraGPa4OaovSSgXxIF9RtPm25PFGh5oEnRxpH+dAeoFhAjeG8kidU72joGmhwAGtF1jcN2+WAwIATwK2jgW7/lg1NlBoYRRhuVuuJwrgTIDEVvpGiZ4vgaK8AFwILsyp667+eYm/2pe5AnQMfkRHX99neAGGgsRevc8Pw5aDIAWkh25G0IBJABhxEtO3QTlLzctlnqeIIzQxr7w6G0B+1mLNBakobWPsn3GR/NggB6SYMeDhzIK5sA9ApaAtrfNNGTlmw234QDGkCX09h1HKbdBRrAHxiXOO3Ruv7qI39g2sJp05bhTE9Su30UeJK0WdRwpxYycwQEM1qX2F9A99BdQPfQX0AHOivoq0R33W1bbVUg6sDgwmi9Yn9nwb29s6De31kAMgCQF9L02Ytx0sPFOMlwMQ54skAkp4kcz0aBxwoygKL1W3BQE/Qs0P/FxX40pT3Z4bTtvTvjFmD2ImjA9YsNib1f5Sl3BgSgjljJ/lok0N5wlYZYsf32WZBvAQgxLaMNRzMA6yDnKFrD9OcdgAv4Jk/TMZ5WB48IVEfQuO4y89HSIRAT01q2O6b5rT+mCViG8whastvfOwf6PvDBaAl9vLQQuIFrccQGHq4jAO0LxAiamKMZdwg8hDQPwy2rwAnwMcPFHfJ6D8dfmqvhkgLgA/AiCI/5yyqo81oXeamDq/WXnz//DxMMox3YVwAA";
window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7Wc23LbOBKG34W+VTkBCJCU73JYV2U3M5MaZ2YvVCkXLcIO1xTJIaFktam8+xYoSuwWmnLT9FzNVIzu/gF8aBxE4EfQVN/b4Gr1I3jMyyy4EjJZBGW6McFVcFMVaZm+eTCl/Vdug0WwbYrgKlgXadua9hX+8+VXuymCxeGvwVUQ/FwcvGohj17XVdnaZru2VcNxeYHLA/eLoE4bU1pf6RBYvJYKRi7N2uZVyQ08FJ8T93taFIbVfhfHovPj3aZZ1pi2nRAXmMyJX9WmTPPbtM5vH82OFd8zmRhfvlYDt435a2tae51u18Zeb8uM1wak2RwdmamLave5ejQ84HD5+ZHfVUUxgXfCaI6GB2PfpkVarg0rOio+J+4mL+2v159ZQYeycyLaJi3be8NLZ6DwPMYf8taa5n21SXNe/3om8+K3VfHN3FTFJAWe0UzCPjX5Jm12EzQQRjP7PuMBfig5J1phyuxN2xrLy2io+MyW/vzphtu++6Jz47k0+D616dvdmwkT2Zjly6n5nK8fmWN9xHCOlntj1187p5+anJlafZtZDKbbcv3103ZTX29L/uRGms3R0dr0kVf/Q8lZ0UyZvas2tcPJZG/yJmuqmhd9xHKOmnVjUmt+a9bpTV4+FOYmz0z27695U9RVVfBWt0+5mDU7pLss327edTHebDZ/Kt78QJm9mI53xWYzXUZv9XIq6mepqGercEvsu6p63Dv8JW0emXuSEcM5Wuqd/XrtshI/iXkmE+NH6mT07Et+rqpimFnut2W39G1feWXO7m+ljo7eu2YCe9u8tKa5T9emfdX/6awrtJM63cKN+Lp4at920DQSpjbN2pQ2fTBPRkJFucFQ8xz3F7/VXVOTIU8L8Zus+w/b5UVffKQmntaRoNsmnxBzX3pmyKbapYXdvU3bvP1U5aWd0JAXpPFMQet9t0+RAUymB6ehet9tYjfO/KyOoRwfrfXR+nRFyglxQZk/VW1QnRFRbf5QpnbbPAH9qRho9iwRsPl/yUs7FP/1+vPvpq2rsiU1jRbmd4Tbtk93fdGb0dUdr8OYCGPTLLXpc4QMps8XAzsALqvPpFWiGL/R7ffcWkPOa2N+LwYbup6U7rHwpjAPTbqZFn8wmi3gu7lrc0siPRp/sJkdPi9zm6fFx/yvbZ7ldnfz28dJUmj72bLaIq/r9MG8rScRd4HtZsuom7xqcru7NtM6CNs9R8bpMLzflh+7re65HEgW5A/Fszl/3Dcj6dM1mJiGzyg4m4KnBe9z6B/00uucBmT5AlJM09Dr/TMiDjbPCw+h+7gtqjfrdbUt7Xtj07xoz5E3XnrCTFDZtPgzLbbPiXCBrOnqn6nSaHa0pjGt/UfalCZ7jizPw0tJa0xa2Hxj3tS75+jC5i8lqjXW5uUDmbOfUgRsZ8iJtA4HiG9v7a5+Fk4HNZdHF1NFXR4rNPZ75veSXvdM1HZ5cPRshYdKjh0XFEX13WSfmspWa3iuMUMz4fPvkv+12pi79Fl5y5MNfP1dcjd5mW+2m99TelE4VTF294Ki4WTxz22dW9Mcf5WghJ+WeZHjKtLpk+dWntyJhz501LNnPtyQ7W5zB47anwx6LD8vbGbW+SalhzYdGFjMC21Ter6gw/al54Usqofqj98/8KMOBjObOc2L3e23qthOAevEap6E+8aY/5nbdGu/dlsUvgzCcp4Ut2p/jhDPbp6M2jSbtDSlvc3cvn4k79JSSNt5csx/rSnbsbMWWgaymRyeu2Z6KvZTayXPHsgePRvNywezfqw+kKtvpqJL7GayuvOT3/Dz0bkdkl9qwsbcpnZL4jDi9eJoQdeVkDy6KXs0Jd34Y7EHk7nBa1foQ/nHzft3UwRgs7kiNqZtR37CGhMwmMwNvq6ySZH78s8Iiw6c0I+iZ0+cyJIvQfYZz0/RPSL/HGTXxmQf3k/VgU1fTMyzZLyQgDO0n5PwFPHTRIxRf07BWfLHwn9ZBHmZmf8GVz+Cb6ZxyT64CuRleLkMFsF9borMfcV+2Aisq03/E2BWrbfd/37pi/1p1t1PjlerfelXr4PF6vVCicswTr58WawOxt0fun84+Bj+pTMUwWIlKEPhGQpkKIPFSlKG0jOUyDAMFquQMgw9wxAZqmCxUpSh8gwVMtTBYqUpQ+0ZamQYBYtVRBlGnmGEDONgsYopw9gzjJFhEixWCWWYeIYJMlwGi9WSMlx6hksMgONBkOwIHx5xQk+HD80PARAmSDguBMmQ8CESmCLh2BAkR8IHSWCShONDkCwJHyaBaRKOEUHyJHygBCZKOE4EyZTwoRKYKuFYESRXwgdLYLKE40WQbAkfLoHpEo4ZQfIlfMAEJkw6ZiRJmPQJk5gw6ZiRJGHSJ0ye5KguSdFZikhTmDDpmJEkYdInTGLCpGNGkoRJnzCJCZOOGUkSJn3CJCZMOmYkSZj0CZOYMOmYkSRh0idMYsKkY0aShEmfMIkJk44ZSRImfcIkJix0zIQkYaFPWIgJCx0zIUlY6BMWYsJCx0woF2F0KWNs6wMWnkyE3UxIT4XEXIgBCx0yIQlY6AMWYsBCh0yoKdU+XyHmK3TEhCRfoc9XiPkKHTEhyVfo8xVivkJHTEjyFfp8hZiv0BETknyFPl8h5ks5YhTJl/L5Upgv5YhRgmhs5eOlMF7KEaPIBKZ8vhTmSzliVEgF9vFSJ2utbrFFr7aI5RbGSzliFJm/lM+XwnwpR4wi+VI+XwrzpRwxiuRL+XwpzJdyxCiSL+XzpTBfyhGjSL6Uz5fCfGlHjCb50j5fGvOlHTKazF/aB0xjwLRDRpOAaR8wjQHT4RjZ2gdMY8C0GoNT+3zpk/V8t6AnE6cmlvSYL+2I0STZ2udLY760I0bTewmfL4350o4YTZKtfb405ks7YjRJtvb50pivqOOLJDvy+YowX1HHF0l25PMVYb4iR0z0mujmyMcrwnhFjpiIBDvy+YowX5FDJiLBjnzAIgxY5JCJSMAiH7DoZNPY7RpJwCJi34gBixwyEQlY5AMWYcCiZGwxEvl8RZivaDm2JIh8vCKMV+yAiUiwYx+vGOMVO2AierPs4xVjvOIOLxLs2OcrxnzFHV8k2LHPV4z5ih0xMZmyY5+vGPMVO2JikuzY5yvGfMWOmJgkO/b5ik8OJrqTCZLsmDibwHzFDpmYJDv2AYsxYPFyLBPEPmAxBixxyMTkqEh8wBIMWOKQiUk6Ex+wBAOWOGTimFCd+HwlmK/EERPTpzk+XwnmK+n4IuFMfL4SzFfiiEmotk58vBKMV+KASahJPfHpSjBdieMlIdFMfLqSk6OvZLSpicMvDFfieElIrBOfrgTTtXS8JCTWS5+uJaZrKcaaeunDtcRwLeVYUy99uPp/6s6Qv5nGmuzD/ix5tTr+iPojuO0PmKPXh+PtH0Ekg6sfPxdBvHT//TkcLHf/ejxbdn9zEY+fswzeQjl4C3tvUcLztv/yqh6+vAIigdtIsdztz90HF4kYXCTR3mgpma76X2nzDHqMNfD4munpcMmBaDsFekJN9ZeBi0CgO5agO3idOrisDjcrgD8F/HH7YXhWZnAE+pPbB+BZnMEP6FTB89NddKyaddp294Bbdw/4+3APGEgEdZXMunbO2+4Wpa1OGA5B94bM7j3crQReQI3DCVXurp0BNwlwwxuf+GsfMAxAvWJeOw3faIEhHgM3vIrtmV+DF1zAcAdjc4Izu7+pD2oHVLH89F+6Dx404EhHPB/gsxkgBTiKeZXqnkLofoZtjj+WA4cRaCRek3cOu0bqf9wF4wVwIHl8+19uAXEA9Fiz3D0Ye3d4U2dwBFIgLwM+GFvvn0zJ+idTQL4BfSB4sD8Y2zWYu4NxtyPyvgCsCl6/Yp+2f2kDuASVFuxa2xrrAuwLHvzDZ8hgYIdg7uZ1ZH95qzhc3mpxZlagdopXu8N1B9NfdwDDE9RS85z9Z/9F1rEHUG3BoiDiNdr+qZB6fwfGS0ASjAPJG6TuHZy0fwcHdCcY7YKXh9znpd3tbVA/0PZxyPOyLap0/xV3tv+Km0pGGjSc5jXc8eMOkPZBEkp0v8rjtdpwSxWQBoa74g33g5uTdtNgFGjeKOi/kG+6jzdBDwBNEa8f99fQQLWAGBXujTSzeiffuIKEDdZ0MV/XMH2X95YCQwG/irdYdH7Le1RlAcAQvNmpKw7XTIDQsGcr4mWM0/f+ABcAC7Yr9zzJfq256Z8nAfkCzCaSN5v093QAYiDnRLxBDh/KAE0GQAvZjrwvlwFkwGHMyxLeQiUBA2jJQ6HzcW9MhneACVCT8EjoPOXlts3WqF4grSa8kXi4y3tvcB4Ffad5ma+fevbzEJmbwRDUvCEIpzNiI6kA94oHvnsRZ1jPIuRB40lmNyBnVJ0TUOeER1r/hNF+ZKabzTeFVIIqS16VkcN19zIT8Afmc8nLt9hffeIPLIQks8L9Zc20xjkNpKCIN8AOjzUSK27QD4LHXv+y6X33sun9/mVTkNyAOKa77hnHtioIdSADCF6C6x+juXOP0dT9YzQgY4JeCHm94F5cWx9fXEsPL66BngUiJU/kcOkVdCsYZhEvs4Ab+GDsgwylRL/6YMrqn1G4wzsVDSZ3zQNuf0iTuoezHnM0gQJfTFf79/ZAe8PTLR6yhy/HwYwAQEj6k9SEN58f7t4B5gH0Ma9W+wttwAUY1DGvUsNzJKDzQbUUj+9uDjk5eoXHOzx0unv43/b38AE5oGE0r3X7h01BDgCJXfAS+/AqLnADzzJ5w+v43gxoX1AhxctvJzuVEHgIeR4Oz3gDJ8DHBBe31LE4qBDP1eEVGuAD8KIY3fxlEdR5bYq8NMHV6svPn/8HMwsErTleAAA=";

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -86,25 +86,28 @@
<a id="md:📦-installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📦 Installation<a href="#md:📦-installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">solana-agent-kit</span>
</code><button type="button">Copy</button></pre>
<a id="md:quick-start" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Quick Start<a href="#md:quick-start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="typescript"><span class="hl-3">agent</span><span class="hl-1">: </span><span class="hl-4">SolanaAgentKit</span><span class="hl-1">, </span><span class="hl-4">createSolanaTools</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&quot;solana-agent-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// Initialize with private key and optional RPC URL</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">agent</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">SolanaAgentKit</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;your-wallet-private-key-as-base58&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;https://api.mainnet-beta.solana.com&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;your-openai-api-key&quot;</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-5">// Create LangChain tools</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tools</span><span class="hl-1"> = </span><span class="hl-0">createSolanaTools</span><span class="hl-1">(</span><span class="hl-4">agent</span><span class="hl-1">);</span>
<a id="md:quick-start" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Quick Start<a href="#md:quick-start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">SolanaAgentKit</span><span class="hl-1">, </span><span class="hl-4">createSolanaTools</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;solana-agent-kit&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// Initialize with private key and optional RPC URL</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">agent</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">SolanaAgentKit</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;your-wallet-private-key-as-base58&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;https://api.mainnet-beta.solana.com&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;your-openai-api-key&quot;</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-5">// Create LangChain tools</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tools</span><span class="hl-1"> = </span><span class="hl-0">createSolanaTools</span><span class="hl-1">(</span><span class="hl-4">agent</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<a id="md:usage-examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage Examples<a href="#md:usage-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:deploy-a-new-token" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Deploy a New Token<a href="#md:deploy-a-new-token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">result</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">deployToken</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;my ai token&quot;</span><span class="hl-1">, </span><span class="hl-5">// name</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;uri&quot;</span><span class="hl-1">, </span><span class="hl-5">// uri</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;token&quot;</span><span class="hl-1">, </span><span class="hl-5">// symbol</span><br/><span class="hl-1"> </span><span class="hl-9">9</span><span class="hl-1">, </span><span class="hl-5">// decimals</span><br/><span class="hl-1"> </span><span class="hl-9">1000000</span><span class="hl-1"> </span><span class="hl-5">// initial supply</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&quot;Token Mint Address:&quot;</span><span class="hl-1">, </span><span class="hl-4">result</span><span class="hl-1">.</span><span class="hl-4">mint</span><span class="hl-1">.</span><span class="hl-0">toString</span><span class="hl-1">());</span>
<a id="md:usage-examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage Examples<a href="#md:usage-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:deploy-a-new-token" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Deploy a New Token<a href="#md:deploy-a-new-token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">result</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">deployToken</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;my ai token&quot;</span><span class="hl-1">, </span><span class="hl-5">// name</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;uri&quot;</span><span class="hl-1">, </span><span class="hl-5">// uri</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;token&quot;</span><span class="hl-1">, </span><span class="hl-5">// symbol</span><br/><span class="hl-1"> </span><span class="hl-8">9</span><span class="hl-1">, </span><span class="hl-5">// decimals</span><br/><span class="hl-1"> </span><span class="hl-8">1000000</span><span class="hl-1"> </span><span class="hl-5">// initial supply</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&quot;Token Mint Address:&quot;</span><span class="hl-1">, </span><span class="hl-4">result</span><span class="hl-1">.</span><span class="hl-4">mint</span><span class="hl-1">.</span><span class="hl-0">toString</span><span class="hl-1">());</span>
</code><button type="button">Copy</button></pre>
<a id="md:create-nft-collection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Create NFT Collection<a href="#md:create-nft-collection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">collection</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">deployCollection</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">&quot;My NFT Collection&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">uri:</span><span class="hl-1"> </span><span class="hl-2">&quot;https://arweave.net/metadata.json&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">royaltyBasisPoints:</span><span class="hl-1"> </span><span class="hl-9">500</span><span class="hl-1">, </span><span class="hl-5">// 5%</span><br/><span class="hl-1"> </span><span class="hl-4">creators:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">address:</span><span class="hl-1"> </span><span class="hl-2">&quot;creator-wallet-address&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">percentage:</span><span class="hl-1"> </span><span class="hl-9">100</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span>
<a id="md:create-nft-collection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Create NFT Collection<a href="#md:create-nft-collection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">collection</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">deployCollection</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">&quot;My NFT Collection&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">uri:</span><span class="hl-1"> </span><span class="hl-2">&quot;https://arweave.net/metadata.json&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">royaltyBasisPoints:</span><span class="hl-1"> </span><span class="hl-8">500</span><span class="hl-1">, </span><span class="hl-5">// 5%</span><br/><span class="hl-1"> </span><span class="hl-4">creators:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">address:</span><span class="hl-1"> </span><span class="hl-2">&quot;creator-wallet-address&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">percentage:</span><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
<a id="md:swap-tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap Tokens<a href="#md:swap-tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-8">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-8">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">trade</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;target-token-mint&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-9">100</span><span class="hl-1">, </span><span class="hl-5">// amount</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;source-token-mint&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-9">300</span><span class="hl-1"> </span><span class="hl-5">// 3% slippage</span><br/><span class="hl-1">);</span>
<a id="md:swap-tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap Tokens<a href="#md:swap-tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">trade</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;target-token-mint&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1">, </span><span class="hl-5">// amount</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;source-token-mint&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-8">300</span><span class="hl-1"> </span><span class="hl-5">// 3% slippage</span><br/><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<a id="md:lend-tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Lend Tokens<a href="#md:lend-tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-8">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-8">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">lendAssets</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-9">100</span><span class="hl-1"> </span><span class="hl-5">// amount of USDC to lend</span><br/><span class="hl-1">);</span>
<a id="md:lend-tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Lend Tokens<a href="#md:lend-tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">lendAssets</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-8">100</span><span class="hl-1"> </span><span class="hl-5">// amount of USDC to lend</span><br/><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<a id="md:stake-sol" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Stake SOL<a href="#md:stake-sol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">stake</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-9">1</span><span class="hl-1"> </span><span class="hl-5">// amount in SOL to stake</span><br/><span class="hl-1">);</span>
<a id="md:stake-sol" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Stake SOL<a href="#md:stake-sol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">stake</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1"> </span><span class="hl-5">// amount in SOL to stake</span><br/><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<a id="md:send-an-spl-token-airdrop-via-zk-compression" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Send an SPL Token Airdrop via ZK Compression<a href="#md:send-an-spl-token-airdrop-via-zk-compression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-8">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-8">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-6">async</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;~Airdrop cost estimate:&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">getAirdropCostEstimate</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-9">1000</span><span class="hl-1">, </span><span class="hl-5">// recipients</span><br/><span class="hl-1"> </span><span class="hl-9">30_000</span><span class="hl-1"> </span><span class="hl-5">// priority fee in lamports</span><br/><span class="hl-1"> )</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">sendCompressedAirdrop</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN&quot;</span><span class="hl-1">), </span><span class="hl-5">// mint</span><br/><span class="hl-1"> </span><span class="hl-9">42</span><span class="hl-1">, </span><span class="hl-5">// amount per recipient</span><br/><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;1nc1nerator11111111111111111111111111111111&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">// ... add more recipients</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-9">30_000</span><span class="hl-1"> </span><span class="hl-5">// priority fee in lamports</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">})();</span>
<a id="md:send-an-spl-token-airdrop-via-zk-compression" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Send an SPL Token Airdrop via ZK Compression<a href="#md:send-an-spl-token-airdrop-via-zk-compression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">PublicKey</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@solana/web3.js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-6">async</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;~Airdrop cost estimate:&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">getAirdropCostEstimate</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-8">1000</span><span class="hl-1">, </span><span class="hl-5">// recipients</span><br/><span class="hl-1"> </span><span class="hl-8">30_000</span><span class="hl-1"> </span><span class="hl-5">// priority fee in lamports</span><br/><span class="hl-1"> )</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">signature</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">sendCompressedAirdrop</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN&quot;</span><span class="hl-1">), </span><span class="hl-5">// mint</span><br/><span class="hl-1"> </span><span class="hl-8">42</span><span class="hl-1">, </span><span class="hl-5">// amount per recipient</span><br/><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">PublicKey</span><span class="hl-1">(</span><span class="hl-2">&quot;1nc1nerator11111111111111111111111111111111&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">// ... add more recipients</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-8">30_000</span><span class="hl-1"> </span><span class="hl-5">// priority fee in lamports</span><br/><span class="hl-1"> );</span><br/><span class="hl-1">})();</span>
</code><button type="button">Copy</button></pre>
<a id="md:fetch-price-data-from-pyth" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Fetch Price Data from Pyth<a href="#md:fetch-price-data-from-pyth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">price</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">agent</span><span class="hl-1">.</span><span class="hl-0">pythFetchPrice</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;0xe62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43&quot;</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&quot;Price in BTC/USD:&quot;</span><span class="hl-1">, </span><span class="hl-4">price</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<a id="md:dependencies" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Dependencies<a href="#md:dependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The toolkit relies on several key Solana and Metaplex libraries:</p>
@@ -116,9 +119,10 @@
<li>@metaplex-foundation/umi</li>
<li>@lightprotocol/compressed-token</li>
<li>@lightprotocol/stateless.js</li>
<li>@pythnetwork/price-service-client</li>
</ul>
<a id="md:contributing" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Contributing<a href="#md:contributing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Contributions are welcome! Please feel free to submit a Pull Request.
Refer to <a href="media/CONTRIBUTING.md">CONTRIBUTING.md</a> for detailed guidelines on how to contribute to this project.</p>
<a id="md:license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">License<a href="#md:license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>MIT License</p>
<a id="md:security" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Security<a href="#md:security" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This toolkit handles private keys and transactions. Always ensure you're using it in a secure environment and never share your private keys.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:solana-agent-kit"><span>Solana <wbr/>Agent <wbr/>Kit</span></a><ul><li><a href="#md:🔧-core-blockchain-features"><span>🔧 <wbr/>Core <wbr/>Blockchain <wbr/>Features</span></a></li><li><a href="#md:🤖-ai-integration-features"><span>🤖 AI <wbr/>Integration <wbr/>Features</span></a></li><li><a href="#md:📦-installation"><span>📦 <wbr/>Installation</span></a></li><li><a href="#md:quick-start"><span>Quick <wbr/>Start</span></a></li><li><a href="#md:usage-examples"><span>Usage <wbr/>Examples</span></a></li><li><ul><li><a href="#md:deploy-a-new-token"><span>Deploy a <wbr/>New <wbr/>Token</span></a></li><li><a href="#md:create-nft-collection"><span>Create NFT <wbr/>Collection</span></a></li><li><a href="#md:swap-tokens"><span>Swap <wbr/>Tokens</span></a></li><li><a href="#md:lend-tokens"><span>Lend <wbr/>Tokens</span></a></li><li><a href="#md:stake-sol"><span>Stake SOL</span></a></li><li><a href="#md:send-an-spl-token-airdrop-via-zk-compression"><span>Send an SPL <wbr/>Token <wbr/>Airdrop via ZK <wbr/>Compression</span></a></li></ul></li><li><a href="#md:dependencies"><span>Dependencies</span></a></li><li><a href="#md:contributing"><span>Contributing</span></a></li><li><a href="#md:license"><span>License</span></a></li><li><a href="#md:security"><span>Security</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>solana-agent-kit</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:solana-agent-kit"><span>Solana <wbr/>Agent <wbr/>Kit</span></a><ul><li><a href="#md:🔧-core-blockchain-features"><span>🔧 <wbr/>Core <wbr/>Blockchain <wbr/>Features</span></a></li><li><a href="#md:🤖-ai-integration-features"><span>🤖 AI <wbr/>Integration <wbr/>Features</span></a></li><li><a href="#md:📦-installation"><span>📦 <wbr/>Installation</span></a></li><li><a href="#md:quick-start"><span>Quick <wbr/>Start</span></a></li><li><a href="#md:usage-examples"><span>Usage <wbr/>Examples</span></a></li><li><ul><li><a href="#md:deploy-a-new-token"><span>Deploy a <wbr/>New <wbr/>Token</span></a></li><li><a href="#md:create-nft-collection"><span>Create NFT <wbr/>Collection</span></a></li><li><a href="#md:swap-tokens"><span>Swap <wbr/>Tokens</span></a></li><li><a href="#md:lend-tokens"><span>Lend <wbr/>Tokens</span></a></li><li><a href="#md:stake-sol"><span>Stake SOL</span></a></li><li><a href="#md:send-an-spl-token-airdrop-via-zk-compression"><span>Send an SPL <wbr/>Token <wbr/>Airdrop via ZK <wbr/>Compression</span></a></li><li><a href="#md:fetch-price-data-from-pyth"><span>Fetch <wbr/>Price <wbr/>Data from <wbr/>Pyth</span></a></li></ul></li><li><a href="#md:dependencies"><span>Dependencies</span></a></li><li><a href="#md:contributing"><span>Contributing</span></a></li><li><a href="#md:license"><span>License</span></a></li><li><a href="#md:security"><span>Security</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>solana-agent-kit</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -8,5 +8,6 @@
<a href="interfaces/MintCollectionNFTResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Mint<wbr/>CollectionNFTResponse</span></a>
<a href="interfaces/PumpfunLaunchResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Pumpfun<wbr/>Launch<wbr/>Response</span></a>
<a href="interfaces/PumpFunTokenOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Pump<wbr/>Fun<wbr/>Token<wbr/>Options</span></a>
<a href="interfaces/PythFetchPriceResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg><span>Pyth<wbr/>Fetch<wbr/>Price<wbr/>Response</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/createSolanaTools.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Solana<wbr/>Tools</span></a>
</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>solana-agent-kit</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>