Anchor Earn SDK
Anchor Earn is a JavaScript SDK that specializes for integrations that are wishing to leverage the deposit functionality of Anchor.
Anchor Earn only covers the savings-related operations of Anchor. For a SDK with full functional coverage (e.g. minting bLuna, borrowing UST), Anchor.js is recommended.
Anchor Earn is designed with interchain access in mind. Further releases of Anchor Earn are to enable integrations for interchain deposits, opening up savings for applications outside of the Terra blockchain. With the use of EthAnchor, BscAnchor, SolAnchor, etc., Anchor Earn is to be further expanded to enable savings regardless of blockchain or the type of stablecoin.
A complete list of supported blockchains and stablecoins are outlined in the appendix section.
For those interested in reading the code, please refer to the Anchor Earn repository.
Installation
Anchor Earn requires NPM and Node.js 12 or above for its proper usage.
Anchor Earn is available as a package on NPM. Add @anchor-protocol/anchor-earn
to your JavaScript project's package.json
as dependencies using preferred package manager:
or
Initialization
Initializing Anchor Earn
AnchorEarn({chain, network, privateKey?, MnemonicKey?, address?})
AnchorEarn({chain, network, privateKey?, MnemonicKey?, address?})
AnchorEarn
creates an instance of the AnchorEarn
object, used as the entry point to the Anchor Earn SDK.
A blockchain account is required when calling this function. Register the account's private key or mnemonics from which transactions will be signed and broadcasted. If you do not have a pre-created blockchain account, a new account can be created using the Account
instance.
While Anchor Earn by default handles transaction signing and broadcasting, these operations can be handed off to a callback function that connects with external key-signing solutions (e.g. Terra Station Extension, Ledger Hardware Wallet, Custodian APIs). For this case, the AnchorEarn
instance should be created by the pre-created account's address.
Method Parameters
Example
Creating a New Blockchain Account
Account(chain)
Account(chain)
Creating an instance of the Account
object generates a new blockchain account.
Tokens for testnet environments (e.g. Bombay) can be acquired using faucets, outlined in the appendix section.
Method Parameters
Example
The Account
instance contains the information for the newly created account.
privateKey
and mnemonic
constitute as your access key to your account, including the control of your assets.
PLEASE RECORD AND STORE THEM IN A SAFE PLACE AND NEVER SHARE EXTERNALLY.
Attributes
Generating an Account with Mnemonics
MnemonicKey({mnemonic})
MnemonicKey({mnemonic})
An account can also be generated using existing mnemonics. The MnemonicKey
object is borrowed from Terra.js, allowing integrators to access it without any dependencies on Terra.js.
Method Parameter
Usage
For compatibility across tokens with various decimals, Anchor Earn unifies all currency amounts to use the decimal representation. As an example, a value of 10.1 in the amount field will lead to the utilization of 10.1 currency tokens.
Deposit Stablecoins to Anchor
anchorEarn.deposit({currency, amount})
anchorEarn.deposit({currency, amount})
This method deposits the specified amount of stablecoins to Anchor.
Method Parameters
Returns
anchorEarn.deposit
will return a Promise
which resolves with either a OperationError
or TxOutput
object which implements the Output
interface.
Example
Withdraw Stablecoins from Anchor
anchorEarn.withdraw({currency, amount})
anchorEarn.withdraw({currency, amount})
This method withdraws the specified amount of stablecoins (or their aTerra counterpart) from Anchor.
Note that the actual amount of stablecoins withdrawn will be smaller due to transfer fees (tax) enforced by the Terra blockchain.
Method Parameters
Returns
anchorEarn.withdraw
will return a Promise
which resolves with either a OperationError
or TxOutput
object which implements the Output
interface.
Example
Send Tokens
anchorEarn.send({currency, recipient, amount})
anchorEarn.send({currency, recipient, amount})
Use anchorEarn.send
to send tokens (stablecoins or their aTerra counterpart) to a different account.
Method Parameters
Returns
anchorEarn.send
will return a Promise
which resolves with either a OperationError
or TxOutput
object which implements the Output
interface.
Example
Retrieve Balance Information
anchorEarn.balance({currencies})
anchorEarn.balance({currencies})
This method retrieves balance information for the specified stablecoins.
Method Parameters
Returns
anchorEarn.balance
will return a Promise
which resolves with a BalanceOutput
object.
Example
Retrieve Market Information
anchorEarn.market({currencies})
anchorEarn.market({currencies})
This method retrieves market information for the specified stablecoins.
Method Parameters
Returns
anchorEarn.market
will return a Promise
which resolves with a MarketOutput
object.
Example
Resources
CHAINS
The CHAINS
enumerated type specifies blockchains that are supported by Anchor Earn.
Anchor Earn currently supports the following blockchains:
NETWORKS
The NETWORKS
enumerated type specifies the network type to be used.
Anchor Earn supports mainnet and testnet networks with the below chain IDs:
Mainnet
Testnet
DENOMS
Specifies stablecoin currency denominations.
Anchor Earn supports functionalities for the below stablecoin denominations:
Mainnet
Testnet
OperationError
Represents an error that was returned by a request.
Attributes
Output
Represents information for a request made via Anchor Earn.
Attributes
STATUS
Represents the progress status of a previously made request.
TxType
Represents the type of a request.
TxDetails
Represents the details of a transaction.
Attributes
BalanceOutput
The BalanceOutput
namespace represents your balance.
Attributes
BalanceEntry
Represents balance information for a specific stablecoin.
Attributes
MarketOutput
Represents overall market information.
Attributes
MarketEntry
Attributes
CustomSigner
A utility function that allows remote signing of transaction (e.g. Ledger Hardware Wallet, Custodian APIs). When provided, Anchor Earn would act as a message/unsignedTx generator, and all transaction creation and signing should be handled within the function. customSigner
should throw an error if any step results in failures.
CustomBroadcaster
A utility function that allows remote signing and broadcasting of transaction (e.g. Web Wallet Extensions). When provided, Anchor Earn would act as a message generator, and all transaction creation & signing & broadcasting should be handled within the function. customBroadcaster
should throw an error if any step results in failures.
Loggable
A utility function that allows observation of the transaction progress. When provided, the function is called every time there is a state update to the transaction. Particularly useful in case of EthAnchor transactions (not supported in this version), as EthAnchor operations are asynchronous and there are multiple interim states.
Last updated