https://github.com/crossbell-box/crossbell.js
Crossbell.js - A JavaScript SDK to interact with Crossbell
https://github.com/crossbell-box/crossbell.js
Last synced: about 1 year ago
JSON representation
Crossbell.js - A JavaScript SDK to interact with Crossbell
- Host: GitHub
- URL: https://github.com/crossbell-box/crossbell.js
- Owner: Crossbell-Box
- License: mit
- Created: 2022-04-13T15:22:46.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T23:01:28.000Z (about 1 year ago)
- Last Synced: 2025-04-08T00:21:29.638Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://crossbell.js.org
- Size: 13.3 MB
- Stars: 17
- Watchers: 4
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crossbell.js
A JavaScript SDK to interact with the Crossbell. It works for both browser and Node.js.
[](https://npm.im/crossbell) [](https://npm.im/crossbell)
- [API Reference](https://crossbell.js.org/)
- [Vite Example](https://crossbell-js.netlify.app/)
## Installation
```bash
npm install crossbell
```
## Usage
### Requirements
Node.js >= 18.0.0 or Node.js >= 16.14.0 with [fetch polyfill](https://github.com/nodejs/undici)
### Contract
#### Connect with Metamask
```typescript
import { createContract } from 'crossbell'
// Create a new contract instance with metamask provider
const provider = window.ethereum
const contract = new createContract(provider)
// Example API: Create a new character for an address
try {
const result = await contract.character.create({
owner: '0x1234567890123456789012345678901234567890',
handle: 'Jason',
metadataOrUri: 'ipfs://xxxx/metadata.json',
})
console.log(result.data) // '42' (characterId)
console.log(result.transactionHash) // '0xabcdef...'
} catch (e) {
console.error(e.message) // e.g. "execution reverted: Web3Entry: HandleExists"
}
```
#### Connect with Private Key
You can also connect with a private key directly.
```typescript
import { createContract } from 'crossbell'
const privateKey =
'0xabcdef0123456789012345678901234567890123456789012345678901234'
const contract = new createContract(provider)
```
#### Connect with Read-Only
You can also connect with a read-only provider. Note that in this case, you can't do write operations like `createCharacter`.
```typescript
import { createContract } from 'crossbell'
const contract = new createContract(provider) // just pass nothing to use a read-only provider
```
For more contract api, see [docs](https://crossbell.js.org/classes/Contract.html).
### Indexer
You can fetch data from the crossbell indexer.
```typescript
import { createIndexer } from 'crossbell'
const indexer = createIndexer()
// get a list of characters owned by a specific address
const res = await indexer.character.getMany(
'0x1234567890123456789012345678901234567890',
)
console.log(res.list)
```
For more indexer api, see [docs](https://crossbell.js.org/classes/Indexer.html).