If you like video tutorials, here is one of our latest workshops on building an Agent to transact onchain using the Viem SDK with the AI Agent Contract Template. In this tutorial, you will learn:
How to test the WapoJS functions like deriveSecret(salt)to derive an ECDSA key based on your secret added to your Agent Contract's secret vault.
Build and deploy your Agent Contract to IPFS then add your secret salt that will derive an ECDSA key for your deployed agent.
Sign and verify a message using the viem SDK with your agent's derived ECDSA key.
Debug your Agent Contract due to a failed transaction on Base Sepolia.
Resolve the error and execute a successful transaction on Base Sepolia.
Getting Started
Prepare
Clone git repo or use degit to get the source code.
Create .env file with the default ThirdWeb API key for publishing your Agent Contract to IPFS
cp.env.example.env
Build your Agent
npmrunbuild
Test your Agent locally
npmruntest
Expected Test Results
INPUT: {"method":"GET","path":"/ipfs/CID","queries":{"data":["Hello MOON!"],"type":["sign"]},"secret":{"secretSalt":"SECRET_SALT"},"headers":{}}
Signingdata [Hello MOON!]withAccount [0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaD]Signature: 0xb34ff00b803c0cfead2b4f32afab4f73a9169cf24b8236307462a49ff08fc25674303b3e0cea3b80e8eece16c42563fe7d5c7f4ab09857fc4d6a1b99a7c97d2e1b
{status:200, body: '{"derivedPublicKey":"0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaD","data":"Hello MOON!","signature":"0xb34ff00b803c0cfead2b4f32afab4f73a9169cf24b8236307462a49ff08fc25674303b3e0cea3b80e8eece16c42563fe7d5c7f4ab09857fc4d6a1b99a7c97d2e1b"}',
headers:{'Content-Type':'application/json','Access-Control-Allow-Origin':'*' }}INPUT: {"method":"GET","path":"/ipfs/CID","queries":{"data":["Hello MOON!"],"signature":["0xb34ff00b803c0cfead2b4f32afab4f73a9169cf24b8236307462a49ff08fc25674303b3e0cea3b80e8eece16c42563fe7d5c7f4ab09857fc4d6a1b99a7c97d2e1b"],"type":["verify"]},"secret":{"secretSalt":"SECRET_SALT"},"headers":{}}
VerifyingSignaturewithPublicKey0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaDIssignaturevalid?true{status:200, body: '{"derivedPublicKey":"0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaD","data":"Hello MOON!","signature":"0xb34ff00b803c0cfead2b4f32afab4f73a9169cf24b8236307462a49ff08fc25674303b3e0cea3b80e8eece16c42563fe7d5c7f4ab09857fc4d6a1b99a7c97d2e1b","valid":true}',
headers:{'Content-Type':'application/json','Access-Control-Allow-Origin':'*' }}INPUT: {"method":"GET","path":"/ipfs/CID","queries":{"to":["0xC5227Cb20493b97bb02fADb20360fe28F52E2eff"],"gweiAmount":["420"],"type":["sendTx"]},"secret":{"secretSalt":"SECRET_SALT"},"headers":{}}
Sending Transaction with Account 0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaD to 0xC5227Cb20493b97bb02fADb20360fe28F52E2eff for 420 gwei
TransactionHash:0x6a7218d19bb2529df074dd5e2ad30e3c2400a2e2d730ca554f067af29ecfff42TransactionStatus:success{status:200, body: '{"derivedPublicKey":"0x3F003c3501eeD0A8Ab1B023a644EdCD2a8096EaD","to":"0xC5227Cb20493b97bb02fADb20360fe28F52E2eff","gweiAmount":"420","hash":"0x6a7218d19bb2529df074dd5e2ad30e3c2400a2e2d730ca554f067af29ecfff42","receipt":{"blockHash":"0x83688869e27fb83743c7b072ef5f45a3efe3657a2878ca605f6fce8cf3b06c38","blockNumber":"14592136","contractAddress":null,"cumulativeGasUsed":"931909","effectiveGasPrice":"1000983","from":"0x3f003c3501eed0a8ab1b023a644edcd2a8096ead","gasUsed":"21000","l1BaseFeeScalar":"0x44d","l1BlobBaseFee":"0x48540a4664","l1BlobBaseFeeScalar":"0xa118b","l1Fee":"20531405242323","l1GasPrice":"18898712795","l1GasUsed":"1600","logs":[],"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","status":"success","to":"0xc5227cb20493b97bb02fadb20360fe28f52e2eff","transactionHash":"0x6a7218d19bb2529df074dd5e2ad30e3c2400a2e2d730ca554f067af29ecfff42","transactionIndex":4,"type":"eip1559","l1FeeScalar":null}}',
headers:{'Content-Type':'application/json','Access-Control-Allow-Origin':'*' }}Nowyouarereadytopublishyouragent,addsecrets,andinteractwithyouragentinthefollowingsteps:-Execute:'npm run publish-agent'-Setsecrets:'npm run set-secrets'- Go to the url produced by setting the secrets (e.g. https://wapo-testnet.phala.network/ipfs/QmPQJD5zv3cYDRM25uGAVjLvXGNyQf9Vonz7rqkQB52Jae?key=b092532592cbd0cf)
Publishing Your Agent
Upload your compiled AI Agent code to IPFS.
npmrunpublish-agent
Upon a successful upload, the command should show the URL to access your AI Agent.
✓Compiledsuccessfully.67.83KBdist/index.jsRunningcommand:npxthirdwebuploaddist/index.jsThismayrequireyoutologintothirdwebandwilltakesometimetopublishtoIPFS... $$\ $$\ $$\ $$\ $$\ $$ | $$ |\__| $$ | $$ | $$$$$$\ $$$$$$$\ $$\ $$$$$$\ $$$$$$$ |$$\ $$\ $$\ $$$$$$\ $$$$$$$\ \_$$_| $$ __$$\ $$ |$$ __$$\ $$ __$$ |$$ | $$ | $$ |$$ __$$\ $$ __$$\ $$ | $$ | $$ |$$ |$$ |\__|$$ / $$ |$$ | $$ | $$ |$$$$$$$$ |$$ | $$ | $$ |$$\ $$ | $$ |$$ |$$ | $$ | $$ |$$ | $$ | $$ |$$ ____|$$ | $$ |\$$$$|$$ | $$ |$$ |$$ |\$$$$$$$|\$$$$$\$$$$|\$$$$$$$\ $$$$$$$ |\____/ \__|\__|\__|\__|\_______|\_____\____/ \_______|\_______/💎thirdwebv0.14.12💎-UploadingfiletoIPFS.Thismaytakeawhiledependingonfilesizes.✔SuccessfullyuploadedfiletoIPFS.✔FilesstoredatthefollowingIPFSURI:ipfs://QmVJ3xknfRevUkc68iZc4RdPSLL2gLD8WagwMQCdGMyC4g✔ Open this link to view your upload: https://b805a9b72767504353244e0422c2b5f9.ipfscdn.io/ipfs/bafybeidhk5nzutxyx3xusgjl4v6nkvscdoiowzofc7hqnf3l4xipieshie/
AgentContractdeployedat:https://wapo-testnet.phala.network/ipfs/QmVJ3xknfRevUkc68iZc4RdPSLL2gLD8WagwMQCdGMyC4gIfyouragentrequiressecrets,ensuretodothefollowing:1) Edit the ./secrets/default.json file or create a new JSON file in the ./secrets folder and add your secrets to it.2) Run command: 'npm run set-secrets' or 'npm run set-secrets [path-to-json-file]'Deploymentinformationupdatedin./logs/latestDeployment.json
Note that your latest deployment information will be logged to in file ./logs/latestDeployment.json. This file is updated every time you publish a new Agent Contract to IPFS. This file is also used to get the IPFS CID of your Agent Contract when setting secrets for your Agent Contract.
If ThirdWeb fails to publish, please signup for your own ThirdWeb account to publish your Agent Contract to IPFS. Signup or login at https://thirdweb.com/dashboard/
Whenever you log into ThirdWeb, create a new API key and replace the default API Key with yours in the .env file.
THIRDWEB_API_KEY="YOUR_THIRDWEB_API_KEY"
Accessing The Published Agent
Once published, your AI Agent is available at the URL: https://wapo-testnet.phala.network/ipfs/<your-cid>. You can get it from the "Publish to IPFS" step.
By default, all the compiled JS code is visible for anyone to view if they look at IPFS CID. This makes private info like API keys, signer keys, etc. vulnerable to be stolen. To protect devs from leaking keys, we have added a field called secret in the Request object. It allows you to store secrets in a vault for your AI Agent to access.
To add your secrets,
Edit the default.json file or create a new JSON file in the ./secrets folder and add your secrets to it.
{"secretSalt":"SALTY_BAE"}
Run command to set the secrets
npmrunset-secrets# or if you have a custom JSON filenpmrunset-secrets<path-to-json-file>
Note that all your secrets will be logged in file ./logs/secrets.log. This file is updated every time you add new secrets to your Agent Contract. If you have not published an Agent Contract, yet, this command will fail since there is not a CID to map the secrets to.
The API returns a token and a key. The key is the id of your secret. It can be used to specify which secret you are going to pass to your frame. The token can be used by the developer to access the raw secret. You should never leak the token.
To verify the secret, run the following command where key and token are replaced with the values from adding your secret to the vault.
To help create custom logic, we have an array variable named queries that can be accessed in the Request class. To access the queries array variable chatQuery value at index 0, the syntax will look as follows:
constquery=req.queries.chatQuery[0]asstring;
Here is an example of adding a URL query named chatQuery with a value of When did humans land on the moon. queries can have any field name, so chatQuery is just an example of a field name and not a mandatory name, but remember to update your index.ts file logic to use your expected field name.
For more information check the MDN docs on console object.
Congratulations! You have deployed and transacted on Base Sepolia! You now have the tools to connect to any top LLM API with the RedPill Agent Contract template and perform onchain actions with the viem SDK.
