SDK quickstart
On this page
Start with Ammora SDK 0.3.8, Math 0.3.0 and GIWA Sepolia (91342). Read examples directly in Docs, copy the files you need, or give the Markdown version to your coding assistant. No GitHub login is required.
1. Install in your own app
Use Node 24. In a new project:
mkdir my-ammora-app
cd my-ammora-app
npm init -y
npm install --save-exact @ammora-protocol/sdk@0.3.8 viem
The SDK declares its Math dependency. Installing the package gives your app SDK exports; it does not add the example project's npm run launch:… commands. For those commands, use the separate local example setup.
2. Check the deployment catalog
Create start.mjs with this complete example:
import {
giwaSepoliaAutoRouteDeployment,
giwaSepoliaTokenLockDeployment,
} from '@ammora-protocol/sdk';
const deployment = giwaSepoliaAutoRouteDeployment;
if (deployment.chain.id !== 91342) throw new Error('GIWA Sepolia required');
if (deployment.contracts.launch.protocolVersion !== 4) {
throw new Error('This example requires the V4 Launch deployment');
}
console.log('Chain:', deployment.chain.id);
console.log('Config registry:', deployment.contracts.launch.configRegistry);
console.log('Launch factory:', deployment.contracts.launch.factory);
console.log('Token vesting deployment:', giwaSepoliaTokenLockDeployment);
node start.mjs
This verifies that the installed exports load and shows catalog configuration. It makes no RPC requests, signs nothing and does not prove that live contracts match the catalog. Before preparing a transaction, follow deployment verification and inspect the actual chain, contract runtime and state.
3. Pick one working example
| What you want to build | Read the code | Follow the guide |
|---|---|---|
| Read launch Configs | quickstart:configs | Launchpad setup |
| Create a token | launch:create-launch | Config, creation, trading and graduation |
| Configure revenue | launch:fee-config | Recipients and fee claims |
| Read token vesting | token-lock:inspect | Vesting creation and claims |
| Integrate stablecoin liquidity | ALMM unified files | Stablecoin quickstart |
In the example browser, select an example to see its entry file, local imports, input templates and setup files. Copy code copies the displayed file. Copy example Markdown gives your AI the entry code, run command, guide links and supporting-file URLs. The Markdown identifies dependencies; one copied entry file is not a complete project.
The browser also exposes all published files, including the ALMM unified extension. The 188 npm commands and the extension's plan/send interface are distinct.
4. Move from CLI code to your application
Reuse the public SDK builders, clients and receipt parsers shown in the source. In a browser app, sign through the connected user's WalletClient. Keep CLI dotenv, filesystem access and private-key loaders out of browser bundles.
- Select one chain and deployment generation explicitly; do not mix legacy and auto-route registries or IDs.
- Read actual token addresses, decimals, Config hashes, ownership and permissions.
- Keep raw amounts as
bigint; use decimal strings in JSON and format separately for display. - Follow each command's documented mode. Some offer unsigned previews; others are send-only.
- Show approvals, targets, recipients, minimum outputs and deadlines before wallet confirmation.
- Save submitted hashes. Reconcile receipt, nonce and canonical block before retrying an uncertain result.
- Treat fee events, ERC20 transfers and actual recipient balance changes as separate checks. A zero claim is not payment.
5. Give your AI a starting brief
Read https://docs.ammora.org/ai/sdk-quickstart.md and https://docs.ammora.org/llms.txt.
Use @ammora-protocol/sdk@0.3.8 on GIWA Sepolia 91342.
Choose one example at https://docs.ammora.org/examples and read its example Markdown plus linked source files.
Use real SDK exports and parameter types. Do not invent methods, addresses, recipients or token decimals.
Implement reads and unsigned plans first; explain which operations are send-only.
Use connected-wallet signing in a frontend and keep private keys out of browser code.
Preserve exact amount units, deployment selection, authority checks and receipt reconciliation.
List the files to create, installation commands, required user inputs and verification steps.
Distinguish a successful local check from a verified on-chain transaction.
For complete product flows, continue with Build a launchpad, stablecoin liquidity, or token vesting.