GHO-payment-SDK

Github: https://github.com/zhxinyu/gho-payment-sdk

The package GHO-payment-sdk mainly aims to provide GHO token users and holders to make payments activity more easily. GHO is a decentralized multi-collateral stablecoin that is fully backed, transparent and native to the Aave Protocol. Typical payment activity involves transfer and trade. Users can simply call our exported helper functions to perform various transactions using GHO tokens. In particular, the package includes utility functions to transfer, approve, permit, transferFrom and trade.

Here some simple snippets to use:

• getAllowanceGHO(from: string, to: string, provider)
• approveGHO(signer, amount: string, to: string)
• permitGHO(signer, amount: string, spender: string)
• transferGHO(to: string, amount: string, tokenOwner)
• transferFromGHO(from: string, to: string, amount: string, allowanceOwner: ethers.Signer)
• getOutputQuote(tokenA: Token, amountIn: string, provider)
• executeTrade(tradeAccount, signer)

Further usage can see notebook

The project leverages ethers library to export easy-to-use helper function for GHO tokens payment. All the source codes are located in the src directory.

In particular, the tree structure of the project is

├── src
│  ├── constants
│  │  ├── abi.ts
│  │  ├── abi_json.ts
│  │  ├── address.ts
│  │  └── index.ts
│  ├── entities
│  │  ├── index.ts
│  │  └── tokens.ts
│  ├── index.ts
│  ├── trade
│  │  ├── dex
│  │  │  └── uniswap
│  │  │      ├── contract-address.ts
│  │  │      ├── index.ts
│  │  │      ├── pool.ts
│  │  │      └── trade.ts
│  │  └── index.ts
│  ├── transfer
│  │  ├── index.ts
│  │  └── transfer.ts
│  └── utils
│      ├── allowance.ts
│      ├── assert.ts
│      ├── conversion.ts
│      ├── format.ts
│      ├── index.ts
│      ├── print.ts
│      └── providers.ts
├── tests
│  └── index.test.ts

• Trade Export a trade (buy or sell) helper function for GHO token. At present, we support uniswap DEX.

• Transfer Export transfer-related helper function for payments via GHO token. In particular, we include transferGHO, transferFromGHO, transfer, transferFrom.

• Approval Add approve and permit function to increse allowance of GHO token.

• Utilities Add Token entities to facilitate caching and retrieval of token information such as chainId, address, decimals, symbol, abi and contract instance. In particular,

  • getAllowanceGHO, getAllowance
  • approveGHO, approve
  • off-chain signature preparation: permitGHO
  • assert: throw an error if false statement.
  • print:
    • printBalance
  • providers:
    • getJsonRpcProvider,
    • getWallet,
    • sendTransaction,

In the end, we also add a demo via a jupyter notebook. pg2.html