메인 콘텐츠로 건너뛰기
Partner data access, endpoint detail, authentication, allowlist, response contract는 contact@superearn.io로 문의하세요.

1. 통합 표면

SuperEarn 통합 표면은 두 부분으로 나뉩니다.
  • 쓰기 경로(write path): Kaia 컨트랙트 호출, 주로 SuperEarnRouter 경유
  • 읽기/데이터 경로(read/data path): 승인된 통합자에게 제공되는 SuperEarn 지원 data surface
공개 문서는 온체인 write path와 통합자가 이해해야 할 개념을 설명합니다. Backend API route, 내부 indexing 세부사항, authentication 요구사항, response schema는 공개 문서에 게시하지 않습니다.

2. Write path

Deposit과 withdrawal은 아래 문서의 Kaia contract flow를 따르세요. 고수준 흐름은 다음과 같습니다.
  1. 사용자는 Kaia USDT를 SuperEarnRouter를 통해 예치합니다.
  2. Router는 EarnUSDT / Super Vault share를 mint 또는 redeem합니다.
  3. Redemption은 USDT가 claimable 또는 delivered 되기 전에 cooldown request를 생성합니다.
  4. 통합자는 router quote를 사용하고 명시적인 minSharesOut / minAssetsOut 보호를 적용해야 합니다.
사용자-facing 통합에서 CooldownVault deposit 또는 redeem entrypoint를 직접 호출하지 마세요. 해당 flow는 protocol contract로 제한됩니다. Claim은 permissionless지만 보통 protocol keeper가 처리합니다.

3. Read/data path

대부분의 통합은 다음과 같은 read-side data가 필요합니다.
  • Vault discovery와 display metadata
  • 현재 및 과거 yield 정보
  • 사용자 또는 wrapper contract 단위 position view
  • Pending redemption status
  • Transaction 및 earnings history
  • Partner dashboard용 allocation 또는 reporting data
Subgraph 기반 데이터에는 vault metadata, share price update, account share position, position change, deposit과 redemption lifecycle event, strategy report, vault update, fee report, token metadata가 포함될 수 있습니다. 공개 문서는 subgraph endpoint, entity schema, query document, deployment identifier를 게시하지 않습니다. 정확히 지원되는 data surface는 integration type, environment, access model, operational requirement에 따라 달라집니다. 현재 endpoint contract와 access instruction은 통합 상세와 함께 contact@superearn.io로 문의하세요.

4. Token model

Product와 accounting model에서 아래 token 개념을 분리해서 다루세요.
개념DecimalsBuilder 사용법
USDT6사용자가 예치하고 portfolio total에서 기대하는 asset.
seCDV / CooldownVault shares6Protocol flow 내부에서 사용되는 intermediate vault token.
EarnUSDT / Super Vault shares6사용자의 Super Vault position을 나타내는 shares.
KAIA18Kaia transaction gas token.
사용자 경험은 USDT 중심으로 설계하세요. 사용자는 USDT를 예치하고 Super Vault share price에 따라 가치가 변하는 EarnUSDT position을 보유합니다.

5. 출시 전 확인

Production integration을 출시하기 전에:
  1. 현재 contract address와 지원되는 write method를 확인하세요.
  2. Read/data access 승인 여부와 사용할 surface를 확인하세요.
  3. Authentication, allowlist, rate limit, data freshness 기대값을 확인하세요.
  4. Endpoint 변경, deprecation, incident notice가 어떻게 전달되는지 확인하세요.
  5. Deposit, redeem, cooldown, data reconciliation flow를 SuperEarn 팀과 함께 테스트하세요.