/templates

Primary LanguageRust

Ark Protocol

Join our discord and read in “mission” and “about” channels. Also visit us on Twitter.

IMPORTANT: (c) Ark Protocol 2022 ALL rights reserved. No copies, disclosure or forward of all data or any info provided here or by the Ark Protocol team is allowed! In case of any doubt contact Ark Protocol on Discord or Twitter.

Mission

“We from Ark Protocol believe that an NFT collection should depend solely on its project value and utilities - and must be independent of any specific blockchain.”

In the long term the Ark NFT Metaverse will provide utilities for all(!) NFT holders and NFT founders on any Cosmos and IBC-supported chains.

Ark Protocol’s mission is that every NFT project should solely focus and deliver utilities for their community. The technical barriers are high and require a deep technological understanding of smart contracts and multichain interactions. For NFT projects and their limited resources these obstacles are not only distracting from their NFT mission, it also increases costs in terms of resources like hiring developers and additional time to be considered for their roadmap.

Ark Protocol aims to lower these technical barriers ideally to zero. All this will be embraced by Ark Protocol’s NFT Metaverse by providing:

  1. Technical, low-level (though challenging) utilities

This allows NFT collections for launching and listing on multiple chains.

  1. Provide high-level, NFT oriented utilities like:

Easy access to other marketplaces and chains, DAO, staking, DeFi and other utilities.

  1. NFT Alliance

All NFT projects can benefit from each other. Sharing is caring. A NFT Alliance unites all projects to one big NFT fam where all communities across all chains can contribute and provide services and utilities to others.

This is Ark Protocol’s long term mission. We know it takes time and there is a long way to go. We don’t want to reinvent the wheel. There are many other and existing projects, people and utilities of great value. We believe in collaboration. The crypto and NFT space is big enough for all of us. We can only eat one steak per day ;).

Ark Protocol does not only serve the crypto and NFT community. From the beginning we will serve for higher human goals. This is why Chauncy St John is also a team member of Ark Protocol. Starting with our first and future funds and perpetual income we will donate a certain amount to Angel Protocol - because sharing is caring!

Development Environment

Chains: Juno and Stargaze

TODO: https://github.com/arkprotocol/arkprotocol/issues/3

Cargo

workspace

There is a main Cargo.toml file in root folder. It defines a Cargo Workspace and include all members in contracts folder.

This allows like building and testing all contracts from root folder:

$ cargo build # builds all contracts (pint and pong)
$ cargo test # tests all contracts (pint and pong)
$ cargo build -p ping # builds ping contract
$ cargo test -p ping # tests ping contract

Minimal Cargo Project

!!! IMPORTANT NOTE !!! In case:

  • contracts provide additional examples, then please add to minimal template
  • example might be bigger it may be created in a new dedicated template project
  • always use minimal template for any kind of project

For new Cargo projects please use templates/minimal.

Steps for creating a new project:

  • copy minimal e.g. to contracts folder
  • rename folder
  • adjust some files (read below)

These files and folders are there in minimal template:

  • examples
    • schema.rs: remove or uncomment, then call cargo schema which generates JSON files in schema folder
  • src
    • error.rs: extend with custom errors
    • execute.rs: remove or add code
    • helpers.rs: add helper functions here
    • lib.rs: exports modules
    • msg.rs: add messages here
    • query.rs: remove or add code
    • state.rs: remove or add code

In case of changes on above files you might need to adjust Cargo.toml. There are example crates for dependencies and dev dependencies that can be commented out as needed.

Tests

ts-relayer

Scripts (from package.json)

Scripts defined in package.json can be run like npm run build:test. These are the important scripts:

  • build:test: transpiles/compiles TypeScript files, everytime changes are made in TS a build is required!
  • build:wasm: calls build_integration_wasm.sh script
  • fix: reformats all ts files using prettier and eslint
  • test: calls build:test and all scripts starting with test:*
  • test:unit: runs unit tests (all files ending with *.spec.ts)

Ava is used for unit tests. For command line options read here: https://github.com/avajs/ava/blob/main/docs/05-command-line.md

In many cases your work on integration tests and do not build wasm files all the time. So the minimal and fastest would be using npm run build:test;npm run test:unit

Integration Tests

For integration tests the following might be useful:

utils.ts:

  • uploadAndInstantiateAll(): returns ChainInfo with these props:

    • wasmClient
    • osmoCLient
    • wasmContractInfos: a record of contracts with code id and contract address
    • osmoContractInfos: a record of contracts with code id and contract address

  • createIbcConnectionAndChannel(wasmClient, osmoClient, wasmContractAddress, osmoContractAddress, ordering, version): create an IBC channel for between 2 contracts on different chains

Here is a code snippet for uploading, instantiating contracts and creating IBC channel between 2 contracts:

let wasmContractInfos: Record<string, ContractInfo> = {};
let osmoContractInfos: Record<string, ContractInfo> = {};
let wasmClient: CosmWasmSigner;
let osmoClient: CosmWasmSigner;
let channelInfo: ChannelInfo;

const WASM_FILE = "./internal/ibc_dispatcher.wasm";

//Upload contracts to chains.
test.before(async (t) => {
  const contracts: Record<string, ContractMsg> = {
    contract1: {
      path: WASM_FILE,
      instantiateMsg: {},
    },
  };
  const chainInfo = await uploadAndInstantiateAll(contracts, contracts);
  wasmContractInfos = chainInfo.wasmContractInfos;
  osmoContractInfos = chainInfo.osmoContractInfos;
  wasmClient = chainInfo.wasmClient;
  osmoClient = chainInfo.osmoClient;

  channelInfo = await createIbcConnectionAndChannel(
    chainInfo.wasmClient,
    chainInfo.osmoClient,
    chainInfo.wasmContractInfos["contract1"].address,
    chainInfo.osmoContractInfos["contract1"].address,
    Order.ORDER_UNORDERED,
    "ping-1"
  );

  t.pass();
});

In controller.ts there is also:

  • instantiateContract(client, codeId, msg, label)
  • executeContract(client, contractAddr)
  • getIbcPortId(client, contractAddress, msg)

Contracts

ibc-example

TODO: https://github.com/arkprotocol/arkprotocol/issues/2

cw721-extension examples

This is based on: https://github.com/CosmWasm/cw-nfts/tree/main/contracts/cw721-metadata-onchain

Simple cw712 contract with metadata as extension stored on chain. Look here:

  • state.rs: defines metadata and adds it to Cw721Contract
  • execute.rs and query.rs: entry endpoints are dispatched through Cw721MetadataContract.

Have a look at unit tests showing how to:

  • instantiate a new NFT collection
  • mint an NFT for this instantiated collection
  • transfer an NFT to another address

Resources

Ark Protocol PoC

Ethan talk on IBC during HackAtom Seoul. YouTube videos with bookmark where he starts talking: