Aligned-JS

Aligned-js is a JavaScript library for interacting with the Aligned layer.

SDK API Reference

$3

Submits a proof to the batcher to be verified and returns an aligned verification data struct.

``js
import { submit, Network } from "aligned";

async function main() {
const alignedData = await submit(
"BATCHER_URL",
"NETWORK.NAME",
"VerificationData",
"MAX_FEE",
"WALLET_ACCOUNT",
"NONCE"
);
console.log(alignedData);
}
`

$3

Submits multiple proofs to the batcher to be verified and returns an aligned verification data array.

`js
import { submitMultiple, Network } from "aligned";

async function main() {
const alignedData = await submitMultiple(
"BATCHER_URL",
"NETWORK.NAME",
"VerificationData",
"MAX_FEE",
"WALLET_ACCOUNT",
"NONCE"
);
console.log(alignedData);
}
`

$3

Submits a proof to the batcher to be verified, waits for the verification on ethereum and returns an aligned verification data struct.

`js
import { submitAndWaitVerification, Network } from "aligned";

async function main() {
const alignedData = await submitAndWaitVerification(
"BATCHER_URL",
"ETH_RPC_API",
"NETWORK.NAME",
"VerificationData",
"MAX_FEE",
"WALLET_ACCOUNT",
"NONCE"
);
console.log(alignedData);
}
`

$3

Checks if the proof has been verified with Aligned and is included in the batch on-chain.

`js
import { isProofVerified, Network } from "aligned";

async function main() {
const verified = await isProofVerified(
"alignedVerificationData",
"NETWORK.NAME",
"ETH_RPC_API"
);
console.log(verified);
}
`

$3

Returns the nonce to use for a given address.

`js
import { getNextNonce, Network } from "aligned";

async function main() {
const nonce = await getNextNonce(
"ETH_RPC_API",
"ADDRESS",
"NETWORK.NAME",
);
console.log(nonce);
}
`

$3

Queries a User's balance that was deposited in Aligned

`js
import { getBalanceInAligned, Network } from "aligned";

async function main() {
const balance = await getNextNonce(
"ADDRESS",
"ETH_RPC_API",
"NETWORK.NAME",
);
console.log(balance);
}
``

✏️ Contributing

If you consider to contribute to this project please read CONTRIBUTING.md first.

📜 License

Copyright (c) 2024 Broly Labs

Licensed under the MIT license.