Partner quickstart — Ammora SDK 0.3.8

On this page

Create new tokens with Ammora contracts and connect trading and fee sharing before and after graduation. The default path is GIWA Sepolia · auto-route V4 · Concentrated Graduation. Ammora HTTP API integration is not required.

1. Install

Validated with Node 24.18.0; nvm users can run nvm use with .nvmrc. The GitHub repository is invitation-only, so an anonymous 404 does not indicate an SDK installation error. The public npm package, Docs example browser and local source setup require no GitHub access or npm login. To run the guide's npm run … examples:

bash

curl -fL https://docs.ammora.org/examples/setup.mjs -o ammora-examples-setup.mjs
# Review the setup source, then prepare a new directory
node ammora-examples-setup.mjs ./ammora-examples
cd ammora-examples
npm ci --ignore-scripts
cp .env.example .env

The project pins public @ammora-protocol/sdk@0.3.8. To install only the SDK in your own application, use the following. This does not install the examples' npm commands.

bash

npm install --save-exact @ammora-protocol/sdk@0.3.8 viem dotenv

2. Configure GIWA and make the first reads

Change the copied local .env default from legacy as shown below. Do not mix Registry, Config ID, Factory, or Manager values from different deployment generations.

dotenv

AMMORA_CHAIN_ID=91342
AMMORA_GIWA_GENERATION=auto-route
AMMORA_RPC_INTERVAL_MS=600
AMMORA_SEND=0
AMMORA_READ_RECEIPT=

Existing shell environment variables take precedence over .env; align them too. An empty AMMORA_READ_RECEIPT prevents reads being pinned to an old transaction. These reads require neither a private key nor funds.

bash

npm run quickstart:verify
npm run quickstart:configs -- 10
npm run launch:get-config -- 6

Continue to previews after deployment verification passes. The auto-route generation name does not imply that every aggregation or native route is active. The default quote asset is an ERC20.

3. Prepare wallets and funds

Role	Preparation
Config creator	Configuration wallet, gas ETH, and native Config creation costs
Creator / Partner	Actual token Creator and Partner fee recipient; each signs their own claims
Trading / depositing wallet	GIWA ETH for gas and the actual trading/deposit assets; WETH and ETH are separate balances
LP owner / delegate	Actual Manager NFT owner; grant fee authority only when delegation is needed
Distribution recipients / payout	Two to five distinct recipients when required, plus reviewed payout addresses

Roles may use different wallets. Each sender needs gas ETH; inspect exact input amounts, creation costs, and approvals in the relevant preview. A separate payout address receives funds without gaining claim authority. AMMORA_ACCOUNT specifies the unsigned plan's caller; it does not change the signing wallet.

Keep CLI keys in your private local environment, never in source, commits, or frontend code. Applications should use the user's connected WalletClient. Use your team's addresses, assets, Configs, and position IDs instead of copying another wallet from examples or validation reports.

4. Connect configuration through claims

Step	Flow	Detailed instructions
1	Select recipients and Creator/Partner split → preview before/after graduation → create Config	Fee configuration, distribution preview: `launch:fee-config` → `launch:config-json`
2	Create token → trade before graduation → graduate → trade after graduation	Launchpad steps 4–7; optionally combine the first purchase
3	Creator and Partner separately claim positive quote/token accruals, optionally to a payout address	Creator/Partner claims: `launch:claim-fees`
4	Optionally fund a distribution vault with received assets; each recipient claims their index	Multi-recipient distribution: `dfs:create-json` → `dfs:state` → `dfs:fund` → `dfs:claim`
5	LP owner claims or grants fee authority → delegate claims → revoke	LP delegation and claims: `arl:fee-delegate` / `arl:claim-position-fee`
6	Confirm successful receipts, transfer events, and payout balance increases	Payment verification and read-only recovery

The Creator percentage applies to fees after the Protocol share. Post-graduation distribution depends on LP positions and reinvestment settings; do not reuse the pre-graduation split formula. Claiming quote fees does not also claim issued-token fees.

DFS distributes one asset using fixed recipients and weights. If fees were paid to another address, that payout wallet must fund the vault. Assigning a vault as Partner recipient does not automatically fund it. LP permission claim-fee-to-owner pays only the owner; claim-fee permits a delegate to choose a separate payout. Neither grants locked-principal withdrawal rights or NFT ownership.

Default to AMMORA_SEND=0 and enable AMMORA_SEND=1 only for the specific send step. Follow each command's documented mode; not every command supports unsigned preview. Do not count zero claims as payments or resend an existing hash after a read failure.

Validation scope

See the public 0.3.7 guide audit (GitHub access may be required), Creator/Partner/multi-recipient payments (GitHub access may be required), and LP delegation payments and permission denials (GitHub access may be required). Reuse these only within their original source, SDK, and block scope. Check a new team's addresses, Config, funds, and permissions before execution; historical evidence does not guarantee a current claimable balance.

For issuer-native stablecoins and DEX liquidity, use the native stablecoin integration guide. That connects existing issuer ERC20s to independent pools, separately from new Launch token creation and graduation.

See the SDK 0.3.8 examples for vesting creation/claim and public ALMM readiness.

Was this page helpful?

Continue buildingOpen the transaction builder