⚙️AKKA SDK Interface

Technical overview about AKKA's SDK.

interface AKKA {
    
    getConfig(): Config // Get the current configuration of the SDK
    
    setConfig(configUpdate: ConfigUpdate): Config // Set a new confuration for the SDK
    
    healthcheck(request: HealthcheckRequest, options?: RequestOptions): Promise<HealthcheckResponse> // Check if akka backend is up
    
    getSpender(request: SpenderRequest, options?: RequestOptions): Promise<SpenderResponse> // Get AKKA contract
    
    getApproveTransaction(request: ApproveTransactionRequest, options?: RequestOptions): Promise<ApproveTransactionResponse> // Get approve transaction data
    
    getAllowance(request: AllowanceRequest, options?: RequestOptions): Promise<AllowanceResponse> // Get token allowance
    
    getTokens(request?: TokensRequest, options?: RequestOptions): Promise<TokensResponse> // Get tokens list
    
    getQuote(request: QuoteRequest, options?: RequestOptions): Promise<QuoteResponse> // Get a quote for a token transfer
    
    getSwap(request: OnChainSwapRequest, options?: RequestOptions): Promise<OnChainSwapResponse> // Get data for swap transaction

    getTokenApproval(signer: Signer, token: Token, approvalAddress: string): Promise<string | undefined> // Get the current approval for a certain token
    
    approveToken(signer: Signer, request: ApproveTokenRequest): Promise<void> // Set approval for a certain token and amount
    
    onChainSwap(signer: Signer, request: OnChainSwapRequest, options?: RequestOptions): Promise<providers.TransactionResponse> // swap the route using akka contract
}

Last updated