Improv hub

The hub contract is responsible for creating new stories and maintaining the state of all ongoing stories.

Messages

InstantiateMsg

Instantiates the Improv hub contract.

JSON

Rust

{
  "owner": "<Terra-address>",
  "wormhole_core_bridge_addr": "<Terra-address>",
  "wormhole_token_bridge_addr": "<Terra-address>",
  "improv_relayer_addr": "<Terra-address>",
  "bid_token": "<Terra-address>",
  "writing_extension_period": 1661296904,
  "auction_report_submission_period": 1661296904,
  "voting_period": 1661296904,
  "veto_threshold": "0.5"
}

InstantiateMsg

Instantiates the Improv hub contract.

JSON

Rust

{
  "owner": "<Terra-address>",
  "wormhole_core_bridge_addr": "<Terra-address>",
  "wormhole_token_bridge_addr": "<Terra-address>",
  "improv_relayer_addr": "<Terra-address>",
  "bid_token": "<Terra-address>",
  "writing_extension_period": 1661296904,
  "auction_report_submission_period": 1661296904,
  "voting_period": 1661296904,
  "veto_threshold": "0.5"
}

ExecuteMsgs

create_proposal

Creates a new proposal and submit it to the community for casting. Writers post a pitch with a synopsis, open cast positions (character bios), a minimum funding target, deadline, and a self-introduction.

JSON

Rust

{
  "create_proposal": {
    "synopsis": "string",
    "min_funding_target": "u128",
    "writing_deadline": u64,
    "bidding_deadline": u64,
    "author_self_intro": "string",
    "cast": [
      {
        "chain_id": 2,
        "reserve_price": "100000000",
        "increment": "10000000",
        "collections": [
          [
            0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
            244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128,
            95, 211
          ]
        ]
      }
    ]
  }
}

submit_story

When the writer is finished, they can submit an Arweave or IPFS URI with the plaintext or pdf version of the finished manuscript.

Final versions are denoted using "is_final": true,.

JSON

Rust

{
  "submit_story": {
    "proposal_id": 1,
    "is_final": false,
    "story_uri": "https://example.improv/blank.pdf"
  }
}

whitelist_collection (internal)

Allows the contract owner to whitelist new NFT collections.

JSON

Rust

{
  "whitelist_collection": {
    "chain_id": 2,
    "address": [
      0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149, 244,
      91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128, 95, 211
    ],
    "name": null
  }
}

create_proposal

submit_story

When the writer is finished, they can submit an Arweave or IPFS URI with the plaintext or pdf version of the finished manuscript.

Final versions are denoted using "is_final": true,.

whitelist_collection (internal)

Allows the contract owner to whitelist new NFT collections.

JSON

Rust

{
  "create_proposal": {
    "synopsis": "string",
    "min_funding_target": "u128",
    "writing_deadline": u64,
    "bidding_deadline": u64,
    "author_self_intro": "string",
    "cast": [
      {
        "chain_id": 2,
        "reserve_price": "100000000",
        "increment": "10000000",
        "collections": [
          [
            0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
            244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128,
            95, 211
          ]
        ]
      }
    ]
  }
}

QueryMsgs

Config

Returns the configuration for the Improv hub.

Request

{
  "config": {}
}

Response

{
  "owner": "terra...",
  "wormhole_core_bridge_addr": "terra...",
  "wormhole_token_bridge_addr": "terra...",
  "improv_relayer_addr": "terra...",
  "bid_token": "terra...",
  "writing_extension_period": 1661296904,
  "auction_report_submission_period": 1661296904,
  "voting_period": 1661296904,
  "veto_threshold": "0.5"
}

State

Returns the state information of the Improv Hub.

Request

{
  "state": {}
}

Response

{
  "total_proposals": 1,
  "total_collections": 1
}

view_proposal

Returns the details of a submitted proposal.

Request

{
  "proposal": { "proposal_id": 1 }
}

Response

{
  "id": 1,
  "status": "InAuction",
  "title": "Minute to Midnight",
  "genre": "Action",
  "synopsis": "It took 200,000 years for humans to leave the solar system. Now, there is no return. Join the last of the human race in a fight against the clock. Space is endless, Time is short.",
  "min_funding_target": "300000000",
  "writing_deadline": 1661296904,
  "bidding_deadline": 1661296904,
  "author_self_intro": "Will E. Maekit is an award winning novelist and author of "Portent of call."
  "author": "terra...",
  "is_story_final": false,
  "story_uri": "https://mag.wcoomd.org/uploads/2018/05/blank.pdf",
  "story_submission_time": 1661296904,
  "cast": [
    {
      "character_id": 1,
      "chain_id": 2,
      "reserve_price": "100000000",
      "increment": "10000000",
      "collections": [
        [
          0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
          244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128,
          95, 211
        ]
      ],
      "vote": null,
      "bid_amount": "100000000",
      "nft_address": [
        0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
        244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128, 95,
        211
      ],
      "nft_token_id": 1,
      "name": "Jane",
      "description": "An unlikely hero, Jane Goodall is one of only 6000 humans left in the universe. She has lived her entire life on her ship, `Tiwanaku`. The 22 year old daughter of the last human born on Earth, Jane has struggled her whole life to find her place among the last humans. Bold, smart, and rebelious, Jane just wants a few moments by herself, away from the worries and monotony of life on her disintegrating ship. Though she doesn't want to be, she is humanity's last hope."
    }
  ],
  "veto_id": 0,
  "total_vetoes": 0,
  "veto_reports": [],
  "auction_reports": [],
  "bridged_funds": [],
  "proposal_vaa": null,
  "lastest_veto_vaa": null,
  "is_funds_bridged": false
}

Query Proposals

Query Params

filter proposals by:
- author or
- status or
- genre or
- author and status or
- genre and status
order_by: asc/desc
start_at: pagination
limit: (max 50)

Request

{
  "proposals": {
    "status": "in_writing",
    "author": "terra...",
    "start_at": null,
    "limit": 1,
    "order_by": "asc"
  }
}

Response

{
  "proposals": [
    {
      "id": 1,
      "status": "InAuction",
      "title": "Minute to Midnight",
      "genre": "Action",
      "synopsis": "It took 200,000 years for humans to leave the solar system. Now, there is no return. Join the last of the human race in a fight against the clock. Space is endless, Time is short.",
      "min_funding_target": "300000000",
      "writing_deadline": 1661296904,
      "bidding_deadline": 1661296904,
      "author_self_intro": "Will E. Maekit is an award winning novelist and author of 'Portent of call.'",
      "author": "terra...",
      "author_self_intro": "Reginald Rose (regie.eth) is a playwright who tweets things about penguins... latest piece was “In the Darkness",
      "is_story_final": false,
      "story_uri": "https://mag.wcoomd.org/uploads/2018/05/blank.pdf",
      "story_submission_time": 1661296904,
      "cast": [
        {
          "character_id": 1,
          "chain_id": 2,
          "reserve_price": "100000000",
          "increment": "10000000",
          "collections": [
            [
              0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254,
              149, 244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61,
              158, 128, 95, 211
            ]
          ],
          "vote": null,
          "bid_amount": "100000000",
          "nft_address": [
            0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
            244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128,
            95, 211
          ],
          "nft_token_id": 1,
          "name": "George",
          "description": "Assistant high school football coach. A small, petty man who is at first vary of, and then impressed with the authority he has. Handles himself quite formally. Not overly bright, but dogged."
        }
      ],
      "veto_id": 0,
      "total_vetoes": 0,
      "veto_reports": [],
      "auction_reports": [],
      "bridged_funds": [],
      "proposal_vaa": null,
      "lastest_veto_vaa": null,
      "is_funds_bridged": false
    }
  ],
  "next_proposal": 2
}

whitelisted_collections

Query the whitelisted collections using the following parameters.

Query Params:

order_by: asc/desc
start_at: pagination
limit: (max 50)

Request

{
  "whitelisted_collections": {
    "start_at": null,
    "limit": 1,
    "order_by": "asc"
  }
}

Response

{
  "collections": [
    {
      "id": 1,
      "chain_id": 18,
      "address": [
        0, 211, 109, 140, 122, 144, 121, 30, 247, 18, 45, 161, 65, 254, 149,
        244, 91, 45, 133, 49, 27, 173, 12, 221, 185, 156, 34, 61, 158, 128, 95,
        211
      ],
      "name": "Bored Llamas",
      "image_uri": "http://a-bored-llama.jpeg"
    }
  ],
  "next_collection": 2
}

Config

Returns the configuration for the Improv hub.

State

Returns the state information of the Improv Hub.

view_proposal

Returns the details of a submitted proposal.

Query Proposals

Query Params

filter proposals by:
- author or
- status or
- genre or
- author and status or
- genre and status
order_by: asc/desc
start_at: pagination
limit: (max 50)

whitelisted_collections

Query the whitelisted collections using the following parameters.

Query Params:

order_by: asc/desc
start_at: pagination
limit: (max 50)

Request

{
  "config": {}
}

Response

{
  "owner": "terra...",
  "wormhole_core_bridge_addr": "terra...",
  "wormhole_token_bridge_addr": "terra...",
  "improv_relayer_addr": "terra...",
  "bid_token": "terra...",
  "writing_extension_period": 1661296904,
  "auction_report_submission_period": 1661296904,
  "voting_period": 1661296904,
  "veto_threshold": "0.5"
}

Improv hub

Messages​

InstantiateMsg​

InstantiateMsg​

ExecuteMsgs​

create_proposal​

submit_story​

whitelist_collection (internal)​

create_proposal​

submit_story​

whitelist_collection (internal)​

QueryMsgs​

Config​

State​

view_proposal​

Query Proposals​

whitelisted_collections​

Config​

State​

view_proposal​

Query Proposals​

whitelisted_collections​

Messages

InstantiateMsg

InstantiateMsg

ExecuteMsgs

create_proposal

submit_story

whitelist_collection (internal)

create_proposal

submit_story

whitelist_collection (internal)

QueryMsgs

Config

State

view_proposal

Query Proposals

whitelisted_collections

Config

State

view_proposal

Query Proposals

whitelisted_collections