Struct DamlJsonClient 

pub struct DamlJsonClient { /* private fields */ }

Daml JSON API client.

See here for full details of the Daml JSON API.

Examples

The following example connects to a Daml ledger via the JSON API and creates a contract:

use serde_json::json;
use daml_json::service::DamlJsonClientBuilder;
use daml_json::error::DamlJsonResult;
#[tokio::main]
async fn main() -> DamlJsonResult<()> {
    let payload = json!({ "sender": "Alice", "receiver": "Bob", "count": "0" });
    let client = DamlJsonClientBuilder::url("https://api.myledger.org")
        .with_auth("...token...".into())
        .build()?;
    let create_response = client.create("Fuji.PingPong:Ping", payload.clone()).await?;
    assert_eq!(create_response.payload, payload);
    Ok(())
}

Implementations

impl DamlJsonClient

pub fn new( url: impl Into<String>, token: Option<String>, ) -> DamlJsonResult<Self>

Create a new DamlJsonClient.

pub fn new_from_config(config: DamlJsonClientConfig) -> DamlJsonResult<Self>

Create a new DamlJsonClient from a DamlJsonClientConfig.

pub const fn config(&self) -> &DamlJsonClientConfig

Return the current configuration.

pub async fn create( &self, template_id: &str, payload: Value, ) -> DamlJsonResult<DamlJsonCreatedEvent>

Create a new Daml contract.

pub async fn create_with_meta( &self, template_id: &str, payload: Value, meta: DamlJsonRequestMeta, ) -> DamlJsonResult<DamlJsonCreatedEvent>

Create a new Daml Contract with optional meta field.

pub async fn exercise( &self, template_id: &str, contract_id: &str, choice: &str, argument: Value, ) -> DamlJsonResult<DamlJsonExerciseResult>

Exercise a Daml choice by contract id.

pub async fn exercise_by_key( &self, template_id: &str, key: Value, choice: &str, argument: Value, ) -> DamlJsonResult<DamlJsonExerciseResult>

Exercise a Daml choice by contract key.

pub async fn create_and_exercise( &self, template_id: &str, payload: Value, choice: &str, argument: Value, ) -> DamlJsonResult<DamlJsonExerciseResult>

Create and exercise a Daml choice.

pub async fn fetch( &self, contract_id: &str, ) -> DamlJsonResult<DamlJsonCreatedEvent>

Fetch a Daml contract by id.

pub async fn fetch_by_key( &self, template_id: &str, key: Value, ) -> DamlJsonResult<DamlJsonCreatedEvent>

Fetch a Daml contract by key.

pub async fn query_all(&self) -> DamlJsonResult<Vec<DamlJsonCreatedEvent>>

List all currently active contracts for all known templates.

pub async fn query<S: Into<String> + Debug>( &self, template_ids: Vec<S>, query: Value, ) -> DamlJsonResult<Vec<DamlJsonCreatedEvent>>

List currently active contracts that match a given query.

pub async fn fetch_parties<S: Into<String> + Debug>( &self, parties: Vec<S>, ) -> DamlJsonResult<Vec<DamlJsonParty>>

Fetch Daml Parties by identifiers.

Retrieve the DamlJsonParty entries for the given parties identifiers. Unknown parties are silently discarded.

pub async fn fetch_parties_with_unknown<S: Into<String> + Debug>( &self, parties: Vec<S>, ) -> DamlJsonResult<(Vec<DamlJsonParty>, Vec<String>)>

Fetch Daml Parties and unknown Daml Parties by identifiers.

Retrieve the DamlJsonParty entries for the given parties identifiers and unknown party identifiers.

pub async fn fetch_all_parties(&self) -> DamlJsonResult<Vec<DamlJsonParty>>

Fetch all known Parties.

pub async fn allocate_party( &self, identifier_hint: Option<&str>, display_name: Option<&str>, ) -> DamlJsonResult<DamlJsonParty>

Allocate Party.

pub async fn list_packages(&self) -> DamlJsonResult<Vec<String>>

List All DALF packages

pub async fn download_package( &self, package_id: &str, ) -> DamlJsonResult<Vec<u8>>

Download a DALF package.

pub async fn upload_dar(&self, content: Vec<u8>) -> DamlJsonResult<()>

Upload a DAR file.