Skip to main content

Async client for NEAR Blockchain with native HOT Protocol & NEAR Intents support

Project description

py-near

Financial Contributors on Open Collective PyPi Package Version Supported python versions Documentation Status Github issues MIT License Twitter

py-near is a Async client for NEAR Blockchain with native HOT Protocol & NEAR Intents support

Examples

📚 Click to see some basic examples

Few steps before getting started...

  • Install the latest stable version of py-near, simply running pip install py-near
  • Create NEAR account and get your private key wallet

Simple money transfer

from py_near.account import Account
import asyncio
from py_near.dapps.core import NEAR

ACCOUNT_ID = "bob.near"
PRIVATE_KEY = "ed25519:..."


async def main():
   acc = Account(ACCOUNT_ID, PRIVATE_KEY)

   await acc.startup()
   print(await acc.get_balance() / NEAR)
   print(await acc.get_balance("bob.near") / NEAR)

   tr = await acc.send_money("bob.near", NEAR * 2)
   print(tr.transaction.hash)
   print(tr.logs)


asyncio.run(main())

Working with NEAR Intents (OmniBalance)

from py_near.omni_balance import OmniBalance
import asyncio

ACCOUNT_ID = "bob.near"
PRIVATE_KEY = "ed25519:..."


async def main():
    omni = OmniBalance(ACCOUNT_ID, PRIVATE_KEY)
    await omni.startup()
    
    # Create intent with multiple actions: transfer, token swap, and auth call
    commitment = omni.transfer(
        tokens={"nep141:wrap.near": "5"},
        receiver_id="alice.near",
        memo="Test transfer",
    ).token_diff({
        "nep141:wrap.near": "-5",
    }).auth_call("contract.near", msg="test").sign()
    
    # Simulate intent before submitting
    sim = await omni.simulate_intent(commitment)
    print(sim.logged_intents)
    
    # Submit intent to solver network
    intent_hash = await omni.publish_intents(commitment)
    print(f"Intent hash: {intent_hash}")
    
    # Wait for transaction hash
    tr_hash = await omni.get_tr_hash_from_intent(intent_hash)
    print(f"Transaction hash: {tr_hash}")
    
    await omni.shutdown()


asyncio.run(main())

Parallel requests

Only one parallel request can be made from one private key. All transaction calls execute sequentially. To make several parallel calls you need to use several private keys

acc = Account("bob.near", private_key1)

for i in range(2):
  signer = InMemorySigner.from_random(AccountId("bob.near"), KeyType.ED25519)
  await acc.add_full_access_public_key(str(signer.public_key))
  print(signer.secret_key)

Now we can call transactions in parallel

acc = Account("bob.near", [private_key1, private_key2, private_key3])
# request time = count transactions / count public keys
tasks = [
  asyncio.create_task(acc.send_money("alisa.near", 1)),
  asyncio.create_task(acc.send_money("alisa.near", 1)),
  asyncio.create_task(acc.send_money("alisa.near", 1)),
]
for t in tasks:
  await t

Official py-near resources:

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Code of conduct].

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_near-1.2.3.tar.gz (42.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_near-1.2.3-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

Details for the file py_near-1.2.3.tar.gz.

File metadata

  • Download URL: py_near-1.2.3.tar.gz
  • Upload date:
  • Size: 42.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_near-1.2.3.tar.gz
Algorithm Hash digest
SHA256 83052a7e244ed1ba6d57d91ae0113d64398c08327412c78bb1cd13044d57f3fe
MD5 3ac690b043ed51187d481f4596b231b9
BLAKE2b-256 c9cfba37fba514a85636e155c2236a791dd3e84956ceb20f31ffa3bfc2e44710

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_near-1.2.3.tar.gz:

Publisher: publish.yml on pvolnov/py-near

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_near-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: py_near-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 49.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_near-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7f552254812de965de0fc88c1fe4de28a7cf8abb835b09c0c9b6d422ecb51895
MD5 ba6e71be1ab8bd72e8b5f3f8286853b0
BLAKE2b-256 cd1e58166c2d5787436ce866bf10150c70a6289bc43b02daa68d3ff5c37e1aa5

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_near-1.2.3-py3-none-any.whl:

Publisher: publish.yml on pvolnov/py-near

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page