https://github.com/btc415/btc-ordinal

Inscriptions and BRC20 Rust library
https://github.com/btc415/btc-ordinal

bitcoin ordinals ordinals-nft rust rust-lang

Last synced: 5 days ago
JSON representation

Inscriptions and BRC20 Rust library

• Host: GitHub
• URL: https://github.com/btc415/btc-ordinal
• Owner: BTC415
• Created: 2024-03-04T05:18:56.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-03-04T05:42:59.000Z (8 months ago)
• Last Synced: 2024-10-11T14:14:43.493Z (about 1 month ago)
• Topics: bitcoin, ordinals, ordinals-nft, rust, rust-lang
• Language: TypeScript
• Homepage:
• Size: 231 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OrdConnect

OrdConnect is a JavaScript library for interacting with wallet management and Bitcoin transactions.

## Installation

You can install OrdConnect via npm or yarn:

```bash

npm install ordconnect

# or

yarn add ordconnect

```

# Usage

## Get Wallet Manager

import { WalletManager } from 'ord-connect';

## Sending Bitcoin (BTC)

send(amount: number, address: string, session: Session);

```

Session: {

        cardinalAddress: string,

        id: string,

        ordinalAddress: string,

        wallet: string,

} | null

```

## Signing PSBTs

signPsbt(params: Params)

```

Params: {

  psbtBase64: string,

  inputsToSign: [{

    address: string,

    signingIndexes: number[], // int array of indexes to sign

  }],

  broadcast: boolean,

}

```

## Bitcoin Kit Functions

All the Bitcoin-related functions available in the btckit library are also accessible through this library. Please refer to the btckit documentation for detailed information on these functions.

## License

This project is licensed under the MIT License.

## Contributing

Contributions are welcome!

## Issues

If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

## Acknowledgments

Special thanks to the developers of the btckit library for their contributions and support.