Install

pip3 install ic-py

Features

Modules & Usage

1. Principal

fromic.principalimportPrincipalp=Principal()# default is management canister id `aaaaa-aa`p1=Principal(bytes=b'')# create an instance from bytesp2=Principal.anonymous()# create anonymous principalp3=Principal.self_authenticating(pubkey)# create a principal from public keyp4=Principal.from_str('aaaaa-aa')# create an instance from stringp5=Principal.from_hex('xxx')# create an instance from hex

p.bytes# principal bytesp.len# byte array lengthp.to_str()# convert to string

2. Identity

fromic.identityimportIdentityi=Identity()# create an identity instance, key is randomly generatedi1=Identity(privkey="833fe62409237b9d62ec77587520911e9a759cec1d19755b7da901b96dca3d42")# create an instance from private key

msg=b”ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f“sig=i.sign(msg)# sig = (der_encoded_pubkey, signature)

3. Client

fromic.clientimportClientclient=Client(url="https://ic0.app")

4. Candid

fromic.candidimportencode,decode,Types# params is an array, return value is encoded bytesparams= [{'type':Types.Nat,'value':10}]data=encode(params)

# data is bytes, return value is an parameter arrayparams=decode(data)

5. Agent

fromic.clientimportClientfromic.identityimportIdentityfromic.agentimportAgent# Identity and Client are dependencies of Agentiden=Identity()client=Client()agent=Agent(iden,client)

# query the name of token canister `gvbup-jyaaa-aaaah-qcdwa-cai`name=agent.query_raw("gvbup-jyaaa-aaaah-qcdwa-cai","name",encode([]))

# transfer 100 token to blackhole address `aaaaa-aa`params= [{'type':Types.Principal,'value':'aaaaa-aa'},{'type':Types.Nat,'value':10000000000}]result=agent.update_raw("gvbup-jyaaa-aaaah-qcdwa-cai","transfer",encode(params))

6. Canister

fromic.canisterimportCanisterfromic.clientimportClientfromic.identityimportIdentityfromic.agentimportAgentfromic.candidimportTypesiden=Identity()client=Client()agent=Agent(iden,client)# read governance candid from filegovernance_did=open("governance.did").read()# create a governance canister instancegovernance=Canister(agent=agent,canister_id="rrkah-fqaaa-aaaaa-aaaaq-cai",candid=governance_did)# call canister method with instanceres=governance.list_proposals(    {'include_reward_status': [],'before_proposal': [],'limit':100,'exclude_topic': [],'include_status': [1]    })

7. Async request

importasynciofromic.canisterimportCanisterfromic.clientimportClientfromic.identityimportIdentityfromic.agentimportAgentfromic.candidimportTypesiden=Identity()client=Client()agent=Agent(iden,client)# read governance candid from filegovernance_did=open("governance.did").read()# create a governance canister instancegovernance=Canister(agent=agent,canister_id="rrkah-fqaaa-aaaaa-aaaaq-cai",candid=governance_did)# async callasyncdefasync_test():res=awaitgovernance.list_proposals_async(    {'include_reward_status': [],'before_proposal': [],'limit':100,'exclude_topic': [],'include_status': [1]    }  )print(res)asyncio.run(async_test())