Movatterモバイル変換

wevm/oxPublic

NotificationsYou must be signed in to change notification settings
Fork31
Star179

Standard Library for Ethereum

oxlib.sh

License

MIT license

179 stars 31 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 819 Commits
.changeset		.changeset
.github		.github
.vscode		.vscode
contracts		contracts
examples/webauthn-p256		examples/webauthn-p256
patches		patches
scripts		scripts
site		site
src		src
test		test
vectors		vectors
.gitignore		.gitignore
.gitmodules		.gitmodules
.npmrc		.npmrc
LICENSE		LICENSE
biome.json		biome.json
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.base.json		tsconfig.base.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
tsdoc.json		tsdoc.json

Repository files navigation

Overview

Ox (⦻) is the foundation of robust Ethereum software written in TypeScript. It is an Ethereum Standard Library that provides a set of lightweight, performant, and type-safe TypeScript modules for Ethereum.

It offers core utilities & types for primitives such as: ABIs, Addresses, Blocks, Bytes, ECDSA, Hex, JSON-RPC, RLP, Signing & Signatures, Transaction Envelopes, and more.

As an unopinionated Standard Library, it is designed to be used by higher-level consumers (such asViem,Tevm, or their alternatives) to provide their own opinionated interfaces, and/or when reaching for low-level primitives may be needed without buying into a Client Abstraction stack (Viem, Ethers, Web3.js, etc).

Documentation

Head to the documentation to read and learn more about Ox.

Example Usage

The example below demonstrates how to construct, sign, and broadcast a transaction envelope using Ox:

import{Provider,Secp256k1,TransactionEnvelopeEip1559,Value}from'ox'// 1. Construct a transaction envelope.constenvelope=TransactionEnvelopeEip1559.from({chainId:1,gas:21000n,nonce:0n,maxFeePerGas:Value.fromGwei('10'),maxPriorityFeePerGas:Value.fromGwei('1'),to:'0x70997970c51812dc3a010c7d01b50e0d17dc79c8',value:Value.fromEther('1'),})// 2. Get the signing payload for the envelope.constpayload=TransactionEnvelopeEip1559.getSignPayload(envelope)// 3. Sign the payload with your private key using secp256k1.constsignature=Secp256k1.sign({ payload,privateKey:'0x...'})// 4. Serialize the envelope with the signature.constserialized=TransactionEnvelopeEip1559.serialize(envelope,{ signature})// 5. Broadcast the envelope to the network.constprovider=Provider.from(window.ethereum)consthash=awaitprovider.request({method:'eth_sendRawTransaction',params:[serialized],})

Note

Ox's APIs are purposely stateless, unopinionated, and verbose. The example above can definitely be achieved in a few lines of code in a more concise manner, however, the goal is for higher-level abstractions (Viem, etc) built on top of Ox to handle this for you.