Account

Struct Account 

Source
pub struct Account { /* private fields */ }
Expand description

Unified account primitive for credential management and signing operations.

Account combines wallet (private key), API credentials, and signing capabilities into a single abstraction. It provides factory methods for loading credentials from various sources (environment variables, files) and handles both EIP-712 order signing and HMAC-based L2 API authentication.

§Example

use polyte_clob::Account;

// Load from environment variables
let account = Account::from_env()?;

// Or load from a JSON file
let account = Account::from_file("config/account.json")?;

// Get the wallet address
println!("Address: {:?}", account.address());

Implementations§

Source§

impl Account

Source

pub fn new( private_key: impl Into<String>, credentials: Credentials, ) -> Result<Self>

Create a new account from private key and credentials.

§Arguments
  • private_key - Hex-encoded private key (with or without 0x prefix)
  • credentials - API credentials for L2 authentication
§Example
use polyte_clob::{Account, Credentials};

let credentials = Credentials {
    key: "api_key".to_string(),
    secret: "api_secret".to_string(),
    passphrase: "passphrase".to_string(),
};

let account = Account::new("0x...", credentials)?;
Source

pub fn from_env() -> Result<Self>

Load account from environment variables.

Reads the following environment variables:

  • POLYMARKET_PRIVATE_KEY: Hex-encoded private key
  • POLYMARKET_API_KEY: API key
  • POLYMARKET_API_SECRET: API secret (base64 encoded)
  • POLYMARKET_API_PASSPHRASE: API passphrase
§Example
use polyte_clob::Account;

let account = Account::from_env()?;
Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Load account from a JSON configuration file.

The file should contain:

{
    "private_key": "0x...",
    "key": "api_key",
    "secret": "api_secret",
    "passphrase": "passphrase"
}
§Example
use polyte_clob::Account;

let account = Account::from_file("config/account.json")?;
Source

pub fn from_json(json: &str) -> Result<Self>

Load account from a JSON string.

§Example
use polyte_clob::Account;

let json = r#"{
    "private_key": "0x...",
    "key": "api_key",
    "secret": "api_secret",
    "passphrase": "passphrase"
}"#;

let account = Account::from_json(json)?;
Source

pub fn address(&self) -> Address

Get the wallet address.

Source

pub fn wallet(&self) -> &Wallet

Get a reference to the wallet.

Source

pub fn credentials(&self) -> &Credentials

Get a reference to the credentials.

Source

pub fn signer(&self) -> &Signer

Get a reference to the HMAC signer.

Source

pub async fn sign_order( &self, order: &Order, chain_id: u64, ) -> Result<SignedOrder>

Sign an order using EIP-712.

§Arguments
  • order - The unsigned order to sign
  • chain_id - The chain ID for EIP-712 domain
§Example
use polyte_clob::{Account, Order};

async fn example(account: &Account, order: &Order) -> Result<(), Box<dyn std::error::Error>> {
    let signed_order = account.sign_order(order, 137).await?;
    println!("Signature: {}", signed_order.signature);
    Ok(())
}
Source

pub async fn sign_clob_auth( &self, chain_id: u64, timestamp: u64, nonce: u32, ) -> Result<String>

Sign a CLOB authentication message for API key creation (L1 auth).

§Arguments
  • chain_id - The chain ID for EIP-712 domain
  • timestamp - Unix timestamp in seconds
  • nonce - Random nonce value
Source

pub fn sign_l2_request( &self, timestamp: u64, method: &str, path: &str, body: Option<&str>, ) -> Result<String>

Sign an L2 API request message using HMAC.

§Arguments
  • timestamp - Unix timestamp in seconds
  • method - HTTP method (GET, POST, DELETE)
  • path - Request path (e.g., “/order”)
  • body - Optional request body

Trait Implementations§

Source§

impl Clone for Account

Source§

fn clone(&self) -> Account

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Account

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more