Belugas Protocol
  • Belugas Protocol Documentation
  • Getting Started
    • Networks
    • Protocol Math
      • bToken and Underlying Decimals
      • Interpreting Exchange Rates
      • Calculating Accrued Interest
      • Calculating the APY Using Rate Per Block
    • Gas Costs
  • BTokens
    • Mint
    • Redeem
    • Redeem Underlying
    • Borrow
    • Repay Borrow
    • Repay Borrow Behalf
    • Transfer
    • Liquidate Borrow
    • Key Events
    • Error Codes
    • Failure Info
    • Exchange Rate
    • Get Cash
    • Total Borrow
    • Borrow Balance
    • Borrow Rate
    • Total Supply
    • Underlying Balance
    • Supply Rate
    • Total Reserves
    • Reserve Factor
  • Comptroller
    • Enter Markets
    • Exit Market
    • Get Assets In
    • Collateral Factor
    • Get Account Liquidity
    • Close Factor
    • Liquidation Incentive
    • Key Events
    • Error Codes
    • Failure Info
    • BUL Distribution Speeds
    • Claim BUL
    • Market Metadata
  • Governance
    • Delegate
    • Delegate By Signature
    • Get Current Votes
    • Get Prior Votes
    • Key Events
    • Governor Bravo
    • Quorum Votes
    • Proposal Threshold
    • Proposal Max Operations
    • Voting Delay
    • Voting Period
    • Propose
    • Queue
    • Execute
    • Cancel
    • Get Actions
    • Get Receipt
    • State
    • Cast Vote
    • Cast Vote With Reason
    • Cast Vote By Signature
    • Timelock
    • Pause Guardian
  • LP Staking
    • LP Utility
    • LP Staking Options
    • Zapping LP
    • Maintaining Eligibility Status
  • API
    • BTokenService
      • GET: /btoken
    • MarketHistoryService
      • GET: /market_history/graph
    • ProposalService
      • GET: /proposals
      • GET: /proposals/:id
      • GET: /proposals/statistics
    • VoterService
      • GET: /voters/accounts
      • GET: /voters/accounts/:address
      • GET: /voters/history/:address
      • GET: /voters/:proposalId
    • GovernanceService
      • GET: /governance/belugas
      • GET: /governance/proposals
      • GET: /governance/proposal_vote_receipts
      • GET: /governance/accounts
    • Shared Data Types
  • Belugas.js
    • Belugas Constructor
    • API Methods
      • Account
      • bToken
      • Market History
      • Governance
    • bToken Methods
      • Supply
      • Redeem
      • Borrow
      • Repay Borrow
    • BUL Methods
      • To Checksum Address
      • Get BUL Balance
      • Get BUL Accrued
      • Claim BUL
      • Delegate
      • Delegate By Sig
      • Create Delegate Signature
    • Comptroller Methods
      • Enter Markets
      • Exit Market
    • Ethereum Methods
      • Read
      • Trx
      • Get Balance
    • Governance Methods
      • Cast Vote
      • Cast Vote By Sig
      • Create Vote Signature
    • Price Feed Methods
      • Get Price
    • Utility Methods
      • Get Address
      • Get ABI
      • Get Network Name With Chain ID
  • Security
    • Formal Verification
    • Bug Bounty Program
  • Terms of Service
Powered by GitBook
On this page
  1. Belugas.js
  2. bToken Methods

Redeem

Redeems the user's Ethereum asset from the Belugas Protocol.

  • asset (string) A string of the asset to redeem, or its bToken name.

  • amount (number | string | BigNumber) A string, number, or BigNumber object of the amount of an asset to redeem. Use the mantissa boolean in the options parameter to indicate if this value is scaled up (so there are no decimals) or in its natural scale. This can be an amount of bTokens or underlying asset (use the asset parameter to specify).

  • [options] (CallOptions) Call options and Ethers.js overrides for the transaction.

  • RETURN (object) Returns an Ethers.js transaction object of the redeem transaction.

const belugas = new Belugas(window.ethereum);

(async function() {

  console.log('Redeeming ETH...');
  const trx = await belugas.redeem(Belugas.ETH, 1); // also accepts bToken args
  console.log('Ethers.js transaction object', trx);

})().catch(console.error);
PreviousSupplyNextBorrow

Last updated 1 year ago