https://github.com/microchipgnu/near-ca
Simplify the process of interacting with any chain with NEAR Protocol accounts
https://github.com/microchipgnu/near-ca
Last synced: 2 months ago
JSON representation
Simplify the process of interacting with any chain with NEAR Protocol accounts
- Host: GitHub
- URL: https://github.com/microchipgnu/near-ca
- Owner: microchipgnu
- Created: 2024-03-09T01:13:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T10:36:47.000Z (over 2 years ago)
- Last Synced: 2024-03-12T11:55:01.201Z (over 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NEAR Chain Abstraction Layer (NEAR-CA)
**DISCLAIMER: This should only be used for educational purposes.**
NEAR-CA is a TypeScript library that provides an abstraction layer for interacting with the NEAR blockchain. It simplifies the process of performing transactions and managing accounts on NEAR and Ethereum chains.
Intended to be used on server-side applications only. This works best with [Bun](https://bun.sh).
## Features
- Account management for NEAR blockchain.
- Transaction signing and sending on Ethereum blockchain.
- Key derivation functions for cryptographic operations.
- Support for EIP-1559 transactions on Ethereum.
## Installation
To install NEAR-CA, run the following command:
```bash
bun add near-ca
```
Alternatively,
```bash
npm add near-ca
```
```bash
pnpm add near-ca
```
## Usage
For Ethereum, you can derive addresses, create payloads for transactions, and send signed transactions.
Example: Deriving an Ethereum address and sending a transaction
```typescript
const ethAddress = await deriveEthAddress("ethereum,1");
const functionSignature = web3.eth.abi.encodeFunctionCall(
{
name: "safeMint",
type: "function",
inputs: [
{
type: "address",
name: "to",
},
],
},
["0xAA5FcF171dDf9FE59c985A28747e650C2e9069cA"]
);
await signAndSendTransaction(
ethAddress,
"0xAA5FcF171dDf9FE59c985A28747e650C2e9069cA",
0,
functionSignature
);
```
## Examples
1. [Mint NFT](./examples/mint-nft.ts)
1. [Send ETH](./examples/send-eth.ts)
## Configuration
Before using NEAR-CA, ensure you have the following environment variables set:
- `NEAR_ACCOUNT_ID`: Your NEAR account identifier.
- `NEAR_ACCOUNT_PRIVATE_KEY`: Your NEAR account private key.
- `NEAR_MULTICHAIN_CONTRACT`: The NEAR contract that handles multichain operations.
Copy the `.env.example` file and place these values in `.env`