51 |
102 |
120 |
124 |
125 |
--------------------------------------------------------------------------------
/doc/examples.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
52 |
72 |
100 |
101 |
53 |
71 |
54 |
55 |
70 |
56 |
67 |
68 |
69 | API reference¶
57 | 66 |
53 |
123 |
142 |
146 |
147 |
--------------------------------------------------------------------------------
/doc/gettingstarted.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
54 |
93 |
121 |
122 |
55 |
92 |
56 |
57 |
91 |
58 |
64 |
65 |
70 |
71 |
79 |
80 |
86 |
87 |
88 |
89 |
90 | Examples¶
59 |A basic program that uses python-verge looks like this:
60 |First, import the library and exceptions.
61 |import vergerpc
62 | from vergerpc.exceptions import InsufficientFunds
63 | Then, we connect to the currently running verge instance of the current user on the local machine 66 | with one call to 67 | connect_to_local(). This returns a VERGEConnection objects:
68 |conn = vergerpc.connect_to_local()
69 | Try to move one verge from account testaccount to account testaccount2 using 72 | move(). Catch the InsufficientFunds 73 | exception in the case the originating account is broke:
74 |try:
75 | conn.move("testaccount", "testaccount2", 1.0)
76 | except InsufficientFunds,e:
77 | print "Account does not have enough funds available!"
78 | Retrieve general server information with getinfo() and print some statistics:
81 |info = conn.getinfo()
82 | print "Blocks: %i" % info.blocks
83 | print "Connections: %i" % info.connections
84 | print "Difficulty: %f" % info.difficulty
85 |
51 |
106 |
124 |
128 |
129 |
--------------------------------------------------------------------------------
/doc/index.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
52 |
76 |
104 |
105 |
53 |
75 |
54 |
55 |
74 |
56 |
71 |
72 |
73 | Getting Started¶
57 |
58 |
70 | -
59 |
- Introduction 60 |
- Usage
-
61 |
- Setting up verge for remote control 62 |
- Connecting to the wallet from Python 63 |
- How to use the API 64 |
- The account API 65 |
67 | - Examples 68 |
47 |
123 |
138 |
142 |
143 |
--------------------------------------------------------------------------------
/doc/introduction.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
48 |
88 |
121 |
122 |
49 |
87 |
50 |
51 |
86 |
52 |
83 |
84 |
85 | verge-python - Easy-to-use VERGE API client.¶
53 |verge-python is a set of Python libraries that allows easy access to the 54 | verge peer-to-peer cryptocurrency client API.
55 |Contents:
56 |
57 |
74 | -
58 |
- Getting Started
-
59 |
- Introduction 60 |
- Usage 61 |
- Examples 62 |
64 | - API reference 71 | 72 |
75 |
82 | Indices and tables¶
76 |-
77 |
- Index 78 |
- Module Index 79 |
- Search Page 80 |
53 |
131 |
150 |
154 |
155 |
--------------------------------------------------------------------------------
/doc/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vergecurrency/verge-python/8b05f1589ec944f429e25299fb2f5d6e7641c141/doc/objects.inv
--------------------------------------------------------------------------------
/doc/py-modindex.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
54 |
101 |
129 |
130 |
55 |
100 |
56 |
57 |
99 |
58 |
76 |
77 |
96 |
97 |
98 | Introduction¶
59 |The goal of this library is to make it easier for:
60 |-
61 |
- Payment gateways to support verge 62 |
- Merchant sites to integrate verge payments directly 63 |
- Other services that require (micro-)payments to use verge 64 |
In this initial release it implements a thin wrapper around the 66 | VERGE JSON-RPC API. Using this API from Python directly is conceptually very simple, 67 | here is the example from the API 68 | documentation page:
69 |from jsonrpc import ServiceProxy
70 |
71 | access = ServiceProxy("http://user:password@127.0.0.1:8332")
72 | access.getinfo()
73 | access.listreceivedbyaddress(6)
74 | access.sendtoaddress("11yEmxiMso2RsFVfBcCa616npBvGgxiBX", 10)
75 | However, this approach has some disadvantages, one thing is that error handling is complex, as it 78 | requires manually checking the contents of JSONException objects.
79 |verge-python attempts to create an even more friendly interface by wrapping the JSON-RPC API. The major advantages 80 | compared to a raw jsonrpc based approach are:
81 |-
82 |
- Better exception handling. Exceptions are converted to subclasses of VERGEException. 83 |
- Automatic verge configuration loading. In case the verge -server or verged program runs on the same 84 | machine as the client script, and as the same user, the configuration file can automatically be parsed. This 85 | makes it unneccesary to explicitly specify a username and password. Of course, this is still possible. 86 |
- Documentation in Pythonish format. You are reading this right now. 87 |
- The functions 88 | getinfo(), listreceivedbyaccount(), 89 | listreceivedbyaddress(), 90 | listtransactions() and more return actual Python objects, instead of simply 91 | dictionaries. This makes for cleaner code, as the fields can simply be addressed with x.foo instead of 92 | x['foo']. 93 |
The plan for future releases is to add a more high-level interface on top of this.
95 |
46 |
117 |
129 |
133 |
134 |
--------------------------------------------------------------------------------
/doc/search.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
47 |
98 |
115 |
116 |
48 |
97 |
49 |
50 |
51 |
58 |
93 |
94 |
95 |
96 | Python Module Index
52 | 53 |
54 | d
55 |
56 |
57 | | 60 | d | ||
| 64 | | 65 | vergerpc | 66 | |
| 69 | | 70 | vergerpc.config | 71 | |
| 74 | | 75 | vergerpc.connection | 76 | |
| 79 | | 80 | vergerpc.data | 81 | |
| 84 | | 85 | vergerpc.exceptions | 86 | |
| 89 | | 90 | vergerpc.util | 91 | |
51 |
88 |
100 |
104 |
105 |
--------------------------------------------------------------------------------
/doc/searchindex.js:
--------------------------------------------------------------------------------
1 | Search.setIndex({titles:["vergerpc.util — Generic utilities used by verge client library","vergerpc — Convenience functions","Examples","vergerpc.exceptions — Exception definitions","API reference","Introduction","vergerpc.data — VERGE RPC service, data objects","vergerpc.config — Utilities for reading verge configuration files","Getting Started","vergerpc.connection — Connect to VERGE server via JSON-RPC","Usage","verge-python - Easy-to-use VERGE API client."],objnames:{"0":["py","module","Python module"],"1":["py","exception","Python exception"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:exception","2":"py:method","3":"py:class","4":"py:function","5":"py:attribute"},objects:{"":{vergerpc:[1,0,0,"-"]},"vergerpc.util":{DStruct:[0,3,1,""]},"vergerpc.connection":{VERGEConnection:[9,3,1,""]},vergerpc:{data:[6,0,0,"-"],config:[7,0,0,"-"],util:[0,0,0,"-"],connect_to_local:[1,4,1,""],exceptions:[3,0,0,"-"],connect_to_remote:[1,4,1,""],connection:[9,0,0,"-"]},"vergerpc.exceptions":{wrap_exception:[3,4,1,""],WalletError:[3,1,1,""],NotConnected:[3,1,1,""],SafeMode:[3,1,1,""],VERGEException:[3,1,1,""],DownloadingBlocks:[3,1,1,""],InvalidParameter:[3,1,1,""],WalletPassphraseIncorrect:[3,1,1,""],InvalidTransactionID:[3,5,1,""],WalletEncryptionFailed:[3,1,1,""],SendError:[3,5,1,""],WalletWrongEncState:[3,1,1,""],ClientException:[3,1,1,""],OutOfMemory:[3,1,1,""],TransportException:[3,1,1,""],WalletUnlockNeeded:[3,1,1,""],KeypoolRanOut:[3,1,1,""],WalletAlreadyUnlocked:[3,1,1,""],JSONTypeError:[3,1,1,""],InvalidAddressOrKey:[3,1,1,""],InsufficientFunds:[3,1,1,""],InvalidAmount:[3,5,1,""],InvalidAccountName:[3,1,1,""]},"vergerpc.data":{MiningInfo:[6,3,1,""],AccountInfo:[6,3,1,""],TransactionInfo:[6,3,1,""],WorkItem:[6,3,1,""],ServerInfo:[6,3,1,""],AddressInfo:[6,3,1,""],AddressValidation:[6,3,1,""]},"vergerpc.connection.VERGEConnection":{getaccountaddress:[9,2,1,""],listunspent:[9,2,1,""],getmininginfo:[9,2,1,""],getinfo:[9,2,1,""],getblock:[9,2,1,""],validateaddress:[9,2,1,""],getbalance:[9,2,1,""],listreceivedbyaccount:[9,2,1,""],sendfrom:[9,2,1,""],sendtoaddress:[9,2,1,""],stop:[9,2,1,""],backupwallet:[9,2,1,""],listtransactions:[9,2,1,""],keypoolrefill:[9,2,1,""],walletlock:[9,2,1,""],setaccount:[9,2,1,""],getrawtransaction:[9,2,1,""],getreceivedbyaccount:[9,2,1,""],decoderawtransaction:[9,2,1,""],getreceivedbyaddress:[9,2,1,""],move:[9,2,1,""],getgenerate:[9,2,1,""],setgenerate:[9,2,1,""],getconnectioncount:[9,2,1,""],signmessage:[9,2,1,""],gettransaction:[9,2,1,""],getblockcount:[9,2,1,""],getblocknumber:[9,2,1,""],verifymessage:[9,2,1,""],walletpassphrasechange:[9,2,1,""],getdifficulty:[9,2,1,""],getaddressesbyaccount:[9,2,1,""],walletpassphrase:[9,2,1,""],sendmany:[9,2,1,""],listaccounts:[9,2,1,""],dumpprivkey:[9,2,1,""],getaccount:[9,2,1,""],gettxout:[9,2,1,""],listreceivedbyaddress:[9,2,1,""],getwork:[9,2,1,""],getblockhash:[9,2,1,""],getnewaddress:[9,2,1,""],importprivkey:[9,2,1,""],gethashespersec:[9,2,1,""],createrawtransaction:[9,2,1,""],signrawtransaction:[9,2,1,""]},"vergerpc.config":{read_config_file:[7,4,1,""],read_default_config:[7,4,1,""]}},envversion:43,filenames:["vergerpc.util","vergerpc","examples","vergerpc.exceptions","apireference","introduction","vergerpc.data","vergerpc.config","gettingstarted","vergerpc.connection","usage","index"],terms:{currentblocktx:6,also:10,paytxfe:6,doe:2,credit:9,ran:3,etc:3,block:[3,9,2,6],spend:9,usag:[],even:5,clientexcept:3,raw:[9,5],again:[9,10],all:9,between:10,main:10,specifi:[9,5,10],get:[],time:9,proxi:6,getbal:[9,10],origin:2,argument:[9,1,7,10],about:[9,10],give:10,node:9,level:[3,5],isvalid:[6,10],signatur:9,dat:9,move:[9,2,6],access:[11,5],skip:9,args_t:[0,6],com:10,getconnectioncount:9,passphras:[3,9],invalidaccountnam:3,ismin:6,implement:5,enabl:[9,6],args_d:[0,6],last:9,associ:[9,6],pars:[5,7],tri:9,deni:3,program:[5,2],importprivkei:9,found:3,effici:0,output:9,insufficientfund:[3,2],load:5,friendli:5,handl:5,getgener:9,yoyodyn:10,timestamp:6,command:[3,10],same:5,unneccesari:5,either:[9,10],variou:9,"function":[],getinfo:[9,5,2,10,6],disadvantag:5,dont_rais:9,"class":[0,9,6,3],"case":[5,2],consid:9,abl:[9,10],insuffici:3,invalidtransactionid:3,server:[],util:[],sourc:9,connect_to_loc:[1,2,10],hashespersec:6,more:[0,5,10,3],createrawtransact:9,unspent:9,maxconf:9,account:[],wrap:5,pass:3,invalidparamet:3,p2p:3,raw_detail:3,error:[3,5,6,7],serial:9,verbos:9,thin:[9,5],getdifficulti:9,onc:10,readabl:9,retriev:2,actual:5,private_kei:9,out:[3,10],input:9,onli:[9,6],vergeconnect:[9,1,2],peer:[3,11],bar:10,broke:2,gettransact:9,four:10,easi:[],requir:[9,5],thank:10,call:[3,9,2],pay_to:10,given:[3,9],conceptu:5,automat:5,outofmemori:3,unlock:[3,9],incorrect:3,look:2,"true":[9,6],than:9,count:9,minconf:9,thi:[1,2,3,5,9,10],acct:9,defin:[3,9],unless:9,listunsp:9,proof:9,introduct:[],conf:10,altcoin:9,copi:9,queri:9,produc:9,conn:[9,2,10],oper:3,localhost:[9,1],validateaddress:[9,6,10],accountinfo:[9,6],must:10,you:[9,5,10],done:10,walletpassphras:[3,9],goal:5,first:[3,9,2,6],processor:[9,6],simpli:[5,10],fee:6,"default":[9,1,7,10],vergeaddress:9,code:[3,5],otheraccount:6,chain:9,transact:[3,9,6],password:[5,9,1,10],unicod:9,pleas:10,setaccount:9,credenti:10,add:[9,5],multipl:[9,10],specif:3,fund:[3,2,6],latest:9,dynam:0,script:5,verged:[3,5,10],enter:3,unexpect:3,never:3,support:5,own:1,make:5,unabl:7,transport:3,version:6,memori:[0,9,3],name:[3,9,6],after:[9,6,10],host:[9,1,10],certain:[9,10],most:[6,10],getreceivedbyaccount:9,testnet:6,transcat:9,gettxout:9,cryptocurr:11,disablesafemod:3,page:[11,5],befor:9,mode:3,separ:10,walletpassphraseincorrect:[3,9],gethashespersec:9,attempt:5,much:10,confirm:[9,6],list:9,directori:[9,7,10],ioerror:7,altern:1,easiest:10,subclass:5,should:9,walletalreadyunlock:3,occur:7,buffer:6,work:9,here:5,manual:5,fill:9,pythonish:5,thei:9,cleaner:5,from_:9,togeth:10,dstruct:[0,6],haven:9,machin:[5,1,2,10],minimum:9,site:5,previou:[9,10],jsonrpc:5,receiv:[3,9,6,10],human:9,getblocknumb:9,fail:[3,9],decod:9,high:5,filenam:[9,1,7],your:[9,10],compar:5,connect:[],"while":9,been:10,advanc:10,map:9,how:[],read_config_fil:7,approach:5,includeempti:9,simpl:[0,5,7],keep:9,redeemscript:9,serviceproxi:5,paramet:[3,9,10],base58:9,right:5,deprec:9,coin:[9,10],problem:3,midstat:6,per:[9,6],whether:[9,10],failur:3,mempool:9,transactioninfo:[9,6],standard:[1,7],from:[],sent:6,fromaccount:9,modul:11,blockchain:9,validat:6,open:7,two:10,success:9,precomput:6,solv:9,send:[9,6,10],"new":[9,10],convert:[3,5],getaccountaddress:9,getmininginfo:[9,6],allow:[9,10,11],integr:5,privat:9,signmessag:9,softwar:10,set:[],current:[7,9,2,10,6],remov:9,basic:[2,10],remot:[],perform:9,merchant:5,recommend:9,previous_transact:9,see:10,via:[],hostnam:10,limit:6,serverinfo:[9,6],valueerror:7,best:9,use_http:[9,1],which:[9,6],walletencryptionfail:3,mkzbybiq6dnoqekakpmjegydbw2yinqnht:9,locat:[1,7],senderror:3,signrawtransact:9,transportexcept:3,repres:9,listaccount:9,setgener:9,local:[1,2,10],gener:[],configur:[],rpc:[],oldest:6,categori:6,whose:9,walleterror:3,chang:9,pirat:10,search:11,possibl:[9,5],littl:6,transactiond:9,second:[9,6],sign:9,prepar:10,destin:9,timeout:9,recent:[9,6],form:9,longest:9,workitem:[9,6],vout:9,futur:5,"11yemximso2rsfvfbcca616npbvggxibx":5,number:[9,6],encod:9,sendmani:9,made:10,except:[],tovergeaddress:9,jsontypeerror:3,epoch:6,keypoolrefil:[3,9],explicitli:[5,10],getnewaddress:[9,10],were:6,safemod:3,as_dict:9,less:[0,9],begin:10,a9d4599e15b53f3eb531608ddb31f48c695c3d0b3538a6bda871e8b34f2f430c:9,todict:9,dure:3,maxim:9,comment_to:9,none:[3,9,1,7],notconnect:3,object:[],clear:10,yet:9,accept:10,network:[3,6],instanc:[1,2,10],place:10,collect:0,rpcuser:10,sendfrom:9,mstgam1apjejfswfaarvazhrm26mv5gl73:10,least:9,each:9,howev:[5,10],verge:[],mine:9,depend:9,"try":2,alia:3,off:9,txid:[9,6],"float":9,submit:9,anoth:9,vergeexcept:[3,5],downloadingblock:3,target:6,ship:10,automag:10,listreceivedbyaddress:[9,5,6],read:[],detail:[9,10],config:[],easier:5,encrypt:[3,9,6],custom:10,authent:9,amount:[9,6,10],addressvalid:[9,6],verifymessag:9,backup:9,getreceivedbyaddress:[9,10],control:[],sinc:6,home:[7,10],background:10,path:[9,1,7],verifi:9,fals:[9,1,6],endian:6,hash1:6,print:[2,10],still:[3,5],utxo:9,hexstr:9,have:[2,10],file:[],download:3,unspecifi:3,behav:9,wrong:3,alreadi:3,unlimit:9,oldpassphras:9,pai:6,structur:0,els:10,dictionari:[9,5],type:[3,9],walletwrongencst:3,definit:[],document:[5,10],complex:5,getaddressesbyaccount:9,initi:5,statist:2,balanc:[9,6,10],instead:[9,5],real:6,plan:5,want:10,turn:9,complet:[3,9],python:[],round:9,decrypt:9,rais:[3,9,7],interfac:5,anyth:10,log:[9,10],unlocked_until:6,belong:9,some:[5,2],wallet:[],"catch":2,book:9,walletlock:9,json:[],comment:9,bool:9,releas:5,cours:5,non:[1,7],conveni:[],run:[3,5,2,10],half:6,vergerpc:[],sandwidth:10,like:[0,9,2],payment:[9,5,10],keypool:[3,9,6],check:[5,10],state:[3,9,6],total:[9,6],newpassphras:9,wrap_except:3,string:9,msg:3,exampl:[],foo:[5,10],stop:9,size:6,sort:10,invalidaddressorkei:3,mai:9,usernam:5,format:[9,5,6],wai:10,testaccount2:2,messag:[9,6],field:5,invalid:[3,10],addressinfo:[9,6],neccesari:10,mani:10,data:[],measur:9,getwork:[9,6],gatewai:5,content:[11,5],pool:[9,6],user:[1,2,5,7,9,10],connect_to_remot:[1,10],base:[0,9,5,6,3],contain:9,top:5,"public":9,mininginfo:[9,6],safe:[3,9,10],superclass:3,protocol:3,keypoolranout:3,delimit:7,getblock:9,getaccount:9,walletpassphrasechang:9,rescan:9,hash:[9,6],listreceivedbyaccount:[9,5,6],decoderawtransact:9,better:5,"import":[9,5,2,10],currentblocks:6,str:9,inform:[9,2,10,6],getrawtransact:9,within:10,method:[9,10],correct:10,difficulti:[9,2,6],provid:[3,9,10],backupwallet:9,jsonexcept:5,info:[9,2],port:[9,1,10],listtransact:[9,5,6],pooledtx:6,empti:9,sendtoaddress:[9,5,10],advantag:5,rpcpassword:10,servic:[],ani:[3,9,6,10],address:[3,9,5,6,10],avail:[9,2],thing:5,creat:[9,5,10],valid:[9,10],scriptpubkei:9,major:5,includ:[9,6],write:10,walletunlockneed:3,dogeconf:10,keypoololdest:6,genproclimit:[9,6],disabl:9,option:[9,1,7],builtin:[0,9,3],lock:[9,6],index:[9,11],nearest:9,wrapper:[9,5],getblockcount:9,veri:5,valu:9,transfer:9,http:[5,10],privkei:9,store:[9,10],directli:5,can:[9,5,10],when:10,invalidamount:3,paid:[9,6],around:[9,5],now:5,constructor:9,need:9,flexibl:0,kei:[3,9,6],process:10,testaccount:2,hex:9,read_default_config:7,"return":[1,2,5,6,9,10],micro:5,bank:10,getblockhash:9,dumpprivkei:9,toaccount:9,other:[3,9,5,6],enough:2,client:[],result:9,namedtupl:0},titleterms:{config:7,conveni:1,how:10,"function":1,introduct:5,object:6,set:10,easi:11,refer:4,remot:10,server:9,util:[0,7],control:10,exampl:2,usag:10,vergerpc:[0,1,3,7,6,9],python:[11,10],via:9,connect:[9,10],account:10,wallet:10,definit:3,indic:11,file:7,tabl:11,read:7,from:10,except:3,servic:6,data:6,librari:0,verge:[0,6,7,9,10,11],gener:0,json:9,get:8,configur:7,rpc:[9,6],api:[4,10,11],start:8,client:[0,11]}})
--------------------------------------------------------------------------------
/doc/usage.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
52 |
82 |
86 |
87 |
53 |
81 |
54 |
55 |
80 | Search
56 |
57 |
58 |
63 | 59 | Please activate JavaScript to enable the search 60 | functionality. 61 |
62 |64 | From here you can search these documents. Enter your search 65 | words into the box below and click "search". Note that the search 66 | function will automatically search for all of the words. Pages 67 | containing fewer words won't appear in the result list. 68 |
69 | 74 | 75 |
76 |
77 |
78 |
79 |
53 |
202 |
221 |
225 |
226 |
--------------------------------------------------------------------------------
/doc/vergerpc.config.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
54 |
161 |
200 |
201 |
55 |
160 |
56 |
57 |
159 |
58 |
156 |
157 |
158 | Usage¶
59 |See also the `main verge documentation`_ for details and background on setting up and 60 | using verged remotely.
61 |
62 |
70 |
71 |
75 |
76 |
77 | Setting up verge for remote control¶
63 |If you run VERGE with the -server argument, or if you run verged, it can be controlled 64 | either by sending it HTTP-JSON-RPC commands.
65 |However, beginning with VERGE 0.3.3 you must create a verge.conf file in the VERGE data directory 66 | (default $HOME/.dogeconf) and set an RPC password:
67 |rpcuser=anything
68 | rpcpassword=anything
69 | Once that is done, the easiest way to check whether VERGE accepts remote commands is by running 72 | VERGE again, with the command (and any parameters) as arguments. For example:
73 |$ verged getinfo
74 |
78 |
99 | Connecting to the wallet from Python¶
79 |There are two functions for this:
80 |-
81 |
- Connecting to local verge instance 82 |
Use the function connect_to_local(). This automagically 83 | sorts out the connection to a verge process running on the current machine, 84 | for the current user.
85 |88 |87 |conn = vergerpc.connect_to_local() 86 |
89 | - Connecting to a remote verge instance 90 |
Use the function connect_to_remote(). For this function 91 | it is neccesary to explicitly specify a hostname and port to connect to, and 92 | to provide user credentials for logging in.
93 |96 |95 |conn = vergerpc.connect_to_remote('foo', 'bar', host='payments.yoyodyne.com', port=8332) 94 |
97 |
100 |
148 | How to use the API¶
101 |For basic sending and receiving of payments, the four most important methods are
102 |-
103 |
- Getting the current balance 104 |
Use the method getbalance() to get the current server balance.
105 |108 |107 |print "Your balance is %f" % (conn.getbalance(),) 106 |
109 | - Check a customer address for validity and get information about it 110 |
This can be done with the method validateaddress().
111 |118 |117 |rv = conn.validateaddress(foo) 112 | if rv.isvalid: 113 | print "The address that you provided is valid" 114 | else: 115 | print "The address that you provided is invalid, please correct" 116 |
119 | - Sending payments 120 |
The method sendtoaddress() sends a specified 121 | amount of coins to a specified address.
122 |125 |124 |conn.sendtoaddress("msTGAm1ApjEJfsWfAaRVaZHRm26mv5GL73", 20.0) 123 |
126 | - Get a new address for accepting payments 127 |
To accept payments, use the method getnewaddress() 128 | to generate a new address. Give this address to the customer and store it in a safe place, to be able to check 129 | when the payment to this address has been made.
130 |134 |133 |pay_to = conn.getnewaddress() 131 | print "We will ship the pirate sandwidth after payment of 200 coins to ", pay_to 132 |
135 | - Check how much has been received at a certain address 136 |
The method getreceivedbyaddress() 137 | returns how many verges have been received at a certain address. Together with the 138 | previous function, this can be used to check whether a payment has been made 139 | by the customer.
140 |145 |144 |amount = conn.getreceivedbyaddress(pay_to) 141 | if amount > 200.0: 142 | print "Thanks, your sandwidth will be prepared and shipped." 143 |
146 |
149 |
155 | The account API¶
150 |More advanced usage of verge allows multiple accounts within one wallet. This 151 | can be useful if you are writing software for a bank, or 152 | simply want to have a clear separation between customers payments.
153 |For this, see the Account API documentation.
154 |
49 |
107 |
123 |
127 |
128 |
--------------------------------------------------------------------------------
/doc/vergerpc.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
50 |
80 |
105 |
106 |
51 |
79 |
52 |
53 |
78 |
54 |
75 |
76 |
77 | vergerpc.config — Utilities for reading verge configuration files¶
55 |Utilities for reading verge configuration files.
56 |-
57 |
- 58 | vergerpc.config.read_config_file(filename)¶ 59 |
Read a simple '='-delimited config file. 60 | Raises IOError if unable to open file, or ValueError 61 | if an parse error occurs.
62 |
-
65 |
- 66 | vergerpc.config.read_default_config(filename=None)¶ 67 |
Read verge default configuration from the current user’s home directory.
68 |Arguments:
69 |-
70 |
- filename: Path to a configuration file in a non-standard location (optional) 71 |
53 |
116 |
135 |
139 |
140 |
--------------------------------------------------------------------------------
/doc/vergerpc.util.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
54 |
86 |
114 |
115 |
55 |
85 |
56 |
57 |
84 |
58 |
81 |
82 |
83 | vergerpc — Convenience functions¶
59 |verge-python - Easy-to-use VERGE API client
60 |-
61 |
- 62 | vergerpc.connect_to_local(filename=None)¶ 63 |
Connect to default VERGE instance owned by this user, on this machine.
64 |Returns a VERGEConnection object.
65 |Arguments:
66 |67 |
71 |-
68 |
- filename: Path to a configuration file in a non-standard location (optional) 69 |
-
74 |
- 75 | vergerpc.connect_to_remote(user, password, host='localhost', port=22555, use_https=False)¶ 76 |
Connect to remote or alternative local verge client instance.
77 |Returns a VERGEConnection object.
78 |
43 |
88 |
100 |
104 |
105 |
--------------------------------------------------------------------------------
/release_process.txt:
--------------------------------------------------------------------------------
1 | Release process
2 |
3 | - Update Changelog (using git history output from dist-tools/changelog.sh)
4 |
5 | - Change version numbers in setup.py and sphinx/source/conf.py
6 |
7 | - Commit
8 |
9 | - Make tag and upload to github
10 |
11 | - git tag -a vX.X
12 | - git push origin vX.X
13 |
14 | - Run make in doc/
15 |
16 | - Update documentation on github
17 |
18 | - git checkout gh_pages
19 | - rm -r doc
20 | - mkdir doc
21 | - cp -r sphinx/build/html/* doc/
22 | - git add doc
23 | - git commit -a
24 | - git push origin gh-pages:gh-pages
25 |
26 | - Upload to pypi
27 |
28 | - python setup.py sdist upload
29 |
30 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import setup, find_packages
2 | setup(
3 | name='verge-python',
4 | version='0.1.3',
5 | description='Friendly VERGE JSON-RPC API binding for Python',
6 | long_description='This package allows performing commands such as listing the current balance'
7 | ' and sending coins to the original client from Python. The communication with the'
8 | ' client happens over JSON-RPC.',
9 | url='https://github.com/vergecurrency/verge-python',
10 | classifiers=[
11 | 'Development Status :: 4 - Beta',
12 | 'Environment :: Console',
13 | 'Environment :: Web Environment',
14 | 'Intended Audience :: Developers',
15 | 'Programming Language :: Python',
16 | 'License :: OSI Approved :: MIT License',
17 | 'Topic :: Office/Business :: Financial'
18 | ],
19 | packages=find_packages("src"),
20 | package_dir={'': 'src'}
21 | )
22 |
--------------------------------------------------------------------------------
/sphinx/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = build
9 |
10 | # Internal variables.
11 | PAPEROPT_a4 = -D latex_paper_size=a4
12 | PAPEROPT_letter = -D latex_paper_size=letter
13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14 |
15 | .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16 |
17 | help:
18 | @echo "Please use \`make
44 |
64 |
86 |
87 |
45 |
63 |
46 |
47 |
62 |
48 |
59 |
60 |
61 | vergerpc.util — Generic utilities used by verge client library¶
49 |Generic utilities used by verge client library.
50 |-
51 |
- 52 | class vergerpc.util.DStruct(*args_t, **args_d)¶ 53 |
Bases: builtins.object
54 |Simple dynamic structure, like collections.namedtuple but more flexible 55 | (and less memory-efficient)
56 |