Write builder python psudo-code

[rmsams]

In order to (1) know how this repo should be structured and (2) make sure that we are all aligned on the intended SDK api's, someone should write some python psudo-code to illustrate how a builder develops a product using python.

[szemate]

Proposed API already under development, gives the builder multiple options:

1. Importing a JSON specification file

import afp
from decimal import Decimal

app = afp.AFP(authenticator=afp.Authenticator(...))
product = app.Product(ipfs_config=afp.IPFSConfig(...))

with open("json-spec.json") as f:
    product_spec = product.validate_json(f.read())

product_spec_with_metadata_cid = product.pin(product_spec)
tx = product.register(product_spec_with_metadata_cid, initial_builder_stake=Decimal("1"))

print(product.state(product.id(product_spec_with_metadata_cid)))

2. Writing specification in Python with Pydantic models

import afp
from decimal import Decimal

# afp.schemas module has Pydantic models that map 1:1 to JSON schema objects
product_spec = afp.schemas.PredictionProduct(
    product=afp.schemas.PredictionProductV1(...),
    outcome_space=afp.schemas.OutcomeSpace(...),
    outcome_point=afp.schemas.OutcomePoint(...),
)

app = afp.AFP(authenticator=afp.Authenticator(...))
product = app.Product(ipfs_config=afp.IPFSConfig(...))

product_spec_with_metadata_cid = product.pin(product_spec)
tx = product.register(product_spec_with_metadata_cid, initial_builder_stake=Decimal("1"))

print(product.state(product.id(product_spec_with_metadata_cid)))

3. Writing specification in Python as a dictionary

import afp
from decimal import Decimal

# Write a Python dictionary equivalent to an imported JSON file
product_dict = {
    "product": {...},
    "outcome_space": {...},
    "outcome_point": {...},
}

app = afp.AFP(authenticator=afp.Authenticator(...))
product = app.Product(ipfs_config=afp.IPFSConfig(...))

product_spec = product.validate(product_dict)
product_spec_with_metadata_cid = product.pin(product_spec)
tx = product.register(product_spec_with_metadata_cid, initial_builder_stake=Decimal("1"))

print(product.state(product.id(product_spec_with_metadata_cid)))

4. Downloading an on-chain product

import afp
from decimal import Decimal

app = afp.AFP(authenticator=afp.Authenticator(...))
product = app.Product(ipfs_config=afp.IPFSConfig(...))

product_spec = product.get("0x...")
print(product.dump_json(product_spec))