USYC

https://usyc.docs.hashnote.com
Admin
USYC is an onchain token representing Hashnote's Short Duration Yield Fund, which invests in...
Tokens:2,627
Snippets:12
Trust Score:7.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### TypeScript Functions for Buying and Selling USYC

Source: https://usyc.docs.hashnote.com/integration-guides/typescript

This TypeScript code demonstrates how to interact with the USYC Teller contract to buy and sell USYC tokens. It includes the ABI definition for the teller contract, relevant contract addresses (USDC, USYC, USYC Teller), and example `writeContract` calls using `wagmi/core` for approving token spending and executing buy/sell operations. It handles both USDC to USYC conversion and USYC to USDC conversion.

```TypeScript
import { Address, erc20ABI, writeContract } from '@wagmi/core'

const USYC_TELLER_ABI = [
  {
    inputs: [{ internalType: 'uint256', name: '_amount', type: 'uint256' }],
    name: 'sell',
    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
    stateMutability: 'nonpayable',
    type: 'function',
  },
  {
    inputs: [{ internalType: 'uint256', name: '_amount', type: 'uint256' }],
    name: 'buy',
    outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
    stateMutability: 'nonpayable',
    type: 'function',
  },
] as const

// Addresses on Ethereum Mainnet
const USYC_TELLER_ADDRESS: Address = '0xAAF405C48e8c73aECedA3E40fE34e5C0ff8f5DE5'
const USDC_ADDRESS: Address = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
const USYC_ADDRESS: Address = '0x136471a34f6ef19fE571EFFC1CA711fdb8E49f2b'

// Quantities
const ONE_HUNDRED_USDC = BigInt(100_000000) // USDC decimals=6
const ONE_HUNDRED_USYC = BigInt(100_000000) // USYC decimals=6

// BUY USYC
export const approveUSYCTellerToSpendUSDC = () =>
  writeContract({
    chainId: 1,
    address: USDC_ADDRESS,
    abi: erc20ABI,
    functionName: 'approve',
    args: [USYC_TELLER_ADDRESS, ONE_HUNDRED_USDC],
  })

export const buyUSYC = () =>
  writeContract({
    address: USYC_TELLER_ADDRESS,
    chainId: 1,
    abi: USYC_TELLER_ABI,
    functionName: 'buy',
    args: [ONE_HUNDRED_USDC],
  })

// Sell USYC
export const approveUSYCTellerToSpendUSYC = () =>
  writeContract({
    chainId: 1,
    address: USYC_ADDRESS,
    abi: erc20ABI,
    functionName: 'approve',
    args: [USYC_TELLER_ADDRESS, ONE_HUNDRED_USYC],
  })

export const sellUSYC = () =>
  writeContract({
    address: USYC_TELLER_ADDRESS,
    chainId: 1,
    abi: USYC_TELLER_ABI,
    functionName: 'sell',
    args: [ONE_HUNDRED_USYC],
  })
```

--------------------------------

### Solidity USYC Buy and Sell Operations

Source: https://usyc.docs.hashnote.com/integration-guides/solidity

This Solidity code snippet demonstrates how to programmatically buy and sell USYC tokens. It defines an ITeller interface for interacting with the Teller contract, approves spending of PYUSD for buying and USYC for selling, and then executes the buy and sell functions. It requires the IERC20 interface for token approvals.

```Solidity
import "../IERC20.sol";
interface ITeller {
    function buy(uint256 _amount) external returns (uint256);
    function sell(uint256 _amount) external returns (uint256);
}

ITeller teller = ITeller(0x0a5ea26fdd38cf2acb06dc64198374c337879dab);

// Buying USYC
IERC20 pyusd = IERC20(0x6c3ea9036406852006290770BEdFcAbA0e23A0e8);
uint256 paying = 100 * 1e6; // 100.000000 PYUSD
pyusd.approve(address(teller), paying); // approving teller to spend 100 PYUSD
uint256 usycPurchased = teller.buy(paying);

// Selling USYC
IERC20 usyc = IERC20(0x136471a34f6ef19fE571EFFC1CA711fdb8E49f2b);
uint256 selling = 100 * 1e6; // 100.000000 USYC
usyc.approve(address(teller), selling); // approving teller to spend 100 USYC
uint256 usdcPayout = teller.sell(selling)
```

--------------------------------

### Sepolia Smart Contract Addresses

Source: https://usyc.docs.hashnote.com/overview/smart-contracts

Provides the deployed addresses for key smart contracts on the Sepolia testnet, useful for development, testing, and integration purposes before deploying to Mainnet.

```APIDOC
ERC20: 0x38D3A3f8717F4DB1CcB4Ad7D8C755919440848A3
Oracle: 0x35b96d80C72f873bACc44A1fACfb1f5fac064f1a
Teller (USDC): 0xbb0524426bc1d13dAB721DB69D86374FC6BaCDba
Entitlements: 0xFA4400c1B9AC496d9578B4B6507295A5aaD29EE7
```

--------------------------------

### Hashnote USYC Web2 API Endpoints

Source: https://usyc.docs.hashnote.com/integration-guides

Public HTTP endpoints for retrieving current and historical USYC prices, and checking token access entitlements on both Mainnet and Sepolia networks. These endpoints offer an alternative to direct smart contract interactions and do not require authentication.

```APIDOC
GET /api/price
Description: Current Price
Network: Mainnet
Base URL: https://usyc.hashnote.com
```

```APIDOC
GET /api/price-reports
Description: Historical price reports
Network: Mainnet
Base URL: https://usyc.hashnote.com
```

```APIDOC
GET /api/price
Description: Current Price
Network: Sepolia
Base URL: https://usyc.dev.hashnote.com
```

```APIDOC
GET /api/price-reports
Description: Historical price reports
Network: Sepolia
Base URL: https://usyc.dev.hashnote.com
```

```APIDOC
GET /v1/entitlements/token_access
Description: Access to USYC
Network: Mainnet
Base URL: https://api.hashnote.com
Parameters:
  address: string (Ethereum address)
  symbol: string (Token symbol, e.g., USYC)
```

```APIDOC
GET /v1/entitlements/token_access
Description: Access to USYC
Network: Sepolia
Base URL: https://api.dev.hashnote.com
Parameters:
  address: string (Ethereum address)
  symbol: string (Token symbol, e.g., USYC)
```

--------------------------------

### Mainnet Smart Contract Addresses

Source: https://usyc.docs.hashnote.com/overview/smart-contracts

Provides the deployed addresses for key smart contracts on the Ethereum Mainnet, essential for interacting with the Hashnote USYC system in a production environment.

```APIDOC
ERC20: 0x136471a34f6ef19fE571EFFC1CA711fdb8E49f2b
Oracle: 0x4c48bcb2160F8e0aDbf9D4F3B034f1e36d1f8b3e
Teller (USDC): 0x5C73E1cfdD85b7f1d608F7F7736fC8C653513B7A
Entitlements: 0x470f3b37B9B20E13b0A2a5965Df6bD3f9640DFB4
```

--------------------------------

### USYC Price Reports API Endpoints

Source: https://usyc.docs.hashnote.com/overview/token-price

Provides access to indexed and normalized on-chain price reports via a JSON API. Available on Mainnet and Sepolia.

```APIDOC
API Endpoints:
  Mainnet: https://usyc.hashnote.com/api/price-reports
  Sepolia: https://usyc.dev.hashnote.com/api/price-reports
```

--------------------------------

### USYC Public Web2 API Endpoints

Source: https://usyc.docs.hashnote.com/integration-guides/web2-api

A collection of public HTTP endpoints for accessing USYC data, including current price, historical price reports, and token access entitlements, available on both Mainnet and Sepolia networks.

```APIDOC
Network: Mainnet
Description: Current Price
Endpoint: https://usyc.hashnote.com/api/price
```

```APIDOC
Network: Sepolia
Description: Current Price
Endpoint: https://usyc.dev.hashnote.com/api/price
```

```APIDOC
Network: Mainnet
Description: Historical price reports
Endpoint: https://usyc.hashnote.com/api/price-reports
```

```APIDOC
Network: Sepolia
Description: Historical price reports
Endpoint: https://usyc.dev.hashnote.com/api/price-reports
```

```APIDOC
Network: Mainnet
Description: Access to USYC
Endpoint: https://api.hashnote.com/v1/entitlements/token_access?address={address}&symbol=USYC
```

```APIDOC
Network: Sepolia
Description: Access to USYC
Endpoint: https://api.dev.hashnote.com/v1/entitlements/token_access?address={address}&symbol=USYC
```

--------------------------------

### Purchase USYC Tokens via Etherscan Teller Contract

Source: https://usyc.docs.hashnote.com/integration-guides/etherscan

This section outlines the steps to purchase USYC tokens using the Teller contract on Etherscan. After approving the USDC allowance, you will navigate to the Teller contract, find the 'buy' function, and specify the amount of USDC to spend.

```Etherscan UI
Navigate to the Teller contract (https://etherscan.io/address/0xAAF405C48e8c73aECedA3E40fE34e5C0ff8f5DE5).
Click on the `Write Proxy` tab.
Scroll down to the `buy` function.
Enter the amount of USDC you wish to spend on the purchase.
```

--------------------------------

### USYC Oracle Etherscan References

Source: https://usyc.docs.hashnote.com/overview/token-price

References to the USYC Oracle smart contract on Etherscan, including its address and ABI, which adheres to the Chainlink aggregator interface. These links provide direct access to the on-chain contract details and its interface definition.

```APIDOC
USYC Oracle Etherscan Address:
https://etherscan.io/address/0x4c48bcb2160F8e0aDbf9D4F3B034f1e36d1f8b3e#readProxyContract

USYC Oracle ABI:
https://etherscan.io/address/0x3B7ad4835d817181592788A7E6D588D334e0426b#code
```

--------------------------------

### Sell USYC Tokens via Etherscan Teller Contract

Source: https://usyc.docs.hashnote.com/integration-guides/etherscan

This section describes the process of selling USYC tokens through the Teller contract on Etherscan. After approving the USYC allowance, you will navigate to the Teller contract, find the 'sell' function, and specify the amount of USYC you wish to sell.

```Etherscan UI
Navigate to the Teller contract (https://etherscan.io/address/0xAAF405C48e8c73aECedA3E40fE34e5C0ff8f5DE5).
Click on the `Write Proxy` tab.
Scroll down to the `sell` function.
Enter the amount of USYC you wish to sell.
```

--------------------------------

### Approve USDC Allowance on Etherscan for USYC Purchase

Source: https://usyc.docs.hashnote.com/integration-guides/etherscan

This section describes how to grant the Teller contract permission to spend your USDC on Etherscan. This is a prerequisite before purchasing USYC tokens. You will navigate to the USDC contract, use the 'approve' function, and specify the Teller contract address and the amount of USDC.

```Etherscan UI
Navigate to the USDC contract (https://etherscan.io/address/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48).
Click on the `Write Proxy` tab.
Scroll down to the `approve` function.
Enter the Teller address (0x5C73E1cfdD85b7f1d608F7F7736fC8C653513B7A) into the `spender` field.
Enter the amount of USDC you would like to spend to purchase USYC.
```

--------------------------------

### Approve USYC Allowance on Etherscan for USYC Sale

Source: https://usyc.docs.hashnote.com/integration-guides/etherscan

This section details how to grant the Teller contract permission to spend your USYC on Etherscan. This is a necessary step before selling your USYC tokens. You will navigate to the USYC contract, use the 'approve' function, and specify the Teller contract address and the amount of USYC you intend to sell.

```Etherscan UI
Navigate to the USYC contract (https://etherscan.io/address/0x136471a34f6ef19fE571EFFC1CA711fdb8E49f2b).
Click on the `Write Proxy` tab.
Scroll down to the `approve` function.
Enter the Teller address (0x5C73E1cfdD85b7f1d608F7F7736fC8C653513B7A) into the `spender` field.
Enter the amount of USYC you will be selling.
```
Tokens:
Raw